@boatdev/sdk 1.0.0

package/src/models/SnapshotTreeEntry.ts

@@ -0,0 +1,95 @@
+/* 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 SnapshotTreeEntry
+ */
+export interface SnapshotTreeEntry {
+    /**
+     * Path relative to the snapshot root. Docker named volumes appear under `__dockervol__/`.
+     * @type {string}
+     * @memberof SnapshotTreeEntry
+     */
+    path: string;
+    /**
+     * 
+     * @type {SnapshotTreeEntryKindEnum}
+     * @memberof SnapshotTreeEntry
+     */
+    kind: SnapshotTreeEntryKindEnum;
+    /**
+     * File size in bytes. Omitted for directories.
+     * @type {number}
+     * @memberof SnapshotTreeEntry
+     */
+    size?: number;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotTreeEntryKindEnum = {
+    File: 'file',
+    Dir: 'dir',
+    Symlink: 'symlink'
+} as const;
+export type SnapshotTreeEntryKindEnum = typeof SnapshotTreeEntryKindEnum[keyof typeof SnapshotTreeEntryKindEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotTreeEntry interface.
+ */
+export function instanceOfSnapshotTreeEntry(value: object): value is SnapshotTreeEntry {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotTreeEntryFromJSON(json: any): SnapshotTreeEntry {
+    return SnapshotTreeEntryFromJSONTyped(json, false);
+}
+
+export function SnapshotTreeEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotTreeEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'kind': json['kind'],
+        'size': json['size'] == null ? undefined : json['size'],
+    };
+}
+
+export function SnapshotTreeEntryToJSON(json: any): SnapshotTreeEntry {
+    return SnapshotTreeEntryToJSONTyped(json, false);
+}
+
+export function SnapshotTreeEntryToJSONTyped(value?: SnapshotTreeEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'kind': value['kind'],
+        'size': value['size'],
+    };
+}
+

package/src/models/SnapshotTreeResponse.ts

