@boatdev/sdk 1.0.0 → 1.1.0

package/src/models/ActiveOrgResponse.ts

@@ -0,0 +1,102 @@
+/* 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 { ActiveOrgResponseAllOfActive } from './ActiveOrgResponseAllOfActive';
+import {
+    ActiveOrgResponseAllOfActiveFromJSON,
+    ActiveOrgResponseAllOfActiveFromJSONTyped,
+    ActiveOrgResponseAllOfActiveToJSON,
+    ActiveOrgResponseAllOfActiveToJSONTyped,
+} from './ActiveOrgResponseAllOfActive';
+
+/**
+ * 
+ * @export
+ * @interface ActiveOrgResponse
+ */
+export interface ActiveOrgResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ActiveOrgResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {ActiveOrgResponseTypeEnum}
+     * @memberof ActiveOrgResponse
+     */
+    type: ActiveOrgResponseTypeEnum;
+    /**
+     * 
+     * @type {ActiveOrgResponseAllOfActive}
+     * @memberof ActiveOrgResponse
+     */
+    active: ActiveOrgResponseAllOfActive;
+}
+
+
+/**
+ * @export
+ */
+export const ActiveOrgResponseTypeEnum = {
+    OrgActiveUpdated: 'org.active_updated'
+} as const;
+export type ActiveOrgResponseTypeEnum = typeof ActiveOrgResponseTypeEnum[keyof typeof ActiveOrgResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the ActiveOrgResponse interface.
+ */
+export function instanceOfActiveOrgResponse(value: object): value is ActiveOrgResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('active' in value) || value['active'] === undefined) return false;
+    return true;
+}
+
+export function ActiveOrgResponseFromJSON(json: any): ActiveOrgResponse {
+    return ActiveOrgResponseFromJSONTyped(json, false);
+}
+
+export function ActiveOrgResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActiveOrgResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'active': ActiveOrgResponseAllOfActiveFromJSON(json['active']),
+    };
+}
+
+export function ActiveOrgResponseToJSON(json: any): ActiveOrgResponse {
+    return ActiveOrgResponseToJSONTyped(json, false);
+}
+
+export function ActiveOrgResponseToJSONTyped(value?: ActiveOrgResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'active': ActiveOrgResponseAllOfActiveToJSON(value['active']),
+    };
+}
+

package/src/models/ActiveOrgResponseAllOfActive.ts

@@ -0,0 +1,95 @@
+/* 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 ActiveOrgResponseAllOfActive
+ */
+export interface ActiveOrgResponseAllOfActive {
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveOrgResponseAllOfActive
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ActiveOrgResponseAllOfActive
+     */
+    name: string;
+    /**
+     * 
+     * @type {ActiveOrgResponseAllOfActiveTypeEnum}
+     * @memberof ActiveOrgResponseAllOfActive
+     */
+    type: ActiveOrgResponseAllOfActiveTypeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ActiveOrgResponseAllOfActiveTypeEnum = {
+    Personal: 'personal',
+    Org: 'org'
+} as const;
+export type ActiveOrgResponseAllOfActiveTypeEnum = typeof ActiveOrgResponseAllOfActiveTypeEnum[keyof typeof ActiveOrgResponseAllOfActiveTypeEnum];
+
+
+/**
+ * Check if a given object implements the ActiveOrgResponseAllOfActive interface.
+ */
+export function instanceOfActiveOrgResponseAllOfActive(value: object): value is ActiveOrgResponseAllOfActive {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function ActiveOrgResponseAllOfActiveFromJSON(json: any): ActiveOrgResponseAllOfActive {
+    return ActiveOrgResponseAllOfActiveFromJSONTyped(json, false);
+}
+
+export function ActiveOrgResponseAllOfActiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActiveOrgResponseAllOfActive {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'type': json['type'],
+    };
+}
+
+export function ActiveOrgResponseAllOfActiveToJSON(json: any): ActiveOrgResponseAllOfActive {
+    return ActiveOrgResponseAllOfActiveToJSONTyped(json, false);
+}
+
+export function ActiveOrgResponseAllOfActiveToJSONTyped(value?: ActiveOrgResponseAllOfActive | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'type': value['type'],
+    };
+}
+

package/src/models/ActiveOrgUpdateRequest.ts

