@boatdev/sdk 1.0.0

package/src/models/ApiKeySecretResponse.ts

@@ -0,0 +1,110 @@
+/* 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 { ApiKey } from './ApiKey';
+import {
+    ApiKeyFromJSON,
+    ApiKeyFromJSONTyped,
+    ApiKeyToJSON,
+    ApiKeyToJSONTyped,
+} from './ApiKey';
+
+/**
+ * 
+ * @export
+ * @interface ApiKeySecretResponse
+ */
+export interface ApiKeySecretResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeySecretResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof ApiKeySecretResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {ApiKey}
+     * @memberof ApiKeySecretResponse
+     */
+    apiKey: ApiKey;
+    /**
+     * Raw secret returned once. Store it before closing the response.
+     * @type {string}
+     * @memberof ApiKeySecretResponse
+     */
+    secret: string;
+    /**
+     * 
+     * @type {Array<ApiKey>}
+     * @memberof ApiKeySecretResponse
+     */
+    apiKeys: Array<ApiKey>;
+}
+
+/**
+ * Check if a given object implements the ApiKeySecretResponse interface.
+ */
+export function instanceOfApiKeySecretResponse(value: object): value is ApiKeySecretResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('apiKey' in value) || value['apiKey'] === undefined) return false;
+    if (!('secret' in value) || value['secret'] === undefined) return false;
+    if (!('apiKeys' in value) || value['apiKeys'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeySecretResponseFromJSON(json: any): ApiKeySecretResponse {
+    return ApiKeySecretResponseFromJSONTyped(json, false);
+}
+
+export function ApiKeySecretResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeySecretResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'apiKey': ApiKeyFromJSON(json['apiKey']),
+        'secret': json['secret'],
+        'apiKeys': ((json['apiKeys'] as Array<any>).map(ApiKeyFromJSON)),
+    };
+}
+
+export function ApiKeySecretResponseToJSON(json: any): ApiKeySecretResponse {
+    return ApiKeySecretResponseToJSONTyped(json, false);
+}
+
+export function ApiKeySecretResponseToJSONTyped(value?: ApiKeySecretResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'apiKey': ApiKeyToJSON(value['apiKey']),
+        'secret': value['secret'],
+        'apiKeys': ((value['apiKeys'] as Array<any>).map(ApiKeyToJSON)),
+    };
+}
+

package/src/models/ApiKeyUsageResponse.ts

