@boatdev/sdk 1.0.0

package/dist/esm/models/EnvironmentItemChangeResponse.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Result of a granular environment change. Every change mints a new immutable version holding just that delta; existing sandboxes stay pinned until upgraded.
+ * @export
+ * @interface EnvironmentItemChangeResponse
+ */
+export interface EnvironmentItemChangeResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof EnvironmentItemChangeResponse
+     */
+    success: boolean;
+    /**
+     * Id of the newly minted environment version. This is a version id, not the environment's own id: the environment id you passed in the path is unchanged.
+     * @type {string}
+     * @memberof EnvironmentItemChangeResponse
+     */
+    versionId?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof EnvironmentItemChangeResponse
+     */
+    versionNumber?: number;
+}
+/**
+ * Check if a given object implements the EnvironmentItemChangeResponse interface.
+ */
+export declare function instanceOfEnvironmentItemChangeResponse(value: object): value is EnvironmentItemChangeResponse;
+export declare function EnvironmentItemChangeResponseFromJSON(json: any): EnvironmentItemChangeResponse;
+export declare function EnvironmentItemChangeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentItemChangeResponse;
+export declare function EnvironmentItemChangeResponseToJSON(json: any): EnvironmentItemChangeResponse;
+export declare function EnvironmentItemChangeResponseToJSONTyped(value?: EnvironmentItemChangeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EnvironmentItemChangeResponse.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the EnvironmentItemChangeResponse interface.
+ */
+export function instanceOfEnvironmentItemChangeResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    return true;
+}
+export function EnvironmentItemChangeResponseFromJSON(json) {
+    return EnvironmentItemChangeResponseFromJSONTyped(json, false);
+}
+export function EnvironmentItemChangeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'versionId': json['versionId'] == null ? undefined : json['versionId'],
+        'versionNumber': json['versionNumber'] == null ? undefined : json['versionNumber'],
+    };
+}
+export function EnvironmentItemChangeResponseToJSON(json) {
+    return EnvironmentItemChangeResponseToJSONTyped(json, false);
+}
+export function EnvironmentItemChangeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'versionId': value['versionId'],
+        'versionNumber': value['versionNumber'],
+    };
+}

package/dist/esm/models/ErrorEnvelope.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 type { ErrorEnvelopeError } from './ErrorEnvelopeError';
+/**
+ *
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ErrorEnvelope
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelope
+     */
+    type: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorEnvelope
+     */
+    status: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelope
+     */
+    code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelope
+     */
+    message: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelope
+     */
+    requestId: string;
+    /**
+     *
+     * @type {ErrorEnvelopeError}
+     * @memberof ErrorEnvelope
+     */
+    error: ErrorEnvelopeError;
+}
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export declare function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ErrorEnvelope.js

@@ -0,0 +1,68 @@
+/* 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 { ErrorEnvelopeErrorFromJSON, ErrorEnvelopeErrorToJSON, } from './ErrorEnvelopeError';
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export function instanceOfErrorEnvelope(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    if (!('requestId' in value) || value['requestId'] === undefined)
+        return false;
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    return true;
+}
+export function ErrorEnvelopeFromJSON(json) {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+export function ErrorEnvelopeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'status': json['status'],
+        'code': json['code'],
+        'message': json['message'],
+        'requestId': json['requestId'],
+        'error': ErrorEnvelopeErrorFromJSON(json['error']),
+    };
+}
+export function ErrorEnvelopeToJSON(json) {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+export function ErrorEnvelopeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'code': value['code'],
+        'message': value['message'],
+        'requestId': value['requestId'],
+        'error': ErrorEnvelopeErrorToJSON(value['error']),
+    };
+}

package/dist/esm/models/ErrorEnvelopeError.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ErrorEnvelopeError
+ */
+export interface ErrorEnvelopeError {
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelopeError
+     */
+    code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEnvelopeError
+     */
+    message: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorEnvelopeError
+     */
+    status: number;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ErrorEnvelopeError
+     */
+    details?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the ErrorEnvelopeError interface.
+ */
+export declare function instanceOfErrorEnvelopeError(value: object): value is ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorFromJSON(json: any): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorToJSON(json: any): ErrorEnvelopeError;
+export declare function ErrorEnvelopeErrorToJSONTyped(value?: ErrorEnvelopeError | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ErrorEnvelopeError.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ErrorEnvelopeError interface.
+ */
+export function instanceOfErrorEnvelopeError(value) {
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function ErrorEnvelopeErrorFromJSON(json) {
+    return ErrorEnvelopeErrorFromJSONTyped(json, false);
+}
+export function ErrorEnvelopeErrorFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': json['code'],
+        'message': json['message'],
+        'status': json['status'],
+        'details': json['details'] == null ? undefined : json['details'],
+    };
+}
+export function ErrorEnvelopeErrorToJSON(json) {
+    return ErrorEnvelopeErrorToJSONTyped(json, false);
+}
+export function ErrorEnvelopeErrorToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': value['code'],
+        'message': value['message'],
+        'status': value['status'],
+        'details': value['details'],
+    };
+}

