@boatdev/sdk 1.9.2 → 1.9.3

package/src/models/CommandAttachFrame.ts

@@ -0,0 +1,179 @@
+/* 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 line of `GET /sandboxes/{sandboxId}/commands/{processId}/stream` (application/x-ndjson).
+ * - `attached`: first line. `processId`, `stdoutOffset`, `stderrOffset` (where the output starts).
+ * - `stdout` / `stderr`: a chunk. `data`, and `nextOffset` for that stream.
+ * - `heartbeat`: sent after 15 s with no other line.
+ * - `exit`: last line when the command ended and all its output was sent. `status`, `exitCode`, `signal`, `stdoutOffset`, `stderrOffset`.
+ * - `reconnect`: last line after 10 minutes. Open the stream again with its `stdoutOffset` and `stderrOffset`. Nothing is lost or repeated.
+ * - `error`: last line on a failure. `error`, `message`, `stdoutOffset`, `stderrOffset`.
+ * 
+ * @export
+ * @interface CommandAttachFrame
+ */
+export interface CommandAttachFrame {
+    /**
+     * 
+     * @type {CommandAttachFrameTypeEnum}
+     * @memberof CommandAttachFrame
+     */
+    type: CommandAttachFrameTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandAttachFrame
+     */
+    processId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandAttachFrame
+     */
+    data?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandAttachFrame
+     */
+    nextOffset?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandAttachFrame
+     */
+    stdoutOffset?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandAttachFrame
+     */
+    stderrOffset?: number;
+    /**
+     * 
+     * @type {CommandAttachFrameStatusEnum}
+     * @memberof CommandAttachFrame
+     */
+    status?: CommandAttachFrameStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CommandAttachFrame
+     */
+    exitCode?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandAttachFrame
+     */
+    signal?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandAttachFrame
+     */
+    error?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandAttachFrame
+     */
+    message?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CommandAttachFrameTypeEnum = {
+    Attached: 'attached',
+    Stdout: 'stdout',
+    Stderr: 'stderr',
+    Heartbeat: 'heartbeat',
+    Exit: 'exit',
+    Reconnect: 'reconnect',
+    Error: 'error'
+} as const;
+export type CommandAttachFrameTypeEnum = typeof CommandAttachFrameTypeEnum[keyof typeof CommandAttachFrameTypeEnum];
+
+/**
+ * @export
+ */
+export const CommandAttachFrameStatusEnum = {
+    Running: 'running',
+    Exited: 'exited',
+    Lost: 'lost'
+} as const;
+export type CommandAttachFrameStatusEnum = typeof CommandAttachFrameStatusEnum[keyof typeof CommandAttachFrameStatusEnum];
+
+
+/**
+ * Check if a given object implements the CommandAttachFrame interface.
+ */
+export function instanceOfCommandAttachFrame(value: object): value is CommandAttachFrame {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function CommandAttachFrameFromJSON(json: any): CommandAttachFrame {
+    return CommandAttachFrameFromJSONTyped(json, false);
+}
+
+export function CommandAttachFrameFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandAttachFrame {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'processId': json['processId'] == null ? undefined : json['processId'],
+        'data': json['data'] == null ? undefined : json['data'],
+        'nextOffset': json['nextOffset'] == null ? undefined : json['nextOffset'],
+        'stdoutOffset': json['stdoutOffset'] == null ? undefined : json['stdoutOffset'],
+        'stderrOffset': json['stderrOffset'] == null ? undefined : json['stderrOffset'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'exitCode': json['exitCode'] == null ? undefined : json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function CommandAttachFrameToJSON(json: any): CommandAttachFrame {
+    return CommandAttachFrameToJSONTyped(json, false);
+}
+
+export function CommandAttachFrameToJSONTyped(value?: CommandAttachFrame | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'processId': value['processId'],
+        'data': value['data'],
+        'nextOffset': value['nextOffset'],
+        'stdoutOffset': value['stdoutOffset'],
+        'stderrOffset': value['stderrOffset'],
+        'status': value['status'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'error': value['error'],
+        'message': value['message'],
+    };
+}
+

package/src/models/CommandInfoResponse.ts

@@ -0,0 +1,102 @@
+/* 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 { CommandRecord } from './CommandRecord';
+import {
+    CommandRecordFromJSON,
+    CommandRecordFromJSONTyped,
+    CommandRecordToJSON,
+    CommandRecordToJSONTyped,
+} from './CommandRecord';
+
+/**
+ * 
+ * @export
+ * @interface CommandInfoResponse
+ */
+export interface CommandInfoResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandInfoResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandInfoResponseTypeEnum}
+     * @memberof CommandInfoResponse
+     */
+    type: CommandInfoResponseTypeEnum;
+    /**
+     * 
+     * @type {CommandRecord}
+     * @memberof CommandInfoResponse
+     */
+    command: CommandRecord;
+}
+
+
+/**
+ * @export
+ */
+export const CommandInfoResponseTypeEnum = {
+    CommandInfo: 'command.info'
+} as const;
+export type CommandInfoResponseTypeEnum = typeof CommandInfoResponseTypeEnum[keyof typeof CommandInfoResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the CommandInfoResponse interface.
+ */
+export function instanceOfCommandInfoResponse(value: object): value is CommandInfoResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('command' in value) || value['command'] === undefined) return false;
+    return true;
+}
+
+export function CommandInfoResponseFromJSON(json: any): CommandInfoResponse {
+    return CommandInfoResponseFromJSONTyped(json, false);
+}
+
+export function CommandInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandInfoResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'command': CommandRecordFromJSON(json['command']),
+    };
+}
+
+export function CommandInfoResponseToJSON(json: any): CommandInfoResponse {
+    return CommandInfoResponseToJSONTyped(json, false);
+}
+
+export function CommandInfoResponseToJSONTyped(value?: CommandInfoResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'command': CommandRecordToJSON(value['command']),
+    };
+}
+