@@ -0,0 +1,246 @@
+/* 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 { ApiKeyScope } from './ApiKeyScope';
+import {
+    ApiKeyScopeFromJSON,
+    ApiKeyScopeFromJSONTyped,
+    ApiKeyScopeToJSON,
+    ApiKeyScopeToJSONTyped,
+} from './ApiKeyScope';
+import type { ApiKeyRequestUsage } from './ApiKeyRequestUsage';
+import {
+    ApiKeyRequestUsageFromJSON,
+    ApiKeyRequestUsageFromJSONTyped,
+    ApiKeyRequestUsageToJSON,
+    ApiKeyRequestUsageToJSONTyped,
+} from './ApiKeyRequestUsage';
+import type { ApiKeyCreatedResource } from './ApiKeyCreatedResource';
+import {
+    ApiKeyCreatedResourceFromJSON,
+    ApiKeyCreatedResourceFromJSONTyped,
+    ApiKeyCreatedResourceToJSON,
+    ApiKeyCreatedResourceToJSONTyped,
+} from './ApiKeyCreatedResource';
+import type { ApiKeyResourceTotals } from './ApiKeyResourceTotals';
+import {
+    ApiKeyResourceTotalsFromJSON,
+    ApiKeyResourceTotalsFromJSONTyped,
+    ApiKeyResourceTotalsToJSON,
+    ApiKeyResourceTotalsToJSONTyped,
+} from './ApiKeyResourceTotals';
+
+/**
+ * 
+ * @export
+ * @interface ApiKeyUsageResponse
+ */
+export interface ApiKeyUsageResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeyUsageResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    name: string;
+    /**
+     * Credential storage lane. Scoped secrets are never stored in the legacy hash column.
+     * @type {ApiKeyUsageResponseCredentialLaneEnum}
+     * @memberof ApiKeyUsageResponse
+     */
+    credentialLane: ApiKeyUsageResponseCredentialLaneEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    keyPrefix: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    keyLastFour: string;
+    /**
+     * Sandbox ID for a platform-managed machine key, or null for a user-created key.
+     * @type {string}
+     * @memberof ApiKeyUsageResponse
+     */
+    sandboxId: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyUsageResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyUsageResponse
+     */
+    lastUsedAt: Date;
+    /**
+     * 
+     * @type {ApiKeyRequestUsage}
+     * @memberof ApiKeyUsageResponse
+     */
+    usage: ApiKeyRequestUsage;
+    /**
+     * 
+     * @type {ApiKeyResourceTotals}
+     * @memberof ApiKeyUsageResponse
+     */
+    resources: ApiKeyResourceTotals;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyUsageResponse
+     */
+    expiresAt?: Date;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeyUsageResponse
+     */
+    expired?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeyUsageResponse
+     */
+    expiringSoon?: boolean;
+    /**
+     * 
+     * @type {ApiKeyScope}
+     * @memberof ApiKeyUsageResponse
+     */
+    scope?: ApiKeyScope;
+    /**
+     * 
+     * @type {Array<ApiKeyCreatedResource>}
+     * @memberof ApiKeyUsageResponse
+     */
+    createdResources: Array<ApiKeyCreatedResource>;
+}
+
+
+/**
+ * @export
+ */
+export const ApiKeyUsageResponseCredentialLaneEnum = {
+    Legacy: 'legacy',
+    ScopedV1: 'scoped-v1'
+} as const;
+export type ApiKeyUsageResponseCredentialLaneEnum = typeof ApiKeyUsageResponseCredentialLaneEnum[keyof typeof ApiKeyUsageResponseCredentialLaneEnum];
+
+
+/**
+ * Check if a given object implements the ApiKeyUsageResponse interface.
+ */
+export function instanceOfApiKeyUsageResponse(value: object): value is ApiKeyUsageResponse {
+    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 (!('name' in value) || value['name'] === undefined) return false;
+    if (!('credentialLane' in value) || value['credentialLane'] === undefined) return false;
+    if (!('keyPrefix' in value) || value['keyPrefix'] === undefined) return false;
+    if (!('keyLastFour' in value) || value['keyLastFour'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
+    if (!('usage' in value) || value['usage'] === undefined) return false;
+    if (!('resources' in value) || value['resources'] === undefined) return false;
+    if (!('createdResources' in value) || value['createdResources'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyUsageResponseFromJSON(json: any): ApiKeyUsageResponse {
+    return ApiKeyUsageResponseFromJSONTyped(json, false);
+}
+
+export function ApiKeyUsageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyUsageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'name': json['name'],
+        'credentialLane': json['credentialLane'],
+        'keyPrefix': json['keyPrefix'],
+        'keyLastFour': json['keyLastFour'],
+        'sandboxId': json['sandboxId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'lastUsedAt': (new Date(json['lastUsedAt'])),
+        'usage': ApiKeyRequestUsageFromJSON(json['usage']),
+        'resources': ApiKeyResourceTotalsFromJSON(json['resources']),
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+        'expired': json['expired'] == null ? undefined : json['expired'],
+        'expiringSoon': json['expiringSoon'] == null ? undefined : json['expiringSoon'],
+        'scope': json['scope'] == null ? undefined : ApiKeyScopeFromJSON(json['scope']),
+        'createdResources': ((json['createdResources'] as Array<any>).map(ApiKeyCreatedResourceFromJSON)),
+    };
+}
+
+export function ApiKeyUsageResponseToJSON(json: any): ApiKeyUsageResponse {
+    return ApiKeyUsageResponseToJSONTyped(json, false);
+}
+
+export function ApiKeyUsageResponseToJSONTyped(value?: ApiKeyUsageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'name': value['name'],
+        'credentialLane': value['credentialLane'],
+        'keyPrefix': value['keyPrefix'],
+        'keyLastFour': value['keyLastFour'],
+        'sandboxId': value['sandboxId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'lastUsedAt': value['lastUsedAt'].toISOString(),
+        'usage': ApiKeyRequestUsageToJSON(value['usage']),
+        'resources': ApiKeyResourceTotalsToJSON(value['resources']),
+        'expiresAt': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'expired': value['expired'],
+        'expiringSoon': value['expiringSoon'],
+        'scope': ApiKeyScopeToJSON(value['scope']),
+        'createdResources': ((value['createdResources'] as Array<any>).map(ApiKeyCreatedResourceToJSON)),
+    };
+}
+

package/src/models/ApiKeysResponse.ts

@@ -0,0 +1,108 @@
+/* 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 { ApiKeyCatalog } from './ApiKeyCatalog';
+import {
+    ApiKeyCatalogFromJSON,
+    ApiKeyCatalogFromJSONTyped,
+    ApiKeyCatalogToJSON,
+    ApiKeyCatalogToJSONTyped,
+} from './ApiKeyCatalog';
+import type { ApiKey } from './ApiKey';
+import {
+    ApiKeyFromJSON,
+    ApiKeyFromJSONTyped,
+    ApiKeyToJSON,
+    ApiKeyToJSONTyped,
+} from './ApiKey';
+
+/**
+ * 
+ * @export
+ * @interface ApiKeysResponse
+ */
+export interface ApiKeysResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeysResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof ApiKeysResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Array<ApiKey>}
+     * @memberof ApiKeysResponse
+     */
+    apiKeys: Array<ApiKey>;
+    /**
+     * 
+     * @type {ApiKeyCatalog}
+     * @memberof ApiKeysResponse
+     */
+    catalog: ApiKeyCatalog;
+}
+
+/**
+ * Check if a given object implements the ApiKeysResponse interface.
+ */
+export function instanceOfApiKeysResponse(value: object): value is ApiKeysResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('apiKeys' in value) || value['apiKeys'] === undefined) return false;
+    if (!('catalog' in value) || value['catalog'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeysResponseFromJSON(json: any): ApiKeysResponse {
+    return ApiKeysResponseFromJSONTyped(json, false);
+}
+
+export function ApiKeysResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeysResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'apiKeys': ((json['apiKeys'] as Array<any>).map(ApiKeyFromJSON)),
+        'catalog': ApiKeyCatalogFromJSON(json['catalog']),
+    };
+}
+
+export function ApiKeysResponseToJSON(json: any): ApiKeysResponse {
+    return ApiKeysResponseToJSONTyped(json, false);
+}
+
+export function ApiKeysResponseToJSONTyped(value?: ApiKeysResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'apiKeys': ((value['apiKeys'] as Array<any>).map(ApiKeyToJSON)),
+        'catalog': ApiKeyCatalogToJSON(value['catalog']),
+    };
+}
+

