@boatdev/sdk 1.7.0 → 1.9.0

package/docs/BoatApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://boat.dev/api/v1*
 | [**create**](BoatApi.md#create) | **POST** /sandboxes | Create sandbox |
 | [**createEnvironment**](BoatApi.md#createenvironment) | **POST** /environments | Create a sandbox environment |
 | [**createScopedApiKey**](BoatApi.md#createscopedapikeyoperation) | **POST** /api-keys/scoped | Create a scoped API key |
+| [**createSnapshotShare**](BoatApi.md#createsnapshotshare) | **POST** /named-snapshots/{name}/shares | Share a named snapshot |
 | [**createWebhook**](BoatApi.md#createwebhook) | **POST** /webhooks | Create webhook |
 | [**deleteEnvironment**](BoatApi.md#deleteenvironment) | **DELETE** /environments/{environmentId} | Delete a sandbox environment |
 | [**deleteEnvironmentRepo**](BoatApi.md#deleteenvironmentrepo) | **DELETE** /environments/{environmentId}/repos/{repositoryId} | Remove a repository from an environment |
@@ -36,6 +37,7 @@ All URIs are relative to *https://boat.dev/api/v1*
 | [**getSnapshotDownload**](BoatApi.md#getsnapshotdownload) | **GET** /snapshots/{snapshotId}/download | Get snapshot download |
 | [**getSnapshotFile**](BoatApi.md#getsnapshotfile) | **GET** /snapshots/{snapshotId}/files | Download a file or folder from a snapshot |
 | [**getSnapshotTree**](BoatApi.md#getsnapshottree) | **GET** /snapshots/{snapshotId}/tree | Get snapshot file tree |
+| [**getStop**](BoatApi.md#getstop) | **GET** /sandboxes/{sandboxId}/stops/{stopId} | Get a stop by id |
 | [**getWebhook**](BoatApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get webhook |
 | [**hostPort**](BoatApi.md#hostportoperation) | **POST** /sandboxes/{sandboxId}/host | Expose a sandbox port on a public HTTPS URL |
 | [**interrupt**](BoatApi.md#interrupt) | **POST** /sandboxes/{sandboxId}/interrupt | Interrupt running work |
@@ -43,15 +45,18 @@ All URIs are relative to *https://boat.dev/api/v1*
 | [**listNamedSnapshots**](BoatApi.md#listnamedsnapshots) | **GET** /named-snapshots | List named snapshots |
 | [**listOrganizations**](BoatApi.md#listorganizations) | **GET** /orgs | List organizations |
 | [**listSandboxSnapshots**](BoatApi.md#listsandboxsnapshots) | **GET** /sandboxes/{sandboxId}/snapshots | List boat snapshots |
+| [**listSnapshotShares**](BoatApi.md#listsnapshotshares) | **GET** /named-snapshots/{name}/shares | List share codes of a named snapshot |
 | [**listSnapshots**](BoatApi.md#listsnapshots) | **GET** /snapshots | List snapshots |
 | [**listWebhooks**](BoatApi.md#listwebhooks) | **GET** /webhooks | List webhooks |
 | [**me**](BoatApi.md#me) | **GET** /me | Get current Boat user |
 | [**prompt**](BoatApi.md#promptoperation) | **POST** /sandboxes/{sandboxId}/prompt | Prompt Sandbox |
 | [**promptRunStatus**](BoatApi.md#promptrunstatus) | **GET** /sandboxes/{sandboxId}/prompts/{promptId} | Get prompt run status |
 | [**readFile**](BoatApi.md#readfile) | **GET** /sandboxes/{sandboxId}/files | Read a file from a sandbox |
+| [**recover**](BoatApi.md#recover) | **POST** /sandboxes/{sandboxId}/recover | Recover a sandbox that stopped responding |
 | [**repos**](BoatApi.md#repos) | **GET** /repos | List GitHub repositories available to Boat |
 | [**resume**](BoatApi.md#resumeoperation) | **POST** /sandboxes/{sandboxId}/resume | Resume sandbox |
 | [**revokeApiKey**](BoatApi.md#revokeapikey) | **DELETE** /api-keys/{apiKeyId} | Revoke an API key |
+| [**revokeSnapshotShare**](BoatApi.md#revokesnapshotshare) | **DELETE** /named-snapshots/{name}/shares/{shareId} | Revoke a share code |
 | [**rotateApiKey**](BoatApi.md#rotateapikey) | **POST** /api-keys/{apiKeyId}/rotate | Rotate an API key |
 | [**rotateWebhookSigningSecret**](BoatApi.md#rotatewebhooksigningsecret) | **POST** /webhooks/{webhookId}/rotate | Rotate webhook signing secret |
 | [**sandboxes**](BoatApi.md#sandboxes) | **GET** /sandboxes | List sandboxes |
@@ -297,6 +302,8 @@ This endpoint does not need any parameter.
 
 Download a sandbox artifact
 
+Downloads one file of up to 50 MiB, under /home/user or /tmp, as raw bytes.
+
 ### Example
 
 ```ts
@@ -827,6 +834,79 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createSnapshotShare
+
+> NamedSnapshotShareCreatedResponse createSnapshotShare(name)
+
+Share a named snapshot
+
+Make a secret code that lets any Boat account create a sandbox from this named snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { CreateSnapshotShareRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string
+    name: name_example,
+  } satisfies CreateSnapshotShareRequest;
+
+  try {
+    const data = await api.createSnapshotShare(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**NamedSnapshotShareCreatedResponse**](NamedSnapshotShareCreatedResponse.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Code created. Store `shareCode` now; Boat does not show it again. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **404** | Resource not found. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## createWebhook
 
 > WebhookSecretResponse createWebhook(webhookCreateRequest)
@@ -2482,6 +2562,82 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getStop
+
+> StopOperationResponse getStop(sandboxId, stopId)
+
+Get a stop by id
+
+Returns one stop of this sandbox by the id that `POST /sandboxes/{sandboxId}/stop` returned. Old stops stay readable after a resume or a later stop. Returns 404 when the id is unknown or belongs to another sandbox.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { GetStopRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string | Public Sandbox id returned by create/list/get sandbox calls.
+    sandboxId: sandboxId_example,
+    // string
+    stopId: stopId_example,
+  } satisfies GetStopRequest;
+
+  try {
+    const data = await api.getStop(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
+| **stopId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**StopOperationResponse**](StopOperationResponse.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The stop. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **404** | Resource not found. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getWebhook
 
 > WebhookResponse getWebhook(webhookId)
@@ -3000,6 +3156,79 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## listSnapshotShares
+
+> NamedSnapshotShareListResponse listSnapshotShares(name)
+
+List share codes of a named snapshot
+
+List the share codes of a named snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { ListSnapshotSharesRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string
+    name: name_example,
+  } satisfies ListSnapshotSharesRequest;
+
+  try {
+    const data = await api.listSnapshotShares(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**NamedSnapshotShareListResponse**](NamedSnapshotShareListResponse.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The snapshot\'s share codes. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **404** | Resource not found. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listSnapshots
 
 > SnapshotListResponse listSnapshots(limit, cursor, sort)
@@ -3368,6 +3597,8 @@ example().catch(console.error);
 
 Read a file from a sandbox
 
+Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+
 ### Example
 
 ```ts
@@ -3438,6 +3669,80 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## recover
+
+> Recover200Response recover(sandboxId)
+
+Recover a sandbox that stopped responding
+
+Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does.  Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to   answer, or resume it from its last snapshot. - `reset_failed`: the power-cycle failed. Reply to the incident email. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { RecoverRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string | Public Sandbox id returned by create/list/get sandbox calls.
+    sandboxId: sandboxId_example,
+  } satisfies RecoverRequest;
+
+  try {
+    const data = await api.recover(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Recover200Response**](Recover200Response.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The power-cycle started. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **404** | Resource not found. |  -  |
+| **409** | The sandbox cannot be recovered now. `code` says why (see above). |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## repos
 
 > ReposResponse repos(sync, limit, cursor, sort, q, selected)
@@ -3678,6 +3983,82 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## revokeSnapshotShare
+
+> NamedSnapshotShareRevokedResponse revokeSnapshotShare(name, shareId)
+
+Revoke a share code
+
+Revoke a share code (`boat snapshot unshare <name> <share-id>` in the CLI). The code stops creating new sandboxes. Sandboxes already created from it keep their own copy. Needs `snapshot.write`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { RevokeSnapshotShareRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string
+    name: name_example,
+    // string | Share id, for example `shr_...`.
+    shareId: shareId_example,
+  } satisfies RevokeSnapshotShareRequest;
+
+  try {
+    const data = await api.revokeSnapshotShare(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` |  | [Defaults to `undefined`] |
+| **shareId** | `string` | Share id, for example `shr_...`. | [Defaults to `undefined`] |
+
+### Return type
+
+[**NamedSnapshotShareRevokedResponse**](NamedSnapshotShareRevokedResponse.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Revoked. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **404** | Resource not found. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## rotateApiKey
 
 > ApiKeySecretResponse rotateApiKey(apiKeyId)
@@ -4518,7 +4899,7 @@ example().catch(console.error);
 
 Steer a running turn
 
-Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
+Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. `error.details.reason` says why: `turn_ended` (with `error.details.lastTurn.status` and `.error` of the newest turn), `turn_not_started` (the turn is starting; retry in a moment), `no_turn`, `not_running` (the sandbox is not running) or `delivery_failed` (the sandbox did not accept the steer; check the turn before sending more work). The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
 
 ### Example
 
@@ -4600,7 +4981,7 @@ example().catch(console.error);
 
 Stop and archive sandbox
 
-Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, accepting the loss of everything written since the last successful snapshot. This is irreversible; only reach for it after a stop has already failed. 
+Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, keeping the last successful snapshot and losing everything written since then. This is irreversible; only reach for it after a stop has already failed. A force on a stop that is already pending escalates that stop. 
 
 ### Example
 
@@ -5208,6 +5589,8 @@ example().catch(console.error);
 
 Write a file in a sandbox
 
+Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+
 ### Example
 
 ```ts

package/docs/NamedSnapshotShare.md

@@ -0,0 +1,45 @@
+
+# NamedSnapshotShare
+
+A share code for a named snapshot. Any Boat account that holds the code can create a sandbox from the snapshot. Boat stores only a hash of the code. The full code is in the create response only.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`codePrefix` | string
+`status` | string
+`useCount` | number
+`lastUsedAt` | Date
+`revokedAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { NamedSnapshotShare } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "codePrefix": null,
+  "status": null,
+  "useCount": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+  "createdAt": null,
+} satisfies NamedSnapshotShare
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NamedSnapshotShare
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/NamedSnapshotShareCreatedResponse.md

@@ -0,0 +1,40 @@
+
+# NamedSnapshotShareCreatedResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`name` | string
+`shareCode` | string
+`share` | [NamedSnapshotShare](NamedSnapshotShare.md)
+
+## Example
+
+```typescript
+import type { NamedSnapshotShareCreatedResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "name": null,
+  "shareCode": null,
+  "share": null,
+} satisfies NamedSnapshotShareCreatedResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NamedSnapshotShareCreatedResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/NamedSnapshotShareListResponse.md

@@ -0,0 +1,38 @@
+
+# NamedSnapshotShareListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`name` | string
+`shares` | [Array<NamedSnapshotShare>](NamedSnapshotShare.md)
+
+## Example
+
+```typescript
+import type { NamedSnapshotShareListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "name": null,
+  "shares": null,
+} satisfies NamedSnapshotShareListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NamedSnapshotShareListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/NamedSnapshotShareRevokedResponse.md

@@ -0,0 +1,38 @@
+
+# NamedSnapshotShareRevokedResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`name` | string
+`share` | [NamedSnapshotShare](NamedSnapshotShare.md)
+
+## Example
+
+```typescript
+import type { NamedSnapshotShareRevokedResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "name": null,
+  "share": null,
+} satisfies NamedSnapshotShareRevokedResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NamedSnapshotShareRevokedResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/Recover200Response.md

@@ -0,0 +1,38 @@
+
+# Recover200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`status` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { Recover200Response } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "status": null,
+  "message": null,
+} satisfies Recover200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Recover200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)