@boatdev/sdk 1.6.0 → 1.8.0

package/src/models/Recover200Response.ts

@@ -0,0 +1,99 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface Recover200Response
+ */
+export interface Recover200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Recover200Response
+     */
+    ok?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Recover200Response
+     */
+    type?: string;
+    /**
+     * 
+     * @type {Recover200ResponseStatusEnum}
+     * @memberof Recover200Response
+     */
+    status?: Recover200ResponseStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Recover200Response
+     */
+    message?: string;
+}
+
+
+/**
+ * @export
+ */
+export const Recover200ResponseStatusEnum = {
+    Recovering: 'recovering'
+} as const;
+export type Recover200ResponseStatusEnum = typeof Recover200ResponseStatusEnum[keyof typeof Recover200ResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the Recover200Response interface.
+ */
+export function instanceOfRecover200Response(value: object): value is Recover200Response {
+    return true;
+}
+
+export function Recover200ResponseFromJSON(json: any): Recover200Response {
+    return Recover200ResponseFromJSONTyped(json, false);
+}
+
+export function Recover200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Recover200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'] == null ? undefined : json['ok'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function Recover200ResponseToJSON(json: any): Recover200Response {
+    return Recover200ResponseToJSONTyped(json, false);
+}
+
+export function Recover200ResponseToJSONTyped(value?: Recover200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'message': value['message'],
+    };
+}
+

package/src/models/ResumeRequest.ts

@@ -26,7 +26,7 @@ export interface ResumeRequest {
      */
     failFast?: boolean;
     /**
-     * Resume onto a different machine size. Omit to keep the sandbox's current type. A resume already restores onto a fresh machine, so changing size costs nothing extra. Shrinking is rejected with `type_too_small` when the sandbox's data would not fit the smaller disk.
+     * Resume onto a different machine size. Omit to keep the sandbox's current type. `xlarge` needs the $100/month plan or higher (403 `machine_class_plan_required`). A resume already restores onto a fresh machine, so changing size costs nothing extra. Shrinking is rejected with `type_too_small` when the sandbox's data would not fit the smaller disk.
      * @type {ResumeRequestTypeEnum}
      * @memberof ResumeRequest
      */
@@ -64,7 +64,8 @@ export interface ResumeRequest {
 export const ResumeRequestTypeEnum = {
     Small: 'small',
     Default: 'default',
-    Large: 'large'
+    Large: 'large',
+    Xlarge: 'xlarge'
 } as const;
 export type ResumeRequestTypeEnum = typeof ResumeRequestTypeEnum[keyof typeof ResumeRequestTypeEnum];
 

package/src/models/Sandbox.ts

@@ -20,6 +20,13 @@ import {
     SandboxTeamToJSON,
     SandboxTeamToJSONTyped,
 } from './SandboxTeam';
+import type { StopOperation } from './StopOperation';
+import {
+    StopOperationFromJSON,
+    StopOperationFromJSONTyped,
+    StopOperationToJSON,
+    StopOperationToJSONTyped,
+} from './StopOperation';
 
 /**
  * 
@@ -69,6 +76,18 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     degradedSince?: Date | null;
+    /**
+     * True once every file of the sandbox's snapshot is on its disk. A resumed or forked sandbox is usable before that: its files keep copying in the background, and its docker volumes move onto the real disk near the end. Its docker containers start earlier; at that point their volume mounts move onto the real disk in place, without a restart. The `sandbox.hydrated` webhook fires at the same moment this turns true. A sandbox that restored nothing is hydrated from the start.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    hydrated?: boolean;
+    /**
+     * When the last resume or fork finished copying files in, or null.
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    hydratedAt?: Date | null;
     /**
      * Current machine size: what the sandbox was created with, or the size it was last resumed or forked onto.
      * @type {SandboxTypeEnum}
@@ -88,7 +107,7 @@ export interface Sandbox {
      */
     memoryGB?: number;
     /**
-     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, and 2 for `large`.
+     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, 2 for `large`, and 50/9 (about 5.56) for `xlarge`.
      * @type {number}
      * @memberof Sandbox
      */
@@ -249,6 +268,12 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     environmentVersion?: number | null;
+    /**
+     * The last stop you requested (`POST /sandboxes/{sandboxId}/stop`), or null if you never stopped this sandbox.
+     * @type {StopOperation}
+     * @memberof Sandbox
+     */
+    stop?: StopOperation | null;
 }
 
 
@@ -285,7 +310,8 @@ export type SandboxHealthEnum = typeof SandboxHealthEnum[keyof typeof SandboxHea
 export const SandboxTypeEnum = {
     Small: 'small',
     Default: 'default',
-    Large: 'large'
+    Large: 'large',
+    Xlarge: 'xlarge'
 } as const;
 export type SandboxTypeEnum = typeof SandboxTypeEnum[keyof typeof SandboxTypeEnum];
 
@@ -361,6 +387,8 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'health': json['health'] == null ? undefined : json['health'],
         'healthReason': json['healthReason'] == null ? undefined : json['healthReason'],
         'degradedSince': json['degradedSince'] == null ? undefined : (new Date(json['degradedSince'])),
+        'hydrated': json['hydrated'] == null ? undefined : json['hydrated'],
+        'hydratedAt': json['hydratedAt'] == null ? undefined : (new Date(json['hydratedAt'])),
         'type': json['type'] == null ? undefined : json['type'],
         'vcpu': json['vcpu'] == null ? undefined : json['vcpu'],
         'memoryGB': json['memoryGB'] == null ? undefined : json['memoryGB'],
@@ -391,6 +419,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'setupError': json['setupError'] == null ? undefined : json['setupError'],
         'environment': json['environment'] == null ? undefined : json['environment'],
         'environmentVersion': json['environmentVersion'] == null ? undefined : json['environmentVersion'],
+        'stop': json['stop'] == null ? undefined : StopOperationFromJSON(json['stop']),
     };
 }
 
