@boatdev/sdk 1.0.0

package/src/models/PageInfo.ts

@@ -0,0 +1,84 @@
+/* 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 PageInfo
+ */
+export interface PageInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof PageInfo
+     */
+    nextCursor: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PageInfo
+     */
+    hasMore: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof PageInfo
+     */
+    limit: number;
+}
+
+/**
+ * Check if a given object implements the PageInfo interface.
+ */
+export function instanceOfPageInfo(value: object): value is PageInfo {
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined) return false;
+    if (!('hasMore' in value) || value['hasMore'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function PageInfoFromJSON(json: any): PageInfo {
+    return PageInfoFromJSONTyped(json, false);
+}
+
+export function PageInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nextCursor': json['nextCursor'],
+        'hasMore': json['hasMore'],
+        'limit': json['limit'],
+    };
+}
+
+export function PageInfoToJSON(json: any): PageInfo {
+    return PageInfoToJSONTyped(json, false);
+}
+
+export function PageInfoToJSONTyped(value?: PageInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'nextCursor': value['nextCursor'],
+        'hasMore': value['hasMore'],
+        'limit': value['limit'],
+    };
+}
+

package/src/models/PromptEvent.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 { PromptEventData } from './PromptEventData';
+import {
+    PromptEventDataFromJSON,
+    PromptEventDataFromJSONTyped,
+    PromptEventDataToJSON,
+    PromptEventDataToJSONTyped,
+} from './PromptEventData';
+
+/**
+ * 
+ * @export
+ * @interface PromptEvent
+ */
+export interface PromptEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {PromptEventTypeEnum}
+     * @memberof PromptEvent
+     */
+    type: PromptEventTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof PromptEvent
+     */
+    timestamp: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    taskId?: string | null;
+    /**
+     * The conversation this prompt belongs to.
+     * @type {string}
+     * @memberof PromptEvent
+     */
+    conversationId?: string | null;
+    /**
+     * 
+     * @type {PromptEventData}
+     * @memberof PromptEvent
+     */
+    data: PromptEventData;
+}
+
+
+/**
+ * @export
+ */
+export const PromptEventTypeEnum = {
+    Prompt: 'prompt'
+} as const;
+export type PromptEventTypeEnum = typeof PromptEventTypeEnum[keyof typeof PromptEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the PromptEvent interface.
+ */
+export function instanceOfPromptEvent(value: object): value is PromptEvent {
+    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 PromptEventFromJSON(json: any): PromptEvent {
+    return PromptEventFromJSONTyped(json, false);
+}
+
+export function PromptEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptEvent {
+    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': PromptEventDataFromJSON(json['data']),
+    };
+}
+
+export function PromptEventToJSON(json: any): PromptEvent {
+    return PromptEventToJSONTyped(json, false);
+}
+
+export function PromptEventToJSONTyped(value?: PromptEvent | 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': PromptEventDataToJSON(value['data']),
+    };
+}
+

package/src/models/PromptEventData.ts

