@boatdev/sdk 1.4.0 → 1.5.0

package/dist/models/PromptRequest.js

@@ -54,6 +54,7 @@ function PromptRequestFromJSONTyped(json, ignoreDiscriminator) {
         'provider': json['provider'],
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
         '_new': json['new'] == null ? undefined : json['new'],
         'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
         'prompt': json['prompt'],
@@ -70,6 +71,7 @@ function PromptRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'new': value['_new'],
         'conversationId': value['conversationId'],
         'prompt': value['prompt'],

package/dist/models/PromptResponse.d.ts

@@ -76,6 +76,12 @@ export interface PromptResponse {
      * @memberof PromptResponse
      */
     reasoningEffort?: string | null;
+    /**
+     * The prompt runs in fast mode.
+     * @type {boolean}
+     * @memberof PromptResponse
+     */
+    fast?: boolean;
 }
 /**
  * @export

package/dist/models/PromptResponse.js

@@ -70,6 +70,7 @@ function PromptResponseFromJSONTyped(json, ignoreDiscriminator) {
         'provider': json['provider'],
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
     };
 }
 function PromptResponseToJSON(json) {
@@ -90,5 +91,6 @@ function PromptResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
     };
 }

package/dist/models/PromptRun.d.ts

@@ -63,6 +63,12 @@ export interface PromptRun {
      * @memberof PromptRun
      */
     reasoningEffort?: string | null;
+    /**
+     * The prompt runs in fast mode. `null` means no speed is set yet. The prompt waits without a speed choice, or it ended without running (`done` is true). The speed is set when the prompt starts, for the model that runs.
+     * @type {boolean}
+     * @memberof PromptRun
+     */
+    fast?: boolean | null;
     /**
      * The conversation this prompt ran in. A Sandbox runs many conversations in parallel; see [Integrated agents](/integrated-agents).
      * @type {string}

package/dist/models/PromptRun.js

@@ -62,6 +62,7 @@ function PromptRunFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
         'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
     };
 }
@@ -81,6 +82,7 @@ function PromptRunToJSONTyped(value, ignoreDiscriminator = false) {
         'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'conversationId': value['conversationId'],
     };
 }

package/dist/models/Sandbox.d.ts

@@ -166,6 +166,36 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     team?: SandboxTeam;
+    /**
+     * Display name (or email) of the person who created the sandbox. Organization members see every sandbox the organization pays for, so this says whose it is.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    createdBy?: string | null;
+    /**
+     * Account id of the person who created the sandbox.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    createdById?: string | null;
+    /**
+     * What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that is `noEnv` (created with it, or shared and restarted), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that still holds their personal logins, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).
+     * @type {SandboxAccessEnum}
+     * @memberof Sandbox
+     */
+    access?: SandboxAccessEnum;
+    /**
+     * True while the sandbox still holds its creator's personal logins (GitHub token, model logins, secrets). Other members can only see such a sandbox.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    holdsCreatorLogins?: boolean;
+    /**
+     * True once the sandbox is shared but not restarted yet. Its creator's logins are wiped at its next start, and the organization can use it from then on.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    wipePendingUntilRestart?: boolean;
     /**
      * The sandbox's stable three-word subdomain slug (e.g. "frazil-pneuma-rallye"), or null before one is assigned.
      * @type {string}
@@ -251,6 +281,15 @@ export declare const SandboxMachineProviderEnum: {
     readonly Baremetal: 'baremetal';
 };
 export type SandboxMachineProviderEnum = typeof SandboxMachineProviderEnum[keyof typeof SandboxMachineProviderEnum];
+/**
+ * @export
+ */
+export declare const SandboxAccessEnum: {
+    readonly Owner: 'owner';
+    readonly Use: 'use';
+    readonly View: 'view';
+};
+export type SandboxAccessEnum = typeof SandboxAccessEnum[keyof typeof SandboxAccessEnum];
 /**
  * @export
  */

package/dist/models/Sandbox.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SandboxSetupStatusEnum = exports.SandboxLastSnapshotStatusEnum = exports.SandboxMachineProviderEnum = exports.SandboxTypeEnum = exports.SandboxHealthEnum = exports.SandboxStateEnum = void 0;
+exports.SandboxSetupStatusEnum = exports.SandboxLastSnapshotStatusEnum = exports.SandboxAccessEnum = exports.SandboxMachineProviderEnum = exports.SandboxTypeEnum = exports.SandboxHealthEnum = exports.SandboxStateEnum = void 0;
 exports.instanceOfSandbox = instanceOfSandbox;
 exports.SandboxFromJSON = SandboxFromJSON;
 exports.SandboxFromJSONTyped = SandboxFromJSONTyped;
@@ -58,6 +58,14 @@ exports.SandboxMachineProviderEnum = {
     Hetzner: 'hetzner',
     Baremetal: 'baremetal'
 };
+/**
+ * @export
+ */
+exports.SandboxAccessEnum = {
+    Owner: 'owner',
+    Use: 'use',
+    View: 'view'
+};
 /**
  * @export
  */
@@ -126,6 +134,11 @@ function SandboxFromJSONTyped(json, ignoreDiscriminator) {
         'snapshotCompletedAt': json['snapshotCompletedAt'] == null ? undefined : (new Date(json['snapshotCompletedAt'])),
         'snapshotVerifiedAt': json['snapshotVerifiedAt'] == null ? undefined : (new Date(json['snapshotVerifiedAt'])),
         'team': json['team'] == null ? undefined : (0, SandboxTeam_1.SandboxTeamFromJSON)(json['team']),
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'createdById': json['createdById'] == null ? undefined : json['createdById'],
+        'access': json['access'] == null ? undefined : json['access'],
+        'holdsCreatorLogins': json['holdsCreatorLogins'] == null ? undefined : json['holdsCreatorLogins'],
+        'wipePendingUntilRestart': json['wipePendingUntilRestart'] == null ? undefined : json['wipePendingUntilRestart'],
         'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
         'lastSnapshotAttemptAt': json['lastSnapshotAttemptAt'] == null ? undefined : (new Date(json['lastSnapshotAttemptAt'])),
         'lastSnapshotStatus': json['lastSnapshotStatus'] == null ? undefined : json['lastSnapshotStatus'],
@@ -168,6 +181,11 @@ function SandboxToJSONTyped(value, ignoreDiscriminator = false) {
         'snapshotCompletedAt': value['snapshotCompletedAt'] == null ? value['snapshotCompletedAt'] : value['snapshotCompletedAt'].toISOString(),
         'snapshotVerifiedAt': value['snapshotVerifiedAt'] == null ? value['snapshotVerifiedAt'] : value['snapshotVerifiedAt'].toISOString(),
         'team': (0, SandboxTeam_1.SandboxTeamToJSON)(value['team']),
+        'createdBy': value['createdBy'],
+        'createdById': value['createdById'],
+        'access': value['access'],
+        'holdsCreatorLogins': value['holdsCreatorLogins'],
+        'wipePendingUntilRestart': value['wipePendingUntilRestart'],
         'subdomain': value['subdomain'],
         'lastSnapshotAttemptAt': value['lastSnapshotAttemptAt'] == null ? value['lastSnapshotAttemptAt'] : value['lastSnapshotAttemptAt'].toISOString(),
         'lastSnapshotStatus': value['lastSnapshotStatus'],

package/dist/models/Share200Response.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Sandbox } from './Sandbox';
+/**
+ *
+ * @export
+ * @interface Share200Response
+ */
+export interface Share200Response {
+    /**
+     *
+     * @type {Sandbox}
+     * @memberof Share200Response
+     */
+    sandbox?: Sandbox;
+    /**
+     * True when the sandbox was running: what runs on it still holds your logins in memory, so it stays `view` for the organization until you stop and resume it.
+     * @type {boolean}
+     * @memberof Share200Response
+     */
+    restartRequired?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Share200Response
+     */
+    message?: string;
+}
+/**
+ * Check if a given object implements the Share200Response interface.
+ */
+export declare function instanceOfShare200Response(value: object): value is Share200Response;
+export declare function Share200ResponseFromJSON(json: any): Share200Response;
+export declare function Share200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share200Response;
+export declare function Share200ResponseToJSON(json: any): Share200Response;
+export declare function Share200ResponseToJSONTyped(value?: Share200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Share200Response.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfShare200Response = instanceOfShare200Response;
+exports.Share200ResponseFromJSON = Share200ResponseFromJSON;
+exports.Share200ResponseFromJSONTyped = Share200ResponseFromJSONTyped;
+exports.Share200ResponseToJSON = Share200ResponseToJSON;
+exports.Share200ResponseToJSONTyped = Share200ResponseToJSONTyped;
+const Sandbox_1 = require("./Sandbox");
+/**
+ * Check if a given object implements the Share200Response interface.
+ */
+function instanceOfShare200Response(value) {
+    return true;
+}
+function Share200ResponseFromJSON(json) {
+    return Share200ResponseFromJSONTyped(json, false);
+}
+function Share200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sandbox': json['sandbox'] == null ? undefined : (0, Sandbox_1.SandboxFromJSON)(json['sandbox']),
+        'restartRequired': json['restartRequired'] == null ? undefined : json['restartRequired'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+function Share200ResponseToJSON(json) {
+    return Share200ResponseToJSONTyped(json, false);
+}
+function Share200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sandbox': (0, Sandbox_1.SandboxToJSON)(value['sandbox']),
+        'restartRequired': value['restartRequired'],
+        'message': value['message'],
+    };
+}

package/dist/models/index.d.ts

@@ -99,6 +99,7 @@ export * from './SecretsUpdateRequest';
 export * from './SelectedRepository';
 export * from './SetEnvironmentSecretFileRequest';
 export * from './SetEnvironmentVarRequest';
+export * from './Share200Response';
 export * from './SnapshotChunk';
 export * from './SnapshotDownloadResponse';
 export * from './SnapshotDownloadResponseAllOfInventory';

package/dist/models/index.js

@@ -117,6 +117,7 @@ __exportStar(require("./SecretsUpdateRequest"), exports);
 __exportStar(require("./SelectedRepository"), exports);
 __exportStar(require("./SetEnvironmentSecretFileRequest"), exports);
 __exportStar(require("./SetEnvironmentVarRequest"), exports);
+__exportStar(require("./Share200Response"), exports);
 __exportStar(require("./SnapshotChunk"), exports);
 __exportStar(require("./SnapshotDownloadResponse"), exports);
 __exportStar(require("./SnapshotDownloadResponseAllOfInventory"), exports);

package/docs/BoatApi.md

@@ -61,6 +61,7 @@ All URIs are relative to *https://boat.dev/api/v1*
 | [**setActiveOrganization**](BoatApi.md#setactiveorganization) | **PATCH** /orgs/active | Set the active organization |
 | [**setEnvironmentSecretFile**](BoatApi.md#setenvironmentsecretfileoperation) | **PUT** /environments/{environmentId}/secret-files | Write one secret file |
 | [**setEnvironmentVar**](BoatApi.md#setenvironmentvaroperation) | **PUT** /environments/{environmentId}/vars/{key} | Set one environment variable |
+| [**share**](BoatApi.md#share) | **POST** /sandboxes/{sandboxId}/share | Share sandbox with the organization |
 | [**sshKey**](BoatApi.md#sshkeyoperation) | **POST** /sandboxes/{sandboxId}/sshkey | Configure sandbox SSH key |
 | [**steer**](BoatApi.md#steeroperation) | **POST** /sandboxes/{sandboxId}/steer | Steer a running turn |
 | [**stop**](BoatApi.md#stopoperation) | **POST** /sandboxes/{sandboxId}/stop | Stop and archive sandbox |
@@ -3827,10 +3828,12 @@ example().catch(console.error);
 
 ## sandboxes
 
-> SandboxListResponse sandboxes(limit, cursor, sort, state)
+> SandboxListResponse sandboxes(org, xBoatOrg, limit, cursor, sort, state)
 
 List sandboxes
 
+Your sandboxes. In an organization\'s scope (the active wallet, `org`, or `X-Boat-Org`) the list also holds every sandbox that organization pays for, whoever created it; `createdBy` and `access` say whose it is and what you may do with it.
+
 ### Example
 
 ```ts
@@ -3849,6 +3852,10 @@ async function example() {
   const api = new BoatApi(config);
 
   const body = {
+    // string | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. (optional)
+    org: org_example,
+    // string | Same as the `org` query parameter. Query wins when both are set. (optional)
+    xBoatOrg: xBoatOrg_example,
     // number | Maximum items to return. (optional)
     limit: 56,
     // string | Opaque pagination cursor returned as `pageInfo.nextCursor`. (optional)
@@ -3876,6 +3883,8 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **org** | `string` | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. | [Optional] [Defaults to `undefined`] |
+| **xBoatOrg** | `string` | Same as the `org` query parameter. Query wins when both are set. | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Maximum items to return. | [Optional] [Defaults to `100`] |
 | **cursor** | `string` | Opaque pagination cursor returned as `pageInfo.nextCursor`. | [Optional] [Defaults to `undefined`] |
 | **sort** | `asc`, `desc` | Sort direction for cursor pagination. | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
@@ -4349,6 +4358,81 @@ 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)
 
 
+## share
+
+> Share200Response share(sandboxId)
+
+Share sandbox with the organization
+
+Let every member of the organization that pays for this sandbox use it.  Your personal logins (GitHub token, Claude and Codex logins, environment secrets, the sandbox\'s own CLI key) are never pushed to it again and are wiped off its disk at its next start, so a teammate never acts as you. Files you wrote stay. One-way: the sandbox stays like a `noEnv` sandbox from then on. A running sandbox stays `view` for the organization until you stop and resume it (`restartRequired`).  Only the person who created the sandbox can share it, and only a sandbox billed to an organization. Sharing an already shared sandbox is a no-op. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { ShareRequest } 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 ShareRequest;
+
+  try {
+    const data = await api.share(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
+
+[**Share200Response**](Share200Response.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 sandbox is shared. |  -  |
+| **400** | Invalid request body or parameters. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **403** | Authenticated token is not allowed to perform this action. |  -  |
+| **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)
+
+
 ## sshKey
 
 > SshKeyResponse sshKey(sandboxId, sshKeyRequest)

package/docs/PromptRequest.md

@@ -10,6 +10,7 @@ Name | Type
 `provider` | string
 `model` | string
 `reasoningEffort` | string
+`fast` | boolean
 `_new` | boolean
 `conversationId` | string
 `prompt` | string
@@ -24,6 +25,7 @@ const example = {
   "provider": null,
   "model": null,
   "reasoningEffort": null,
+  "fast": null,
   "_new": null,
   "conversationId": null,
   "prompt": null,

package/docs/PromptResponse.md

@@ -16,6 +16,7 @@ Name | Type
 `provider` | string
 `model` | string
 `reasoningEffort` | string
+`fast` | boolean
 
 ## Example
 
@@ -34,6 +35,7 @@ const example = {
   "provider": null,
   "model": null,
   "reasoningEffort": null,
+  "fast": null,
 } satisfies PromptResponse
 
 console.log(example)

package/docs/PromptRun.md

@@ -14,6 +14,7 @@ Name | Type
 `createdAt` | Date
 `model` | string
 `reasoningEffort` | string
+`fast` | boolean
 `conversationId` | string
 
 ## Example
@@ -31,6 +32,7 @@ const example = {
   "createdAt": null,
   "model": null,
   "reasoningEffort": null,
+  "fast": null,
   "conversationId": null,
 } satisfies PromptRun
 

package/docs/Sandbox.md

@@ -31,6 +31,11 @@ Name | Type
 `snapshotCompletedAt` | Date
 `snapshotVerifiedAt` | Date
 `team` | [SandboxTeam](SandboxTeam.md)
+`createdBy` | string
+`createdById` | string
+`access` | string
+`holdsCreatorLogins` | boolean
+`wipePendingUntilRestart` | boolean
 `subdomain` | string
 `lastSnapshotAttemptAt` | Date
 `lastSnapshotStatus` | string
@@ -71,6 +76,11 @@ const example = {
   "snapshotCompletedAt": null,
   "snapshotVerifiedAt": null,
   "team": null,
+  "createdBy": null,
+  "createdById": null,
+  "access": null,
+  "holdsCreatorLogins": null,
+  "wipePendingUntilRestart": null,
   "subdomain": null,
   "lastSnapshotAttemptAt": null,
   "lastSnapshotStatus": null,

package/docs/Share200Response.md

@@ -0,0 +1,36 @@
+
+# Share200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sandbox` | [Sandbox](Sandbox.md)
+`restartRequired` | boolean
+`message` | string
+
+## Example
+
+```typescript
+import type { Share200Response } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sandbox": null,
+  "restartRequired": null,
+  "message": null,
+} satisfies Share200Response
+
+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 Share200Response
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boatdev/sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "OpenAPI client for @boatdev/sdk",
   "author": "OpenAPI-Generator",
   "license": "MIT",