@@ -412,6 +441,8 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'health': value['health'],
         'healthReason': value['healthReason'],
         'degradedSince': value['degradedSince'] == null ? value['degradedSince'] : value['degradedSince'].toISOString(),
+        'hydrated': value['hydrated'],
+        'hydratedAt': value['hydratedAt'] == null ? value['hydratedAt'] : value['hydratedAt'].toISOString(),
         'type': value['type'],
         'vcpu': value['vcpu'],
         'memoryGB': value['memoryGB'],
@@ -442,6 +473,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'setupError': value['setupError'],
         'environment': value['environment'],
         'environmentVersion': value['environmentVersion'],
+        'stop': StopOperationToJSON(value['stop']),
     };
 }
 

package/src/models/SandboxUsageResponse.ts

@@ -44,7 +44,7 @@ export interface SandboxUsageResponse {
      */
     sandboxType: SandboxUsageResponseSandboxTypeEnum;
     /**
-     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, and 2 for `large`.
+     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, 2 for `large`, and 50/9 (about 5.56) for `xlarge`.
      * @type {number}
      * @memberof SandboxUsageResponse
      */
@@ -94,7 +94,8 @@ export interface SandboxUsageResponse {
 export const SandboxUsageResponseSandboxTypeEnum = {
     Small: 'small',
     Default: 'default',
-    Large: 'large'
+    Large: 'large',
+    Xlarge: 'xlarge'
 } as const;
 export type SandboxUsageResponseSandboxTypeEnum = typeof SandboxUsageResponseSandboxTypeEnum[keyof typeof SandboxUsageResponseSandboxTypeEnum];
 

package/src/models/StopOperation.ts

@@ -0,0 +1,124 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface StopOperation
+ */
+export interface StopOperation {
+    /**
+     * Stable id of this stop. Calling stop again while it is pending returns the same id.
+     * @type {string}
+     * @memberof StopOperation
+     */
+    id: string;
+    /**
+     * `pending`: accepted, the sandbox is archiving. `failing`: the last attempt failed (see `error`); it is retried automatically until the sandbox archives. Running commands or prompts does not cancel it. `completed`: the sandbox is archived. `superseded`: a resume ended it before it completed.
+     * @type {StopOperationStatusEnum}
+     * @memberof StopOperation
+     */
+    status: StopOperationStatusEnum;
+    /**
+     * When the stop was accepted. On the sandbox, null once it has ended. Read by id (`GET /sandboxes/{sandboxId}/stops/{stopId}`), it is kept.
+     * @type {Date}
+     * @memberof StopOperation
+     */
+    requestedAt: Date | null;
+    /**
+     * When the last archival attempt ended.
+     * @type {Date}
+     * @memberof StopOperation
+     */
+    lastAttemptAt: Date | null;
+    /**
+     * Why the last attempt failed, while `status` is `failing`. Otherwise null.
+     * @type {string}
+     * @memberof StopOperation
+     */
+    error: string | null;
+    /**
+     * When the stop completed or was superseded.
+     * @type {Date}
+     * @memberof StopOperation
+     */
+    endedAt: Date | null;
+}
+
+
+/**
+ * @export
+ */
+export const StopOperationStatusEnum = {
+    Pending: 'pending',
+    Failing: 'failing',
+    Completed: 'completed',
+    Superseded: 'superseded'
+} as const;
+export type StopOperationStatusEnum = typeof StopOperationStatusEnum[keyof typeof StopOperationStatusEnum];
+
+
+/**
+ * Check if a given object implements the StopOperation interface.
+ */
+export function instanceOfStopOperation(value: object): value is StopOperation {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('requestedAt' in value) || value['requestedAt'] === undefined) return false;
+    if (!('lastAttemptAt' in value) || value['lastAttemptAt'] === undefined) return false;
+    if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('endedAt' in value) || value['endedAt'] === undefined) return false;
+    return true;
+}
+
+export function StopOperationFromJSON(json: any): StopOperation {
+    return StopOperationFromJSONTyped(json, false);
+}
+
+export function StopOperationFromJSONTyped(json: any, ignoreDiscriminator: boolean): StopOperation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'requestedAt': (json['requestedAt'] == null ? null : new Date(json['requestedAt'])),
+        'lastAttemptAt': (json['lastAttemptAt'] == null ? null : new Date(json['lastAttemptAt'])),
+        'error': json['error'],
+        'endedAt': (json['endedAt'] == null ? null : new Date(json['endedAt'])),
+    };
+}
+
+export function StopOperationToJSON(json: any): StopOperation {
+    return StopOperationToJSONTyped(json, false);
+}
+
+export function StopOperationToJSONTyped(value?: StopOperation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'requestedAt': value['requestedAt'] == null ? value['requestedAt'] : value['requestedAt'].toISOString(),
+        'lastAttemptAt': value['lastAttemptAt'] == null ? value['lastAttemptAt'] : value['lastAttemptAt'].toISOString(),
+        'error': value['error'],
+        'endedAt': value['endedAt'] == null ? value['endedAt'] : value['endedAt'].toISOString(),
+    };
+}
+

