@boatdev/sdk 1.0.1 → 1.1.0

package/dist/apis/BoatApi.js

@@ -65,6 +65,7 @@ const CreateSandboxResponse_1 = require("../models/CreateSandboxResponse");
 const CreateScopedApiKeyRequest_1 = require("../models/CreateScopedApiKeyRequest");
 const DataRetentionPolicyResponse_1 = require("../models/DataRetentionPolicyResponse");
 const DataRetentionUpdateRequest_1 = require("../models/DataRetentionUpdateRequest");
+const DeletionOperationListResponse_1 = require("../models/DeletionOperationListResponse");
 const DeletionOperationResponse_1 = require("../models/DeletionOperationResponse");
 const DesktopRequest_1 = require("../models/DesktopRequest");
 const DesktopResponse_1 = require("../models/DesktopResponse");
@@ -127,7 +128,8 @@ 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().');
         }
@@ -300,7 +302,8 @@ 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().');
         }
@@ -436,7 +439,8 @@ 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'];
@@ -485,7 +489,8 @@ 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().');
         }
@@ -528,7 +533,8 @@ 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().');
         }
@@ -571,7 +577,8 @@ 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().');
         }
@@ -883,6 +890,54 @@ 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) => (0, DeletionOperationListResponse_1.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
      */
@@ -915,7 +970,7 @@ 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) {
@@ -924,7 +979,7 @@ class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeletionOperationResponse_1.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) {
@@ -976,7 +1031,8 @@ 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().');
         }
@@ -1121,7 +1177,8 @@ 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().');
         }
@@ -1543,7 +1600,8 @@ 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().');
         }
@@ -1932,7 +1990,8 @@ 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().');
         }
@@ -2130,7 +2189,8 @@ 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().');
         }
@@ -2346,7 +2406,8 @@ 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().');
         }
@@ -2427,7 +2488,8 @@ 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().');
         }
@@ -2470,7 +2532,8 @@ 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().');
         }
@@ -2513,7 +2576,8 @@ 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().');
         }
@@ -2560,7 +2624,8 @@ 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().');
         }
@@ -2611,7 +2676,8 @@ 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().');
         }
@@ -2658,7 +2724,8 @@ 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().');
         }
@@ -2708,7 +2775,8 @@ 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().');
         }
@@ -2752,7 +2820,8 @@ 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().');
         }
@@ -2797,7 +2866,8 @@ 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().');
         }
@@ -2840,7 +2910,8 @@ 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().');
         }
@@ -2887,7 +2958,8 @@ 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().');
         }
@@ -2928,7 +3000,8 @@ 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().');
         }
@@ -2975,7 +3048,8 @@ 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().');
         }
@@ -3067,7 +3141,8 @@ 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().');
         }