@boatdev/sdk 1.0.0

package/dist/esm/models/ResumeRequest.js

@@ -0,0 +1,58 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ResumeRequestTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+};
+/**
+ * Check if a given object implements the ResumeRequest interface.
+ */
+export function instanceOfResumeRequest(value) {
+    return true;
+}
+export function ResumeRequestFromJSON(json) {
+    return ResumeRequestFromJSONTyped(json, false);
+}
+export function ResumeRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'] == null ? undefined : json['type'],
+        'env': json['env'] == null ? undefined : json['env'],
+        'environment': json['environment'] == null ? undefined : json['environment'],
+        'noEnv': json['noEnv'] == null ? undefined : json['noEnv'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+export function ResumeRequestToJSON(json) {
+    return ResumeRequestToJSONTyped(json, false);
+}
+export function ResumeRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'env': value['env'],
+        'environment': value['environment'],
+        'noEnv': value['noEnv'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}

package/dist/esm/models/RotateApiKey409Response.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.
+ */
+/**
+ *
+ * @export
+ * @interface RotateApiKey409Response
+ */
+export interface RotateApiKey409Response {
+    /**
+     *
+     * @type {RotateApiKey409ResponseErrorEnum}
+     * @memberof RotateApiKey409Response
+     */
+    error: RotateApiKey409ResponseErrorEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof RotateApiKey409Response
+     */
+    message: string;
+}
+/**
+ * @export
+ */
+export declare const RotateApiKey409ResponseErrorEnum: {
+    readonly ApiKeyExpired: 'api_key_expired';
+};
+export type RotateApiKey409ResponseErrorEnum = typeof RotateApiKey409ResponseErrorEnum[keyof typeof RotateApiKey409ResponseErrorEnum];
+/**
+ * Check if a given object implements the RotateApiKey409Response interface.
+ */
+export declare function instanceOfRotateApiKey409Response(value: object): value is RotateApiKey409Response;
+export declare function RotateApiKey409ResponseFromJSON(json: any): RotateApiKey409Response;
+export declare function RotateApiKey409ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RotateApiKey409Response;
+export declare function RotateApiKey409ResponseToJSON(json: any): RotateApiKey409Response;
+export declare function RotateApiKey409ResponseToJSONTyped(value?: RotateApiKey409Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RotateApiKey409Response.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const RotateApiKey409ResponseErrorEnum = {
+    ApiKeyExpired: 'api_key_expired'
+};
+/**
+ * Check if a given object implements the RotateApiKey409Response interface.
+ */
+export function instanceOfRotateApiKey409Response(value) {
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function RotateApiKey409ResponseFromJSON(json) {
+    return RotateApiKey409ResponseFromJSONTyped(json, false);
+}
+export function RotateApiKey409ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'error': json['error'],
+        'message': json['message'],
+    };
+}
+export function RotateApiKey409ResponseToJSON(json) {
+    return RotateApiKey409ResponseToJSONTyped(json, false);
+}
+export function RotateApiKey409ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'error': value['error'],
+        'message': value['message'],
+    };
+}

package/dist/esm/models/Sandbox.d.ts

