@boatdev/sdk 1.10.0 → 1.11.0

package/src/models/ResourceAccess.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * Which organization members can use this organization environment or profile. `restricted` false means every member. `restricted` true means owners, admins and `members` only. Others do not see it in lists. Personal environments and profiles always return `restricted` false.
+ * @export
+ * @interface ResourceAccess
+ */
+export interface ResourceAccess {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ResourceAccess
+     */
+    restricted: boolean;
+    /**
+     * Member ids. Empty when `restricted` is false.
+     * @type {Array<string>}
+     * @memberof ResourceAccess
+     */
+    members: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ResourceAccess interface.
+ */
+export function instanceOfResourceAccess(value: object): value is ResourceAccess {
+    if (!('restricted' in value) || value['restricted'] === undefined) return false;
+    if (!('members' in value) || value['members'] === undefined) return false;
+    return true;
+}
+
+export function ResourceAccessFromJSON(json: any): ResourceAccess {
+    return ResourceAccessFromJSONTyped(json, false);
+}
+
+export function ResourceAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceAccess {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'restricted': json['restricted'],
+        'members': json['members'],
+    };
+}
+
+export function ResourceAccessToJSON(json: any): ResourceAccess {
+    return ResourceAccessToJSONTyped(json, false);
+}
+
+export function ResourceAccessToJSONTyped(value?: ResourceAccess | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'restricted': value['restricted'],
+        'members': value['members'],
+    };
+}
+

package/src/models/ResourceAccessUpdate.ts

@@ -0,0 +1,74 @@
+/* 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';
+/**
+ * Set who can use an organization environment (owner or admin) or profile (owner). A change does not touch running sandboxes. A bad list returns `400 invalid_access`.
+ * @export
+ * @interface ResourceAccessUpdate
+ */
+export interface ResourceAccessUpdate {
+    /**
+     * False opens it to every member. True limits it to owners, admins and `members`.
+     * @type {boolean}
+     * @memberof ResourceAccessUpdate
+     */
+    restricted: boolean;
+    /**
+     * Member ids or emails of active members. Replaces the full list.
+     * @type {Array<string>}
+     * @memberof ResourceAccessUpdate
+     */
+    members?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ResourceAccessUpdate interface.
+ */
+export function instanceOfResourceAccessUpdate(value: object): value is ResourceAccessUpdate {
+    if (!('restricted' in value) || value['restricted'] === undefined) return false;
+    return true;
+}
+
+export function ResourceAccessUpdateFromJSON(json: any): ResourceAccessUpdate {
+    return ResourceAccessUpdateFromJSONTyped(json, false);
+}
+
+export function ResourceAccessUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceAccessUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'restricted': json['restricted'],
+        'members': json['members'] == null ? undefined : json['members'],
+    };
+}
+
+export function ResourceAccessUpdateToJSON(json: any): ResourceAccessUpdate {
+    return ResourceAccessUpdateToJSONTyped(json, false);
+}
+
+export function ResourceAccessUpdateToJSONTyped(value?: ResourceAccessUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'restricted': value['restricted'],
+        'members': value['members'],
+    };
+}
+

package/src/models/Sandbox.ts

@@ -27,6 +27,13 @@ import {
     StopOperationToJSON,
     StopOperationToJSONTyped,
 } from './StopOperation';
