@boatdev/sdk 1.0.0

package/src/models/SandboxEnvironmentResponse.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';
+import type { SandboxEnvironment } from './SandboxEnvironment';
+import {
+    SandboxEnvironmentFromJSON,
+    SandboxEnvironmentFromJSONTyped,
+    SandboxEnvironmentToJSON,
+    SandboxEnvironmentToJSONTyped,
+} from './SandboxEnvironment';
+
+/**
+ * 
+ * @export
+ * @interface SandboxEnvironmentResponse
+ */
+export interface SandboxEnvironmentResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SandboxEnvironmentResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {SandboxEnvironment}
+     * @memberof SandboxEnvironmentResponse
+     */
+    environment?: SandboxEnvironment | null;
+}
+
+/**
+ * Check if a given object implements the SandboxEnvironmentResponse interface.
+ */
+export function instanceOfSandboxEnvironmentResponse(value: object): value is SandboxEnvironmentResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function SandboxEnvironmentResponseFromJSON(json: any): SandboxEnvironmentResponse {
+    return SandboxEnvironmentResponseFromJSONTyped(json, false);
+}
+
+export function SandboxEnvironmentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxEnvironmentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'environment': json['environment'] == null ? undefined : SandboxEnvironmentFromJSON(json['environment']),
+    };
+}
+
+export function SandboxEnvironmentResponseToJSON(json: any): SandboxEnvironmentResponse {
+    return SandboxEnvironmentResponseToJSONTyped(json, false);
+}
+
+export function SandboxEnvironmentResponseToJSONTyped(value?: SandboxEnvironmentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'environment': SandboxEnvironmentToJSON(value['environment']),
+    };
+}
+

package/src/models/SandboxEnvironmentVersionSummary.ts

@@ -0,0 +1,93 @@
+/* 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';
+/**
+ * An immutable snapshot of an environment's config. Editing an environment mints a new version; sandboxes stay pinned to the version they were created on until upgraded.
+ * @export
+ * @interface SandboxEnvironmentVersionSummary
+ */
+export interface SandboxEnvironmentVersionSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxEnvironmentVersionSummary
+     */
+    id: string;
+    /**
+     * Monotonically increasing per environment; version 1 is the first.
+     * @type {number}
+     * @memberof SandboxEnvironmentVersionSummary
+     */
+    versionNumber: number;
+    /**
+     * Number of the caller's active sandboxes currently pinned to this version.
+     * @type {number}
+     * @memberof SandboxEnvironmentVersionSummary
+     */
+    sandboxCount: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SandboxEnvironmentVersionSummary
+     */
+    createdAt: Date;
+}
+
+/**
+ * Check if a given object implements the SandboxEnvironmentVersionSummary interface.
+ */
+export function instanceOfSandboxEnvironmentVersionSummary(value: object): value is SandboxEnvironmentVersionSummary {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('sandboxCount' in value) || value['sandboxCount'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function SandboxEnvironmentVersionSummaryFromJSON(json: any): SandboxEnvironmentVersionSummary {
+    return SandboxEnvironmentVersionSummaryFromJSONTyped(json, false);
+}
+
+export function SandboxEnvironmentVersionSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxEnvironmentVersionSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'versionNumber': json['versionNumber'],
+        'sandboxCount': json['sandboxCount'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function SandboxEnvironmentVersionSummaryToJSON(json: any): SandboxEnvironmentVersionSummary {
+    return SandboxEnvironmentVersionSummaryToJSONTyped(json, false);
+}
+
+export function SandboxEnvironmentVersionSummaryToJSONTyped(value?: SandboxEnvironmentVersionSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'versionNumber': value['versionNumber'],
+        'sandboxCount': value['sandboxCount'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/SandboxEvent.ts

@@ -0,0 +1,109 @@
+/* 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 SandboxEvent
+ */
+export interface SandboxEvent {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxEvent
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxEvent
+     */
+    type: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SandboxEvent
+     */
+    timestamp?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxEvent
+     */
+    taskId?: string | null;
+    /**
+     * The conversation this event belongs to. Filter the stream with `?conversation=<id>`. See [Integrated agents](/integrated-agents).
+     * @type {string}
+     * @memberof SandboxEvent
+     */
+    conversationId?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof SandboxEvent
+     */
+    data?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the SandboxEvent interface.
+ */
+export function instanceOfSandboxEvent(value: object): value is SandboxEvent {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function SandboxEventFromJSON(json: any): SandboxEvent {
+    return SandboxEventFromJSONTyped(json, false);
+}
+
+export function SandboxEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'id': json['id'] == null ? undefined : json['id'],
+        'type': json['type'],
+        'timestamp': json['timestamp'] == null ? undefined : json['timestamp'],
+        'taskId': json['taskId'] == null ? undefined : json['taskId'],
+        'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
+        'data': json['data'] == null ? undefined : json['data'],
+    };
+}
+
+export function SandboxEventToJSON(json: any): SandboxEvent {
+    return SandboxEventToJSONTyped(json, false);
+}
+
+export function SandboxEventToJSONTyped(value?: SandboxEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'conversationId': value['conversationId'],
+        'data': value['data'],
+    };
+}
+

package/src/models/SandboxInfoResponse.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';
+import type { Sandbox } from './Sandbox';
+import {
+    SandboxFromJSON,
+    SandboxFromJSONTyped,
+    SandboxToJSON,
+    SandboxToJSONTyped,
+} from './Sandbox';
+
+/**
+ * 
+ * @export
+ * @interface SandboxInfoResponse
+ */
+export interface SandboxInfoResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SandboxInfoResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxInfoResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Sandbox}
+     * @memberof SandboxInfoResponse
+     */
+    sandbox: Sandbox;
+}
+
+/**
+ * Check if a given object implements the SandboxInfoResponse interface.
+ */
+export function instanceOfSandboxInfoResponse(value: object): value is SandboxInfoResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('sandbox' in value) || value['sandbox'] === undefined) return false;
+    return true;
+}
+
+export function SandboxInfoResponseFromJSON(json: any): SandboxInfoResponse {
+    return SandboxInfoResponseFromJSONTyped(json, false);
+}
+
+export function SandboxInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxInfoResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'sandbox': SandboxFromJSON(json['sandbox']),
+    };
+}
+
+export function SandboxInfoResponseToJSON(json: any): SandboxInfoResponse {
+    return SandboxInfoResponseToJSONTyped(json, false);
+}
+
+export function SandboxInfoResponseToJSONTyped(value?: SandboxInfoResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'sandbox': SandboxToJSON(value['sandbox']),
+    };
+}
+

