@boatdev/sdk 1.0.0

package/src/models/SnapshotDownloadResponse.ts

@@ -0,0 +1,181 @@
+/* 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 { SnapshotChunk } from './SnapshotChunk';
+import {
+    SnapshotChunkFromJSON,
+    SnapshotChunkFromJSONTyped,
+    SnapshotChunkToJSON,
+    SnapshotChunkToJSONTyped,
+} from './SnapshotChunk';
+import type { SnapshotDownloadResponseAllOfInventory } from './SnapshotDownloadResponseAllOfInventory';
+import {
+    SnapshotDownloadResponseAllOfInventoryFromJSON,
+    SnapshotDownloadResponseAllOfInventoryFromJSONTyped,
+    SnapshotDownloadResponseAllOfInventoryToJSON,
+    SnapshotDownloadResponseAllOfInventoryToJSONTyped,
+} from './SnapshotDownloadResponseAllOfInventory';
+
+/**
+ * 
+ * @export
+ * @interface SnapshotDownloadResponse
+ */
+export interface SnapshotDownloadResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapshotDownloadResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SnapshotDownloadResponseTypeEnum}
+     * @memberof SnapshotDownloadResponse
+     */
+    type: SnapshotDownloadResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotDownloadResponse
+     */
+    snapshotId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotDownloadResponse
+     */
+    sandboxId: string;
+    /**
+     * 
+     * @type {SnapshotDownloadResponseKindEnum}
+     * @memberof SnapshotDownloadResponse
+     */
+    kind: SnapshotDownloadResponseKindEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapshotDownloadResponse
+     */
+    generation: number;
+    /**
+     * Lifetime of every `signedUrl` in this response.
+     * @type {number}
+     * @memberof SnapshotDownloadResponse
+     */
+    expiresInSeconds: number;
+    /**
+     * Human-readable note on how to reassemble the chunks into a filesystem.
+     * @type {string}
+     * @memberof SnapshotDownloadResponse
+     */
+    reconstruct: string;
+    /**
+     * 
+     * @type {SnapshotDownloadResponseAllOfInventory}
+     * @memberof SnapshotDownloadResponse
+     */
+    inventory?: SnapshotDownloadResponseAllOfInventory | null;
+    /**
+     * Every chunk across the chain (all generations up to and including this snapshot), ordered by `(generation, chunkIndex)`.
+     * @type {Array<SnapshotChunk>}
+     * @memberof SnapshotDownloadResponse
+     */
+    chunks: Array<SnapshotChunk>;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotDownloadResponseTypeEnum = {
+    SnapshotDownload: 'snapshot.download'
+} as const;
+export type SnapshotDownloadResponseTypeEnum = typeof SnapshotDownloadResponseTypeEnum[keyof typeof SnapshotDownloadResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const SnapshotDownloadResponseKindEnum = {
+    Base: 'base',
+    Incremental: 'incremental',
+    Legacy: 'legacy'
+} as const;
+export type SnapshotDownloadResponseKindEnum = typeof SnapshotDownloadResponseKindEnum[keyof typeof SnapshotDownloadResponseKindEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotDownloadResponse interface.
+ */
+export function instanceOfSnapshotDownloadResponse(value: object): value is SnapshotDownloadResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('snapshotId' in value) || value['snapshotId'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('generation' in value) || value['generation'] === undefined) return false;
+    if (!('expiresInSeconds' in value) || value['expiresInSeconds'] === undefined) return false;
+    if (!('reconstruct' in value) || value['reconstruct'] === undefined) return false;
+    if (!('chunks' in value) || value['chunks'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotDownloadResponseFromJSON(json: any): SnapshotDownloadResponse {
+    return SnapshotDownloadResponseFromJSONTyped(json, false);
+}
+
+export function SnapshotDownloadResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotDownloadResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshotId': json['snapshotId'],
+        'sandboxId': json['sandboxId'],
+        'kind': json['kind'],
+        'generation': json['generation'],
+        'expiresInSeconds': json['expiresInSeconds'],
+        'reconstruct': json['reconstruct'],
+        'inventory': json['inventory'] == null ? undefined : SnapshotDownloadResponseAllOfInventoryFromJSON(json['inventory']),
+        'chunks': ((json['chunks'] as Array<any>).map(SnapshotChunkFromJSON)),
+    };
+}
+
+export function SnapshotDownloadResponseToJSON(json: any): SnapshotDownloadResponse {
+    return SnapshotDownloadResponseToJSONTyped(json, false);
+}
+
+export function SnapshotDownloadResponseToJSONTyped(value?: SnapshotDownloadResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshotId': value['snapshotId'],
+        'sandboxId': value['sandboxId'],
+        'kind': value['kind'],
+        'generation': value['generation'],
+        'expiresInSeconds': value['expiresInSeconds'],
+        'reconstruct': value['reconstruct'],
+        'inventory': SnapshotDownloadResponseAllOfInventoryToJSON(value['inventory']),
+        'chunks': ((value['chunks'] as Array<any>).map(SnapshotChunkToJSON)),
+    };
+}
+

package/src/models/SnapshotDownloadResponseAllOfInventory.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 SnapshotDownloadResponseAllOfInventory
+ */
+export interface SnapshotDownloadResponseAllOfInventory {
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotDownloadResponseAllOfInventory
+     */
+    r2Key: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotDownloadResponseAllOfInventory
+     */
+    signedUrl: string;
+}
+
+/**
+ * Check if a given object implements the SnapshotDownloadResponseAllOfInventory interface.
+ */
+export function instanceOfSnapshotDownloadResponseAllOfInventory(value: object): value is SnapshotDownloadResponseAllOfInventory {
+    if (!('r2Key' in value) || value['r2Key'] === undefined) return false;
+    if (!('signedUrl' in value) || value['signedUrl'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotDownloadResponseAllOfInventoryFromJSON(json: any): SnapshotDownloadResponseAllOfInventory {
+    return SnapshotDownloadResponseAllOfInventoryFromJSONTyped(json, false);
+}
+
+export function SnapshotDownloadResponseAllOfInventoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotDownloadResponseAllOfInventory {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'r2Key': json['r2Key'],
+        'signedUrl': json['signedUrl'],
+    };
+}
+
+export function SnapshotDownloadResponseAllOfInventoryToJSON(json: any): SnapshotDownloadResponseAllOfInventory {
+    return SnapshotDownloadResponseAllOfInventoryToJSONTyped(json, false);
+}
+
+export function SnapshotDownloadResponseAllOfInventoryToJSONTyped(value?: SnapshotDownloadResponseAllOfInventory | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'r2Key': value['r2Key'],
+        'signedUrl': value['signedUrl'],
+    };
+}
+

package/src/models/SnapshotLatestResponse.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 { SnapshotSummary } from './SnapshotSummary';
+import {
+    SnapshotSummaryFromJSON,
+    SnapshotSummaryFromJSONTyped,
+    SnapshotSummaryToJSON,
+    SnapshotSummaryToJSONTyped,
+} from './SnapshotSummary';
+
+/**
+ * 
+ * @export
+ * @interface SnapshotLatestResponse
+ */
+export interface SnapshotLatestResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapshotLatestResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SnapshotLatestResponseTypeEnum}
+     * @memberof SnapshotLatestResponse
+     */
+    type: SnapshotLatestResponseTypeEnum;
+    /**
+     * 
+     * @type {SnapshotSummary}
+     * @memberof SnapshotLatestResponse
+     */
+    snapshot: SnapshotSummary | null;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotLatestResponseTypeEnum = {
+    SnapshotLatest: 'snapshot.latest'
+} as const;
+export type SnapshotLatestResponseTypeEnum = typeof SnapshotLatestResponseTypeEnum[keyof typeof SnapshotLatestResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotLatestResponse interface.
+ */
+export function instanceOfSnapshotLatestResponse(value: object): value is SnapshotLatestResponse {
+    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 SnapshotLatestResponseFromJSON(json: any): SnapshotLatestResponse {
+    return SnapshotLatestResponseFromJSONTyped(json, false);
+}
+
+export function SnapshotLatestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotLatestResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshot': SnapshotSummaryFromJSON(json['snapshot']),
+    };
+}
+
+export function SnapshotLatestResponseToJSON(json: any): SnapshotLatestResponse {
+    return SnapshotLatestResponseToJSONTyped(json, false);
+}
+
+export function SnapshotLatestResponseToJSONTyped(value?: SnapshotLatestResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshot': SnapshotSummaryToJSON(value['snapshot']),
+    };
+}
+