package/src/models/StopOperationResponse.ts

@@ -0,0 +1,111 @@
+/* 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 { StopOperation } from './StopOperation';
+import {
+    StopOperationFromJSON,
+    StopOperationFromJSONTyped,
+    StopOperationToJSON,
+    StopOperationToJSONTyped,
+} from './StopOperation';
+
+/**
+ * 
+ * @export
+ * @interface StopOperationResponse
+ */
+export interface StopOperationResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StopOperationResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {StopOperationResponseTypeEnum}
+     * @memberof StopOperationResponse
+     */
+    type: StopOperationResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof StopOperationResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {StopOperation}
+     * @memberof StopOperationResponse
+     */
+    stop: StopOperation;
+}
+
+
+/**
+ * @export
+ */
+export const StopOperationResponseTypeEnum = {
+    StopStatus: 'stop.status'
+} as const;
+export type StopOperationResponseTypeEnum = typeof StopOperationResponseTypeEnum[keyof typeof StopOperationResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the StopOperationResponse interface.
+ */
+export function instanceOfStopOperationResponse(value: object): value is StopOperationResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('stop' in value) || value['stop'] === undefined) return false;
+    return true;
+}
+
+export function StopOperationResponseFromJSON(json: any): StopOperationResponse {
+    return StopOperationResponseFromJSONTyped(json, false);
+}
+
+export function StopOperationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StopOperationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'stop': StopOperationFromJSON(json['stop']),
+    };
+}
+
+export function StopOperationResponseToJSON(json: any): StopOperationResponse {
+    return StopOperationResponseToJSONTyped(json, false);
+}
+
+export function StopOperationResponseToJSONTyped(value?: StopOperationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'stop': StopOperationToJSON(value['stop']),
+    };
+}
+

package/src/models/StopRequest.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface StopRequest {
     /**
-     * Stop the sandbox even if its disk cannot be snapshotted. Everything written since the last successful snapshot is permanently LOST. Without this, a sandbox whose snapshot pipeline is failing is left running rather than discarding your work, and you are not billed for that time. Only use this after a stop has already been refused.
+     * Stop the sandbox even if its disk cannot be snapshotted. It keeps its last successful snapshot and everything written since then is permanently LOST. Without this, a sandbox whose snapshot pipeline is failing is left running rather than discarding your work, and you are not billed for that time. Only use this after a stop has already been refused.
      * @type {boolean}
      * @memberof StopRequest
      */

package/src/models/UpdateSandboxRequest.ts

@@ -26,7 +26,7 @@ export interface UpdateSandboxRequest {
      */
     name?: string;
     /**
-     * New archival TTL. `null` disables auto-stop.
+     * New auto-stop TTL. The deadline becomes now + `ttlSeconds`, so calling this again extends a running sandbox's life. `null` disables auto-stop.
      * @type {number}
      * @memberof UpdateSandboxRequest
      */

package/src/models/index.ts

@@ -76,6 +76,7 @@ export * from './PromptRequest';
 export * from './PromptResponse';
 export * from './PromptRun';
 export * from './PromptRunResponse';
+export * from './Recover200Response';
 export * from './RepoSelectionRequest';
 export * from './RepoSelectionResponse';
 export * from './ReposResponse';
@@ -118,6 +119,8 @@ export * from './SteerEvent';
 export * from './SteerEventData';
 export * from './SteerRequest';
 export * from './SteerResponse';
+export * from './StopOperation';
+export * from './StopOperationResponse';
 export * from './StopRequest';
 export * from './SuccessBase';
 export * from './UnknownEvent';

package/src/runtime.ts

@@ -1,3 +1,4 @@
+import { defaultFetch } from './http2-fetch';
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -202,7 +203,7 @@ export class BaseAPI {
         }
         let response: Response | undefined = undefined;
         try {
-            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            response = await (this.configuration.fetchApi || defaultFetch)(fetchParams.url, fetchParams.init);
         } catch (e) {
             for (const middleware of this.middleware) {
                 if (middleware.onError) {