@boatdev/sdk 1.9.4 → 1.9.6

package/src/models/FileUrlRequest.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';
+/**
+ * 
+ * @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 function instanceOfFileUrlRequest(value: object): value is FileUrlRequest {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    return true;
+}
+
+export function FileUrlRequestFromJSON(json: any): FileUrlRequest {
+    return FileUrlRequestFromJSONTyped(json, false);
+}
+
+export function FileUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+
+export function FileUrlRequestToJSON(json: any): FileUrlRequest {
+    return FileUrlRequestToJSONTyped(json, false);
+}
+
+export function FileUrlRequestToJSONTyped(value?: FileUrlRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}
+

package/src/models/FileUrlResponse.ts

@@ -0,0 +1,131 @@
+/* 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 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 const FileUrlResponseTypeEnum = {
+    FileDownloadUrl: 'file.download_url',
+    FileUploadUrl: 'file.upload_url'
+} as const;
+export type FileUrlResponseTypeEnum = typeof FileUrlResponseTypeEnum[keyof typeof FileUrlResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const FileUrlResponseMethodEnum = {
+    Get: 'GET',
+    Put: 'PUT'
+} as const;
+export type FileUrlResponseMethodEnum = typeof FileUrlResponseMethodEnum[keyof typeof FileUrlResponseMethodEnum];
+
+
+/**
+ * Check if a given object implements the FileUrlResponse interface.
+ */
+export function instanceOfFileUrlResponse(value: object): value is FileUrlResponse {
+    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: any): FileUrlResponse {
+    return FileUrlResponseFromJSONTyped(json, false);
+}
+
+export function FileUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlResponse {
+    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: any): FileUrlResponse {
+    return FileUrlResponseToJSONTyped(json, false);
+}
+
+export function FileUrlResponseToJSONTyped(value?: FileUrlResponse | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/ProcessListResponse.ts

@@ -52,7 +52,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/src/models/SandboxAiAccessResponse.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';
+/**
+ * 
+ * @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 function instanceOfSandboxAiAccessResponse(value: object): value is SandboxAiAccessResponse {
+    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: any): SandboxAiAccessResponse {
+    return SandboxAiAccessResponseFromJSONTyped(json, false);
+}
+
+export function SandboxAiAccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxAiAccessResponse {
+    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: any): SandboxAiAccessResponse {
+    return SandboxAiAccessResponseToJSONTyped(json, false);
+}
+
+export function SandboxAiAccessResponseToJSONTyped(value?: SandboxAiAccessResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'sandboxId': value['sandboxId'],
+        'blocked': value['blocked'],
+    };
+}
+

package/src/models/SandboxAiUsage.ts

@@ -0,0 +1,126 @@
+/* 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 { AiUsageRow } from './AiUsageRow';
+import {
+    AiUsageRowFromJSON,
+    AiUsageRowFromJSONTyped,
+    AiUsageRowToJSON,
+    AiUsageRowToJSONTyped,
+} from './AiUsageRow';
+import type { AiUsageTotals } from './AiUsageTotals';
+import {
+    AiUsageTotalsFromJSON,
+    AiUsageTotalsFromJSONTyped,
+    AiUsageTotalsToJSON,
+    AiUsageTotalsToJSONTyped,
+} 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 function instanceOfSandboxAiUsage(value: object): value is SandboxAiUsage {
+    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: any): SandboxAiUsage {
+    return SandboxAiUsageFromJSONTyped(json, false);
+}
+
+export function SandboxAiUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxAiUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandboxId': json['sandboxId'],
+        'name': json['name'],
+        'blocked': json['blocked'],
+        'usage': ((json['usage'] as Array<any>).map(AiUsageRowFromJSON)),
+        'totals': AiUsageTotalsFromJSON(json['totals']),
+        'dollars': json['dollars'],
+    };
+}
+
+export function SandboxAiUsageToJSON(json: any): SandboxAiUsage {
+    return SandboxAiUsageToJSONTyped(json, false);
+}
+
+export function SandboxAiUsageToJSONTyped(value?: SandboxAiUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandboxId': value['sandboxId'],
+        'name': value['name'],
+        'blocked': value['blocked'],
+        'usage': ((value['usage'] as Array<any>).map(AiUsageRowToJSON)),
+        'totals': AiUsageTotalsToJSON(value['totals']),
+        'dollars': value['dollars'],
+    };
+}
+

package/src/models/SandboxAiUsageResponse.ts

@@ -0,0 +1,162 @@
+/* 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 { AiUsageRow } from './AiUsageRow';
+import {
+    AiUsageRowFromJSON,
+    AiUsageRowFromJSONTyped,
+    AiUsageRowToJSON,
+    AiUsageRowToJSONTyped,
+} from './AiUsageRow';
+import type { AiUsageTotals } from './AiUsageTotals';
+import {
+    AiUsageTotalsFromJSON,
+    AiUsageTotalsFromJSONTyped,
+    AiUsageTotalsToJSON,
+    AiUsageTotalsToJSONTyped,
+} from './AiUsageTotals';
+
+/**
+ * 
+ * @export
+ * @interface SandboxAiUsageResponse
+ */
+export interface SandboxAiUsageResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SandboxAiUsageResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof SandboxAiUsageResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxAiUsageResponse
+     */
+    sandboxId: string;
+    /**
+     * True when the proxy refuses this sandbox's placeholders.
+     * @type {boolean}
+     * @memberof SandboxAiUsageResponse
+     */
+    blocked: boolean;
+    /**
+     * True when the sandbox holds placeholders, not real keys.
+     * @type {boolean}
+     * @memberof SandboxAiUsageResponse
+     */
+    proxied: boolean;
+    /**
+     * The profile the sandbox uses. Null means its owner's default.
+     * @type {string}
+     * @memberof SandboxAiUsageResponse
+     */
+    credentialProfileId: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SandboxAiUsageResponse
+     */
+    since: Date;
+    /**
+     * 
+     * @type {Array<AiUsageRow>}
+     * @memberof SandboxAiUsageResponse
+     */
+    usage: Array<AiUsageRow>;
+    /**
+     * 
+     * @type {AiUsageTotals}
+     * @memberof SandboxAiUsageResponse
+     */
+    totals: AiUsageTotals;
+    /**
+     * 
+     * @type {number}
+     * @memberof SandboxAiUsageResponse
+     */
+    dollars: number;
+}
+
+/**
+ * Check if a given object implements the SandboxAiUsageResponse interface.
+ */
+export function instanceOfSandboxAiUsageResponse(value: object): value is SandboxAiUsageResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('blocked' in value) || value['blocked'] === undefined) return false;
+    if (!('proxied' in value) || value['proxied'] === undefined) return false;
+    if (!('credentialProfileId' in value) || value['credentialProfileId'] === undefined) return false;
+    if (!('since' in value) || value['since'] === 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 SandboxAiUsageResponseFromJSON(json: any): SandboxAiUsageResponse {
+    return SandboxAiUsageResponseFromJSONTyped(json, false);
+}
+
+export function SandboxAiUsageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxAiUsageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'sandboxId': json['sandboxId'],
+        'blocked': json['blocked'],
+        'proxied': json['proxied'],
+        'credentialProfileId': json['credentialProfileId'],
+        'since': (new Date(json['since'])),
+        'usage': ((json['usage'] as Array<any>).map(AiUsageRowFromJSON)),
+        'totals': AiUsageTotalsFromJSON(json['totals']),
+        'dollars': json['dollars'],
+    };
+}
+
+export function SandboxAiUsageResponseToJSON(json: any): SandboxAiUsageResponse {
+    return SandboxAiUsageResponseToJSONTyped(json, false);
+}
+
+export function SandboxAiUsageResponseToJSONTyped(value?: SandboxAiUsageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'sandboxId': value['sandboxId'],
+        'blocked': value['blocked'],
+        'proxied': value['proxied'],
+        'credentialProfileId': value['credentialProfileId'],
+        'since': value['since'].toISOString().substring(0,10),
+        'usage': ((value['usage'] as Array<any>).map(AiUsageRowToJSON)),
+        'totals': AiUsageTotalsToJSON(value['totals']),
+        'dollars': value['dollars'],
+    };
+}
+

