@boatdev/sdk 1.9.4 → 1.9.6

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { CredentialProfile } from './CredentialProfile';
+/**
+ *
+ * @export
+ * @interface CredentialProfileResponse
+ */
+export interface CredentialProfileResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CredentialProfileResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof CredentialProfileResponse
+     */
+    type: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CredentialProfileResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {CredentialProfile}
+     * @memberof CredentialProfileResponse
+     */
+    profile: CredentialProfile;
+}
+/**
+ * Check if a given object implements the CredentialProfileResponse interface.
+ */
+export declare function instanceOfCredentialProfileResponse(value: object): value is CredentialProfileResponse;
+export declare function CredentialProfileResponseFromJSON(json: any): CredentialProfileResponse;
+export declare function CredentialProfileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CredentialProfileResponse;
+export declare function CredentialProfileResponseToJSON(json: any): CredentialProfileResponse;
+export declare function CredentialProfileResponseToJSONTyped(value?: CredentialProfileResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CredentialProfileResponse.js

@@ -0,0 +1,56 @@
+/* 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 { CredentialProfileFromJSON, CredentialProfileToJSON, } from './CredentialProfile';
+/**
+ * Check if a given object implements the CredentialProfileResponse interface.
+ */
+export function instanceOfCredentialProfileResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('profile' in value) || value['profile'] === undefined)
+        return false;
+    return true;
+}
+export function CredentialProfileResponseFromJSON(json) {
+    return CredentialProfileResponseFromJSONTyped(json, false);
+}
+export function CredentialProfileResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'profile': CredentialProfileFromJSON(json['profile']),
+    };
+}
+export function CredentialProfileResponseToJSON(json) {
+    return CredentialProfileResponseToJSONTyped(json, false);
+}
+export function CredentialProfileResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'profile': CredentialProfileToJSON(value['profile']),
+    };
+}

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

@@ -46,7 +46,7 @@ export interface 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.
+     * 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, or a sandbox forked or deployed from it, still builds on this data; it goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
      * @type {DeletionOperationStageEnum}
      * @memberof DeletionOperation
      */

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

@@ -0,0 +1,38 @@
+/**
+ * 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 FileUrlRequest
+ */
+export interface FileUrlRequest {
+    /**
+     * Absolute path, or path relative to the sandbox work directory (/home/user). It must resolve under /home/user or /tmp.
+     * @type {string}
+     * @memberof FileUrlRequest
+     */
+    path: string;
+    /**
+     * How long the URL stays valid.
+     * @type {number}
+     * @memberof FileUrlRequest
+     */
+    ttlSeconds?: number;
+}
+/**
+ * Check if a given object implements the FileUrlRequest interface.
+ */
+export declare function instanceOfFileUrlRequest(value: object): value is FileUrlRequest;
+export declare function FileUrlRequestFromJSON(json: any): FileUrlRequest;
+export declare function FileUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlRequest;
+export declare function FileUrlRequestToJSON(json: any): FileUrlRequest;
+export declare function FileUrlRequestToJSONTyped(value?: FileUrlRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileUrlRequest.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the FileUrlRequest interface.
+ */
+export function instanceOfFileUrlRequest(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    return true;
+}
+export function FileUrlRequestFromJSON(json) {
+    return FileUrlRequestFromJSONTyped(json, false);
+}
+export function FileUrlRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+export function FileUrlRequestToJSON(json) {
+    return FileUrlRequestToJSONTyped(json, false);
+}
+export function FileUrlRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}

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