@@ -0,0 +1,173 @@
+/* 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 { SnapshotTreeEntry } from './SnapshotTreeEntry';
+import {
+    SnapshotTreeEntryFromJSON,
+    SnapshotTreeEntryFromJSONTyped,
+    SnapshotTreeEntryToJSON,
+    SnapshotTreeEntryToJSONTyped,
+} from './SnapshotTreeEntry';
+
+/**
+ * 
+ * @export
+ * @interface SnapshotTreeResponse
+ */
+export interface SnapshotTreeResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapshotTreeResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SnapshotTreeResponseTypeEnum}
+     * @memberof SnapshotTreeResponse
+     */
+    type: SnapshotTreeResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotTreeResponse
+     */
+    snapshotId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotTreeResponse
+     */
+    sandboxId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapshotTreeResponse
+     */
+    generation: number;
+    /**
+     * `false` for legacy snapshots or inventories too large to expand; see `reason`.
+     * @type {boolean}
+     * @memberof SnapshotTreeResponse
+     */
+    treeAvailable: boolean;
+    /**
+     * `true` when the file list was capped; not every entry is returned.
+     * @type {boolean}
+     * @memberof SnapshotTreeResponse
+     */
+    truncated: boolean;
+    /**
+     * Number of your files in this snapshot (base-image system files excluded).
+     * @type {number}
+     * @memberof SnapshotTreeResponse
+     */
+    fileCount: number;
+    /**
+     * Total bytes of your data in this snapshot (base-image system files excluded).
+     * @type {number}
+     * @memberof SnapshotTreeResponse
+     */
+    totalSizeBytes: number;
+    /**
+     * Exactly the files/dirs a resume or download returns, your data only; base-image system entries are not listed.
+     * @type {Array<SnapshotTreeEntry>}
+     * @memberof SnapshotTreeResponse
+     */
+    entries: Array<SnapshotTreeEntry>;
+    /**
+     * Why the tree is unavailable, when `treeAvailable` is `false`.
+     * @type {string}
+     * @memberof SnapshotTreeResponse
+     */
+    reason?: string;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotTreeResponseTypeEnum = {
+    SnapshotTree: 'snapshot.tree'
+} as const;
+export type SnapshotTreeResponseTypeEnum = typeof SnapshotTreeResponseTypeEnum[keyof typeof SnapshotTreeResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotTreeResponse interface.
+ */
+export function instanceOfSnapshotTreeResponse(value: object): value is SnapshotTreeResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('snapshotId' in value) || value['snapshotId'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('generation' in value) || value['generation'] === undefined) return false;
+    if (!('treeAvailable' in value) || value['treeAvailable'] === undefined) return false;
+    if (!('truncated' in value) || value['truncated'] === undefined) return false;
+    if (!('fileCount' in value) || value['fileCount'] === undefined) return false;
+    if (!('totalSizeBytes' in value) || value['totalSizeBytes'] === undefined) return false;
+    if (!('entries' in value) || value['entries'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotTreeResponseFromJSON(json: any): SnapshotTreeResponse {
+    return SnapshotTreeResponseFromJSONTyped(json, false);
+}
+
+export function SnapshotTreeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotTreeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshotId': json['snapshotId'],
+        'sandboxId': json['sandboxId'],
+        'generation': json['generation'],
+        'treeAvailable': json['treeAvailable'],
+        'truncated': json['truncated'],
+        'fileCount': json['fileCount'],
+        'totalSizeBytes': json['totalSizeBytes'],
+        'entries': ((json['entries'] as Array<any>).map(SnapshotTreeEntryFromJSON)),
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+
+export function SnapshotTreeResponseToJSON(json: any): SnapshotTreeResponse {
+    return SnapshotTreeResponseToJSONTyped(json, false);
+}
+
+export function SnapshotTreeResponseToJSONTyped(value?: SnapshotTreeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshotId': value['snapshotId'],
+        'sandboxId': value['sandboxId'],
+        'generation': value['generation'],
+        'treeAvailable': value['treeAvailable'],
+        'truncated': value['truncated'],
+        'fileCount': value['fileCount'],
+        'totalSizeBytes': value['totalSizeBytes'],
+        'entries': ((value['entries'] as Array<any>).map(SnapshotTreeEntryToJSON)),
+        'reason': value['reason'],
+    };
+}
+

package/src/models/SshKeyRequest.ts

@@ -0,0 +1,66 @@
+/* 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 SshKeyRequest
+ */
+export interface SshKeyRequest {
+    /**
+     * Public SSH key in OpenSSH format. Private keys are rejected.
+     * @type {string}
+     * @memberof SshKeyRequest
+     */
+    key: string;
+}
+
+/**
+ * Check if a given object implements the SshKeyRequest interface.
+ */
+export function instanceOfSshKeyRequest(value: object): value is SshKeyRequest {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    return true;
+}
+
+export function SshKeyRequestFromJSON(json: any): SshKeyRequest {
+    return SshKeyRequestFromJSONTyped(json, false);
+}
+
+export function SshKeyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SshKeyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+    };
+}
+
+export function SshKeyRequestToJSON(json: any): SshKeyRequest {
+    return SshKeyRequestToJSONTyped(json, false);
+}
+
+export function SshKeyRequestToJSONTyped(value?: SshKeyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+    };
+}
+

package/src/models/SshKeyResponse.ts

@@ -0,0 +1,99 @@
+/* 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 SshKeyResponse
+ */
+export interface SshKeyResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SshKeyResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof SshKeyResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SshKeyResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SshKeyResponse
+     */
+    machineIp?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SshKeyResponse
+     */
+    sshUser?: string;
+}
+
+/**
+ * Check if a given object implements the SshKeyResponse interface.
+ */
+export function instanceOfSshKeyResponse(value: object): value is SshKeyResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function SshKeyResponseFromJSON(json: any): SshKeyResponse {
+    return SshKeyResponseFromJSONTyped(json, false);
+}
+
+export function SshKeyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SshKeyResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'machineIp': json['machineIp'] == null ? undefined : json['machineIp'],
+        'sshUser': json['sshUser'] == null ? undefined : json['sshUser'],
+    };
+}
+
+export function SshKeyResponseToJSON(json: any): SshKeyResponse {
+    return SshKeyResponseToJSONTyped(json, false);
+}
+
+export function SshKeyResponseToJSONTyped(value?: SshKeyResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'machineIp': value['machineIp'],
+        'sshUser': value['sshUser'],
+    };
+}
+