package/src/models/SandboxEnvironment.ts

@@ -78,7 +78,7 @@ export interface SandboxEnvironment {
      */
     safetyAnsweredAt?: Date | null;
     /**
-     * When true the environment passes nothing to a sandbox (repos, secrets, and all credentials withheld), overriding the fine-grained flags below. Use for sandboxes handed to third parties.
+     * When true the environment passes nothing to a sandbox (repos, secrets, and all credentials withheld), overriding the fine-grained flags below. Use for sandboxes handed to third parties. The one exception is `proxyAiCredentials`.
      * @type {boolean}
      * @memberof SandboxEnvironment
      */
@@ -107,6 +107,18 @@ export interface SandboxEnvironment {
      * @memberof SandboxEnvironment
      */
     passAgentsCredentials: boolean;
+    /**
+     * The AI credential profile the environment's sandboxes get. Null means the sandbox owner's default profile.
+     * @type {string}
+     * @memberof SandboxEnvironment
+     */
+    credentialProfileId?: string | null;
+    /**
+     * Only with `safeForThirdParties` true. The sandboxes still get AI credentials, as AI credentials proxy placeholders. Real keys never enter them.
+     * @type {boolean}
+     * @memberof SandboxEnvironment
+     */
+    proxyAiCredentials?: boolean;
     /**
      * The latest version's .env-style content. Treat as sensitive.
      * @type {string}
@@ -173,6 +185,8 @@ export function SandboxEnvironmentFromJSONTyped(json: any, ignoreDiscriminator:
         'passSecrets': json['passSecrets'],
         'passSandboxCredentials': json['passSandboxCredentials'],
         'passAgentsCredentials': json['passAgentsCredentials'],
+        'credentialProfileId': json['credentialProfileId'] == null ? undefined : json['credentialProfileId'],
+        'proxyAiCredentials': json['proxyAiCredentials'] == null ? undefined : json['proxyAiCredentials'],
         'envContents': json['envContents'],
         'secretFiles': ((json['secretFiles'] as Array<any>).map(SecretFileFromJSON)),
         'selectedRepositories': json['selectedRepositories'] == null ? undefined : ((json['selectedRepositories'] as Array<any>).map(SelectedRepositoryFromJSON)),
@@ -202,6 +216,8 @@ export function SandboxEnvironmentToJSONTyped(value?: SandboxEnvironment | null,
         'passSecrets': value['passSecrets'],
         'passSandboxCredentials': value['passSandboxCredentials'],
         'passAgentsCredentials': value['passAgentsCredentials'],
+        'credentialProfileId': value['credentialProfileId'],
+        'proxyAiCredentials': value['proxyAiCredentials'],
         'envContents': value['envContents'],
         'secretFiles': ((value['secretFiles'] as Array<any>).map(SecretFileToJSON)),
         'selectedRepositories': value['selectedRepositories'] == null ? undefined : ((value['selectedRepositories'] as Array<any>).map(SelectedRepositoryToJSON)),