@boatdev/sdk 1.9.9 → 1.11.0

package/dist/models/SavedSnapshot.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.
+ */
+/**
+ * A saved 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 saved snapshot still deploys. Saved snapshots never expire; re-saving a name replaces its artifact.
+ * @export
+ * @interface SavedSnapshot
+ */
+export interface SavedSnapshot {
+    /**
+     * The user-chosen handle, unique within your account.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    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 {SavedSnapshotStatusEnum}
+     * @memberof SavedSnapshot
+     */
+    status: SavedSnapshotStatusEnum;
+    /**
+     * Failure reason. Only present when `status` is `failed`.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    error?: string;
+    /**
+     * The sandbox this snapshot was saved from (display only).
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    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 SavedSnapshot
+     */
+    snapshotId?: string;
+    /**
+     * Sandbox type the snapshot was saved from. Deploys default to it.
+     * @type {string}
+     * @memberof SavedSnapshot
+     */
+    type?: string;
+    /**
+     * Restored content size of the frozen state, in bytes.
+     * @type {number}
+     * @memberof SavedSnapshot
+     */
+    sizeBytes?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof SavedSnapshot
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const SavedSnapshotStatusEnum: {
+    readonly Saving: 'saving';
+    readonly Ready: 'ready';
+    readonly Failed: 'failed';
+};
+export type SavedSnapshotStatusEnum = typeof SavedSnapshotStatusEnum[keyof typeof SavedSnapshotStatusEnum];
+/**
+ * Check if a given object implements the SavedSnapshot interface.
+ */
+export declare function instanceOfSavedSnapshot(value: object): value is SavedSnapshot;
+export declare function SavedSnapshotFromJSON(json: any): SavedSnapshot;
+export declare function SavedSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshot;
+export declare function SavedSnapshotToJSON(json: any): SavedSnapshot;
+export declare function SavedSnapshotToJSONTyped(value?: SavedSnapshot | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SavedSnapshot.js

@@ -0,0 +1,79 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SavedSnapshotStatusEnum = void 0;
+exports.instanceOfSavedSnapshot = instanceOfSavedSnapshot;
+exports.SavedSnapshotFromJSON = SavedSnapshotFromJSON;
+exports.SavedSnapshotFromJSONTyped = SavedSnapshotFromJSONTyped;
+exports.SavedSnapshotToJSON = SavedSnapshotToJSON;
+exports.SavedSnapshotToJSONTyped = SavedSnapshotToJSONTyped;
+/**
+ * @export
+ */
+exports.SavedSnapshotStatusEnum = {
+    Saving: 'saving',
+    Ready: 'ready',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the SavedSnapshot interface.
+ */
+function instanceOfSavedSnapshot(value) {
+    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;
+}
+function SavedSnapshotFromJSON(json) {
+    return SavedSnapshotFromJSONTyped(json, false);
+}
+function SavedSnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    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'])),
+    };
+}
+function SavedSnapshotToJSON(json) {
+    return SavedSnapshotToJSONTyped(json, false);
+}
+function SavedSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/SavedSnapshotAllowance.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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.
+ */
+/**
+ * What the request's wallet (your active organization, `?org=`, or personal) pays for saved snapshots. 10 are free per wallet; each one above costs $1.70 a month, charged daily from usage. An organization's count includes every member's names billed to it.
+ * @export
+ * @interface SavedSnapshotAllowance
+ */
+export interface SavedSnapshotAllowance {
+    /**
+     * Organization the numbers are for. null = personal.
+     * @type {string}
+     * @memberof SavedSnapshotAllowance
+     */
+    org?: string | null;
+    /**
+     * That organization's name.
+     * @type {string}
+     * @memberof SavedSnapshotAllowance
+     */
+    orgName?: string | null;
+    /**
+     * Saved snapshots the plan includes: 10 per $20 of plan per seat, never fewer than 10.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    included?: number;
+    /**
+     * Same value as included. Kept for older clients.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     * @deprecated
+     */
+    free?: number;
+    /**
+     * Saved snapshots this wallet keeps.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    used?: number;
+    /**
+     * Saved snapshots above the included ones.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    extra?: number;
+    /**
+     * What the extra ones cost per month.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    extraMonthlyDollars?: number;
+    /**
+     * Boat time the extra ones take per day, in dollars (the daily charge).
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    extraDailyDollars?: number;
+    /**
+     * Monthly price of one extra saved snapshot.
+     * @type {number}
+     * @memberof SavedSnapshotAllowance
+     */
+    pricePerExtraMonthlyDollars?: number;
+}
+/**
+ * Check if a given object implements the SavedSnapshotAllowance interface.
+ */
+export declare function instanceOfSavedSnapshotAllowance(value: object): value is SavedSnapshotAllowance;
+export declare function SavedSnapshotAllowanceFromJSON(json: any): SavedSnapshotAllowance;
+export declare function SavedSnapshotAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotAllowance;
+export declare function SavedSnapshotAllowanceToJSON(json: any): SavedSnapshotAllowance;
+export declare function SavedSnapshotAllowanceToJSONTyped(value?: SavedSnapshotAllowance | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SavedSnapshotAllowance.js

@@ -0,0 +1,64 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSavedSnapshotAllowance = instanceOfSavedSnapshotAllowance;
+exports.SavedSnapshotAllowanceFromJSON = SavedSnapshotAllowanceFromJSON;
+exports.SavedSnapshotAllowanceFromJSONTyped = SavedSnapshotAllowanceFromJSONTyped;
+exports.SavedSnapshotAllowanceToJSON = SavedSnapshotAllowanceToJSON;
+exports.SavedSnapshotAllowanceToJSONTyped = SavedSnapshotAllowanceToJSONTyped;
+/**
+ * Check if a given object implements the SavedSnapshotAllowance interface.
+ */
+function instanceOfSavedSnapshotAllowance(value) {
+    return true;
+}
+function SavedSnapshotAllowanceFromJSON(json) {
+    return SavedSnapshotAllowanceFromJSONTyped(json, false);
+}
+function SavedSnapshotAllowanceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'org': json['org'] == null ? undefined : json['org'],
+        'orgName': json['orgName'] == null ? undefined : json['orgName'],
+        'included': json['included'] == null ? undefined : json['included'],
+        'free': json['free'] == null ? undefined : json['free'],
+        'used': json['used'] == null ? undefined : json['used'],
+        'extra': json['extra'] == null ? undefined : json['extra'],
+        'extraMonthlyDollars': json['extraMonthlyDollars'] == null ? undefined : json['extraMonthlyDollars'],
+        'extraDailyDollars': json['extraDailyDollars'] == null ? undefined : json['extraDailyDollars'],
+        'pricePerExtraMonthlyDollars': json['pricePerExtraMonthlyDollars'] == null ? undefined : json['pricePerExtraMonthlyDollars'],
+    };
+}
+function SavedSnapshotAllowanceToJSON(json) {
+    return SavedSnapshotAllowanceToJSONTyped(json, false);
+}
+function SavedSnapshotAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'org': value['org'],
+        'orgName': value['orgName'],
+        'included': value['included'],
+        'free': value['free'],
+        'used': value['used'],
+        'extra': value['extra'],
+        'extraMonthlyDollars': value['extraMonthlyDollars'],
+        'extraDailyDollars': value['extraDailyDollars'],
+        'pricePerExtraMonthlyDollars': value['pricePerExtraMonthlyDollars'],
+    };
+}