@@ -0,0 +1,98 @@
+/* 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 PromptEventData
+ */
+export interface PromptEventData {
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptEventData
+     */
+    prompt: string;
+    /**
+     * 
+     * @type {PromptEventDataStatusEnum}
+     * @memberof PromptEventData
+     */
+    status: PromptEventDataStatusEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PromptEventData
+     */
+    isReverted?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const PromptEventDataStatusEnum = {
+    Sending: 'sending',
+    Queued: 'queued',
+    Running: 'running',
+    Finished: 'finished',
+    Failed: 'failed',
+    Interrupted: 'interrupted'
+} as const;
+export type PromptEventDataStatusEnum = typeof PromptEventDataStatusEnum[keyof typeof PromptEventDataStatusEnum];
+
+
+/**
+ * Check if a given object implements the PromptEventData interface.
+ */
+export function instanceOfPromptEventData(value: object): value is PromptEventData {
+    if (!('prompt' in value) || value['prompt'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function PromptEventDataFromJSON(json: any): PromptEventData {
+    return PromptEventDataFromJSONTyped(json, false);
+}
+
+export function PromptEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptEventData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'prompt': json['prompt'],
+        'status': json['status'],
+        'isReverted': json['is_reverted'] == null ? undefined : json['is_reverted'],
+    };
+}
+
+export function PromptEventDataToJSON(json: any): PromptEventData {
+    return PromptEventDataToJSONTyped(json, false);
+}
+
+export function PromptEventDataToJSONTyped(value?: PromptEventData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'prompt': value['prompt'],
+        'status': value['status'],
+        'is_reverted': value['isReverted'],
+    };
+}
+

package/src/models/PromptRequest.ts

@@ -0,0 +1,132 @@
+/* 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';
+/**
+ * Work item to queue inside an existing sandbox. Provider credentials must already be configured in the Boat dashboard.
+ * 
+ * **Providers (harnesses):** `codex`, `claude-code` (alias `claude`), `pi`, `opencode`, `prime-agent` (alias `prime`), `kimi` (Kimi Code CLI, alias `kimi-code`). Omit `provider` to use the harness the user selected on the Agents dashboard.
+ * 
+ * **Models & reasoning effort** are harness- and model-specific and change over time. Fetch the live catalog (every provider's models and which reasoning-effort levels each accepts) from `GET /provider-models`. Some models accept no reasoning control. `pi`, `opencode` and `prime-agent` also expose models routed through OpenRouter and llmgateway (ids like `openrouter:anthropic/claude-sonnet-4.5`).
+ * 
+ * **Conversations:** a sandbox runs many conversations in parallel, each with its own history. Set `new: true` to start a fresh conversation, or `conversationId` to continue a specific one; omit both to continue the sandbox's most-recently-active conversation. The response returns the `conversationId` this prompt ran in. Conversations run concurrently up to a per-sandbox limit that scales with the sandbox's memory; beyond it, prompts queue.
+ * 
+ * @export
+ * @interface PromptRequest
+ */
+export interface PromptRequest {
+    /**
+     * 
+     * @type {PromptRequestProviderEnum}
+     * @memberof PromptRequest
+     */
+    provider: PromptRequestProviderEnum;
+    /**
+     * Optional provider model id from `GET /provider-models`. Omit to use the model selected for that harness on the Agents dashboard. Unknown explicit ids are currently forwarded rather than rejected by request validation.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    model?: string | null;
+    /**
+     * Optional reasoning/thinking level (e.g. `none`, `low`, `medium`, `high`, `xhigh`, `max`). Which levels a given model accepts is listed per model in `GET /provider-models`; some models accept none.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    reasoningEffort?: string | null;
+    /**
+     * Start a NEW conversation on the sandbox (runs in parallel with any existing ones) instead of continuing the most-recently-active one. Mutually exclusive with `conversationId`.
+     * @type {boolean}
+     * @memberof PromptRequest
+     */
+    _new?: boolean;
+    /**
+     * Continue a specific conversation by id (as returned by a previous prompt). Omit (and omit `new`) to continue the sandbox's most-recently-active conversation.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    conversationId?: string | null;
+    /**
+     * Natural-language task for the sandbox, including repo, preview, or browser-use instructions.
+     * @type {string}
+     * @memberof PromptRequest
+     */
+    prompt: string;
+}
+
+
+/**
+ * @export
+ */
+export const PromptRequestProviderEnum = {
+    Codex: 'codex',
+    ClaudeCode: 'claude-code',
+    Claude: 'claude',
+    Pi: 'pi',
+    Opencode: 'opencode',
+    PrimeAgent: 'prime-agent',
+    Prime: 'prime',
+    Kimi: 'kimi',
+    KimiCode: 'kimi-code'
+} as const;
+export type PromptRequestProviderEnum = typeof PromptRequestProviderEnum[keyof typeof PromptRequestProviderEnum];
+
+
+/**
+ * Check if a given object implements the PromptRequest interface.
+ */
+export function instanceOfPromptRequest(value: object): value is PromptRequest {
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    if (!('prompt' in value) || value['prompt'] === undefined) return false;
+    return true;
+}
+
+export function PromptRequestFromJSON(json: any): PromptRequest {
+    return PromptRequestFromJSONTyped(json, false);
+}
+
+export function PromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'provider': json['provider'],
+        'model': json['model'] == null ? undefined : json['model'],
+        'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        '_new': json['new'] == null ? undefined : json['new'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'prompt': json['prompt'],
+    };
+}
+
+export function PromptRequestToJSON(json: any): PromptRequest {
+    return PromptRequestToJSONTyped(json, false);
+}
+
+export function PromptRequestToJSONTyped(value?: PromptRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'provider': value['provider'],
+        'model': value['model'],
+        'reasoningEffort': value['reasoningEffort'],
+        'new': value['_new'],
+        'conversationId': value['conversationId'],
+        'prompt': value['prompt'],
+    };
+}
+