@@ -0,0 +1,211 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface Sandbox
+ */
+export interface Sandbox {
+    /**
+     *
+     * @type {string}
+     * @memberof Sandbox
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Sandbox
+     */
+    name: string;
+    /**
+     *
+     * @type {SandboxStateEnum}
+     * @memberof Sandbox
+     */
+    state: SandboxStateEnum;
+    /**
+     * Current machine size: what the sandbox was created with, or the size it was last resumed or forked onto. Legacy bare-metal sandboxes read as `default`.
+     * @type {SandboxTypeEnum}
+     * @memberof Sandbox
+     */
+    type?: SandboxTypeEnum;
+    /**
+     * vCPUs guaranteed by this sandbox's type.
+     * @type {number}
+     * @memberof Sandbox
+     */
+    vcpu?: number;
+    /**
+     * RAM in GB guaranteed by this sandbox's type.
+     * @type {number}
+     * @memberof Sandbox
+     */
+    memoryGB?: number;
+    /**
+     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, 2 for `large`, and 50/9 for `xlarge`.
+     * @type {number}
+     * @memberof Sandbox
+     */
+    billingMultiplier?: number;
+    /**
+     * Machine URL when assigned.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    url?: string | null;
+    /**
+     * Machine IPv6 or IPv4 address when assigned.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    ip?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    createdAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    updatedAt?: Date | null;
+    /**
+     * Automatic archival time, or null when auto-stop is disabled.
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    archiveAfter?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    desktopAvailable: boolean;
+    /**
+     * Secret-bearing desktop stream URL when available. Redact from logs.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    desktopUrl?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    snapshotAvailable: boolean;
+    /**
+     * Timestamp of the most recent successfully completed snapshot, or null.
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    snapshotCompletedAt?: Date | null;
+    /**
+     * The sandbox's stable three-word subdomain slug (e.g. "frazil-pneuma-rallye"), or null before one is assigned.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    subdomain?: string | null;
+    /**
+     * Timestamp of the most recent snapshot attempt of any status (queued, in_progress, completed, failed, cancelled), or null. Use with snapshotCompletedAt to detect snapshots that keep failing.
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    lastSnapshotAttemptAt?: Date | null;
+    /**
+     * Status of the most recent snapshot attempt, or null if none. A value other than completed while snapshotCompletedAt stays stale indicates failing snapshots.
+     * @type {SandboxLastSnapshotStatusEnum}
+     * @memberof Sandbox
+     */
+    lastSnapshotStatus?: SandboxLastSnapshotStatusEnum | null;
+    /**
+     * 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}
+     * @memberof Sandbox
+     */
+    setupStatus?: SandboxSetupStatusEnum | null;
+    /**
+     * Short failure detail (exit code plus a stderr tail) when `setupStatus` is `failed`; while `pending`, may carry the last start/upload error from a retry in progress. Otherwise null.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    setupError?: string | null;
+    /**
+     * Name of the sandbox environment this sandbox is running, or null if it is attached to none (a `noEnv` sandbox, or one whose environment was deleted). A sandbox freezes onto one environment version when it starts and keeps it for life, so this is what the sandbox actually holds, not what the environment says today.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    environment?: string | null;
+    /**
+     * Version number of `environment` that this sandbox is pinned to. Compare it against the environment's latest version to see whether an upgrade is pending: a sandbox below the latest is still running the older configuration until someone calls `POST /environments/{environmentId}/upgrade`.
+     * @type {number}
+     * @memberof Sandbox
+     */
+    environmentVersion?: number | null;
+}
+/**
+ * @export
+ */
+export declare const SandboxStateEnum: {
+    readonly Init: 'init';
+    readonly Provisioning: 'provisioning';
+    readonly Provisioned: 'provisioned';
+    readonly Cloning: 'cloning';
+    readonly Ready: 'ready';
+    readonly Idle: 'idle';
+    readonly Running: 'running';
+    readonly Archiving: 'archiving';
+    readonly Archived: 'archived';
+    readonly Error: 'error';
+};
+export type SandboxStateEnum = typeof SandboxStateEnum[keyof typeof SandboxStateEnum];
+/**
+ * @export
+ */
+export declare const SandboxTypeEnum: {
+    readonly Small: 'small';
+    readonly Default: 'default';
+    readonly Large: 'large';
+    readonly Xlarge: 'xlarge';
+};
+export type SandboxTypeEnum = typeof SandboxTypeEnum[keyof typeof SandboxTypeEnum];
+/**
+ * @export
+ */
+export declare const SandboxLastSnapshotStatusEnum: {
+    readonly Queued: 'queued';
+    readonly InProgress: 'in_progress';
+    readonly Completed: 'completed';
+    readonly Failed: 'failed';
+    readonly Cancelled: 'cancelled';
+};
+export type SandboxLastSnapshotStatusEnum = typeof SandboxLastSnapshotStatusEnum[keyof typeof SandboxLastSnapshotStatusEnum];
+/**
+ * @export
+ */
+export declare const SandboxSetupStatusEnum: {
+    readonly Pending: 'pending';
+    readonly Running: 'running';
+    readonly Done: 'done';
+    readonly Failed: 'failed';
+};
+export type SandboxSetupStatusEnum = typeof SandboxSetupStatusEnum[keyof typeof SandboxSetupStatusEnum];
+/**
+ * Check if a given object implements the Sandbox interface.
+ */
+export declare function instanceOfSandbox(value: object): value is Sandbox;
+export declare function SandboxFromJSON(json: any): Sandbox;
+export declare function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sandbox;
+export declare function SandboxToJSON(json: any): Sandbox;
+export declare function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Sandbox.js