package/src/models/SandboxListResponse.ts

@@ -0,0 +1,117 @@
+/* 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 { Sandbox } from './Sandbox';
+import {
+    SandboxFromJSON,
+    SandboxFromJSONTyped,
+    SandboxToJSON,
+    SandboxToJSONTyped,
+} from './Sandbox';
+
+/**
+ * 
+ * @export
+ * @interface SandboxListResponse
+ */
+export interface SandboxListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SandboxListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SandboxListResponseTypeEnum}
+     * @memberof SandboxListResponse
+     */
+    type: SandboxListResponseTypeEnum;
+    /**
+     * 
+     * @type {Array<Sandbox>}
+     * @memberof SandboxListResponse
+     */
+    sandboxes: Array<Sandbox>;
+    /**
+     * 
+     * @type {PageInfo}
+     * @memberof SandboxListResponse
+     */
+    pageInfo?: PageInfo;
+}
+
+
+/**
+ * @export
+ */
+export const SandboxListResponseTypeEnum = {
+    SandboxList: 'sandbox.list'
+} as const;
+export type SandboxListResponseTypeEnum = typeof SandboxListResponseTypeEnum[keyof typeof SandboxListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SandboxListResponse interface.
+ */
+export function instanceOfSandboxListResponse(value: object): value is SandboxListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('sandboxes' in value) || value['sandboxes'] === undefined) return false;
+    return true;
+}
+
+export function SandboxListResponseFromJSON(json: any): SandboxListResponse {
+    return SandboxListResponseFromJSONTyped(json, false);
+}
+
+export function SandboxListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'sandboxes': ((json['sandboxes'] as Array<any>).map(SandboxFromJSON)),
+        'pageInfo': json['pageInfo'] == null ? undefined : PageInfoFromJSON(json['pageInfo']),
+    };
+}
+
+export function SandboxListResponseToJSON(json: any): SandboxListResponse {
+    return SandboxListResponseToJSONTyped(json, false);
+}
+
+export function SandboxListResponseToJSONTyped(value?: SandboxListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'sandboxes': ((value['sandboxes'] as Array<any>).map(SandboxToJSON)),
+        'pageInfo': PageInfoToJSON(value['pageInfo']),
+    };
+}
+

package/src/models/SandboxUsageResponse.ts

