@boatdev/sdk 1.0.0

package/src/models/SteerEventData.ts

@@ -0,0 +1,97 @@
+/* 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 SteerEventData
+ */
+export interface SteerEventData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SteerEventData
+     */
+    message: string;
+    /**
+     * True when the turn that was already running took the message (both native modes); false when Boat interrupted that turn and immediately continued the same conversation with it.
+     * @type {boolean}
+     * @memberof SteerEventData
+     */
+    _native: boolean;
+    /**
+     * `native`: the harness folded the message into the running turn. `native-continued`: the harness accepted it but its turn ended without acting on it, so Boat ran it immediately as its own turn on the same session (nothing interrupted, the instruction lands one turn boundary later). `fallback`: the harness has no mid-turn primitive, so Boat interrupted that turn and continued the same conversation with the instruction. `late`: the turn had already finished, so it ran as an ordinary new turn.
+     * @type {SteerEventDataModeEnum}
+     * @memberof SteerEventData
+     */
+    mode: SteerEventDataModeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const SteerEventDataModeEnum = {
+    Native: 'native',
+    NativeContinued: 'native-continued',
+    Fallback: 'fallback',
+    Late: 'late'
+} as const;
+export type SteerEventDataModeEnum = typeof SteerEventDataModeEnum[keyof typeof SteerEventDataModeEnum];
+
+
+/**
+ * Check if a given object implements the SteerEventData interface.
+ */
+export function instanceOfSteerEventData(value: object): value is SteerEventData {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('_native' in value) || value['_native'] === undefined) return false;
+    if (!('mode' in value) || value['mode'] === undefined) return false;
+    return true;
+}
+
+export function SteerEventDataFromJSON(json: any): SteerEventData {
+    return SteerEventDataFromJSONTyped(json, false);
+}
+
+export function SteerEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SteerEventData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        '_native': json['native'],
+        'mode': json['mode'],
+    };
+}
+
+export function SteerEventDataToJSON(json: any): SteerEventData {
+    return SteerEventDataToJSONTyped(json, false);
+}
+
+export function SteerEventDataToJSONTyped(value?: SteerEventData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'native': value['_native'],
+        'mode': value['mode'],
+    };
+}
+

package/src/models/SteerRequest.ts

@@ -0,0 +1,79 @@
+/* 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';
+/**
+ * A message for a turn that is ALREADY RUNNING. The agent takes it into account and keeps what it was doing, instead of queueing behind the turn (`POST /prompt`) or stopping it (`POST /interrupt`).
+ * 
+ * **Conversations:** omit `conversation` to steer the sandbox's most-recently-active conversation, exactly like `POST /prompt` chooses one. Pass a `conversation` id to steer a specific one while the others keep running.
+ * 
+ * The response's `native` says how the harness took it. See [Integrated agents](/integrated-agents).
+ * 
+ * @export
+ * @interface SteerRequest
+ */
+export interface SteerRequest {
+    /**
+     * The extra instruction for the running turn.
+     * @type {string}
+     * @memberof SteerRequest
+     */
+    message: string;
+    /**
+     * Conversation id to steer. Omit to steer the sandbox's most-recently-active conversation.
+     * @type {string}
+     * @memberof SteerRequest
+     */
+    conversation?: string | null;
+}
+
+/**
+ * Check if a given object implements the SteerRequest interface.
+ */
+export function instanceOfSteerRequest(value: object): value is SteerRequest {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function SteerRequestFromJSON(json: any): SteerRequest {
+    return SteerRequestFromJSONTyped(json, false);
+}
+
+export function SteerRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SteerRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'conversation': json['conversation'] == null ? undefined : json['conversation'],
+    };
+}
+
+export function SteerRequestToJSON(json: any): SteerRequest {
+    return SteerRequestToJSONTyped(json, false);
+}
+
+export function SteerRequestToJSONTyped(value?: SteerRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'conversation': value['conversation'],
+    };
+}
+

package/src/models/SteerResponse.ts