package/src/models/CommandListResponse.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';
+import type { CommandRecord } from './CommandRecord';
+import {
+    CommandRecordFromJSON,
+    CommandRecordFromJSONTyped,
+    CommandRecordToJSON,
+    CommandRecordToJSONTyped,
+} from './CommandRecord';
+
+/**
+ * 
+ * @export
+ * @interface CommandListResponse
+ */
+export interface CommandListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandListResponseTypeEnum}
+     * @memberof CommandListResponse
+     */
+    type: CommandListResponseTypeEnum;
+    /**
+     * Newest first.
+     * @type {Array<CommandRecord>}
+     * @memberof CommandListResponse
+     */
+    commands: Array<CommandRecord>;
+    /**
+     * Pass as `cursor` to get the next page. Null on the last page.
+     * @type {string}
+     * @memberof CommandListResponse
+     */
+    nextCursor: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CommandListResponseTypeEnum = {
+    CommandList: 'command.list'
+} as const;
+export type CommandListResponseTypeEnum = typeof CommandListResponseTypeEnum[keyof typeof CommandListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the CommandListResponse interface.
+ */
+export function instanceOfCommandListResponse(value: object): value is CommandListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('commands' in value) || value['commands'] === undefined) return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined) return false;
+    return true;
+}
+
+export function CommandListResponseFromJSON(json: any): CommandListResponse {
+    return CommandListResponseFromJSONTyped(json, false);
+}
+
+export function CommandListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'commands': ((json['commands'] as Array<any>).map(CommandRecordFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+
+export function CommandListResponseToJSON(json: any): CommandListResponse {
+    return CommandListResponseToJSONTyped(json, false);
+}
+
+export function CommandListResponseToJSONTyped(value?: CommandListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'commands': ((value['commands'] as Array<any>).map(CommandRecordToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}
+

package/src/models/CommandLogsResponse.ts

@@ -0,0 +1,175 @@
+/* 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 CommandLogsResponse
+ */
+export interface CommandLogsResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CommandLogsResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {CommandLogsResponseTypeEnum}
+     * @memberof CommandLogsResponse
+     */
+    type: CommandLogsResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandLogsResponse
+     */
+    commandId: string;
+    /**
+     * 
+     * @type {CommandLogsResponseStreamEnum}
+     * @memberof CommandLogsResponse
+     */
+    stream: CommandLogsResponseStreamEnum;
+    /**
+     * Byte position of the first byte in `data`. Greater than the requested offset only when output was not kept (see outputTruncated).
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    offset: number;
+    /**
+     * Pass as `offset` to read on.
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    nextOffset: number;
+    /**
+     * Bytes the stream has so far.
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    size: number;
+    /**
+     * 
+     * @type {CommandLogsResponseEncodingEnum}
+     * @memberof CommandLogsResponse
+     */
+    encoding: CommandLogsResponseEncodingEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CommandLogsResponse
+     */
+    data: string;
+    /**
+     * True when the command ended and this read reached the end of the stream.
+     * @type {boolean}
+     * @memberof CommandLogsResponse
+     */
+    done: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const CommandLogsResponseTypeEnum = {
+    CommandLogs: 'command.logs'
+} as const;
+export type CommandLogsResponseTypeEnum = typeof CommandLogsResponseTypeEnum[keyof typeof CommandLogsResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const CommandLogsResponseStreamEnum = {
+    Stdout: 'stdout',
+    Stderr: 'stderr'
+} as const;
+export type CommandLogsResponseStreamEnum = typeof CommandLogsResponseStreamEnum[keyof typeof CommandLogsResponseStreamEnum];
+
+/**
+ * @export
+ */
+export const CommandLogsResponseEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+} as const;
+export type CommandLogsResponseEncodingEnum = typeof CommandLogsResponseEncodingEnum[keyof typeof CommandLogsResponseEncodingEnum];
+
+
+/**
+ * Check if a given object implements the CommandLogsResponse interface.
+ */
+export function instanceOfCommandLogsResponse(value: object): value is CommandLogsResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('commandId' in value) || value['commandId'] === undefined) return false;
+    if (!('stream' in value) || value['stream'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    if (!('nextOffset' in value) || value['nextOffset'] === undefined) return false;
+    if (!('size' in value) || value['size'] === undefined) return false;
+    if (!('encoding' in value) || value['encoding'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('done' in value) || value['done'] === undefined) return false;
+    return true;
+}
+
+export function CommandLogsResponseFromJSON(json: any): CommandLogsResponse {
+    return CommandLogsResponseFromJSONTyped(json, false);
+}
+
+export function CommandLogsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandLogsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'commandId': json['commandId'],
+        'stream': json['stream'],
+        'offset': json['offset'],
+        'nextOffset': json['nextOffset'],
+        'size': json['size'],
+        'encoding': json['encoding'],
+        'data': json['data'],
+        'done': json['done'],
+    };
+}
+
+export function CommandLogsResponseToJSON(json: any): CommandLogsResponse {
+    return CommandLogsResponseToJSONTyped(json, false);
+}
+
+export function CommandLogsResponseToJSONTyped(value?: CommandLogsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'commandId': value['commandId'],
+        'stream': value['stream'],
+        'offset': value['offset'],
+        'nextOffset': value['nextOffset'],
+        'size': value['size'],
+        'encoding': value['encoding'],
+        'data': value['data'],
+        'done': value['done'],
+    };
+}
+