@boatdev/sdk 1.0.0

package/src/models/CommandResponse.ts

@@ -0,0 +1,178 @@
+/* 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 CommandResponse
+ */
+export interface CommandResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandResponseTypeEnum}
+     * @memberof CommandResponse
+     */
+    type: CommandResponseTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandResponse
+     */
+    exitCode: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    signal?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    stdout: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    stderr: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    stdoutTruncated?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    stderrTruncated?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    timedOut: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    cwd?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CommandResponse
+     */
+    startedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CommandResponse
+     */
+    finishedAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const CommandResponseTypeEnum = {
+    CommandFinished: 'command.finished'
+} as const;
+export type CommandResponseTypeEnum = typeof CommandResponseTypeEnum[keyof typeof CommandResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the CommandResponse interface.
+ */
+export function instanceOfCommandResponse(value: object): value is CommandResponse {
+    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 (!('exitCode' in value) || value['exitCode'] === undefined) return false;
+    if (!('stdout' in value) || value['stdout'] === undefined) return false;
+    if (!('stderr' in value) || value['stderr'] === undefined) return false;
+    if (!('timedOut' in value) || value['timedOut'] === undefined) return false;
+    return true;
+}
+
+export function CommandResponseFromJSON(json: any): CommandResponse {
+    return CommandResponseFromJSONTyped(json, false);
+}
+
+export function CommandResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'exitCode': json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'stdout': json['stdout'],
+        'stderr': json['stderr'],
+        'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
+        'stderrTruncated': json['stderrTruncated'] == null ? undefined : json['stderrTruncated'],
+        'timedOut': json['timedOut'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'finishedAt': json['finishedAt'] == null ? undefined : (new Date(json['finishedAt'])),
+    };
+}
+
+export function CommandResponseToJSON(json: any): CommandResponse {
+    return CommandResponseToJSONTyped(json, false);
+}
+
+export function CommandResponseToJSONTyped(value?: CommandResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'stdout': value['stdout'],
+        'stderr': value['stderr'],
+        'stdoutTruncated': value['stdoutTruncated'],
+        'stderrTruncated': value['stderrTruncated'],
+        'timedOut': value['timedOut'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+    };
+}
+

package/src/models/CommandStartedResponse.ts

@@ -0,0 +1,154 @@
+/* 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 CommandStartedResponse
+ */
+export interface CommandStartedResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStartedResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandStartedResponseTypeEnum}
+     * @memberof CommandStartedResponse
+     */
+    type: CommandStartedResponseTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStartedResponse
+     */
+    success: boolean;
+    /**
+     * Process id to poll with the command status endpoint.
+     * @type {number}
+     * @memberof CommandStartedResponse
+     */
+    processId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandStartedResponse
+     */
+    pid: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    command: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    cwd?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CommandStartedResponse
+     */
+    startedAt: Date;
+    /**
+     * Stdout log file on the sandbox (~/.ascii/processes/<pid>.log).
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    logPath?: string;
+    /**
+     * Stderr log file on the sandbox.
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    errLogPath?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CommandStartedResponseTypeEnum = {
+    CommandStarted: 'command.started'
+} as const;
+export type CommandStartedResponseTypeEnum = typeof CommandStartedResponseTypeEnum[keyof typeof CommandStartedResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the CommandStartedResponse interface.
+ */
+export function instanceOfCommandStartedResponse(value: object): value is CommandStartedResponse {
+    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 (!('processId' in value) || value['processId'] === undefined) return false;
+    if (!('pid' in value) || value['pid'] === undefined) return false;
+    if (!('command' in value) || value['command'] === undefined) return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined) return false;
+    return true;
+}
+
+export function CommandStartedResponseFromJSON(json: any): CommandStartedResponse {
+    return CommandStartedResponseFromJSONTyped(json, false);
+}
+
+export function CommandStartedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandStartedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'processId': json['processId'],
+        'pid': json['pid'],
+        'command': json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'startedAt': (new Date(json['startedAt'])),
+        'logPath': json['logPath'] == null ? undefined : json['logPath'],
+        'errLogPath': json['errLogPath'] == null ? undefined : json['errLogPath'],
+    };
+}
+
+export function CommandStartedResponseToJSON(json: any): CommandStartedResponse {
+    return CommandStartedResponseToJSONTyped(json, false);
+}
+
+export function CommandStartedResponseToJSONTyped(value?: CommandStartedResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'processId': value['processId'],
+        'pid': value['pid'],
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'].toISOString(),
+        'logPath': value['logPath'],
+        'errLogPath': value['errLogPath'],
+    };
+}
+