@@ -0,0 +1,156 @@
+/* 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 SteerResponse
+ */
+export interface SteerResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SteerResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SteerResponseTypeEnum}
+     * @memberof SteerResponse
+     */
+    type: SteerResponseTypeEnum;
+    /**
+     * Sandbox id.
+     * @type {string}
+     * @memberof SteerResponse
+     */
+    id: string;
+    /**
+     * The conversation whose running turn was steered.
+     * @type {string}
+     * @memberof SteerResponse
+     */
+    conversationId: string;
+    /**
+     * Id of the steer record. It appears in `GET /events` as a `steer` event; it is not a prompt run and has no lifecycle to poll.
+     * @type {string}
+     * @memberof SteerResponse
+     */
+    promptId: string;
+    /**
+     * `true` when the harness accepted the message into the turn that was already running, so nothing was interrupted. `false` when Boat interrupted that turn and immediately continued the SAME conversation with the instruction, which keeps the harness session and all of its memory but may repeat a little of the work in flight.
+     * @type {boolean}
+     * @memberof SteerResponse
+     */
+    _native: boolean;
+    /**
+     * How the message was delivered. `native` and `fallback` mirror the `native` field; `late` means the turn finished between the request and its delivery, so the message ran as an ordinary new turn on the conversation. A steer reported `native` here can settle as `native-continued` on the `steer` event: the harness accepted it but its turn ended without acting on it, so Boat continued it immediately as its own turn on the same session. Read the event for the settled mode.
+     * @type {SteerResponseModeEnum}
+     * @memberof SteerResponse
+     */
+    mode?: SteerResponseModeEnum;
+    /**
+     * 
+     * @type {SteerResponseStatusEnum}
+     * @memberof SteerResponse
+     */
+    status: SteerResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const SteerResponseTypeEnum = {
+    PromptSteered: 'prompt.steered'
+} as const;
+export type SteerResponseTypeEnum = typeof SteerResponseTypeEnum[keyof typeof SteerResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const SteerResponseModeEnum = {
+    Native: 'native',
+    Fallback: 'fallback',
+    Late: 'late'
+} as const;
+export type SteerResponseModeEnum = typeof SteerResponseModeEnum[keyof typeof SteerResponseModeEnum];
+
+/**
+ * @export
+ */
+export const SteerResponseStatusEnum = {
+    Steered: 'steered'
+} as const;
+export type SteerResponseStatusEnum = typeof SteerResponseStatusEnum[keyof typeof SteerResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the SteerResponse interface.
+ */
+export function instanceOfSteerResponse(value: object): value is SteerResponse {
+    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 (!('conversationId' in value) || value['conversationId'] === undefined) return false;
+    if (!('promptId' in value) || value['promptId'] === undefined) return false;
+    if (!('_native' in value) || value['_native'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function SteerResponseFromJSON(json: any): SteerResponse {
+    return SteerResponseFromJSONTyped(json, false);
+}
+
+export function SteerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SteerResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'conversationId': json['conversationId'],
+        'promptId': json['promptId'],
+        '_native': json['native'],
+        'mode': json['mode'] == null ? undefined : json['mode'],
+        'status': json['status'],
+    };
+}
+
+export function SteerResponseToJSON(json: any): SteerResponse {
+    return SteerResponseToJSONTyped(json, false);
+}
+
+export function SteerResponseToJSONTyped(value?: SteerResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'conversationId': value['conversationId'],
+        'promptId': value['promptId'],
+        'native': value['_native'],
+        'mode': value['mode'],
+        'status': value['status'],
+    };
+}
+

package/src/models/StopRequest.ts

@@ -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 { mapValues } from '../runtime';
+/**
+ * Options for stopping a sandbox.
+ * @export
+ * @interface StopRequest
+ */
+export interface StopRequest {
+    /**
+     * Stop the sandbox even if its disk cannot be snapshotted. Everything written since the last successful snapshot is permanently LOST. Without this, a sandbox whose snapshot pipeline is failing is left running rather than discarding your work, and you are not billed for that time. Only use this after a stop has already been refused.
+     * @type {boolean}
+     * @memberof StopRequest
+     */
+    force?: boolean;
+}
+
+/**
+ * Check if a given object implements the StopRequest interface.
+ */
+export function instanceOfStopRequest(value: object): value is StopRequest {
+    return true;
+}
+
+export function StopRequestFromJSON(json: any): StopRequest {
+    return StopRequestFromJSONTyped(json, false);
+}
+
+export function StopRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StopRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'force': json['force'] == null ? undefined : json['force'],
+    };
+}
+
+export function StopRequestToJSON(json: any): StopRequest {
+    return StopRequestToJSONTyped(json, false);
+}
+
+export function StopRequestToJSONTyped(value?: StopRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'force': value['force'],
+    };
+}
+

package/src/models/SuccessBase.ts

@@ -0,0 +1,75 @@
+/* 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 SuccessBase
+ */
+export interface SuccessBase {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SuccessBase
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof SuccessBase
+     */
+    type: string;
+}
+
+/**
+ * Check if a given object implements the SuccessBase interface.
+ */
+export function instanceOfSuccessBase(value: object): value is SuccessBase {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function SuccessBaseFromJSON(json: any): SuccessBase {
+    return SuccessBaseFromJSONTyped(json, false);
+}
+
+export function SuccessBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SuccessBase {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+    };
+}
+
+export function SuccessBaseToJSON(json: any): SuccessBase {
+    return SuccessBaseToJSONTyped(json, false);
+}
+
+export function SuccessBaseToJSONTyped(value?: SuccessBase | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+    };
+}
+

package/src/models/UnknownEvent.ts