+import type { SandboxLastReboot } from './SandboxLastReboot';
+import {
+    SandboxLastRebootFromJSON,
+    SandboxLastRebootFromJSONTyped,
+    SandboxLastRebootToJSON,
+    SandboxLastRebootToJSONTyped,
+} from './SandboxLastReboot';
 import type { SandboxCost } from './SandboxCost';
 import {
     SandboxCostFromJSON,
@@ -294,6 +301,12 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     lastSnapshotStatus?: SandboxLastSnapshotStatusEnum | null;
+    /**
+     * 
+     * @type {SandboxLastReboot}
+     * @memberof Sandbox
+     */
+    lastReboot?: SandboxLastReboot;
     /**
      * Outcome of the create-time `setupScript`: `pending` (stored, not yet started), `running` (executing on the sandbox in the background), `done` (exit code 0) or `failed` (non-zero exit, or the sandbox lost track of the process). Null when the sandbox was created without a setup script.
      * @type {SandboxSetupStatusEnum}
@@ -480,6 +493,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
         'lastSnapshotAttemptAt': json['lastSnapshotAttemptAt'] == null ? undefined : (new Date(json['lastSnapshotAttemptAt'])),
         'lastSnapshotStatus': json['lastSnapshotStatus'] == null ? undefined : json['lastSnapshotStatus'],
+        'lastReboot': json['lastReboot'] == null ? undefined : SandboxLastRebootFromJSON(json['lastReboot']),
         'setupStatus': json['setupStatus'] == null ? undefined : json['setupStatus'],
         'setupError': json['setupError'] == null ? undefined : json['setupError'],
         'environment': json['environment'] == null ? undefined : json['environment'],
@@ -540,6 +554,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'subdomain': value['subdomain'],
         'lastSnapshotAttemptAt': value['lastSnapshotAttemptAt'] == null ? value['lastSnapshotAttemptAt'] : value['lastSnapshotAttemptAt'].toISOString(),
         'lastSnapshotStatus': value['lastSnapshotStatus'],
+        'lastReboot': SandboxLastRebootToJSON(value['lastReboot']),
         'setupStatus': value['setupStatus'],
         'setupError': value['setupError'],
         'environment': value['environment'],

package/src/models/SandboxEnvironment.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ResourceAccess } from './ResourceAccess';
+import {
+    ResourceAccessFromJSON,
+    ResourceAccessFromJSONTyped,
+    ResourceAccessToJSON,
+    ResourceAccessToJSONTyped,
+} from './ResourceAccess';
 import type { SelectedRepository } from './SelectedRepository';
 import {
     SelectedRepositoryFromJSON,
@@ -119,6 +126,12 @@ export interface SandboxEnvironment {
      * @memberof SandboxEnvironment
      */
     proxyAiCredentials?: boolean;
+    /**
+     * 
+     * @type {ResourceAccess}
+     * @memberof SandboxEnvironment
+     */
+    access?: ResourceAccess;
     /**
      * The latest version's .env-style content. Treat as sensitive.
      * @type {string}
@@ -187,6 +200,7 @@ export function SandboxEnvironmentFromJSONTyped(json: any, ignoreDiscriminator:
         'passAgentsCredentials': json['passAgentsCredentials'],
         'credentialProfileId': json['credentialProfileId'] == null ? undefined : json['credentialProfileId'],
         'proxyAiCredentials': json['proxyAiCredentials'] == null ? undefined : json['proxyAiCredentials'],
+        'access': json['access'] == null ? undefined : ResourceAccessFromJSON(json['access']),
         'envContents': json['envContents'],
         'secretFiles': ((json['secretFiles'] as Array<any>).map(SecretFileFromJSON)),
         'selectedRepositories': json['selectedRepositories'] == null ? undefined : ((json['selectedRepositories'] as Array<any>).map(SelectedRepositoryFromJSON)),
@@ -218,6 +232,7 @@ export function SandboxEnvironmentToJSONTyped(value?: SandboxEnvironment | null,
         'passAgentsCredentials': value['passAgentsCredentials'],
         'credentialProfileId': value['credentialProfileId'],
         'proxyAiCredentials': value['proxyAiCredentials'],
+        'access': ResourceAccessToJSON(value['access']),
         'envContents': value['envContents'],
         'secretFiles': ((value['secretFiles'] as Array<any>).map(SecretFileToJSON)),
         'selectedRepositories': value['selectedRepositories'] == null ? undefined : ((value['selectedRepositories'] as Array<any>).map(SelectedRepositoryToJSON)),

package/src/models/SandboxLastReboot.ts

@@ -0,0 +1,85 @@
+/* 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';
+/**
+ * The last time the sandbox's kernel restarted on its machine, or null if it never did. Every process running at that time ended. `crash` means the system log ended with no shutdown, for example after a kernel panic.
+ * @export
+ * @interface SandboxLastReboot
+ */
+export interface SandboxLastReboot {
+    /**
+     * 
+     * @type {Date}
+     * @memberof SandboxLastReboot
+     */
+    at?: Date;
+    /**
+     * 
+     * @type {SandboxLastRebootReasonEnum}
+     * @memberof SandboxLastReboot
+     */
+    reason?: SandboxLastRebootReasonEnum;
+}
+
+
+/**
+ * @export
+ */
+export const SandboxLastRebootReasonEnum = {
+    Crash: 'crash',
+    Clean: 'clean',
+    Unknown: 'unknown'
+} as const;
+export type SandboxLastRebootReasonEnum = typeof SandboxLastRebootReasonEnum[keyof typeof SandboxLastRebootReasonEnum];
+
+
+/**
+ * Check if a given object implements the SandboxLastReboot interface.
+ */
+export function instanceOfSandboxLastReboot(value: object): value is SandboxLastReboot {
+    return true;
+}
+
+export function SandboxLastRebootFromJSON(json: any): SandboxLastReboot {
+    return SandboxLastRebootFromJSONTyped(json, false);
+}
+
+export function SandboxLastRebootFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxLastReboot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'at': json['at'] == null ? undefined : (new Date(json['at'])),
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+
+export function SandboxLastRebootToJSON(json: any): SandboxLastReboot {
+    return SandboxLastRebootToJSONTyped(json, false);
+}
+
+export function SandboxLastRebootToJSONTyped(value?: SandboxLastReboot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
+        'reason': value['reason'],
+    };
+}
+