@@ -0,0 +1,169 @@
+/* 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 SandboxUsageResponse
+ */
+export interface SandboxUsageResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SandboxUsageResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxUsageResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SandboxUsageResponse
+     */
+    sandboxId: string;
+    /**
+     * The sandbox's current machine size, which sets `billingMultiplier`.
+     * @type {SandboxUsageResponseSandboxTypeEnum}
+     * @memberof SandboxUsageResponse
+     */
+    sandboxType: SandboxUsageResponseSandboxTypeEnum;
+    /**
+     * Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, 2 for `large`, and 50/9 for `xlarge`.
+     * @type {number}
+     * @memberof SandboxUsageResponse
+     */
+    billingMultiplier: number;
+    /**
+     * Start of the window the figures cover. The sandbox's creation time when the request did not pass `since`.
+     * @type {Date}
+     * @memberof SandboxUsageResponse
+     */
+    since: Date;
+    /**
+     * End of the window. Now when the request did not pass `until`, or passed one in the future.
+     * @type {Date}
+     * @memberof SandboxUsageResponse
+     */
+    until: Date;
+    /**
+     * Billable machine-seconds inside the window, the type multiplier already applied: a `large` sandbox that ran ten minutes reads 1200. Includes a running sandbox's time up to `until`. Time while stopped is never counted and time past a refused stop is excluded.
+     * @type {number}
+     * @memberof SandboxUsageResponse
+     */
+    seconds: number;
+    /**
+     * `seconds` at list price (`seconds / secondsPerDollar`), whatever plan, trial or gift actually paid for it. Up to six decimals.
+     * @type {number}
+     * @memberof SandboxUsageResponse
+     */
+    dollars: number;
+    /**
+     * How many billable seconds one dollar buys, so you can price `seconds` yourself.
+     * @type {number}
+     * @memberof SandboxUsageResponse
+     */
+    secondsPerDollar: number;
+    /**
+     * The meter is still moving: the sandbox is up and no refused stop is holding it paused. Read again after it stops for the final figure. `false` on a sandbox that is up but paused past a refused stop, whose figure will not change until it is used again.
+     * @type {boolean}
+     * @memberof SandboxUsageResponse
+     */
+    running: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const SandboxUsageResponseSandboxTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+} as const;
+export type SandboxUsageResponseSandboxTypeEnum = typeof SandboxUsageResponseSandboxTypeEnum[keyof typeof SandboxUsageResponseSandboxTypeEnum];
+
+
+/**
+ * Check if a given object implements the SandboxUsageResponse interface.
+ */
+export function instanceOfSandboxUsageResponse(value: object): value is SandboxUsageResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('sandboxType' in value) || value['sandboxType'] === undefined) return false;
+    if (!('billingMultiplier' in value) || value['billingMultiplier'] === undefined) return false;
+    if (!('since' in value) || value['since'] === undefined) return false;
+    if (!('until' in value) || value['until'] === undefined) return false;
+    if (!('seconds' in value) || value['seconds'] === undefined) return false;
+    if (!('dollars' in value) || value['dollars'] === undefined) return false;
+    if (!('secondsPerDollar' in value) || value['secondsPerDollar'] === undefined) return false;
+    if (!('running' in value) || value['running'] === undefined) return false;
+    return true;
+}
+
+export function SandboxUsageResponseFromJSON(json: any): SandboxUsageResponse {
+    return SandboxUsageResponseFromJSONTyped(json, false);
+}
+
+export function SandboxUsageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxUsageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'sandboxId': json['sandboxId'],
+        'sandboxType': json['sandboxType'],
+        'billingMultiplier': json['billingMultiplier'],
+        'since': (new Date(json['since'])),
+        'until': (new Date(json['until'])),
+        'seconds': json['seconds'],
+        'dollars': json['dollars'],
+        'secondsPerDollar': json['secondsPerDollar'],
+        'running': json['running'],
+    };
+}
+
+export function SandboxUsageResponseToJSON(json: any): SandboxUsageResponse {
+    return SandboxUsageResponseToJSONTyped(json, false);
+}
+
+export function SandboxUsageResponseToJSONTyped(value?: SandboxUsageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'sandboxId': value['sandboxId'],
+        'sandboxType': value['sandboxType'],
+        'billingMultiplier': value['billingMultiplier'],
+        'since': value['since'].toISOString(),
+        'until': value['until'].toISOString(),
+        'seconds': value['seconds'],
+        'dollars': value['dollars'],
+        'secondsPerDollar': value['secondsPerDollar'],
+        'running': value['running'],
+    };
+}
+