package/src/models/Command200Response.ts

@@ -0,0 +1,76 @@
+/* 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 type { CommandResponse } from './CommandResponse';
+import {
+    instanceOfCommandResponse,
+    CommandResponseFromJSON,
+    CommandResponseFromJSONTyped,
+    CommandResponseToJSON,
+} from './CommandResponse';
+import type { CommandStartedResponse } from './CommandStartedResponse';
+import {
+    instanceOfCommandStartedResponse,
+    CommandStartedResponseFromJSON,
+    CommandStartedResponseFromJSONTyped,
+    CommandStartedResponseToJSON,
+} from './CommandStartedResponse';
+
+/**
+ * @type Command200Response
+ * 
+ * @export
+ */
+export type Command200Response = CommandResponse | CommandStartedResponse;
+
+export function Command200ResponseFromJSON(json: any): Command200Response {
+    return Command200ResponseFromJSONTyped(json, false);
+}
+
+export function Command200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Command200Response {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfCommandResponse(json)) {
+        return CommandResponseFromJSONTyped(json, true);
+    }
+    if (instanceOfCommandStartedResponse(json)) {
+        return CommandStartedResponseFromJSONTyped(json, true);
+    }
+    return {} as any;
+}
+
+export function Command200ResponseToJSON(json: any): any {
+    return Command200ResponseToJSONTyped(json, false);
+}
+
+export function Command200ResponseToJSONTyped(value?: Command200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfCommandResponse(value)) {
+        return CommandResponseToJSON(value as CommandResponse);
+    }
+    if (instanceOfCommandStartedResponse(value)) {
+        return CommandStartedResponseToJSON(value as CommandStartedResponse);
+    }
+    return {};
+}
+

package/src/models/CommandRequest.ts

@@ -0,0 +1,90 @@
+/* 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 CommandRequest
+ */
+export interface CommandRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandRequest
+     */
+    command: string;
+    /**
+     * Relative working directory inside the sandbox work directory.
+     * @type {string}
+     * @memberof CommandRequest
+     */
+    cwd?: string;
+    /**
+     * Command timeout in seconds. Values outside 1-600 are rejected with a 400 invalid_timeout error.
+     * @type {number}
+     * @memberof CommandRequest
+     */
+    timeoutSeconds?: number;
+    /**
+     * Start the command in the background and return a process id immediately instead of waiting for it to finish. Output goes to a log file on the sandbox; poll the status endpoint for it.
+     * @type {boolean}
+     * @memberof CommandRequest
+     */
+    detached?: boolean;
+}
+
+/**
+ * Check if a given object implements the CommandRequest interface.
+ */
+export function instanceOfCommandRequest(value: object): value is CommandRequest {
+    if (!('command' in value) || value['command'] === undefined) return false;
+    return true;
+}
+
+export function CommandRequestFromJSON(json: any): CommandRequest {
+    return CommandRequestFromJSONTyped(json, false);
+}
+
+export function CommandRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'command': json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'timeoutSeconds': json['timeoutSeconds'] == null ? undefined : json['timeoutSeconds'],
+        'detached': json['detached'] == null ? undefined : json['detached'],
+    };
+}
+
+export function CommandRequestToJSON(json: any): CommandRequest {
+    return CommandRequestToJSONTyped(json, false);
+}
+
+export function CommandRequestToJSONTyped(value?: CommandRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'timeoutSeconds': value['timeoutSeconds'],
+        'detached': value['detached'],
+    };
+}
+