package/dist/models/SavedSnapshotDeletedResponse.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 SavedSnapshotDeletedResponse
+ */
+export interface SavedSnapshotDeletedResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SavedSnapshotDeletedResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {SavedSnapshotDeletedResponseTypeEnum}
+     * @memberof SavedSnapshotDeletedResponse
+     */
+    type: SavedSnapshotDeletedResponseTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SavedSnapshotDeletedResponse
+     */
+    name: string;
+    /**
+     *
+     * @type {SavedSnapshotDeletedResponseStatusEnum}
+     * @memberof SavedSnapshotDeletedResponse
+     */
+    status: SavedSnapshotDeletedResponseStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const SavedSnapshotDeletedResponseTypeEnum: {
+    readonly SnapshotSavedDeleted: 'snapshot.saved.deleted';
+};
+export type SavedSnapshotDeletedResponseTypeEnum = typeof SavedSnapshotDeletedResponseTypeEnum[keyof typeof SavedSnapshotDeletedResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const SavedSnapshotDeletedResponseStatusEnum: {
+    readonly Deleted: 'deleted';
+};
+export type SavedSnapshotDeletedResponseStatusEnum = typeof SavedSnapshotDeletedResponseStatusEnum[keyof typeof SavedSnapshotDeletedResponseStatusEnum];
+/**
+ * Check if a given object implements the SavedSnapshotDeletedResponse interface.
+ */
+export declare function instanceOfSavedSnapshotDeletedResponse(value: object): value is SavedSnapshotDeletedResponse;
+export declare function SavedSnapshotDeletedResponseFromJSON(json: any): SavedSnapshotDeletedResponse;
+export declare function SavedSnapshotDeletedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotDeletedResponse;
+export declare function SavedSnapshotDeletedResponseToJSON(json: any): SavedSnapshotDeletedResponse;
+export declare function SavedSnapshotDeletedResponseToJSONTyped(value?: SavedSnapshotDeletedResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SavedSnapshotDeletedResponse.js

@@ -0,0 +1,75 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SavedSnapshotDeletedResponseStatusEnum = exports.SavedSnapshotDeletedResponseTypeEnum = void 0;
+exports.instanceOfSavedSnapshotDeletedResponse = instanceOfSavedSnapshotDeletedResponse;
+exports.SavedSnapshotDeletedResponseFromJSON = SavedSnapshotDeletedResponseFromJSON;
+exports.SavedSnapshotDeletedResponseFromJSONTyped = SavedSnapshotDeletedResponseFromJSONTyped;
+exports.SavedSnapshotDeletedResponseToJSON = SavedSnapshotDeletedResponseToJSON;
+exports.SavedSnapshotDeletedResponseToJSONTyped = SavedSnapshotDeletedResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.SavedSnapshotDeletedResponseTypeEnum = {
+    SnapshotSavedDeleted: 'snapshot.saved.deleted'
+};
+/**
+ * @export
+ */
+exports.SavedSnapshotDeletedResponseStatusEnum = {
+    Deleted: 'deleted'
+};
+/**
+ * Check if a given object implements the SavedSnapshotDeletedResponse interface.
+ */
+function instanceOfSavedSnapshotDeletedResponse(value) {
+    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;
+}
+function SavedSnapshotDeletedResponseFromJSON(json) {
+    return SavedSnapshotDeletedResponseFromJSONTyped(json, false);
+}
+function SavedSnapshotDeletedResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+function SavedSnapshotDeletedResponseToJSON(json) {
+    return SavedSnapshotDeletedResponseToJSONTyped(json, false);
+}
+function SavedSnapshotDeletedResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'status': value['status'],
+    };
+}