@@ -0,0 +1,138 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const SandboxStateEnum = {
+    Init: 'init',
+    Provisioning: 'provisioning',
+    Provisioned: 'provisioned',
+    Cloning: 'cloning',
+    Ready: 'ready',
+    Idle: 'idle',
+    Running: 'running',
+    Archiving: 'archiving',
+    Archived: 'archived',
+    Error: 'error'
+};
+/**
+ * @export
+ */
+export const SandboxTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+};
+/**
+ * @export
+ */
+export const SandboxLastSnapshotStatusEnum = {
+    Queued: 'queued',
+    InProgress: 'in_progress',
+    Completed: 'completed',
+    Failed: 'failed',
+    Cancelled: 'cancelled'
+};
+/**
+ * @export
+ */
+export const SandboxSetupStatusEnum = {
+    Pending: 'pending',
+    Running: 'running',
+    Done: 'done',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the Sandbox interface.
+ */
+export function instanceOfSandbox(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('desktopAvailable' in value) || value['desktopAvailable'] === undefined)
+        return false;
+    if (!('snapshotAvailable' in value) || value['snapshotAvailable'] === undefined)
+        return false;
+    return true;
+}
+export function SandboxFromJSON(json) {
+    return SandboxFromJSONTyped(json, false);
+}
+export function SandboxFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'state': json['state'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'vcpu': json['vcpu'] == null ? undefined : json['vcpu'],
+        'memoryGB': json['memoryGB'] == null ? undefined : json['memoryGB'],
+        'billingMultiplier': json['billingMultiplier'] == null ? undefined : json['billingMultiplier'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'ip': json['ip'] == null ? undefined : json['ip'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'archiveAfter': json['archiveAfter'] == null ? undefined : (new Date(json['archiveAfter'])),
+        'desktopAvailable': json['desktopAvailable'],
+        'desktopUrl': json['desktopUrl'] == null ? undefined : json['desktopUrl'],
+        'snapshotAvailable': json['snapshotAvailable'],
+        'snapshotCompletedAt': json['snapshotCompletedAt'] == null ? undefined : (new Date(json['snapshotCompletedAt'])),
+        'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
+        'lastSnapshotAttemptAt': json['lastSnapshotAttemptAt'] == null ? undefined : (new Date(json['lastSnapshotAttemptAt'])),
+        'lastSnapshotStatus': json['lastSnapshotStatus'] == null ? undefined : json['lastSnapshotStatus'],
+        'setupStatus': json['setupStatus'] == null ? undefined : json['setupStatus'],
+        'setupError': json['setupError'] == null ? undefined : json['setupError'],
+        'environment': json['environment'] == null ? undefined : json['environment'],
+        'environmentVersion': json['environmentVersion'] == null ? undefined : json['environmentVersion'],
+    };
+}
+export function SandboxToJSON(json) {
+    return SandboxToJSONTyped(json, false);
+}
+export function SandboxToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'state': value['state'],
+        'type': value['type'],
+        'vcpu': value['vcpu'],
+        'memoryGB': value['memoryGB'],
+        'billingMultiplier': value['billingMultiplier'],
+        'url': value['url'],
+        'ip': value['ip'],
+        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'archiveAfter': value['archiveAfter'] == null ? value['archiveAfter'] : value['archiveAfter'].toISOString(),
+        'desktopAvailable': value['desktopAvailable'],
+        'desktopUrl': value['desktopUrl'],
+        'snapshotAvailable': value['snapshotAvailable'],
+        'snapshotCompletedAt': value['snapshotCompletedAt'] == null ? value['snapshotCompletedAt'] : value['snapshotCompletedAt'].toISOString(),
+        'subdomain': value['subdomain'],
+        'lastSnapshotAttemptAt': value['lastSnapshotAttemptAt'] == null ? value['lastSnapshotAttemptAt'] : value['lastSnapshotAttemptAt'].toISOString(),
+        'lastSnapshotStatus': value['lastSnapshotStatus'],
+        'setupStatus': value['setupStatus'],
+        'setupError': value['setupError'],
+        'environment': value['environment'],
+        'environmentVersion': value['environmentVersion'],
+    };
+}

package/dist/esm/models/SandboxActionResponse.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 SandboxActionResponse
+ */
+export interface SandboxActionResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SandboxActionResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxActionResponse
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxActionResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxActionResponse
+     */
+    status: string;
+    /**
+     *
+     * @type {Sandbox}
+     * @memberof SandboxActionResponse
+     */
+    sandbox?: Sandbox | null;
+}
+/**
+ * Check if a given object implements the SandboxActionResponse interface.
+ */
+export declare function instanceOfSandboxActionResponse(value: object): value is SandboxActionResponse;
+export declare function SandboxActionResponseFromJSON(json: any): SandboxActionResponse;
+export declare function SandboxActionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxActionResponse;
+export declare function SandboxActionResponseToJSON(json: any): SandboxActionResponse;
+export declare function SandboxActionResponseToJSONTyped(value?: SandboxActionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SandboxActionResponse.js

@@ -0,0 +1,58 @@
+/* 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 { SandboxFromJSON, SandboxToJSON, } from './Sandbox';
+/**
+ * Check if a given object implements the SandboxActionResponse interface.
+ */
+export function instanceOfSandboxActionResponse(value) {
+    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 (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function SandboxActionResponseFromJSON(json) {
+    return SandboxActionResponseFromJSONTyped(json, false);
+}
+export function SandboxActionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'status': json['status'],
+        'sandbox': json['sandbox'] == null ? undefined : SandboxFromJSON(json['sandbox']),
+    };
+}
+export function SandboxActionResponseToJSON(json) {
+    return SandboxActionResponseToJSONTyped(json, false);
+}
+export function SandboxActionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'status': value['status'],
+        'sandbox': SandboxToJSON(value['sandbox']),
+    };
+}