@boatdev/sdk 1.0.1 → 1.1.0

package/dist/esm/apis/BoatApi.js

@@ -29,6 +29,7 @@ import { CreateSandboxResponseFromJSON, } from '../models/CreateSandboxResponse'
 import { CreateScopedApiKeyRequestToJSON, } from '../models/CreateScopedApiKeyRequest';
 import { DataRetentionPolicyResponseFromJSON, } from '../models/DataRetentionPolicyResponse';
 import { DataRetentionUpdateRequestToJSON, } from '../models/DataRetentionUpdateRequest';
+import { DeletionOperationListResponseFromJSON, } from '../models/DeletionOperationListResponse';
 import { DeletionOperationResponseFromJSON, } from '../models/DeletionOperationResponse';
 import { DesktopRequestToJSON, } from '../models/DesktopRequest';
 import { DesktopResponseFromJSON, } from '../models/DesktopResponse';
@@ -91,7 +92,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for addEnvironmentRepo without sending the request
      */
-    async addEnvironmentRepoRequestOpts(requestParameters) {
+    async addEnvironmentRepoRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'addEnvironmentRepoRequest', ['environmentId'], []);
         if (requestParameters['environmentId'] == null) {
             throw new runtime.RequiredError('environmentId', 'Required parameter "environmentId" was null or undefined when calling addEnvironmentRepo().');
         }
@@ -264,7 +266,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for command without sending the request
      */
-    async commandRequestOpts(requestParameters) {
+    async commandRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'commandRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling command().');
         }
@@ -400,7 +403,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for create without sending the request
      */