package/src/models/PromptResponse.ts

@@ -0,0 +1,170 @@
+/* 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 { PromptRun } from './PromptRun';
+import {
+    PromptRunFromJSON,
+    PromptRunFromJSONTyped,
+    PromptRunToJSON,
+    PromptRunToJSONTyped,
+} from './PromptRun';
+
+/**
+ * 
+ * @export
+ * @interface PromptResponse
+ */
+export interface PromptResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PromptResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {PromptResponseTypeEnum}
+     * @memberof PromptResponse
+     */
+    type: PromptResponseTypeEnum;
+    /**
+     * Sandbox id.
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    promptId: string;
+    /**
+     * The conversation this prompt was queued in. A new one when `new` was set, the one named by `conversationId`, or the sandbox's most-recently-active conversation. See [Integrated agents](/integrated-agents).
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    conversationId?: string | null;
+    /**
+     * 
+     * @type {PromptRun}
+     * @memberof PromptResponse
+     */
+    promptRun: PromptRun;
+    /**
+     * 
+     * @type {PromptResponseStatusEnum}
+     * @memberof PromptResponse
+     */
+    status: PromptResponseStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    provider: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    model?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PromptResponse
+     */
+    reasoningEffort?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const PromptResponseTypeEnum = {
+    PromptQueued: 'prompt.queued'
+} as const;
+export type PromptResponseTypeEnum = typeof PromptResponseTypeEnum[keyof typeof PromptResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const PromptResponseStatusEnum = {
+    Queued: 'queued'
+} as const;
+export type PromptResponseStatusEnum = typeof PromptResponseStatusEnum[keyof typeof PromptResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the PromptResponse interface.
+ */
+export function instanceOfPromptResponse(value: object): value is PromptResponse {
+    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 (!('promptId' in value) || value['promptId'] === undefined) return false;
+    if (!('promptRun' in value) || value['promptRun'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    return true;
+}
+
+export function PromptResponseFromJSON(json: any): PromptResponse {
+    return PromptResponseFromJSONTyped(json, false);
+}
+
+export function PromptResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'promptId': json['promptId'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'promptRun': PromptRunFromJSON(json['promptRun']),
+        'status': json['status'],
+        'provider': json['provider'],
+        'model': json['model'] == null ? undefined : json['model'],
+        'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+    };
+}
+
+export function PromptResponseToJSON(json: any): PromptResponse {
+    return PromptResponseToJSONTyped(json, false);
+}
+
+export function PromptResponseToJSONTyped(value?: PromptResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'promptId': value['promptId'],
+        'conversationId': value['conversationId'],
+        'promptRun': PromptRunToJSON(value['promptRun']),
+        'status': value['status'],
+        'provider': value['provider'],
+        'model': value['model'],
+        'reasoningEffort': value['reasoningEffort'],
+    };
+}
+