package/dist/models/SavedSnapshotInfoResponse.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.
+ */
+import type { SavedSnapshot } from './SavedSnapshot';
+/**
+ *
+ * @export
+ * @interface SavedSnapshotInfoResponse
+ */
+export interface SavedSnapshotInfoResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SavedSnapshotInfoResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {SavedSnapshotInfoResponseTypeEnum}
+     * @memberof SavedSnapshotInfoResponse
+     */
+    type: SavedSnapshotInfoResponseTypeEnum;
+    /**
+     *
+     * @type {SavedSnapshot}
+     * @memberof SavedSnapshotInfoResponse
+     */
+    snapshot: SavedSnapshot;
+}
+/**
+ * @export
+ */
+export declare const SavedSnapshotInfoResponseTypeEnum: {
+    readonly SnapshotSavedInfo: 'snapshot.saved.info';
+};
+export type SavedSnapshotInfoResponseTypeEnum = typeof SavedSnapshotInfoResponseTypeEnum[keyof typeof SavedSnapshotInfoResponseTypeEnum];
+/**
+ * Check if a given object implements the SavedSnapshotInfoResponse interface.
+ */
+export declare function instanceOfSavedSnapshotInfoResponse(value: object): value is SavedSnapshotInfoResponse;
+export declare function SavedSnapshotInfoResponseFromJSON(json: any): SavedSnapshotInfoResponse;
+export declare function SavedSnapshotInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotInfoResponse;
+export declare function SavedSnapshotInfoResponseToJSON(json: any): SavedSnapshotInfoResponse;
+export declare function SavedSnapshotInfoResponseToJSONTyped(value?: SavedSnapshotInfoResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SavedSnapshotInfoResponse.js

@@ -0,0 +1,66 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SavedSnapshotInfoResponseTypeEnum = void 0;
+exports.instanceOfSavedSnapshotInfoResponse = instanceOfSavedSnapshotInfoResponse;
+exports.SavedSnapshotInfoResponseFromJSON = SavedSnapshotInfoResponseFromJSON;
+exports.SavedSnapshotInfoResponseFromJSONTyped = SavedSnapshotInfoResponseFromJSONTyped;
+exports.SavedSnapshotInfoResponseToJSON = SavedSnapshotInfoResponseToJSON;
+exports.SavedSnapshotInfoResponseToJSONTyped = SavedSnapshotInfoResponseToJSONTyped;
+const SavedSnapshot_1 = require("./SavedSnapshot");
+/**
+ * @export
+ */
+exports.SavedSnapshotInfoResponseTypeEnum = {
+    SnapshotSavedInfo: 'snapshot.saved.info'
+};
+/**
+ * Check if a given object implements the SavedSnapshotInfoResponse interface.
+ */
+function instanceOfSavedSnapshotInfoResponse(value) {
+    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;
+}
+function SavedSnapshotInfoResponseFromJSON(json) {
+    return SavedSnapshotInfoResponseFromJSONTyped(json, false);
+}
+function SavedSnapshotInfoResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshot': (0, SavedSnapshot_1.SavedSnapshotFromJSON)(json['snapshot']),
+    };
+}
+function SavedSnapshotInfoResponseToJSON(json) {
+    return SavedSnapshotInfoResponseToJSONTyped(json, false);
+}
+function SavedSnapshotInfoResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshot': (0, SavedSnapshot_1.SavedSnapshotToJSON)(value['snapshot']),
+    };
+}