-    async createRequestOpts(requestParameters) {
+    async createRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'createSandboxRequest', ['idempotencyKey', 'org', 'xBoatOrg'], ['org']);
         const queryParameters = {};
         if (requestParameters['org'] != null) {
             queryParameters['org'] = requestParameters['org'];
@@ -449,7 +453,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for createEnvironment without sending the request
      */
-    async createEnvironmentRequestOpts(requestParameters) {
+    async createEnvironmentRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'createSandboxEnvironmentRequest', [], []);
         if (requestParameters['createSandboxEnvironmentRequest'] == null) {
             throw new runtime.RequiredError('createSandboxEnvironmentRequest', 'Required parameter "createSandboxEnvironmentRequest" was null or undefined when calling createEnvironment().');
         }
@@ -492,7 +497,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for createScopedApiKey without sending the request
      */
-    async createScopedApiKeyRequestOpts(requestParameters) {
+    async createScopedApiKeyRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'createScopedApiKeyRequest', [], []);
         if (requestParameters['createScopedApiKeyRequest'] == null) {
             throw new runtime.RequiredError('createScopedApiKeyRequest', 'Required parameter "createScopedApiKeyRequest" was null or undefined when calling createScopedApiKey().');
         }
@@ -535,7 +541,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for createWebhook without sending the request
      */
-    async createWebhookRequestOpts(requestParameters) {
+    async createWebhookRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'webhookCreateRequest', [], []);
         if (requestParameters['webhookCreateRequest'] == null) {
             throw new runtime.RequiredError('webhookCreateRequest', 'Required parameter "webhookCreateRequest" was null or undefined when calling createWebhook().');
         }
@@ -847,6 +854,54 @@ export class BoatApi extends runtime.BaseAPI {
         const response = await this.deleteSandboxRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for deleteSandboxSnapshots without sending the request
+     */
+    async deleteSandboxSnapshotsRequestOpts(requestParameters) {
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling deleteSandboxSnapshots().');
+        }
+        if (requestParameters['xAsciiConfirmDelete'] == null) {
+            throw new runtime.RequiredError('xAsciiConfirmDelete', 'Required parameter "xAsciiConfirmDelete" was null or undefined when calling deleteSandboxSnapshots().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xAsciiConfirmDelete'] != null) {
+            headerParameters['X-Ascii-Confirm-Delete'] = String(requestParameters['xAsciiConfirmDelete']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/sandboxes/{sandboxId}/snapshots`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its named snapshots stay. Snapshots disappear from lists, restores and forks immediately; their stored data is purged in the background. Set `X-Ascii-Confirm-Delete` to the sandbox id.
+     * Permanently delete all snapshots of a sandbox
+     */
+    async deleteSandboxSnapshotsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.deleteSandboxSnapshotsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeletionOperationListResponseFromJSON(jsonValue));
+    }
+    /**
+     * Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its named snapshots stay. Snapshots disappear from lists, restores and forks immediately; their stored data is purged in the background. Set `X-Ascii-Confirm-Delete` to the sandbox id.
+     * Permanently delete all snapshots of a sandbox
+     */
+    async deleteSandboxSnapshots(requestParameters, initOverrides) {
+        const response = await this.deleteSandboxSnapshotsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for deleteSnapshot without sending the request
      */
@@ -879,7 +934,7 @@ export class BoatApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Accept irreversible background deletion of an unpinned snapshot owned by the authenticated account. Snapshots required by another incremental snapshot or active restore return `409`. Poll the returned operation until `completed`.
+     * Accept irreversible deletion of an unpinned snapshot owned by the authenticated account. Any such snapshot is accepted: it disappears from lists, restores and forks immediately, and its stored data is purged in the background once nothing still reads it (see the operation\'s `stage`). `409` only means `X-Ascii-Confirm-Delete` is missing or wrong.
      * Permanently delete snapshot data
      */
     async deleteSnapshotRaw(requestParameters, initOverrides) {
@@ -888,7 +943,7 @@ export class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => DeletionOperationResponseFromJSON(jsonValue));
     }
     /**
-     * Accept irreversible background deletion of an unpinned snapshot owned by the authenticated account. Snapshots required by another incremental snapshot or active restore return `409`. Poll the returned operation until `completed`.
+     * Accept irreversible deletion of an unpinned snapshot owned by the authenticated account. Any such snapshot is accepted: it disappears from lists, restores and forks immediately, and its stored data is purged in the background once nothing still reads it (see the operation\'s `stage`). `409` only means `X-Ascii-Confirm-Delete` is missing or wrong.
      * Permanently delete snapshot data
      */
     async deleteSnapshot(requestParameters, initOverrides) {
@@ -940,7 +995,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for desktop without sending the request
      */
-    async desktopRequestOpts(requestParameters) {
+    async desktopRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'desktopRequest', ['sandboxId', 'vnc', 'theme'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling desktop().');
         }
@@ -1085,7 +1141,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for fork without sending the request
      */
-    async forkRequestOpts(requestParameters) {
+    async forkRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'forkRequest', ['sandboxId', 'idempotencyKey'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling fork().');
         }
@@ -1507,7 +1564,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for hostPort without sending the request
      */
-    async hostPortRequestOpts(requestParameters) {
+    async hostPortRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'hostPortRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling hostPort().');
         }
@@ -1896,7 +1954,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for prompt without sending the request
      */
-    async promptRequestOpts(requestParameters) {
+    async promptRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'promptRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling prompt().');
         }
@@ -2094,7 +2153,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for resume without sending the request
      */
-    async resumeRequestOpts(requestParameters) {
+    async resumeRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'resumeRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling resume().');
         }
@@ -2310,7 +2370,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for saveNamedSnapshot without sending the request
      */
-    async saveNamedSnapshotRequestOpts(requestParameters) {
+    async saveNamedSnapshotRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'namedSnapshotSaveRequest', [], []);
         if (requestParameters['namedSnapshotSaveRequest'] == null) {
             throw new runtime.RequiredError('namedSnapshotSaveRequest', 'Required parameter "namedSnapshotSaveRequest" was null or undefined when calling saveNamedSnapshot().');
         }
@@ -2391,7 +2452,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for selectRepo without sending the request
      */
-    async selectRepoRequestOpts(requestParameters) {
+    async selectRepoRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'repoSelectionRequest', [], []);
         if (requestParameters['repoSelectionRequest'] == null) {
             throw new runtime.RequiredError('repoSelectionRequest', 'Required parameter "repoSelectionRequest" was null or undefined when calling selectRepo().');
         }
@@ -2434,7 +2496,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for setActiveOrganization without sending the request
      */
-    async setActiveOrganizationRequestOpts(requestParameters) {
+    async setActiveOrganizationRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'activeOrgUpdateRequest', [], []);
         if (requestParameters['activeOrgUpdateRequest'] == null) {
             throw new runtime.RequiredError('activeOrgUpdateRequest', 'Required parameter "activeOrgUpdateRequest" was null or undefined when calling setActiveOrganization().');
         }
@@ -2477,7 +2540,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for setEnvironmentSecretFile without sending the request
      */
-    async setEnvironmentSecretFileRequestOpts(requestParameters) {
+    async setEnvironmentSecretFileRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'setEnvironmentSecretFileRequest', ['environmentId'], []);
         if (requestParameters['environmentId'] == null) {
             throw new runtime.RequiredError('environmentId', 'Required parameter "environmentId" was null or undefined when calling setEnvironmentSecretFile().');
         }
@@ -2524,7 +2588,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for setEnvironmentVar without sending the request
      */
-    async setEnvironmentVarRequestOpts(requestParameters) {
+    async setEnvironmentVarRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'setEnvironmentVarRequest', ['environmentId', 'key'], []);
         if (requestParameters['environmentId'] == null) {
             throw new runtime.RequiredError('environmentId', 'Required parameter "environmentId" was null or undefined when calling setEnvironmentVar().');
         }
@@ -2575,7 +2640,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for sshKey without sending the request
      */
-    async sshKeyRequestOpts(requestParameters) {
+    async sshKeyRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'sshKeyRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling sshKey().');
         }
@@ -2622,7 +2688,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for steer without sending the request
      */
-    async steerRequestOpts(requestParameters) {
+    async steerRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'steerRequest', ['sandboxId', 'conversation'], ['conversation']);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling steer().');
         }
@@ -2672,7 +2739,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for stop without sending the request
      */
-    async stopRequestOpts(requestParameters) {
+    async stopRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'stopRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling stop().');
         }
@@ -2716,7 +2784,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for update without sending the request
      */
-    async updateRequestOpts(requestParameters) {
+    async updateRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'updateSandboxRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling update().');
         }
@@ -2761,7 +2830,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for updateDataRetention without sending the request
      */
-    async updateDataRetentionRequestOpts(requestParameters) {
+    async updateDataRetentionRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'dataRetentionUpdateRequest', [], []);
         if (requestParameters['dataRetentionUpdateRequest'] == null) {
             throw new runtime.RequiredError('dataRetentionUpdateRequest', 'Required parameter "dataRetentionUpdateRequest" was null or undefined when calling updateDataRetention().');
         }
@@ -2804,7 +2874,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for updateEnvironment without sending the request
      */
-    async updateEnvironmentRequestOpts(requestParameters) {
+    async updateEnvironmentRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'updateSandboxEnvironmentRequest', ['environmentId'], []);
         if (requestParameters['environmentId'] == null) {
             throw new runtime.RequiredError('environmentId', 'Required parameter "environmentId" was null or undefined when calling updateEnvironment().');
         }
@@ -2851,7 +2922,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for updateSecrets without sending the request
      */
-    async updateSecretsRequestOpts(requestParameters) {
+    async updateSecretsRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'secretsUpdateRequest', [], []);
         if (requestParameters['secretsUpdateRequest'] == null) {
             throw new runtime.RequiredError('secretsUpdateRequest', 'Required parameter "secretsUpdateRequest" was null or undefined when calling updateSecrets().');
         }
@@ -2892,7 +2964,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for updateWebhook without sending the request
      */
-    async updateWebhookRequestOpts(requestParameters) {
+    async updateWebhookRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'webhookUpdateRequest', ['webhookId'], []);
         if (requestParameters['webhookId'] == null) {
             throw new runtime.RequiredError('webhookId', 'Required parameter "webhookId" was null or undefined when calling updateWebhook().');
         }
@@ -2939,7 +3012,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for upgradeEnvironment without sending the request
      */
-    async upgradeEnvironmentRequestOpts(requestParameters) {
+    async upgradeEnvironmentRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'upgradeSandboxEnvironmentRequest', ['environmentId'], []);
         if (requestParameters['environmentId'] == null) {
             throw new runtime.RequiredError('environmentId', 'Required parameter "environmentId" was null or undefined when calling upgradeEnvironment().');
         }
@@ -3031,7 +3105,8 @@ export class BoatApi extends runtime.BaseAPI {
     /**
      * Creates request options for writeFile without sending the request
      */
-    async writeFileRequestOpts(requestParameters) {
+    async writeFileRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'fileWriteRequest', ['sandboxId'], []);
         if (requestParameters['sandboxId'] == null) {
             throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling writeFile().');
         }

package/dist/esm/models/DeletionOperation.d.ts

@@ -45,6 +45,18 @@ export interface DeletionOperation {
      * @memberof DeletionOperation
      */
     status: DeletionOperationStatusEnum;
+    /**
+     * What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot you kept is built on this one; its data goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
+     * @type {DeletionOperationStageEnum}
+     * @memberof DeletionOperation
+     */
+    stage?: DeletionOperationStageEnum;
+    /**
+     * When `waiting_for_uploads` ends.
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    expectedBy?: Date | null;
     /**
      *
      * @type {number}
@@ -91,6 +103,18 @@ export declare const DeletionOperationStatusEnum: {
     readonly Completed: 'completed';
 };
 export type DeletionOperationStatusEnum = typeof DeletionOperationStatusEnum[keyof typeof DeletionOperationStatusEnum];
+/**
+ * @export
+ */
+export declare const DeletionOperationStageEnum: {
+    readonly Removing: 'removing';
+    readonly WaitingForUploads: 'waiting_for_uploads';
+    readonly KeptForNewerSnapshots: 'kept_for_newer_snapshots';
+    readonly WaitingForRestore: 'waiting_for_restore';
+    readonly Retrying: 'retrying';
+    readonly Completed: 'completed';
+};
+export type DeletionOperationStageEnum = typeof DeletionOperationStageEnum[keyof typeof DeletionOperationStageEnum];
 /**
  * Check if a given object implements the DeletionOperation interface.
  */

package/dist/esm/models/DeletionOperation.js

@@ -35,6 +35,17 @@ export const DeletionOperationStatusEnum = {
     Blocked: 'blocked',
     Completed: 'completed'
 };
+/**
+ * @export
+ */
+export const DeletionOperationStageEnum = {
+    Removing: 'removing',
+    WaitingForUploads: 'waiting_for_uploads',
+    KeptForNewerSnapshots: 'kept_for_newer_snapshots',
+    WaitingForRestore: 'waiting_for_restore',
+    Retrying: 'retrying',
+    Completed: 'completed'
+};
 /**
  * Check if a given object implements the DeletionOperation interface.
  */
@@ -70,6 +81,8 @@ export function DeletionOperationFromJSONTyped(json, ignoreDiscriminator) {
         'targetId': json['targetId'],
         'reason': json['reason'],
         'status': json['status'],
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'expectedBy': json['expectedBy'] == null ? undefined : (new Date(json['expectedBy'])),
         'attemptCount': json['attemptCount'],
         'requestedAt': (new Date(json['requestedAt'])),
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
@@ -88,6 +101,8 @@ export function DeletionOperationToJSONTyped(value, ignoreDiscriminator = false)
         'targetId': value['targetId'],
         'reason': value['reason'],
         'status': value['status'],
+        'stage': value['stage'],
+        'expectedBy': value['expectedBy'] == null ? value['expectedBy'] : value['expectedBy'].toISOString(),
         'attemptCount': value['attemptCount'],
         'requestedAt': value['requestedAt'].toISOString(),
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),

package/dist/esm/models/DeletionOperationListResponse.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 { DeletionOperation } from './DeletionOperation';
+/**
+ *
+ * @export
+ * @interface DeletionOperationListResponse
+ */
+export interface DeletionOperationListResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof DeletionOperationListResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {DeletionOperationListResponseTypeEnum}
+     * @memberof DeletionOperationListResponse
+     */
+    type: DeletionOperationListResponseTypeEnum;
+    /**
+     *
+     * @type {Array<DeletionOperation>}
+     * @memberof DeletionOperationListResponse
+     */
+    operations: Array<DeletionOperation>;
+}
+/**
+ * @export
+ */
+export declare const DeletionOperationListResponseTypeEnum: {
+    readonly SnapshotDeleting: 'snapshot.deleting';
+};
+export type DeletionOperationListResponseTypeEnum = typeof DeletionOperationListResponseTypeEnum[keyof typeof DeletionOperationListResponseTypeEnum];
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+export declare function instanceOfDeletionOperationListResponse(value: object): value is DeletionOperationListResponse;
+export declare function DeletionOperationListResponseFromJSON(json: any): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseToJSON(json: any): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseToJSONTyped(value?: DeletionOperationListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DeletionOperationListResponse.js

@@ -0,0 +1,58 @@
+/* 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 { DeletionOperationFromJSON, DeletionOperationToJSON, } from './DeletionOperation';
+/**
+ * @export
+ */
+export const DeletionOperationListResponseTypeEnum = {
+    SnapshotDeleting: 'snapshot.deleting'
+};
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+export function instanceOfDeletionOperationListResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('operations' in value) || value['operations'] === undefined)
+        return false;
+    return true;
+}
+export function DeletionOperationListResponseFromJSON(json) {
+    return DeletionOperationListResponseFromJSONTyped(json, false);
+}
+export function DeletionOperationListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'operations': (json['operations'].map(DeletionOperationFromJSON)),
+    };
+}
+export function DeletionOperationListResponseToJSON(json) {
+    return DeletionOperationListResponseToJSONTyped(json, false);
+}
+export function DeletionOperationListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'operations': (value['operations'].map(DeletionOperationToJSON)),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -31,6 +31,7 @@ export * from './CreateScopedApiKeyRequest';
 export * from './DataRetentionPolicyResponse';
 export * from './DataRetentionUpdateRequest';
 export * from './DeletionOperation';
+export * from './DeletionOperationListResponse';
 export * from './DeletionOperationResponse';
 export * from './DesktopRequest';
 export * from './DesktopResponse';

package/dist/esm/models/index.js

@@ -33,6 +33,7 @@ export * from './CreateScopedApiKeyRequest';
 export * from './DataRetentionPolicyResponse';
 export * from './DataRetentionUpdateRequest';
 export * from './DeletionOperation';
+export * from './DeletionOperationListResponse';
 export * from './DeletionOperationResponse';
 export * from './DesktopRequest';
 export * from './DesktopResponse';

package/dist/esm/runtime.d.ts

@@ -182,3 +182,11 @@ export declare class TextApiResponse {
     constructor(raw: Response);
     value(): Promise<string>;
 }
+/**
+ * A body-taking call's parameters with the body's fields inline, next to the
+ * path/query/header parameters: `fork({ sandboxId, type: 'small' })` is
+ * `fork({ sandboxId, forkRequest: { type: 'small' } })`. Both shapes are accepted.
+ */
+export type FlatBody<R, K extends keyof R> = Omit<R, K> & NonNullable<R[K]>;
+/** Turns either call shape into the wrapped one the generated code sends. */
+export declare function unflattenBody<R>(input: object, bodyKey: string, paramKeys: string[], sharedKeys: string[]): R;

package/dist/esm/runtime.js

@@ -335,3 +335,21 @@ export class TextApiResponse {
     }
     ;
 }
+/** Turns either call shape into the wrapped one the generated code sends. */
+export function unflattenBody(input, bodyKey, paramKeys, sharedKeys) {
+    if (input == null || bodyKey in input)
+        return input;
+    const params = {};
+    const body = {};
+    for (const [k, v] of Object.entries(input)) {
+        const isParam = paramKeys.indexOf(k) !== -1;
+        if (isParam)
+            params[k] = v;
+        if (!isParam || sharedKeys.indexOf(k) !== -1)
+            body[k] = v;
+    }
+    // No body field given: send no body, exactly like the wrapped call with the key omitted.
+    if (Object.keys(body).length > 0)
+        params[bodyKey] = body;
+    return params;
+}

package/dist/models/DeletionOperation.d.ts

@@ -45,6 +45,18 @@ export interface DeletionOperation {
      * @memberof DeletionOperation
      */
     status: DeletionOperationStatusEnum;
+    /**
+     * What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot you kept is built on this one; its data goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
+     * @type {DeletionOperationStageEnum}
+     * @memberof DeletionOperation
+     */
+    stage?: DeletionOperationStageEnum;
+    /**
+     * When `waiting_for_uploads` ends.
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    expectedBy?: Date | null;
     /**
      *
      * @type {number}
@@ -91,6 +103,18 @@ export declare const DeletionOperationStatusEnum: {
     readonly Completed: 'completed';
 };
 export type DeletionOperationStatusEnum = typeof DeletionOperationStatusEnum[keyof typeof DeletionOperationStatusEnum];
+/**
+ * @export
+ */
+export declare const DeletionOperationStageEnum: {
+    readonly Removing: 'removing';
+    readonly WaitingForUploads: 'waiting_for_uploads';
+    readonly KeptForNewerSnapshots: 'kept_for_newer_snapshots';
+    readonly WaitingForRestore: 'waiting_for_restore';
+    readonly Retrying: 'retrying';
+    readonly Completed: 'completed';
+};
+export type DeletionOperationStageEnum = typeof DeletionOperationStageEnum[keyof typeof DeletionOperationStageEnum];
 /**
  * Check if a given object implements the DeletionOperation interface.
  */

package/dist/models/DeletionOperation.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeletionOperationStatusEnum = exports.DeletionOperationReasonEnum = exports.DeletionOperationKindEnum = void 0;
+exports.DeletionOperationStageEnum = exports.DeletionOperationStatusEnum = exports.DeletionOperationReasonEnum = exports.DeletionOperationKindEnum = void 0;
 exports.instanceOfDeletionOperation = instanceOfDeletionOperation;
 exports.DeletionOperationFromJSON = DeletionOperationFromJSON;
 exports.DeletionOperationFromJSONTyped = DeletionOperationFromJSONTyped;
@@ -43,6 +43,17 @@ exports.DeletionOperationStatusEnum = {
     Blocked: 'blocked',
     Completed: 'completed'
 };
+/**
+ * @export
+ */
+exports.DeletionOperationStageEnum = {
+    Removing: 'removing',
+    WaitingForUploads: 'waiting_for_uploads',
+    KeptForNewerSnapshots: 'kept_for_newer_snapshots',
+    WaitingForRestore: 'waiting_for_restore',
+    Retrying: 'retrying',
+    Completed: 'completed'
+};
 /**
  * Check if a given object implements the DeletionOperation interface.
  */
@@ -78,6 +89,8 @@ function DeletionOperationFromJSONTyped(json, ignoreDiscriminator) {
         'targetId': json['targetId'],
         'reason': json['reason'],
         'status': json['status'],
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'expectedBy': json['expectedBy'] == null ? undefined : (new Date(json['expectedBy'])),
         'attemptCount': json['attemptCount'],
         'requestedAt': (new Date(json['requestedAt'])),
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
@@ -96,6 +109,8 @@ function DeletionOperationToJSONTyped(value, ignoreDiscriminator = false) {
         'targetId': value['targetId'],
         'reason': value['reason'],
         'status': value['status'],
+        'stage': value['stage'],
+        'expectedBy': value['expectedBy'] == null ? value['expectedBy'] : value['expectedBy'].toISOString(),
         'attemptCount': value['attemptCount'],
         'requestedAt': value['requestedAt'].toISOString(),
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),