package/src/models/StartWindowUsage.ts

@@ -0,0 +1,81 @@
+/* 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';
+/**
+ * One rolling start window. Null when the account is unlimited.
+ * @export
+ * @interface StartWindowUsage
+ */
+export interface StartWindowUsage {
+    /**
+     * 
+     * @type {number}
+     * @memberof StartWindowUsage
+     */
+    limit?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StartWindowUsage
+     */
+    used?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StartWindowUsage
+     */
+    remaining?: number;
+}
+
+/**
+ * Check if a given object implements the StartWindowUsage interface.
+ */
+export function instanceOfStartWindowUsage(value: object): value is StartWindowUsage {
+    return true;
+}
+
+export function StartWindowUsageFromJSON(json: any): StartWindowUsage {
+    return StartWindowUsageFromJSONTyped(json, false);
+}
+
+export function StartWindowUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWindowUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'] == null ? undefined : json['limit'],
+        'used': json['used'] == null ? undefined : json['used'],
+        'remaining': json['remaining'] == null ? undefined : json['remaining'],
+    };
+}
+
+export function StartWindowUsageToJSON(json: any): StartWindowUsage {
+    return StartWindowUsageToJSONTyped(json, false);
+}
+
+export function StartWindowUsageToJSONTyped(value?: StartWindowUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'limit': value['limit'],
+        'used': value['used'],
+        'remaining': value['remaining'],
+    };
+}
+

package/src/models/SteerEvent.ts

@@ -0,0 +1,127 @@
+/* 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 { SteerEventData } from './SteerEventData';
+import {
+    SteerEventDataFromJSON,
+    SteerEventDataFromJSONTyped,
+    SteerEventDataToJSON,
+    SteerEventDataToJSONTyped,
+} from './SteerEventData';
+
+/**
+ * A message sent into a turn that was already running, via `POST /sandboxes/{sandboxId}/steer`. It is not a prompt run; the output it causes belongs to the turn that was already running.
+ * @export
+ * @interface SteerEvent
+ */
+export interface SteerEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof SteerEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {SteerEventTypeEnum}
+     * @memberof SteerEvent
+     */
+    type: SteerEventTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof SteerEvent
+     */
+    timestamp: number;
+    /**
+     * Id of the steer record, as returned by POST /steer.
+     * @type {string}
+     * @memberof SteerEvent
+     */
+    taskId?: string | null;
+    /**
+     * The conversation whose running turn was steered.
+     * @type {string}
+     * @memberof SteerEvent
+     */
+    conversationId?: string | null;
+    /**
+     * 
+     * @type {SteerEventData}
+     * @memberof SteerEvent
+     */
+    data: SteerEventData;
+}
+
+
+/**
+ * @export
+ */
+export const SteerEventTypeEnum = {
+    Steer: 'steer'
+} as const;
+export type SteerEventTypeEnum = typeof SteerEventTypeEnum[keyof typeof SteerEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the SteerEvent interface.
+ */
+export function instanceOfSteerEvent(value: object): value is SteerEvent {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function SteerEventFromJSON(json: any): SteerEvent {
+    return SteerEventFromJSONTyped(json, false);
+}
+
+export function SteerEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SteerEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        'timestamp': json['timestamp'],
+        'taskId': json['taskId'] == null ? undefined : json['taskId'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'data': SteerEventDataFromJSON(json['data']),
+    };
+}
+
+export function SteerEventToJSON(json: any): SteerEvent {
+    return SteerEventToJSONTyped(json, false);
+}
+
+export function SteerEventToJSONTyped(value?: SteerEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'conversationId': value['conversationId'],
+        'data': SteerEventDataToJSON(value['data']),
+    };
+}
+