package/dist/models/SavedSnapshotListResponse.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { SavedSnapshot } from './SavedSnapshot';
+import type { SavedSnapshotAllowance } from './SavedSnapshotAllowance';
+/**
+ *
+ * @export
+ * @interface SavedSnapshotListResponse
+ */
+export interface SavedSnapshotListResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SavedSnapshotListResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {SavedSnapshotListResponseTypeEnum}
+     * @memberof SavedSnapshotListResponse
+     */
+    type: SavedSnapshotListResponseTypeEnum;
+    /**
+     *
+     * @type {Array<SavedSnapshot>}
+     * @memberof SavedSnapshotListResponse
+     */
+    snapshots: Array<SavedSnapshot>;
+    /**
+     *
+     * @type {SavedSnapshotAllowance}
+     * @memberof SavedSnapshotListResponse
+     */
+    allowance?: SavedSnapshotAllowance;
+}
+/**
+ * @export
+ */
+export declare const SavedSnapshotListResponseTypeEnum: {
+    readonly SnapshotSavedList: 'snapshot.saved.list';
+};
+export type SavedSnapshotListResponseTypeEnum = typeof SavedSnapshotListResponseTypeEnum[keyof typeof SavedSnapshotListResponseTypeEnum];
+/**
+ * Check if a given object implements the SavedSnapshotListResponse interface.
+ */
+export declare function instanceOfSavedSnapshotListResponse(value: object): value is SavedSnapshotListResponse;
+export declare function SavedSnapshotListResponseFromJSON(json: any): SavedSnapshotListResponse;
+export declare function SavedSnapshotListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotListResponse;
+export declare function SavedSnapshotListResponseToJSON(json: any): SavedSnapshotListResponse;
+export declare function SavedSnapshotListResponseToJSONTyped(value?: SavedSnapshotListResponse | null, ignoreDiscriminator?: boolean): any;