package/src/models/CommandStatusResponse.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';
+/**
+ * 
+ * @export
+ * @interface CommandStatusResponse
+ */
+export interface CommandStatusResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandStatusResponseTypeEnum}
+     * @memberof CommandStatusResponse
+     */
+    type: CommandStatusResponseTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    processId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    pid?: number;
+    /**
+     * lost: the sandbox agent restarted and forgot the process; running/exitCode are then a best-effort probe and the logs come from the on-disk files.
+     * @type {CommandStatusResponseStatusEnum}
+     * @memberof CommandStatusResponse
+     */
+    status: CommandStatusResponseStatusEnum;
+    /**
+     * Whether the process is still tracked by the sandbox agent.
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    known?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    running: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    exitCode: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    signal?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    command?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    cwd?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CommandStatusResponse
+     */
+    startedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CommandStatusResponse
+     */
+    finishedAt?: Date | null;
+    /**
+     * Tail of the stdout log file.
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    stdout: string;
+    /**
+     * Tail of the stderr log file.
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    stderr: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    stdoutTruncated?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    stderrTruncated?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    logPath?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    errLogPath?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CommandStatusResponseTypeEnum = {
+    CommandStatus: 'command.status'
+} as const;
+export type CommandStatusResponseTypeEnum = typeof CommandStatusResponseTypeEnum[keyof typeof CommandStatusResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const CommandStatusResponseStatusEnum = {
+    Running: 'running',
+    Exited: 'exited',
+    Lost: 'lost'
+} as const;
+export type CommandStatusResponseStatusEnum = typeof CommandStatusResponseStatusEnum[keyof typeof CommandStatusResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CommandStatusResponse interface.
+ */
+export function instanceOfCommandStatusResponse(value: object): value is CommandStatusResponse {
+    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 (!('processId' in value) || value['processId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('running' in value) || value['running'] === undefined) return false;
+    if (!('exitCode' in value) || value['exitCode'] === undefined) return false;
+    if (!('stdout' in value) || value['stdout'] === undefined) return false;
+    if (!('stderr' in value) || value['stderr'] === undefined) return false;
+    return true;
+}
+
+export function CommandStatusResponseFromJSON(json: any): CommandStatusResponse {
+    return CommandStatusResponseFromJSONTyped(json, false);
+}
+
+export function CommandStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandStatusResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'processId': json['processId'],
+        'pid': json['pid'] == null ? undefined : json['pid'],
+        'status': json['status'],
+        'known': json['known'] == null ? undefined : json['known'],
+        'running': json['running'],
+        'exitCode': json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'command': json['command'] == null ? undefined : json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'finishedAt': json['finishedAt'] == null ? undefined : (new Date(json['finishedAt'])),
+        'stdout': json['stdout'],
+        'stderr': json['stderr'],
+        'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
+        'stderrTruncated': json['stderrTruncated'] == null ? undefined : json['stderrTruncated'],
+        'logPath': json['logPath'] == null ? undefined : json['logPath'],
+        'errLogPath': json['errLogPath'] == null ? undefined : json['errLogPath'],
+    };
+}
+
+export function CommandStatusResponseToJSON(json: any): CommandStatusResponse {
+    return CommandStatusResponseToJSONTyped(json, false);
+}
+
+export function CommandStatusResponseToJSONTyped(value?: CommandStatusResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'processId': value['processId'],
+        'pid': value['pid'],
+        'status': value['status'],
+        'known': value['known'],
+        'running': value['running'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+        'stdout': value['stdout'],
+        'stderr': value['stderr'],
+        'stdoutTruncated': value['stdoutTruncated'],
+        'stderrTruncated': value['stderrTruncated'],
+        'logPath': value['logPath'],
+        'errLogPath': value['errLogPath'],
+    };
+}
+

package/src/models/CompletionEvent.ts

@@ -0,0 +1,111 @@
+/* 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 CompletionEvent
+ */
+export interface CompletionEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof CompletionEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {CompletionEventTypeEnum}
+     * @memberof CompletionEvent
+     */
+    type: CompletionEventTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CompletionEvent
+     */
+    timestamp: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompletionEvent
+     */
+    taskId?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof CompletionEvent
+     */
+    data: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const CompletionEventTypeEnum = {
+    CompactionComplete: 'compaction_complete'
+} as const;
+export type CompletionEventTypeEnum = typeof CompletionEventTypeEnum[keyof typeof CompletionEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the CompletionEvent interface.
+ */
+export function instanceOfCompletionEvent(value: object): value is CompletionEvent {
+    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 CompletionEventFromJSON(json: any): CompletionEvent {
+    return CompletionEventFromJSONTyped(json, false);
+}
+
+export function CompletionEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompletionEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        'timestamp': json['timestamp'],
+        'taskId': json['taskId'] == null ? undefined : json['taskId'],
+        'data': json['data'],
+    };
+}
+
+export function CompletionEventToJSON(json: any): CompletionEvent {
+    return CompletionEventToJSONTyped(json, false);
+}
+
+export function CompletionEventToJSONTyped(value?: CompletionEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'data': value['data'],
+    };
+}
+