@@ -0,0 +1,69 @@
+/* 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 UnknownEvent
+ */
+export interface UnknownEvent {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnknownEvent
+     */
+    type: string;
+}
+
+/**
+ * Check if a given object implements the UnknownEvent interface.
+ */
+export function instanceOfUnknownEvent(value: object): value is UnknownEvent {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function UnknownEventFromJSON(json: any): UnknownEvent {
+    return UnknownEventFromJSONTyped(json, false);
+}
+
+export function UnknownEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnknownEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'type': json['type'],
+    };
+}
+
+export function UnknownEventToJSON(json: any): UnknownEvent {
+    return UnknownEventToJSONTyped(json, false);
+}
+
+export function UnknownEventToJSONTyped(value?: UnknownEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'type': value['type'],
+    };
+}
+

package/src/models/UpdateSandboxEnvironmentRequest.ts

@@ -0,0 +1,152 @@
+/* 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 { UpdateSandboxEnvironmentRequestRepositoriesInner } from './UpdateSandboxEnvironmentRequestRepositoriesInner';
+import {
+    UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSON,
+    UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSONTyped,
+    UpdateSandboxEnvironmentRequestRepositoriesInnerToJSON,
+    UpdateSandboxEnvironmentRequestRepositoriesInnerToJSONTyped,
+} from './UpdateSandboxEnvironmentRequestRepositoriesInner';
+import type { SecretFile } from './SecretFile';
+import {
+    SecretFileFromJSON,
+    SecretFileFromJSONTyped,
+    SecretFileToJSON,
+    SecretFileToJSONTyped,
+} from './SecretFile';
+
+/**
+ * Rename, set-default, and/or edit flags and contents. Any flag or content change mints a new immutable version; existing sandboxes are not touched until you call upgrade.
+ * @export
+ * @interface UpdateSandboxEnvironmentRequest
+ */
+export interface UpdateSandboxEnvironmentRequest {
+    /**
+     * New environment name.
+     * @type {string}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    name?: string;
+    /**
+     * Set to true to make this the default environment (clears the flag on the previous default).
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    safeForThirdParties?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    passGithub?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    passSecrets?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    passSandboxCredentials?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    passAgentsCredentials?: boolean;
+    /**
+     * Full .env-style content for the new version.
+     * @type {string}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    envContents?: string;
+    /**
+     * 
+     * @type {Array<SecretFile>}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    secretFiles?: Array<SecretFile>;
+    /**
+     * Full replacement of the version's repository selection. Each item selects one repository by its internal `databaseId` (from `GET /repos`).
+     * @type {Array<UpdateSandboxEnvironmentRequestRepositoriesInner>}
+     * @memberof UpdateSandboxEnvironmentRequest
+     */
+    repositories?: Array<UpdateSandboxEnvironmentRequestRepositoriesInner>;
+}
+
+/**
+ * Check if a given object implements the UpdateSandboxEnvironmentRequest interface.
+ */
+export function instanceOfUpdateSandboxEnvironmentRequest(value: object): value is UpdateSandboxEnvironmentRequest {
+    return true;
+}
+
+export function UpdateSandboxEnvironmentRequestFromJSON(json: any): UpdateSandboxEnvironmentRequest {
+    return UpdateSandboxEnvironmentRequestFromJSONTyped(json, false);
+}
+
+export function UpdateSandboxEnvironmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSandboxEnvironmentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
+        'safeForThirdParties': json['safeForThirdParties'] == null ? undefined : json['safeForThirdParties'],
+        'passGithub': json['passGithub'] == null ? undefined : json['passGithub'],
+        'passSecrets': json['passSecrets'] == null ? undefined : json['passSecrets'],
+        'passSandboxCredentials': json['passSandboxCredentials'] == null ? undefined : json['passSandboxCredentials'],
+        'passAgentsCredentials': json['passAgentsCredentials'] == null ? undefined : json['passAgentsCredentials'],
+        'envContents': json['envContents'] == null ? undefined : json['envContents'],
+        'secretFiles': json['secretFiles'] == null ? undefined : ((json['secretFiles'] as Array<any>).map(SecretFileFromJSON)),
+        'repositories': json['repositories'] == null ? undefined : ((json['repositories'] as Array<any>).map(UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSON)),
+    };
+}
+
+export function UpdateSandboxEnvironmentRequestToJSON(json: any): UpdateSandboxEnvironmentRequest {
+    return UpdateSandboxEnvironmentRequestToJSONTyped(json, false);
+}
+
+export function UpdateSandboxEnvironmentRequestToJSONTyped(value?: UpdateSandboxEnvironmentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'isDefault': value['isDefault'],
+        'safeForThirdParties': value['safeForThirdParties'],
+        'passGithub': value['passGithub'],
+        'passSecrets': value['passSecrets'],
+        'passSandboxCredentials': value['passSandboxCredentials'],
+        'passAgentsCredentials': value['passAgentsCredentials'],
+        'envContents': value['envContents'],
+        'secretFiles': value['secretFiles'] == null ? undefined : ((value['secretFiles'] as Array<any>).map(SecretFileToJSON)),
+        'repositories': value['repositories'] == null ? undefined : ((value['repositories'] as Array<any>).map(UpdateSandboxEnvironmentRequestRepositoriesInnerToJSON)),
+    };
+}
+