package/src/models/SandboxListResponse.ts

@@ -20,6 +20,13 @@ import {
     PageInfoToJSON,
     PageInfoToJSONTyped,
 } from './PageInfo';
+import type { SandboxListResponseAllOfDeletedCost } from './SandboxListResponseAllOfDeletedCost';
+import {
+    SandboxListResponseAllOfDeletedCostFromJSON,
+    SandboxListResponseAllOfDeletedCostFromJSONTyped,
+    SandboxListResponseAllOfDeletedCostToJSON,
+    SandboxListResponseAllOfDeletedCostToJSONTyped,
+} from './SandboxListResponseAllOfDeletedCost';
 import type { Sandbox } from './Sandbox';
 import {
     SandboxFromJSON,
@@ -58,6 +65,12 @@ export interface SandboxListResponse {
      * @memberof SandboxListResponse
      */
     pageInfo?: PageInfo;
+    /**
+     * 
+     * @type {SandboxListResponseAllOfDeletedCost}
+     * @memberof SandboxListResponse
+     */
+    deletedCost?: SandboxListResponseAllOfDeletedCost;
 }
 
 
@@ -94,6 +107,7 @@ export function SandboxListResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'type': json['type'],
         'sandboxes': ((json['sandboxes'] as Array<any>).map(SandboxFromJSON)),
         'pageInfo': json['pageInfo'] == null ? undefined : PageInfoFromJSON(json['pageInfo']),
+        'deletedCost': json['deletedCost'] == null ? undefined : SandboxListResponseAllOfDeletedCostFromJSON(json['deletedCost']),
     };
 }
 
@@ -112,6 +126,7 @@ export function SandboxListResponseToJSONTyped(value?: SandboxListResponse | nul
         'type': value['type'],
         'sandboxes': ((value['sandboxes'] as Array<any>).map(SandboxToJSON)),
         'pageInfo': PageInfoToJSON(value['pageInfo']),
+        'deletedCost': SandboxListResponseAllOfDeletedCostToJSON(value['deletedCost']),
     };
 }
 