package/dist/esm/models/ErrorEvent.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ErrorEvent
+ */
+export interface ErrorEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEvent
+     */
+    id: string;
+    /**
+     *
+     * @type {ErrorEventTypeEnum}
+     * @memberof ErrorEvent
+     */
+    type: ErrorEventTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorEvent
+     */
+    timestamp: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEvent
+     */
+    taskId?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ErrorEvent
+     */
+    data: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const ErrorEventTypeEnum: {
+    readonly UsageLimit: 'usage_limit';
+};
+export type ErrorEventTypeEnum = typeof ErrorEventTypeEnum[keyof typeof ErrorEventTypeEnum];
+/**
+ * Check if a given object implements the ErrorEvent interface.
+ */
+export declare function instanceOfErrorEvent(value: object): value is ErrorEvent;
+export declare function ErrorEventFromJSON(json: any): ErrorEvent;
+export declare function ErrorEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEvent;
+export declare function ErrorEventToJSON(json: any): ErrorEvent;
+export declare function ErrorEventToJSONTyped(value?: ErrorEvent | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ErrorEvent.js

@@ -0,0 +1,63 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ErrorEventTypeEnum = {
+    UsageLimit: 'usage_limit'
+};
+/**
+ * Check if a given object implements the ErrorEvent interface.
+ */
+export function instanceOfErrorEvent(value) {
+    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 ErrorEventFromJSON(json) {
+    return ErrorEventFromJSONTyped(json, false);
+}
+export function ErrorEventFromJSONTyped(json, ignoreDiscriminator) {
+    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 ErrorEventToJSON(json) {
+    return ErrorEventToJSONTyped(json, false);
+}
+export function ErrorEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'data': value['data'],
+    };
+}

package/dist/esm/models/EventsResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 type { PageInfo } from './PageInfo';
+import type { SandboxEvent } from './SandboxEvent';
+/**
+ *
+ * @export
+ * @interface EventsResponse
+ */
+export interface EventsResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof EventsResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {EventsResponseTypeEnum}
+     * @memberof EventsResponse
+     */
+    type: EventsResponseTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof EventsResponse
+     */
+    id: string;
+    /**
+     * Sandbox work and lifecycle event objects. Event shapes are intentionally extensible; branch on each event `type` when present.
+     * @type {Array<SandboxEvent>}
+     * @memberof EventsResponse
+     */
+    events: Array<SandboxEvent>;
+    /**
+     *
+     * @type {PageInfo}
+     * @memberof EventsResponse
+     */
+    pageInfo?: PageInfo;
+}
+/**
+ * @export
+ */
+export declare const EventsResponseTypeEnum: {
+    readonly EventsList: 'events.list';
+};
+export type EventsResponseTypeEnum = typeof EventsResponseTypeEnum[keyof typeof EventsResponseTypeEnum];
+/**
+ * Check if a given object implements the EventsResponse interface.
+ */
+export declare function instanceOfEventsResponse(value: object): value is EventsResponse;
+export declare function EventsResponseFromJSON(json: any): EventsResponse;
+export declare function EventsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventsResponse;
+export declare function EventsResponseToJSON(json: any): EventsResponse;
+export declare function EventsResponseToJSONTyped(value?: EventsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EventsResponse.js

@@ -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 { PageInfoFromJSON, PageInfoToJSON, } from './PageInfo';
+import { SandboxEventFromJSON, SandboxEventToJSON, } from './SandboxEvent';
+/**
+ * @export
+ */
+export const EventsResponseTypeEnum = {
+    EventsList: 'events.list'
+};
+/**
+ * Check if a given object implements the EventsResponse interface.
+ */
+export function instanceOfEventsResponse(value) {
+    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 (!('events' in value) || value['events'] === undefined)
+        return false;
+    return true;
+}
+export function EventsResponseFromJSON(json) {
+    return EventsResponseFromJSONTyped(json, false);
+}
+export function EventsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'events': (json['events'].map(SandboxEventFromJSON)),
+        'pageInfo': json['pageInfo'] == null ? undefined : PageInfoFromJSON(json['pageInfo']),
+    };
+}
+export function EventsResponseToJSON(json) {
+    return EventsResponseToJSONTyped(json, false);
+}
+export function EventsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'events': (value['events'].map(SandboxEventToJSON)),
+        'pageInfo': PageInfoToJSON(value['pageInfo']),
+    };
+}

package/dist/esm/models/FileReadResponse.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface FileReadResponse
+ */
+export interface FileReadResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileReadResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileReadResponseTypeEnum}
+     * @memberof FileReadResponse
+     */
+    type: FileReadResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileReadResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FileReadResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {FileReadResponseEncodingEnum}
+     * @memberof FileReadResponse
+     */
+    encoding: FileReadResponseEncodingEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof FileReadResponse
+     */
+    size: number;
+    /**
+     *
+     * @type {string}
+     * @memberof FileReadResponse
+     */
+    content: string;
+}
+/**
+ * @export
+ */
+export declare const FileReadResponseTypeEnum: {
+    readonly FileRead: 'file.read';
+};
+export type FileReadResponseTypeEnum = typeof FileReadResponseTypeEnum[keyof typeof FileReadResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const FileReadResponseEncodingEnum: {
+    readonly Utf8: 'utf8';
+    readonly Base64: 'base64';
+};
+export type FileReadResponseEncodingEnum = typeof FileReadResponseEncodingEnum[keyof typeof FileReadResponseEncodingEnum];
+/**
+ * Check if a given object implements the FileReadResponse interface.
+ */
+export declare function instanceOfFileReadResponse(value: object): value is FileReadResponse;
+export declare function FileReadResponseFromJSON(json: any): FileReadResponse;
+export declare function FileReadResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileReadResponse;
+export declare function FileReadResponseToJSON(json: any): FileReadResponse;
+export declare function FileReadResponseToJSONTyped(value?: FileReadResponse | null, ignoreDiscriminator?: boolean): any;