@boatdev/sdk 1.0.0

package/src/models/DesktopResponse.ts

@@ -0,0 +1,123 @@
+/* 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 DesktopResponse
+ */
+export interface DesktopResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DesktopResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DesktopResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DesktopResponse
+     */
+    success?: boolean;
+    /**
+     * Secret-bearing desktop or noVNC URL. Redact from logs.
+     * @type {string}
+     * @memberof DesktopResponse
+     */
+    desktopUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DesktopResponse
+     */
+    ip?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DesktopResponse
+     */
+    mode?: string;
+    /**
+     * For `?vnc=1`, true means VNC is still being prepared; poll again.
+     * @type {boolean}
+     * @memberof DesktopResponse
+     */
+    provisioning?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DesktopResponse
+     */
+    message?: string;
+}
+
+/**
+ * Check if a given object implements the DesktopResponse interface.
+ */
+export function instanceOfDesktopResponse(value: object): value is DesktopResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function DesktopResponseFromJSON(json: any): DesktopResponse {
+    return DesktopResponseFromJSONTyped(json, false);
+}
+
+export function DesktopResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DesktopResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'desktopUrl': json['desktopUrl'] == null ? undefined : json['desktopUrl'],
+        'ip': json['ip'] == null ? undefined : json['ip'],
+        'mode': json['mode'] == null ? undefined : json['mode'],
+        'provisioning': json['provisioning'] == null ? undefined : json['provisioning'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function DesktopResponseToJSON(json: any): DesktopResponse {
+    return DesktopResponseToJSONTyped(json, false);
+}
+
+export function DesktopResponseToJSONTyped(value?: DesktopResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'desktopUrl': value['desktopUrl'],
+        'ip': value['ip'],
+        'mode': value['mode'],
+        'provisioning': value['provisioning'],
+        'message': value['message'],
+    };
+}
+

package/src/models/EnvironmentItemChangeResponse.ts

@@ -0,0 +1,82 @@
+/* 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';
+/**
+ * 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 function instanceOfEnvironmentItemChangeResponse(value: object): value is EnvironmentItemChangeResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function EnvironmentItemChangeResponseFromJSON(json: any): EnvironmentItemChangeResponse {
+    return EnvironmentItemChangeResponseFromJSONTyped(json, false);
+}
+
+export function EnvironmentItemChangeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentItemChangeResponse {
+    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: any): EnvironmentItemChangeResponse {
+    return EnvironmentItemChangeResponseToJSONTyped(json, false);
+}
+
+export function EnvironmentItemChangeResponseToJSONTyped(value?: EnvironmentItemChangeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'versionId': value['versionId'],
+        'versionNumber': value['versionNumber'],
+    };
+}
+

package/src/models/ErrorEnvelope.ts

@@ -0,0 +1,128 @@
+/* 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 { ErrorEnvelopeError } from './ErrorEnvelopeError';
+import {
+    ErrorEnvelopeErrorFromJSON,
+    ErrorEnvelopeErrorFromJSONTyped,
+    ErrorEnvelopeErrorToJSON,
+    ErrorEnvelopeErrorToJSONTyped,
+} 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 function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope {
+    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: any): ErrorEnvelope {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope {
+    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: any): ErrorEnvelope {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/ErrorEnvelopeError.ts

@@ -0,0 +1,92 @@
+/* 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 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 function instanceOfErrorEnvelopeError(value: object): value is ErrorEnvelopeError {
+    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: any): ErrorEnvelopeError {
+    return ErrorEnvelopeErrorFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelopeError {
+    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: any): ErrorEnvelopeError {
+    return ErrorEnvelopeErrorToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeErrorToJSONTyped(value?: ErrorEnvelopeError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'status': value['status'],
+        'details': value['details'],
+    };
+}
+

package/src/models/ErrorEvent.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 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 const ErrorEventTypeEnum = {
+    UsageLimit: 'usage_limit'
+} as const;
+export type ErrorEventTypeEnum = typeof ErrorEventTypeEnum[keyof typeof ErrorEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the ErrorEvent interface.
+ */
+export function instanceOfErrorEvent(value: object): value is ErrorEvent {
+    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: any): ErrorEvent {
+    return ErrorEventFromJSONTyped(json, false);
+}
+
+export function ErrorEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEvent {
+    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: any): ErrorEvent {
+    return ErrorEventToJSONTyped(json, false);
+}
+
+export function ErrorEventToJSONTyped(value?: ErrorEvent | 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'],
+    };
+}
+

package/src/models/EventsResponse.ts

@@ -0,0 +1,126 @@
+/* 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 { PageInfo } from './PageInfo';
+import {
+    PageInfoFromJSON,
+    PageInfoFromJSONTyped,
+    PageInfoToJSON,
+    PageInfoToJSONTyped,
+} from './PageInfo';
+import type { SandboxEvent } from './SandboxEvent';
+import {
+    SandboxEventFromJSON,
+    SandboxEventFromJSONTyped,
+    SandboxEventToJSON,
+    SandboxEventToJSONTyped,
+} 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 const EventsResponseTypeEnum = {
+    EventsList: 'events.list'
+} as const;
+export type EventsResponseTypeEnum = typeof EventsResponseTypeEnum[keyof typeof EventsResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the EventsResponse interface.
+ */
+export function instanceOfEventsResponse(value: object): value is EventsResponse {
+    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: any): EventsResponse {
+    return EventsResponseFromJSONTyped(json, false);
+}
+
+export function EventsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+        'events': ((json['events'] as Array<any>).map(SandboxEventFromJSON)),
+        'pageInfo': json['pageInfo'] == null ? undefined : PageInfoFromJSON(json['pageInfo']),
+    };
+}
+
+export function EventsResponseToJSON(json: any): EventsResponse {
+    return EventsResponseToJSONTyped(json, false);
+}
+
+export function EventsResponseToJSONTyped(value?: EventsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+        'events': ((value['events'] as Array<any>).map(SandboxEventToJSON)),
+        'pageInfo': PageInfoToJSON(value['pageInfo']),
+    };
+}
+