@boatdev/sdk 1.0.0

package/src/models/NamedSnapshot.ts

@@ -0,0 +1,137 @@
+/* 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';
+/**
+ * A named snapshot: a frozen copy of a sandbox's disk at one moment, saved under a name you pick. Independent of the source sandbox's later life: the sandbox can change, stop, or be deleted and the named snapshot still deploys. Named snapshots never expire; re-saving a name replaces its artifact.
+ * @export
+ * @interface NamedSnapshot
+ */
+export interface NamedSnapshot {
+    /**
+     * The user-chosen handle, unique within your account.
+     * @type {string}
+     * @memberof NamedSnapshot
+     */
+    name: string;
+    /**
+     * `saving` while the capture and pin are in flight (a live source sandbox takes a fresh snapshot first, which can run minutes), `ready` when deployable, `failed` if the save did not complete (see `error`; save again to retry).
+     * @type {NamedSnapshotStatusEnum}
+     * @memberof NamedSnapshot
+     */
+    status: NamedSnapshotStatusEnum;
+    /**
+     * Failure reason. Only present when `status` is `failed`.
+     * @type {string}
+     * @memberof NamedSnapshot
+     */
+    error?: string;
+    /**
+     * The sandbox this snapshot was saved from (display only).
+     * @type {string}
+     * @memberof NamedSnapshot
+     */
+    sourceSandboxId: string;
+    /**
+     * The frozen artifact behind the name. Present once `status` is `ready`. Accepted by `GET /api/boat/snapshots/{snapshotId}/tree` to browse its files.
+     * @type {string}
+     * @memberof NamedSnapshot
+     */
+    snapshotId?: string;
+    /**
+     * Sandbox type the snapshot was saved from. Deploys default to it.
+     * @type {string}
+     * @memberof NamedSnapshot
+     */
+    type?: string;
+    /**
+     * Restored content size of the frozen state, in bytes.
+     * @type {number}
+     * @memberof NamedSnapshot
+     */
+    sizeBytes?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NamedSnapshot
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotStatusEnum = {
+    Saving: 'saving',
+    Ready: 'ready',
+    Failed: 'failed'
+} as const;
+export type NamedSnapshotStatusEnum = typeof NamedSnapshotStatusEnum[keyof typeof NamedSnapshotStatusEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshot interface.
+ */
+export function instanceOfNamedSnapshot(value: object): value is NamedSnapshot {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('sourceSandboxId' in value) || value['sourceSandboxId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotFromJSON(json: any): NamedSnapshot {
+    return NamedSnapshotFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'status': json['status'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'sourceSandboxId': json['sourceSandboxId'],
+        'snapshotId': json['snapshotId'] == null ? undefined : json['snapshotId'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'sizeBytes': json['sizeBytes'] == null ? undefined : json['sizeBytes'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function NamedSnapshotToJSON(json: any): NamedSnapshot {
+    return NamedSnapshotToJSONTyped(json, false);
+}
+
+export function NamedSnapshotToJSONTyped(value?: NamedSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'status': value['status'],
+        'error': value['error'],
+        'sourceSandboxId': value['sourceSandboxId'],
+        'snapshotId': value['snapshotId'],
+        'type': value['type'],
+        'sizeBytes': value['sizeBytes'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/NamedSnapshotDeletedResponse.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 NamedSnapshotDeletedResponse
+ */
+export interface NamedSnapshotDeletedResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotDeletedResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotDeletedResponseTypeEnum}
+     * @memberof NamedSnapshotDeletedResponse
+     */
+    type: NamedSnapshotDeletedResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof NamedSnapshotDeletedResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {NamedSnapshotDeletedResponseStatusEnum}
+     * @memberof NamedSnapshotDeletedResponse
+     */
+    status: NamedSnapshotDeletedResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotDeletedResponseTypeEnum = {
+    SnapshotNamedDeleted: 'snapshot.named.deleted'
+} as const;
+export type NamedSnapshotDeletedResponseTypeEnum = typeof NamedSnapshotDeletedResponseTypeEnum[keyof typeof NamedSnapshotDeletedResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const NamedSnapshotDeletedResponseStatusEnum = {
+    Deleted: 'deleted'
+} as const;
+export type NamedSnapshotDeletedResponseStatusEnum = typeof NamedSnapshotDeletedResponseStatusEnum[keyof typeof NamedSnapshotDeletedResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotDeletedResponse interface.
+ */
+export function instanceOfNamedSnapshotDeletedResponse(value: object): value is NamedSnapshotDeletedResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotDeletedResponseFromJSON(json: any): NamedSnapshotDeletedResponse {
+    return NamedSnapshotDeletedResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotDeletedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotDeletedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+
+export function NamedSnapshotDeletedResponseToJSON(json: any): NamedSnapshotDeletedResponse {
+    return NamedSnapshotDeletedResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotDeletedResponseToJSONTyped(value?: NamedSnapshotDeletedResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'status': value['status'],
+    };
+}
+

package/src/models/NamedSnapshotInfoResponse.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 { NamedSnapshot } from './NamedSnapshot';
+import {
+    NamedSnapshotFromJSON,
+    NamedSnapshotFromJSONTyped,
+    NamedSnapshotToJSON,
+    NamedSnapshotToJSONTyped,
+} from './NamedSnapshot';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotInfoResponse
+ */
+export interface NamedSnapshotInfoResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotInfoResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotInfoResponseTypeEnum}
+     * @memberof NamedSnapshotInfoResponse
+     */
+    type: NamedSnapshotInfoResponseTypeEnum;
+    /**
+     * 
+     * @type {NamedSnapshot}
+     * @memberof NamedSnapshotInfoResponse
+     */
+    snapshot: NamedSnapshot;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotInfoResponseTypeEnum = {
+    SnapshotNamedInfo: 'snapshot.named.info'
+} as const;
+export type NamedSnapshotInfoResponseTypeEnum = typeof NamedSnapshotInfoResponseTypeEnum[keyof typeof NamedSnapshotInfoResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotInfoResponse interface.
+ */
+export function instanceOfNamedSnapshotInfoResponse(value: object): value is NamedSnapshotInfoResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('snapshot' in value) || value['snapshot'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotInfoResponseFromJSON(json: any): NamedSnapshotInfoResponse {
+    return NamedSnapshotInfoResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotInfoResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshot': NamedSnapshotFromJSON(json['snapshot']),
+    };
+}
+
+export function NamedSnapshotInfoResponseToJSON(json: any): NamedSnapshotInfoResponse {
+    return NamedSnapshotInfoResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotInfoResponseToJSONTyped(value?: NamedSnapshotInfoResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshot': NamedSnapshotToJSON(value['snapshot']),
+    };
+}
+

package/src/models/NamedSnapshotListResponse.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 { NamedSnapshot } from './NamedSnapshot';
+import {
+    NamedSnapshotFromJSON,
+    NamedSnapshotFromJSONTyped,
+    NamedSnapshotToJSON,
+    NamedSnapshotToJSONTyped,
+} from './NamedSnapshot';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotListResponse
+ */
+export interface NamedSnapshotListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotListResponseTypeEnum}
+     * @memberof NamedSnapshotListResponse
+     */
+    type: NamedSnapshotListResponseTypeEnum;
+    /**
+     * 
+     * @type {Array<NamedSnapshot>}
+     * @memberof NamedSnapshotListResponse
+     */
+    snapshots: Array<NamedSnapshot>;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotListResponseTypeEnum = {
+    SnapshotNamedList: 'snapshot.named.list'
+} as const;
+export type NamedSnapshotListResponseTypeEnum = typeof NamedSnapshotListResponseTypeEnum[keyof typeof NamedSnapshotListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotListResponse interface.
+ */
+export function instanceOfNamedSnapshotListResponse(value: object): value is NamedSnapshotListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('snapshots' in value) || value['snapshots'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotListResponseFromJSON(json: any): NamedSnapshotListResponse {
+    return NamedSnapshotListResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshots': ((json['snapshots'] as Array<any>).map(NamedSnapshotFromJSON)),
+    };
+}
+
+export function NamedSnapshotListResponseToJSON(json: any): NamedSnapshotListResponse {
+    return NamedSnapshotListResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotListResponseToJSONTyped(value?: NamedSnapshotListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshots': ((value['snapshots'] as Array<any>).map(NamedSnapshotToJSON)),
+    };
+}
+

package/src/models/NamedSnapshotSaveRequest.ts

@@ -0,0 +1,75 @@
+/* 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 NamedSnapshotSaveRequest
+ */
+export interface NamedSnapshotSaveRequest {
+    /**
+     * The sandbox whose current state to freeze.
+     * @type {string}
+     * @memberof NamedSnapshotSaveRequest
+     */
+    sandboxId: string;
+    /**
+     * Name to save under. 1-63 lowercase letters, digits, or dashes, starting with a letter or digit. Reusing one of your existing names replaces that snapshot's artifact. `latest`, `tree`, `pull`, `rm`, `save`, `current`, `self`, and `new` are reserved.
+     * @type {string}
+     * @memberof NamedSnapshotSaveRequest
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the NamedSnapshotSaveRequest interface.
+ */
+export function instanceOfNamedSnapshotSaveRequest(value: object): value is NamedSnapshotSaveRequest {
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotSaveRequestFromJSON(json: any): NamedSnapshotSaveRequest {
+    return NamedSnapshotSaveRequestFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotSaveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotSaveRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandboxId': json['sandboxId'],
+        'name': json['name'],
+    };
+}
+
+export function NamedSnapshotSaveRequestToJSON(json: any): NamedSnapshotSaveRequest {
+    return NamedSnapshotSaveRequestToJSONTyped(json, false);
+}
+
+export function NamedSnapshotSaveRequestToJSONTyped(value?: NamedSnapshotSaveRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandboxId': value['sandboxId'],
+        'name': value['name'],
+    };
+}
+

package/src/models/NamedSnapshotSavingResponse.ts

@@ -0,0 +1,119 @@
+/* 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 { NamedSnapshot } from './NamedSnapshot';
+import {
+    NamedSnapshotFromJSON,
+    NamedSnapshotFromJSONTyped,
+    NamedSnapshotToJSON,
+    NamedSnapshotToJSONTyped,
+} from './NamedSnapshot';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotSavingResponse
+ */
+export interface NamedSnapshotSavingResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotSavingResponseTypeEnum}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    type: NamedSnapshotSavingResponseTypeEnum;
+    /**
+     * 
+     * @type {NamedSnapshotSavingResponseStatusEnum}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    status: NamedSnapshotSavingResponseStatusEnum;
+    /**
+     * 
+     * @type {NamedSnapshot}
+     * @memberof NamedSnapshotSavingResponse
+     */
+    snapshot: NamedSnapshot;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotSavingResponseTypeEnum = {
+    SnapshotNamedSaving: 'snapshot.named.saving'
+} as const;
+export type NamedSnapshotSavingResponseTypeEnum = typeof NamedSnapshotSavingResponseTypeEnum[keyof typeof NamedSnapshotSavingResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const NamedSnapshotSavingResponseStatusEnum = {
+    Saving: 'saving'
+} as const;
+export type NamedSnapshotSavingResponseStatusEnum = typeof NamedSnapshotSavingResponseStatusEnum[keyof typeof NamedSnapshotSavingResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotSavingResponse interface.
+ */
+export function instanceOfNamedSnapshotSavingResponse(value: object): value is NamedSnapshotSavingResponse {
+    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 (!('snapshot' in value) || value['snapshot'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotSavingResponseFromJSON(json: any): NamedSnapshotSavingResponse {
+    return NamedSnapshotSavingResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotSavingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotSavingResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'status': json['status'],
+        'snapshot': NamedSnapshotFromJSON(json['snapshot']),
+    };
+}
+
+export function NamedSnapshotSavingResponseToJSON(json: any): NamedSnapshotSavingResponse {
+    return NamedSnapshotSavingResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotSavingResponseToJSONTyped(value?: NamedSnapshotSavingResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'snapshot': NamedSnapshotToJSON(value['snapshot']),
+    };
+}
+