@@ -0,0 +1,66 @@
+/* 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 ActiveOrgUpdateRequest
+ */
+export interface ActiveOrgUpdateRequest {
+    /**
+     * Organization id or name you belong to; `personal`, your own id or `null` for personal.
+     * @type {string}
+     * @memberof ActiveOrgUpdateRequest
+     */
+    org: string | null;
+}
+
+/**
+ * Check if a given object implements the ActiveOrgUpdateRequest interface.
+ */
+export function instanceOfActiveOrgUpdateRequest(value: object): value is ActiveOrgUpdateRequest {
+    if (!('org' in value) || value['org'] === undefined) return false;
+    return true;
+}
+
+export function ActiveOrgUpdateRequestFromJSON(json: any): ActiveOrgUpdateRequest {
+    return ActiveOrgUpdateRequestFromJSONTyped(json, false);
+}
+
+export function ActiveOrgUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActiveOrgUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'org': json['org'],
+    };
+}
+
+export function ActiveOrgUpdateRequestToJSON(json: any): ActiveOrgUpdateRequest {
+    return ActiveOrgUpdateRequestToJSONTyped(json, false);
+}
+
+export function ActiveOrgUpdateRequestToJSONTyped(value?: ActiveOrgUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'org': value['org'],
+    };
+}
+

package/src/models/CommandResponse.ts