@@ -0,0 +1,78 @@
+/**
+ * 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 FileUrlResponse
+ */
+export interface FileUrlResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileUrlResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileUrlResponseTypeEnum}
+     * @memberof FileUrlResponse
+     */
+    type: FileUrlResponseTypeEnum;
+    /**
+     * The signed URL. Send the request straight to it; it needs no Authorization header.
+     * @type {string}
+     * @memberof FileUrlResponse
+     */
+    url: string;
+    /**
+     * GET downloads the file. PUT uploads the request body as the file.
+     * @type {FileUrlResponseMethodEnum}
+     * @memberof FileUrlResponse
+     */
+    method: FileUrlResponseMethodEnum;
+    /**
+     * The canonical path the URL is bound to.
+     * @type {string}
+     * @memberof FileUrlResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof FileUrlResponse
+     */
+    expiresAt: Date;
+}
+/**
+ * @export
+ */
+export declare const FileUrlResponseTypeEnum: {
+    readonly FileDownloadUrl: 'file.download_url';
+    readonly FileUploadUrl: 'file.upload_url';
+};
+export type FileUrlResponseTypeEnum = typeof FileUrlResponseTypeEnum[keyof typeof FileUrlResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const FileUrlResponseMethodEnum: {
+    readonly Get: 'GET';
+    readonly Put: 'PUT';
+};
+export type FileUrlResponseMethodEnum = typeof FileUrlResponseMethodEnum[keyof typeof FileUrlResponseMethodEnum];
+/**
+ * Check if a given object implements the FileUrlResponse interface.
+ */
+export declare function instanceOfFileUrlResponse(value: object): value is FileUrlResponse;
+export declare function FileUrlResponseFromJSON(json: any): FileUrlResponse;
+export declare function FileUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlResponse;
+export declare function FileUrlResponseToJSON(json: any): FileUrlResponse;
+export declare function FileUrlResponseToJSONTyped(value?: FileUrlResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileUrlResponse.js

@@ -0,0 +1,77 @@
+/* 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 FileUrlResponseTypeEnum = {
+    FileDownloadUrl: 'file.download_url',
+    FileUploadUrl: 'file.upload_url'
+};
+/**
+ * @export
+ */
+export const FileUrlResponseMethodEnum = {
+    Get: 'GET',
+    Put: 'PUT'
+};
+/**
+ * Check if a given object implements the FileUrlResponse interface.
+ */
+export function instanceOfFileUrlResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    return true;
+}
+export function FileUrlResponseFromJSON(json) {
+    return FileUrlResponseFromJSONTyped(json, false);
+}
+export function FileUrlResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'url': json['url'],
+        'method': json['method'],
+        'path': json['path'],
+        'expiresAt': (new Date(json['expiresAt'])),
+    };
+}
+export function FileUrlResponseToJSON(json) {
+    return FileUrlResponseToJSONTyped(json, false);
+}
+export function FileUrlResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'url': value['url'],
+        'method': value['method'],
+        'path': value['path'],
+        'expiresAt': value['expiresAt'].toISOString(),
+    };
+}

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