package/src/models/SnapshotListResponse.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 { SnapshotSummary } from './SnapshotSummary';
+import {
+    SnapshotSummaryFromJSON,
+    SnapshotSummaryFromJSONTyped,
+    SnapshotSummaryToJSON,
+    SnapshotSummaryToJSONTyped,
+} from './SnapshotSummary';
+import type { PageInfo } from './PageInfo';
+import {
+    PageInfoFromJSON,
+    PageInfoFromJSONTyped,
+    PageInfoToJSON,
+    PageInfoToJSONTyped,
+} from './PageInfo';
+
+/**
+ * 
+ * @export
+ * @interface SnapshotListResponse
+ */
+export interface SnapshotListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapshotListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {SnapshotListResponseTypeEnum}
+     * @memberof SnapshotListResponse
+     */
+    type: SnapshotListResponseTypeEnum;
+    /**
+     * 
+     * @type {Array<SnapshotSummary>}
+     * @memberof SnapshotListResponse
+     */
+    snapshots: Array<SnapshotSummary>;
+    /**
+     * 
+     * @type {PageInfo}
+     * @memberof SnapshotListResponse
+     */
+    pageInfo?: PageInfo;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotListResponseTypeEnum = {
+    SnapshotList: 'snapshot.list'
+} as const;
+export type SnapshotListResponseTypeEnum = typeof SnapshotListResponseTypeEnum[keyof typeof SnapshotListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotListResponse interface.
+ */
+export function instanceOfSnapshotListResponse(value: object): value is SnapshotListResponse {
+    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 SnapshotListResponseFromJSON(json: any): SnapshotListResponse {
+    return SnapshotListResponseFromJSONTyped(json, false);
+}
+
+export function SnapshotListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'snapshots': ((json['snapshots'] as Array<any>).map(SnapshotSummaryFromJSON)),
+        'pageInfo': json['pageInfo'] == null ? undefined : PageInfoFromJSON(json['pageInfo']),
+    };
+}
+
+export function SnapshotListResponseToJSON(json: any): SnapshotListResponse {
+    return SnapshotListResponseToJSONTyped(json, false);
+}
+
+export function SnapshotListResponseToJSONTyped(value?: SnapshotListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'snapshots': ((value['snapshots'] as Array<any>).map(SnapshotSummaryToJSON)),
+        'pageInfo': PageInfoToJSON(value['pageInfo']),
+    };
+}
+

