@boatdev/sdk 1.4.0 → 1.5.0

package/src/apis/BoatApi.ts

@@ -303,6 +303,11 @@ import {
     SetEnvironmentVarRequestFromJSON,
     SetEnvironmentVarRequestToJSON,
 } from '../models/SetEnvironmentVarRequest';
+import {
+    type Share200Response,
+    Share200ResponseFromJSON,
+    Share200ResponseToJSON,
+} from '../models/Share200Response';
 import {
     type SnapshotDownloadResponse,
     SnapshotDownloadResponseFromJSON,
@@ -616,6 +621,8 @@ export interface RotateWebhookSigningSecretRequest {
 }
 
 export interface SandboxesRequest {
+    org?: string;
+    xBoatOrg?: string;
     limit?: number;
     cursor?: string | null;
     sort?: SandboxesSortEnum;
@@ -645,6 +652,10 @@ export interface SetEnvironmentVarOperationRequest {
     setEnvironmentVarRequest: SetEnvironmentVarRequest;
 }
 
+export interface ShareRequest {
+    sandboxId: string;
+}
+
 export interface SshKeyOperationRequest {
     sandboxId: string;
     sshKeyRequest: SshKeyRequest;
@@ -3650,6 +3661,10 @@ export class BoatApi extends runtime.BaseAPI {
     async sandboxesRequestOpts(requestParameters: SandboxesRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['org'] != null) {
+            queryParameters['org'] = requestParameters['org'];
+        }
+
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -3668,6 +3683,10 @@ export class BoatApi extends runtime.BaseAPI {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+        if (requestParameters['xBoatOrg'] != null) {
+            headerParameters['X-Boat-Org'] = String(requestParameters['xBoatOrg']);
+        }
+
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
             const tokenString = await token("BoatBearerAuth", []);
@@ -3688,6 +3707,7 @@ export class BoatApi extends runtime.BaseAPI {
     }
 
     /**
+     * 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.
      * List sandboxes
      */
     async sandboxesRaw(requestParameters: SandboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxListResponse>> {
@@ -3698,6 +3718,7 @@ export class BoatApi extends runtime.BaseAPI {
     }
 
     /**
+     * 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.
      * List sandboxes
      */
     async sandboxes(requestParameters: SandboxesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxListResponse> {
@@ -4066,6 +4087,61 @@ export class BoatApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for share without sending the request
+     */
+    async shareRequestOpts(requestParameters: ShareRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError(
+                'sandboxId',
+                'Required parameter "sandboxId" was null or undefined when calling share().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/sandboxes/{sandboxId}/share`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * 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. 
+     * Share sandbox with the organization
+     */
+    async shareRaw(requestParameters: ShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Share200Response>> {
+        const requestOptions = await this.shareRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => Share200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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. 
+     * Share sandbox with the organization
+     */
+    async share(requestParameters: ShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Share200Response> {
+        const response = await this.shareRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for sshKey without sending the request
      */

package/src/models/PromptRequest.ts

@@ -44,6 +44,12 @@ export interface PromptRequest {
      * @memberof PromptRequest
      */
     reasoningEffort?: string | null;
+    /**
+     * Optional. `true` runs this prompt in fast mode. The model stays the same and gives output faster. The provider bills fast mode at its higher fast rate. Omit to use the choice saved on the Agents dashboard for that model. `false` forces standard speed. Only models with `fastMode` set to `true` in `GET /provider-models` accept `true`. Other models return 400 `fast_mode_not_supported`.
+     * @type {boolean}
+     * @memberof PromptRequest
+     */
+    fast?: boolean | null;
     /**
      * Start a NEW conversation on the sandbox (runs in parallel with any existing ones) instead of continuing the most-recently-active one. Mutually exclusive with `conversationId`.
      * @type {boolean}
@@ -104,6 +110,7 @@ export function PromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boole
         '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'],
@@ -124,6 +131,7 @@ export function PromptRequestToJSONTyped(value?: PromptRequest | null, ignoreDis
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'new': value['_new'],
         'conversationId': value['conversationId'],
         'prompt': value['prompt'],

package/src/models/PromptResponse.ts

@@ -87,6 +87,12 @@ export interface PromptResponse {
      * @memberof PromptResponse
      */
     reasoningEffort?: string | null;
+    /**
+     * The prompt runs in fast mode.
+     * @type {boolean}
+     * @memberof PromptResponse
+     */
+    fast?: boolean;
 }
 
 
@@ -141,6 +147,7 @@ export function PromptResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'provider': json['provider'],
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
     };
 }
 
@@ -165,6 +172,7 @@ export function PromptResponseToJSONTyped(value?: PromptResponse | null, ignoreD
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
     };
 }
 

package/src/models/PromptRun.ts

@@ -67,6 +67,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}
@@ -120,6 +126,7 @@ export function PromptRunFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         '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'],
     };
 }
@@ -143,6 +150,7 @@ export function PromptRunToJSONTyped(value?: PromptRun | null, ignoreDiscriminat
         'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'conversationId': value['conversationId'],
     };
 }

package/src/models/Sandbox.ts

@@ -177,6 +177,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}
@@ -268,6 +298,16 @@ export const SandboxMachineProviderEnum = {
 } as const;
 export type SandboxMachineProviderEnum = typeof SandboxMachineProviderEnum[keyof typeof SandboxMachineProviderEnum];
 
+/**
+ * @export
+ */
+export const SandboxAccessEnum = {
+    Owner: 'owner',
+    Use: 'use',
+    View: 'view'
+} as const;
+export type SandboxAccessEnum = typeof SandboxAccessEnum[keyof typeof SandboxAccessEnum];
+
 /**
  * @export
  */
@@ -339,6 +379,11 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'snapshotCompletedAt': json['snapshotCompletedAt'] == null ? undefined : (new Date(json['snapshotCompletedAt'])),
         'snapshotVerifiedAt': json['snapshotVerifiedAt'] == null ? undefined : (new Date(json['snapshotVerifiedAt'])),
         'team': json['team'] == null ? undefined : 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'],
@@ -385,6 +430,11 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'snapshotCompletedAt': value['snapshotCompletedAt'] == null ? value['snapshotCompletedAt'] : value['snapshotCompletedAt'].toISOString(),
         'snapshotVerifiedAt': value['snapshotVerifiedAt'] == null ? value['snapshotVerifiedAt'] : value['snapshotVerifiedAt'].toISOString(),
         'team': 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/src/models/Share200Response.ts

@@ -0,0 +1,89 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { Sandbox } from './Sandbox';
+import {
+    SandboxFromJSON,
+    SandboxFromJSONTyped,
+    SandboxToJSON,
+    SandboxToJSONTyped,
+} 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 function instanceOfShare200Response(value: object): value is Share200Response {
+    return true;
+}
+
+export function Share200ResponseFromJSON(json: any): Share200Response {
+    return Share200ResponseFromJSONTyped(json, false);
+}
+
+export function Share200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandbox': json['sandbox'] == null ? undefined : SandboxFromJSON(json['sandbox']),
+        'restartRequired': json['restartRequired'] == null ? undefined : json['restartRequired'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function Share200ResponseToJSON(json: any): Share200Response {
+    return Share200ResponseToJSONTyped(json, false);
+}
+
+export function Share200ResponseToJSONTyped(value?: Share200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandbox': SandboxToJSON(value['sandbox']),
+        'restartRequired': value['restartRequired'],
+        'message': value['message'],
+    };
+}
+

package/src/models/index.ts

@@ -101,6 +101,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';