[email protected]

A TypeScript SDK client for the api.mudbase.dev API.

Usage

First, install the SDK from npm.

npm install mudbase-cells-sdk --save

Next, try it out.

import {
  Configuration,
  BillingApi,
} from 'mudbase-cells-sdk';
import type { GetSandboxBillingUsageRequest } from 'mudbase-cells-sdk';

async function example() {
  console.log("🚀 Testing mudbase-cells-sdk SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: ApiKeyAuth
    apiKey: "YOUR API KEY",
    // Configure HTTP bearer authorization: BearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new BillingApi(config);

  const body = {
    // string
    projectId: projectId_example,
    // number (optional)
    months: 56,
  } satisfies GetSandboxBillingUsageRequest;

  try {
    const data = await api.getSandboxBillingUsage(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.mudbase.dev/api/sandboxes

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- BillingApi | getSandboxBillingUsage | GET /projects/{projectId}/billing/usage | Get billing usage CheckpointsApi | checkpointSession | POST /projects/{projectId}/sessions/{sessionId}/checkpoint | Create a checkpoint CheckpointsApi | deleteCheckpoint | DELETE /projects/{projectId}/sessions/{sessionId}/checkpoints/{checkpointId} | Delete a checkpoint CheckpointsApi | getRestoreJob | GET /projects/{projectId}/sessions/{sessionId}/restores/{restoreId} | Get restore job status CheckpointsApi | listCheckpoints | GET /projects/{projectId}/sessions/{sessionId}/checkpoints | List checkpoints CheckpointsApi | restoreFromCheckpoint | POST /projects/{projectId}/sessions/{sessionId}/restore | Restore from a checkpoint ExecutionApi | execSession | POST /projects/{projectId}/sessions/{sessionId}/exec | Run a command (streaming SSE) FilesApi | readFile | GET /projects/{projectId}/sessions/{sessionId}/files | Read a file FilesApi | writeFiles | POST /projects/{projectId}/sessions/{sessionId}/files | Write files ServicesApi | getServiceLogs | GET /projects/{projectId}/sessions/{sessionId}/services/{name}/logs | Get service logs (snapshot) ServicesApi | listServices | GET /projects/{projectId}/sessions/{sessionId}/services | List services ServicesApi | startService | POST /projects/{projectId}/sessions/{sessionId}/services | Start a service ServicesApi | stopService | DELETE /projects/{projectId}/sessions/{sessionId}/services/{name} | Stop a service ServicesApi | streamServiceLogs | GET /projects/{projectId}/sessions/{sessionId}/services/{name}/logs/stream | Stream service logs (SSE) SessionsApi | closeSession | DELETE /projects/{projectId}/sessions/{sessionId} | Close a session SessionsApi | createSession | POST /projects/{projectId} | Create a session SessionsApi | deleteSessionVolume | DELETE /projects/{projectId}/sessions/{sessionId}/volume | Delete a cell's persistent volume SessionsApi | exposePort | POST /projects/{projectId}/sessions/{sessionId}/expose | Expose a port SessionsApi | getConnectToken | POST /projects/{projectId}/sessions/{sessionId}/connect-token | Get a connect token SessionsApi | getSession | GET /projects/{projectId}/sessions/{sessionId} | Get a session SessionsApi | listSessions | GET /projects/{projectId} | List sessions SessionsApi | patchSession | PATCH /projects/{projectId}/sessions/{sessionId} | Update session metadata SessionsApi | resumeSession | POST /projects/{projectId}/sessions/{sessionId}/resume | Resume a session SessionsApi | suspendSession | POST /projects/{projectId}/sessions/{sessionId}/suspend | Suspend a session

Models

• CheckpointSessionRequest
• CloseSession200Response
• CreateSessionRequest
• CreateSessionRequestInitialExec
• CreateSessionResponse
• CreateSessionResponseUsageWarning
• ErrorResponse
• ExecRequest
• ExposePortRequest
• ListSessions200Response
• PatchSessionRequest
• ReadFileResponse
• RestoreFromCheckpointRequest
• Session
• StartServiceRequest
• WriteFilesRequest
• WriteFilesRequestFilesInner

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

BearerAuth

• Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the MUDBASE project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

For more information, please visit https://cells.mudbase.dev

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License