package/src/models/SnapshotSummary.ts

@@ -0,0 +1,179 @@
+/* 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 SnapshotSummary
+ */
+export interface SnapshotSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotSummary
+     */
+    id: string;
+    /**
+     * Public Sandbox id this snapshot belongs to.
+     * @type {string}
+     * @memberof SnapshotSummary
+     */
+    sandboxId: string;
+    /**
+     * 
+     * @type {SnapshotSummaryStatusEnum}
+     * @memberof SnapshotSummary
+     */
+    status: SnapshotSummaryStatusEnum;
+    /**
+     * `base` (full) or `incremental` (delta on a base). `null` for legacy snapshots.
+     * @type {SnapshotSummaryKindEnum}
+     * @memberof SnapshotSummary
+     */
+    kind?: SnapshotSummaryKindEnum | null;
+    /**
+     * Position in the incremental chain (0 = base).
+     * @type {number}
+     * @memberof SnapshotSummary
+     */
+    generation: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotSummary
+     */
+    chainId?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SnapshotSummary
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SnapshotSummary
+     */
+    completedAt?: Date | null;
+    /**
+     * Bytes this snapshot added (its delta), not the full restored size.
+     * @type {number}
+     * @memberof SnapshotSummary
+     */
+    sizeBytes: number;
+    /**
+     * Inventory entries alive in the chain at this generation (includes base-image system entries).
+     * @type {number}
+     * @memberof SnapshotSummary
+     */
+    fileCount: number;
+    /**
+     * Total bytes of your data restored by this snapshot (what resume/download returns; base image excluded). `null` on legacy snapshots.
+     * @type {number}
+     * @memberof SnapshotSummary
+     */
+    contentSizeBytes?: number | null;
+    /**
+     * Number of your files restored by this snapshot (base image excluded). `null` on legacy snapshots.
+     * @type {number}
+     * @memberof SnapshotSummary
+     */
+    contentFileCount?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const SnapshotSummaryStatusEnum = {
+    Completed: 'completed'
+} as const;
+export type SnapshotSummaryStatusEnum = typeof SnapshotSummaryStatusEnum[keyof typeof SnapshotSummaryStatusEnum];
+
+/**
+ * @export
+ */
+export const SnapshotSummaryKindEnum = {
+    Base: 'base',
+    Incremental: 'incremental'
+} as const;
+export type SnapshotSummaryKindEnum = typeof SnapshotSummaryKindEnum[keyof typeof SnapshotSummaryKindEnum];
+
+
+/**
+ * Check if a given object implements the SnapshotSummary interface.
+ */
+export function instanceOfSnapshotSummary(value: object): value is SnapshotSummary {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('generation' in value) || value['generation'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined) return false;
+    if (!('fileCount' in value) || value['fileCount'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotSummaryFromJSON(json: any): SnapshotSummary {
+    return SnapshotSummaryFromJSONTyped(json, false);
+}
+
+export function SnapshotSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'sandboxId': json['sandboxId'],
+        'status': json['status'],
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'generation': json['generation'],
+        'chainId': json['chainId'] == null ? undefined : json['chainId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'completedAt': json['completedAt'] == null ? undefined : (new Date(json['completedAt'])),
+        'sizeBytes': json['sizeBytes'],
+        'fileCount': json['fileCount'],
+        'contentSizeBytes': json['contentSizeBytes'] == null ? undefined : json['contentSizeBytes'],
+        'contentFileCount': json['contentFileCount'] == null ? undefined : json['contentFileCount'],
+    };
+}
+
+export function SnapshotSummaryToJSON(json: any): SnapshotSummary {
+    return SnapshotSummaryToJSONTyped(json, false);
+}
+
+export function SnapshotSummaryToJSONTyped(value?: SnapshotSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'sandboxId': value['sandboxId'],
+        'status': value['status'],
+        'kind': value['kind'],
+        'generation': value['generation'],
+        'chainId': value['chainId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'sizeBytes': value['sizeBytes'],
+        'fileCount': value['fileCount'],
+        'contentSizeBytes': value['contentSizeBytes'],
+        'contentFileCount': value['contentFileCount'],
+    };
+}
+