@boatdev/sdk 1.10.0 → 1.11.0

package/src/models/SavedSnapshotAllowance.ts

@@ -0,0 +1,130 @@
+/* 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';
+/**
+ * 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 function instanceOfSavedSnapshotAllowance(value: object): value is SavedSnapshotAllowance {
+    return true;
+}
+
+export function SavedSnapshotAllowanceFromJSON(json: any): SavedSnapshotAllowance {
+    return SavedSnapshotAllowanceFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotAllowance {
+    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'],
+    };
+}
+
+export function SavedSnapshotAllowanceToJSON(json: any): SavedSnapshotAllowance {
+    return SavedSnapshotAllowanceToJSONTyped(json, false);
+}
+
+export function SavedSnapshotAllowanceToJSONTyped(value?: SavedSnapshotAllowance | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/SavedSnapshotDeletedResponse.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 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 const SavedSnapshotDeletedResponseTypeEnum = {
+    SnapshotSavedDeleted: 'snapshot.saved.deleted'
+} as const;
+export type SavedSnapshotDeletedResponseTypeEnum = typeof SavedSnapshotDeletedResponseTypeEnum[keyof typeof SavedSnapshotDeletedResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const SavedSnapshotDeletedResponseStatusEnum = {
+    Deleted: 'deleted'
+} as const;
+export type SavedSnapshotDeletedResponseStatusEnum = typeof SavedSnapshotDeletedResponseStatusEnum[keyof typeof SavedSnapshotDeletedResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the SavedSnapshotDeletedResponse interface.
+ */
+export function instanceOfSavedSnapshotDeletedResponse(value: object): value is SavedSnapshotDeletedResponse {
+    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 SavedSnapshotDeletedResponseFromJSON(json: any): SavedSnapshotDeletedResponse {
+    return SavedSnapshotDeletedResponseFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotDeletedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotDeletedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+
+export function SavedSnapshotDeletedResponseToJSON(json: any): SavedSnapshotDeletedResponse {
+    return SavedSnapshotDeletedResponseToJSONTyped(json, false);
+}
+
+export function SavedSnapshotDeletedResponseToJSONTyped(value?: SavedSnapshotDeletedResponse | 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/SavedSnapshotInfoResponse.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 { SavedSnapshot } from './SavedSnapshot';
+import {
+    SavedSnapshotFromJSON,
+    SavedSnapshotFromJSONTyped,
+    SavedSnapshotToJSON,
+    SavedSnapshotToJSONTyped,
+} 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 const SavedSnapshotInfoResponseTypeEnum = {
+    SnapshotSavedInfo: 'snapshot.saved.info'
+} as const;
+export type SavedSnapshotInfoResponseTypeEnum = typeof SavedSnapshotInfoResponseTypeEnum[keyof typeof SavedSnapshotInfoResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SavedSnapshotInfoResponse interface.
+ */
+export function instanceOfSavedSnapshotInfoResponse(value: object): value is SavedSnapshotInfoResponse {
+    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 SavedSnapshotInfoResponseFromJSON(json: any): SavedSnapshotInfoResponse {
+    return SavedSnapshotInfoResponseFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotInfoResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshot': SavedSnapshotFromJSON(json['snapshot']),
+    };
+}
+
+export function SavedSnapshotInfoResponseToJSON(json: any): SavedSnapshotInfoResponse {
+    return SavedSnapshotInfoResponseToJSONTyped(json, false);
+}
+
+export function SavedSnapshotInfoResponseToJSONTyped(value?: SavedSnapshotInfoResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshot': SavedSnapshotToJSON(value['snapshot']),
+    };
+}
+

package/src/models/SavedSnapshotListResponse.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 { SavedSnapshot } from './SavedSnapshot';
+import {
+    SavedSnapshotFromJSON,
+    SavedSnapshotFromJSONTyped,
+    SavedSnapshotToJSON,
+    SavedSnapshotToJSONTyped,
+} from './SavedSnapshot';
+import type { SavedSnapshotAllowance } from './SavedSnapshotAllowance';
+import {
+    SavedSnapshotAllowanceFromJSON,
+    SavedSnapshotAllowanceFromJSONTyped,
+    SavedSnapshotAllowanceToJSON,
+    SavedSnapshotAllowanceToJSONTyped,
+} 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 const SavedSnapshotListResponseTypeEnum = {
+    SnapshotSavedList: 'snapshot.saved.list'
+} as const;
+export type SavedSnapshotListResponseTypeEnum = typeof SavedSnapshotListResponseTypeEnum[keyof typeof SavedSnapshotListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SavedSnapshotListResponse interface.
+ */
+export function instanceOfSavedSnapshotListResponse(value: object): value is SavedSnapshotListResponse {
+    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 SavedSnapshotListResponseFromJSON(json: any): SavedSnapshotListResponse {
+    return SavedSnapshotListResponseFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshots': ((json['snapshots'] as Array<any>).map(SavedSnapshotFromJSON)),
+        'allowance': json['allowance'] == null ? undefined : SavedSnapshotAllowanceFromJSON(json['allowance']),
+    };
+}
+
+export function SavedSnapshotListResponseToJSON(json: any): SavedSnapshotListResponse {
+    return SavedSnapshotListResponseToJSONTyped(json, false);
+}
+
+export function SavedSnapshotListResponseToJSONTyped(value?: SavedSnapshotListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshots': ((value['snapshots'] as Array<any>).map(SavedSnapshotToJSON)),
+        'allowance': SavedSnapshotAllowanceToJSON(value['allowance']),
+    };
+}
+

package/src/models/SavedSnapshotSaveRequest.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 SavedSnapshotSaveRequest
+ */
+export interface SavedSnapshotSaveRequest {
+    /**
+     * The sandbox whose current state to freeze.
+     * @type {string}
+     * @memberof SavedSnapshotSaveRequest
+     */
+    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 SavedSnapshotSaveRequest
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the SavedSnapshotSaveRequest interface.
+ */
+export function instanceOfSavedSnapshotSaveRequest(value: object): value is SavedSnapshotSaveRequest {
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function SavedSnapshotSaveRequestFromJSON(json: any): SavedSnapshotSaveRequest {
+    return SavedSnapshotSaveRequestFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotSaveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotSaveRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandboxId': json['sandboxId'],
+        'name': json['name'],
+    };
+}
+
+export function SavedSnapshotSaveRequestToJSON(json: any): SavedSnapshotSaveRequest {
+    return SavedSnapshotSaveRequestToJSONTyped(json, false);
+}
+
+export function SavedSnapshotSaveRequestToJSONTyped(value?: SavedSnapshotSaveRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandboxId': value['sandboxId'],
+        'name': value['name'],
+    };
+}
+

package/src/models/SavedSnapshotSavingResponse.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 { SavedSnapshot } from './SavedSnapshot';
+import {
+    SavedSnapshotFromJSON,
+    SavedSnapshotFromJSONTyped,
+    SavedSnapshotToJSON,
+    SavedSnapshotToJSONTyped,
+} from './SavedSnapshot';
+
+/**
+ * 
+ * @export
+ * @interface SavedSnapshotSavingResponse
+ */
+export interface SavedSnapshotSavingResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SavedSnapshotSavingResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SavedSnapshotSavingResponseTypeEnum}
+     * @memberof SavedSnapshotSavingResponse
+     */
+    type: SavedSnapshotSavingResponseTypeEnum;
+    /**
+     * 
+     * @type {SavedSnapshotSavingResponseStatusEnum}
+     * @memberof SavedSnapshotSavingResponse
+     */
+    status: SavedSnapshotSavingResponseStatusEnum;
+    /**
+     * 
+     * @type {SavedSnapshot}
+     * @memberof SavedSnapshotSavingResponse
+     */
+    snapshot: SavedSnapshot;
+}
+
+
+/**
+ * @export
+ */
+export const SavedSnapshotSavingResponseTypeEnum = {
+    SnapshotSavedSaving: 'snapshot.saved.saving'
+} as const;
+export type SavedSnapshotSavingResponseTypeEnum = typeof SavedSnapshotSavingResponseTypeEnum[keyof typeof SavedSnapshotSavingResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const SavedSnapshotSavingResponseStatusEnum = {
+    Saving: 'saving'
+} as const;
+export type SavedSnapshotSavingResponseStatusEnum = typeof SavedSnapshotSavingResponseStatusEnum[keyof typeof SavedSnapshotSavingResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the SavedSnapshotSavingResponse interface.
+ */
+export function instanceOfSavedSnapshotSavingResponse(value: object): value is SavedSnapshotSavingResponse {
+    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 SavedSnapshotSavingResponseFromJSON(json: any): SavedSnapshotSavingResponse {
+    return SavedSnapshotSavingResponseFromJSONTyped(json, false);
+}
+
+export function SavedSnapshotSavingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SavedSnapshotSavingResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'status': json['status'],
+        'snapshot': SavedSnapshotFromJSON(json['snapshot']),
+    };
+}
+
+export function SavedSnapshotSavingResponseToJSON(json: any): SavedSnapshotSavingResponse {
+    return SavedSnapshotSavingResponseToJSONTyped(json, false);
+}
+
+export function SavedSnapshotSavingResponseToJSONTyped(value?: SavedSnapshotSavingResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'snapshot': SavedSnapshotToJSON(value['snapshot']),
+    };
+}
+

package/src/models/SnapshotSummary.ts

@@ -92,7 +92,7 @@ export interface SnapshotSummary {
      */
     contentFileCount?: number | null;
     /**
-     * `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, named snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
+     * `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, saved snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
      * @type {SnapshotSummaryOriginEnum}
      * @memberof SnapshotSummary
      */