package/src/models/SandboxListResponseAllOfDeletedCost.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * Only with `include=cost`, and not for an API key limited to some sandboxes. Machine time this calendar month (UTC) of deleted sandboxes this list would otherwise show. They are not in the list, but their time was billed. Add it to the sandboxes' `cost` to get the full total.
+ * @export
+ * @interface SandboxListResponseAllOfDeletedCost
+ */
+export interface SandboxListResponseAllOfDeletedCost {
+    /**
+     * The 1st of this month, 00:00 UTC.
+     * @type {Date}
+     * @memberof SandboxListResponseAllOfDeletedCost
+     */
+    since: Date;
+    /**
+     * Billable machine-seconds, size multiplier applied.
+     * @type {number}
+     * @memberof SandboxListResponseAllOfDeletedCost
+     */
+    seconds: number;
+    /**
+     * seconds / secondsPerDollar, at list price.
+     * @type {number}
+     * @memberof SandboxListResponseAllOfDeletedCost
+     */
+    dollars: number;
+}
+
+/**
+ * Check if a given object implements the SandboxListResponseAllOfDeletedCost interface.
+ */
+export function instanceOfSandboxListResponseAllOfDeletedCost(value: object): value is SandboxListResponseAllOfDeletedCost {
+    if (!('since' in value) || value['since'] === undefined) return false;
+    if (!('seconds' in value) || value['seconds'] === undefined) return false;
+    if (!('dollars' in value) || value['dollars'] === undefined) return false;
+    return true;
+}
+
+export function SandboxListResponseAllOfDeletedCostFromJSON(json: any): SandboxListResponseAllOfDeletedCost {
+    return SandboxListResponseAllOfDeletedCostFromJSONTyped(json, false);
+}
+
+export function SandboxListResponseAllOfDeletedCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxListResponseAllOfDeletedCost {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'since': (new Date(json['since'])),
+        'seconds': json['seconds'],
+        'dollars': json['dollars'],
+    };
+}
+
+export function SandboxListResponseAllOfDeletedCostToJSON(json: any): SandboxListResponseAllOfDeletedCost {
+    return SandboxListResponseAllOfDeletedCostToJSONTyped(json, false);
+}
+
+export function SandboxListResponseAllOfDeletedCostToJSONTyped(value?: SandboxListResponseAllOfDeletedCost | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'since': value['since'].toISOString(),
+        'seconds': value['seconds'],
+        'dollars': value['dollars'],
+    };
+}
+

package/src/models/SavedSnapshot.ts

@@ -0,0 +1,137 @@
+/* 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';
+/**
+ * A saved snapshot: a frozen copy of a sandbox's disk at one moment, saved under a name you pick. Independent of the source sandbox's later life: the sandbox can change, stop, or be deleted and the saved snapshot still deploys. Saved snapshots never expire; re-saving a name replaces its artifact.
+ * @export
+ * @interface SavedSnapshot
+ */
+export interface SavedSnapshot {
+    /**
+     * The user-chosen handle, unique within your account.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    name: string;
+    /**
+     * `saving` while the capture and pin are in flight (a live source sandbox takes a fresh snapshot first, which can run minutes), `ready` when deployable, `failed` if the save did not complete (see `error`; save again to retry).
+     * @type {SavedSnapshotStatusEnum}
+     * @memberof SavedSnapshot
+     */
+    status: SavedSnapshotStatusEnum;
+    /**
+     * Failure reason. Only present when `status` is `failed`.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    error?: string;
+    /**
+     * The sandbox this snapshot was saved from (display only).
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    sourceSandboxId: string;
+    /**
+     * The frozen artifact behind the name. Present once `status` is `ready`. Accepted by `GET /api/boat/snapshots/{snapshotId}/tree` to browse its files.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    snapshotId?: string;
+    /**
+     * Sandbox type the snapshot was saved from. Deploys default to it.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    type?: string;
+    /**
+     * Restored content size of the frozen state, in bytes.
+     * @type {number}
+     * @memberof SavedSnapshot
+     */
+    sizeBytes?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SavedSnapshot
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const SavedSnapshotStatusEnum = {
+    Saving: 'saving',
+    Ready: 'ready',
+    Failed: 'failed'
+} as const;
+export type SavedSnapshotStatusEnum = typeof SavedSnapshotStatusEnum[keyof typeof SavedSnapshotStatusEnum];
+
+
+/**
+ * Check if a given object implements the SavedSnapshot interface.
+ */
+export function instanceOfSavedSnapshot(value: object): value is SavedSnapshot {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('sourceSandboxId' in value) || value['sourceSandboxId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function SavedSnapshotFromJSON(json: any): SavedSnapshot {
+    return SavedSnapshotFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'status': json['status'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'sourceSandboxId': json['sourceSandboxId'],
+        'snapshotId': json['snapshotId'] == null ? undefined : json['snapshotId'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'sizeBytes': json['sizeBytes'] == null ? undefined : json['sizeBytes'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function SavedSnapshotToJSON(json: any): SavedSnapshot {
+    return SavedSnapshotToJSONTyped(json, false);
+}
+
+export function SavedSnapshotToJSONTyped(value?: SavedSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'status': value['status'],
+        'error': value['error'],
+        'sourceSandboxId': value['sourceSandboxId'],
+        'snapshotId': value['snapshotId'],
+        'type': value['type'],
+        'sizeBytes': value['sizeBytes'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}
+