@@ -49,6 +49,12 @@ export interface CommandResponse {
      * @memberof CommandResponse
      */
     signal?: string | null;
+    /**
+     * True when the memory ceiling killed the command or one of its processes and the command failed.
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    oomKilled?: boolean;
     /**
      * 
      * @type {string}
@@ -138,6 +144,7 @@ export function CommandResponseFromJSONTyped(json: any, ignoreDiscriminator: boo
         'success': json['success'],
         'exitCode': json['exitCode'],
         'signal': json['signal'] == null ? undefined : json['signal'],
+        'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
         'stdout': json['stdout'],
         'stderr': json['stderr'],
         'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
@@ -165,6 +172,7 @@ export function CommandResponseToJSONTyped(value?: CommandResponse | null, ignor
         'success': value['success'],
         'exitCode': value['exitCode'],
         'signal': value['signal'],
+        'oomKilled': value['oomKilled'],
         'stdout': value['stdout'],
         'stderr': value['stderr'],
         'stdoutTruncated': value['stdoutTruncated'],

package/src/models/CommandStatusResponse.ts

@@ -79,6 +79,12 @@ export interface CommandStatusResponse {
      * @memberof CommandStatusResponse
      */
     signal?: string | null;
+    /**
+     * True when the memory ceiling killed the command or one of its processes and the command failed.
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    oomKilled?: boolean;
     /**
      * 
      * @type {string}
@@ -197,6 +203,7 @@ export function CommandStatusResponseFromJSONTyped(json: any, ignoreDiscriminato
         'running': json['running'],
         'exitCode': json['exitCode'],
         'signal': json['signal'] == null ? undefined : json['signal'],
+        'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
         'command': json['command'] == null ? undefined : json['command'],
         'cwd': json['cwd'] == null ? undefined : json['cwd'],
         'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
@@ -231,6 +238,7 @@ export function CommandStatusResponseToJSONTyped(value?: CommandStatusResponse |
         'running': value['running'],
         'exitCode': value['exitCode'],
         'signal': value['signal'],
+        'oomKilled': value['oomKilled'],
         'command': value['command'],
         'cwd': value['cwd'],
         'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),

package/src/models/CreateSandboxRequest.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface CreateSandboxRequest {
     /**
-     * Machine size. `small` consumes machine time at half rate and `large` at twice the default rate (see the Billing guide). `xlarge` costs $0.20 per running hour, requires the effective $100 plan or higher, and requires an explicit bare-metal operator allocation. A fork inherits the source sandbox's type unless the fork request passes its own, and resume and fork can move a sandbox between sizes.
+     * Machine size. `small` consumes machine time at half rate and `large` at twice the default rate (see the Billing guide). A fork inherits the source sandbox's type unless the fork request passes its own, and resume and fork can move a sandbox between sizes.
      * @type {CreateSandboxRequestTypeEnum}
      * @memberof CreateSandboxRequest
      */
@@ -56,7 +56,7 @@ export interface CreateSandboxRequest {
      */
     setupScript?: string;
     /**
-     * Bill this sandbox to a team you belong to (the team's shared wallet). Your own account id means personal billing. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId` and over the `X-Boat-Org` / `?org=` request scope.
+     * Bill this sandbox to an organization you belong to (its shared wallet), by id or by name as `GET /orgs` lists it; `personal` or your own account id means personal billing. Omitted, the `X-Boat-Org` / `?org=` request scope applies, then the account's active wallet (`PATCH /orgs/active`), then personal. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId`.
      * @type {string}
      * @memberof CreateSandboxRequest
      */
@@ -82,8 +82,7 @@ export interface CreateSandboxRequest {
 export const CreateSandboxRequestTypeEnum = {
     Small: 'small',
     Default: 'default',
-    Large: 'large',
-    Xlarge: 'xlarge'
+    Large: 'large'
 } as const;
 export type CreateSandboxRequestTypeEnum = typeof CreateSandboxRequestTypeEnum[keyof typeof CreateSandboxRequestTypeEnum];
 

package/src/models/CreateSandboxResponse.ts

@@ -40,7 +40,7 @@ export interface CreateSandboxResponse {
      */
     type: CreateSandboxResponseTypeEnum;
     /**
-     * 
+     * `ready` only when an idempotent retry finds a sandbox that is already past provisioning.
      * @type {CreateSandboxResponseStatusEnum}
      * @memberof CreateSandboxResponse
      */
@@ -57,6 +57,12 @@ export interface CreateSandboxResponse {
      * @memberof CreateSandboxResponse
      */
     sandbox: Sandbox;
+    /**
+     * Present when a fair-use cap on a gifted account shortened the requested auto-stop time.
+     * @type {string}
+     * @memberof CreateSandboxResponse
+     */
+    giftLimitNotice?: string;
 }
 
 
@@ -72,7 +78,8 @@ export type CreateSandboxResponseTypeEnum = typeof CreateSandboxResponseTypeEnum
  * @export
  */
 export const CreateSandboxResponseStatusEnum = {
-    Provisioning: 'provisioning'
+    Provisioning: 'provisioning',
+    Ready: 'ready'
 } as const;
 export type CreateSandboxResponseStatusEnum = typeof CreateSandboxResponseStatusEnum[keyof typeof CreateSandboxResponseStatusEnum];
 
@@ -104,6 +111,7 @@ export function CreateSandboxResponseFromJSONTyped(json: any, ignoreDiscriminato
         'status': json['status'],
         'ttlSeconds': json['ttlSeconds'],
         'sandbox': SandboxFromJSON(json['sandbox']),
+        'giftLimitNotice': json['giftLimitNotice'] == null ? undefined : json['giftLimitNotice'],
     };
 }
 
@@ -123,6 +131,7 @@ export function CreateSandboxResponseToJSONTyped(value?: CreateSandboxResponse |
         'status': value['status'],
         'ttlSeconds': value['ttlSeconds'],
         'sandbox': SandboxToJSON(value['sandbox']),
+        'giftLimitNotice': value['giftLimitNotice'],
     };
 }
 

package/src/models/DeletionOperation.ts

@@ -49,6 +49,18 @@ export interface DeletionOperation {
      * @memberof DeletionOperation
      */
     status: DeletionOperationStatusEnum;
+    /**
+     * What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot you kept is built on this one; its data goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
+     * @type {DeletionOperationStageEnum}
+     * @memberof DeletionOperation
+     */
+    stage?: DeletionOperationStageEnum;
+    /**
+     * When `waiting_for_uploads` ends.
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    expectedBy?: Date | null;
     /**
      * 
      * @type {number}
@@ -100,6 +112,19 @@ export const DeletionOperationStatusEnum = {
 } as const;
 export type DeletionOperationStatusEnum = typeof DeletionOperationStatusEnum[keyof typeof DeletionOperationStatusEnum];
 
+/**
+ * @export
+ */
+export const DeletionOperationStageEnum = {
+    Removing: 'removing',
+    WaitingForUploads: 'waiting_for_uploads',
+    KeptForNewerSnapshots: 'kept_for_newer_snapshots',
+    WaitingForRestore: 'waiting_for_restore',
+    Retrying: 'retrying',
+    Completed: 'completed'
+} as const;
+export type DeletionOperationStageEnum = typeof DeletionOperationStageEnum[keyof typeof DeletionOperationStageEnum];
+
 
 /**
  * Check if a given object implements the DeletionOperation interface.
@@ -131,6 +156,8 @@ export function DeletionOperationFromJSONTyped(json: any, ignoreDiscriminator: b
         'targetId': json['targetId'],
         'reason': json['reason'],
         'status': json['status'],
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'expectedBy': json['expectedBy'] == null ? undefined : (new Date(json['expectedBy'])),
         'attemptCount': json['attemptCount'],
         'requestedAt': (new Date(json['requestedAt'])),
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
@@ -153,6 +180,8 @@ export function DeletionOperationToJSONTyped(value?: DeletionOperation | null, i
         'targetId': value['targetId'],
         'reason': value['reason'],
         'status': value['status'],
+        'stage': value['stage'],
+        'expectedBy': value['expectedBy'] == null ? value['expectedBy'] : value['expectedBy'].toISOString(),
         'attemptCount': value['attemptCount'],
         'requestedAt': value['requestedAt'].toISOString(),
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),

package/src/models/DeletionOperationListResponse.ts

@@ -0,0 +1,102 @@
+/* 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 { DeletionOperation } from './DeletionOperation';
+import {
+    DeletionOperationFromJSON,
+    DeletionOperationFromJSONTyped,
+    DeletionOperationToJSON,
+    DeletionOperationToJSONTyped,
+} from './DeletionOperation';
+
+/**
+ * 
+ * @export
+ * @interface DeletionOperationListResponse
+ */
+export interface DeletionOperationListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeletionOperationListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {DeletionOperationListResponseTypeEnum}
+     * @memberof DeletionOperationListResponse
+     */
+    type: DeletionOperationListResponseTypeEnum;
+    /**
+     * 
+     * @type {Array<DeletionOperation>}
+     * @memberof DeletionOperationListResponse
+     */
+    operations: Array<DeletionOperation>;
+}
+
+
+/**
+ * @export
+ */
+export const DeletionOperationListResponseTypeEnum = {
+    SnapshotDeleting: 'snapshot.deleting'
+} as const;
+export type DeletionOperationListResponseTypeEnum = typeof DeletionOperationListResponseTypeEnum[keyof typeof DeletionOperationListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+export function instanceOfDeletionOperationListResponse(value: object): value is DeletionOperationListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    return true;
+}
+
+export function DeletionOperationListResponseFromJSON(json: any): DeletionOperationListResponse {
+    return DeletionOperationListResponseFromJSONTyped(json, false);
+}
+
+export function DeletionOperationListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperationListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'operations': ((json['operations'] as Array<any>).map(DeletionOperationFromJSON)),
+    };
+}
+
+export function DeletionOperationListResponseToJSON(json: any): DeletionOperationListResponse {
+    return DeletionOperationListResponseToJSONTyped(json, false);
+}
+
+export function DeletionOperationListResponseToJSONTyped(value?: DeletionOperationListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'operations': ((value['operations'] as Array<any>).map(DeletionOperationToJSON)),
+    };
+}
+

package/src/models/ForkRequest.ts

@@ -38,7 +38,7 @@ export interface ForkRequest {
      */
     noEnv?: boolean;
     /**
-     * Machine size for the fork. Omit to inherit the source sandbox's type. The source sandbox is never modified. Shrinking is rejected with `type_too_small` when the source's data would not fit the smaller disk. `xlarge` requires the effective $100 plan or higher and an explicit bare-metal operator allocation.
+     * Machine size for the fork. Omit to inherit the source sandbox's type. The source sandbox is never modified. Shrinking is rejected with `type_too_small` when the source's data would not fit the smaller disk.
      * @type {ForkRequestTypeEnum}
      * @memberof ForkRequest
      */
@@ -58,8 +58,7 @@ export interface ForkRequest {
 export const ForkRequestTypeEnum = {
     Small: 'small',
     Default: 'default',
-    Large: 'large',
-    Xlarge: 'xlarge'
+    Large: 'large'
 } as const;
 export type ForkRequestTypeEnum = typeof ForkRequestTypeEnum[keyof typeof ForkRequestTypeEnum];