@@ -41,7 +41,7 @@ export interface ProcessListResponse {
      */
     sampledAt: Date | null;
     /**
-     * Processes on the sandbox. The list holds at most 500
+     * Processes on the sandbox. The list holds at most 500, busiest first.
      * @type {number}
      * @memberof ProcessListResponse
      */

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

@@ -0,0 +1,56 @@
+/**
+ * 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 SandboxAiAccessResponse
+ */
+export interface SandboxAiAccessResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SandboxAiAccessResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof SandboxAiAccessResponse
+     */
+    type: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SandboxAiAccessResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxAiAccessResponse
+     */
+    sandboxId: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SandboxAiAccessResponse
+     */
+    blocked: boolean;
+}
+/**
+ * Check if a given object implements the SandboxAiAccessResponse interface.
+ */
+export declare function instanceOfSandboxAiAccessResponse(value: object): value is SandboxAiAccessResponse;
+export declare function SandboxAiAccessResponseFromJSON(json: any): SandboxAiAccessResponse;
+export declare function SandboxAiAccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxAiAccessResponse;
+export declare function SandboxAiAccessResponseToJSON(json: any): SandboxAiAccessResponse;
+export declare function SandboxAiAccessResponseToJSONTyped(value?: SandboxAiAccessResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SandboxAiAccessResponse.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SandboxAiAccessResponse interface.
+ */
+export function instanceOfSandboxAiAccessResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined)
+        return false;
+    if (!('blocked' in value) || value['blocked'] === undefined)
+        return false;
+    return true;
+}
+export function SandboxAiAccessResponseFromJSON(json) {
+    return SandboxAiAccessResponseFromJSONTyped(json, false);
+}
+export function SandboxAiAccessResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'sandboxId': json['sandboxId'],
+        'blocked': json['blocked'],
+    };
+}
+export function SandboxAiAccessResponseToJSON(json) {
+    return SandboxAiAccessResponseToJSONTyped(json, false);
+}
+export function SandboxAiAccessResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'sandboxId': value['sandboxId'],
+        'blocked': value['blocked'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { AiUsageRow } from './AiUsageRow';
+import type { AiUsageTotals } from './AiUsageTotals';
+/**
+ *
+ * @export
+ * @interface SandboxAiUsage
+ */
+export interface SandboxAiUsage {
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxAiUsage
+     */
+    sandboxId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SandboxAiUsage
+     */
+    name: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SandboxAiUsage
+     */
+    blocked: boolean;
+    /**
+     *
+     * @type {Array<AiUsageRow>}
+     * @memberof SandboxAiUsage
+     */
+    usage: Array<AiUsageRow>;
+    /**
+     *
+     * @type {AiUsageTotals}
+     * @memberof SandboxAiUsage
+     */
+    totals: AiUsageTotals;
+    /**
+     * Request charge for the period, at the price per 1,000 requests.
+     * @type {number}
+     * @memberof SandboxAiUsage
+     */
+    dollars: number;
+}
+/**
+ * Check if a given object implements the SandboxAiUsage interface.
+ */
+export declare function instanceOfSandboxAiUsage(value: object): value is SandboxAiUsage;
+export declare function SandboxAiUsageFromJSON(json: any): SandboxAiUsage;
+export declare function SandboxAiUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxAiUsage;
+export declare function SandboxAiUsageToJSON(json: any): SandboxAiUsage;
+export declare function SandboxAiUsageToJSONTyped(value?: SandboxAiUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SandboxAiUsage.js

@@ -0,0 +1,65 @@
+/* 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 { AiUsageRowFromJSON, AiUsageRowToJSON, } from './AiUsageRow';
+import { AiUsageTotalsFromJSON, AiUsageTotalsToJSON, } from './AiUsageTotals';
+/**
+ * Check if a given object implements the SandboxAiUsage interface.
+ */
+export function instanceOfSandboxAiUsage(value) {
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('blocked' in value) || value['blocked'] === undefined)
+        return false;
+    if (!('usage' in value) || value['usage'] === undefined)
+        return false;
+    if (!('totals' in value) || value['totals'] === undefined)
+        return false;
+    if (!('dollars' in value) || value['dollars'] === undefined)
+        return false;
+    return true;
+}
+export function SandboxAiUsageFromJSON(json) {
+    return SandboxAiUsageFromJSONTyped(json, false);
+}
+export function SandboxAiUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sandboxId': json['sandboxId'],
+        'name': json['name'],
+        'blocked': json['blocked'],
+        'usage': (json['usage'].map(AiUsageRowFromJSON)),
+        'totals': AiUsageTotalsFromJSON(json['totals']),
+        'dollars': json['dollars'],
+    };
+}
+export function SandboxAiUsageToJSON(json) {
+    return SandboxAiUsageToJSONTyped(json, false);
+}
+export function SandboxAiUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sandboxId': value['sandboxId'],
+        'name': value['name'],
+        'blocked': value['blocked'],
+        'usage': (value['usage'].map(AiUsageRowToJSON)),
+        'totals': AiUsageTotalsToJSON(value['totals']),
+        'dollars': value['dollars'],
+    };
+}