@boatdev/sdk 1.10.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +22 -0
- package/dist/apis/BoatApi.d.ts +92 -12
- package/dist/apis/BoatApi.js +196 -15
- package/dist/esm/apis/BoatApi.d.ts +92 -12
- package/dist/esm/apis/BoatApi.js +196 -15
- package/dist/esm/models/CreateSandboxRequest.d.ts +3 -3
- package/dist/esm/models/CredentialId.d.ts +3 -0
- package/dist/esm/models/CredentialId.js +3 -0
- package/dist/esm/models/CredentialProfile.d.ts +7 -0
- package/dist/esm/models/CredentialProfile.js +3 -0
- package/dist/esm/models/DeletionOperation.d.ts +1 -1
- package/dist/esm/models/ResourceAccess.d.ts +38 -0
- package/dist/esm/models/ResourceAccess.js +47 -0
- package/dist/esm/models/ResourceAccessUpdate.d.ts +38 -0
- package/dist/esm/models/ResourceAccessUpdate.js +45 -0
- package/dist/esm/models/Sandbox.d.ts +7 -0
- package/dist/esm/models/Sandbox.js +3 -0
- package/dist/esm/models/SandboxEnvironment.d.ts +7 -0
- package/dist/esm/models/SandboxEnvironment.js +3 -0
- package/dist/esm/models/SandboxLastReboot.d.ts +47 -0
- package/dist/esm/models/SandboxLastReboot.js +51 -0
- package/dist/esm/models/SandboxListResponse.d.ts +7 -0
- package/dist/esm/models/SandboxListResponse.js +3 -0
- package/dist/esm/models/SandboxListResponseAllOfDeletedCost.d.ts +44 -0
- package/dist/esm/models/SandboxListResponseAllOfDeletedCost.js +51 -0
- package/dist/esm/models/SavedSnapshot.d.ts +83 -0
- package/dist/esm/models/SavedSnapshot.js +71 -0
- package/dist/esm/models/SavedSnapshotAllowance.d.ts +81 -0
- package/dist/esm/models/SavedSnapshotAllowance.js +57 -0
- package/dist/esm/models/SavedSnapshotDeletedResponse.d.ts +64 -0
- package/dist/esm/models/SavedSnapshotDeletedResponse.js +67 -0
- package/dist/esm/models/SavedSnapshotInfoResponse.d.ts +52 -0
- package/dist/esm/models/SavedSnapshotInfoResponse.js +58 -0
- package/dist/esm/models/SavedSnapshotListResponse.d.ts +59 -0
- package/dist/esm/models/SavedSnapshotListResponse.js +61 -0
- package/dist/esm/models/SavedSnapshotSaveRequest.d.ts +38 -0
- package/dist/esm/models/SavedSnapshotSaveRequest.js +47 -0
- package/dist/esm/models/SavedSnapshotSavingResponse.d.ts +65 -0
- package/dist/esm/models/SavedSnapshotSavingResponse.js +68 -0
- package/dist/esm/models/SnapshotSummary.d.ts +1 -1
- package/dist/esm/models/UpdateCredentialProfileRequest.d.ts +7 -0
- package/dist/esm/models/UpdateCredentialProfileRequest.js +3 -0
- package/dist/esm/models/UpdateSandboxEnvironmentRequest.d.ts +7 -0
- package/dist/esm/models/UpdateSandboxEnvironmentRequest.js +3 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/models/CreateSandboxRequest.d.ts +3 -3
- package/dist/models/CredentialId.d.ts +3 -0
- package/dist/models/CredentialId.js +3 -0
- package/dist/models/CredentialProfile.d.ts +7 -0
- package/dist/models/CredentialProfile.js +3 -0
- package/dist/models/DeletionOperation.d.ts +1 -1
- package/dist/models/ResourceAccess.d.ts +38 -0
- package/dist/models/ResourceAccess.js +54 -0
- package/dist/models/ResourceAccessUpdate.d.ts +38 -0
- package/dist/models/ResourceAccessUpdate.js +52 -0
- package/dist/models/Sandbox.d.ts +7 -0
- package/dist/models/Sandbox.js +3 -0
- package/dist/models/SandboxEnvironment.d.ts +7 -0
- package/dist/models/SandboxEnvironment.js +3 -0
- package/dist/models/SandboxLastReboot.d.ts +47 -0
- package/dist/models/SandboxLastReboot.js +59 -0
- package/dist/models/SandboxListResponse.d.ts +7 -0
- package/dist/models/SandboxListResponse.js +3 -0
- package/dist/models/SandboxListResponseAllOfDeletedCost.d.ts +44 -0
- package/dist/models/SandboxListResponseAllOfDeletedCost.js +58 -0
- package/dist/models/SavedSnapshot.d.ts +83 -0
- package/dist/models/SavedSnapshot.js +79 -0
- package/dist/models/SavedSnapshotAllowance.d.ts +81 -0
- package/dist/models/SavedSnapshotAllowance.js +64 -0
- package/dist/models/SavedSnapshotDeletedResponse.d.ts +64 -0
- package/dist/models/SavedSnapshotDeletedResponse.js +75 -0
- package/dist/models/SavedSnapshotInfoResponse.d.ts +52 -0
- package/dist/models/SavedSnapshotInfoResponse.js +66 -0
- package/dist/models/SavedSnapshotListResponse.d.ts +59 -0
- package/dist/models/SavedSnapshotListResponse.js +69 -0
- package/dist/models/SavedSnapshotSaveRequest.d.ts +38 -0
- package/dist/models/SavedSnapshotSaveRequest.js +54 -0
- package/dist/models/SavedSnapshotSavingResponse.d.ts +65 -0
- package/dist/models/SavedSnapshotSavingResponse.js +76 -0
- package/dist/models/SnapshotSummary.d.ts +1 -1
- package/dist/models/UpdateCredentialProfileRequest.d.ts +7 -0
- package/dist/models/UpdateCredentialProfileRequest.js +3 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.d.ts +7 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.js +3 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/docs/BoatApi.md +307 -15
- package/docs/CredentialProfile.md +2 -0
- package/docs/ResourceAccess.md +35 -0
- package/docs/ResourceAccessUpdate.md +35 -0
- package/docs/Sandbox.md +2 -0
- package/docs/SandboxEnvironment.md +2 -0
- package/docs/SandboxLastReboot.md +35 -0
- package/docs/SandboxListResponse.md +2 -0
- package/docs/SandboxListResponseAllOfDeletedCost.md +37 -0
- package/docs/SavedSnapshot.md +47 -0
- package/docs/SavedSnapshotAllowance.md +49 -0
- package/docs/SavedSnapshotDeletedResponse.md +38 -0
- package/docs/SavedSnapshotInfoResponse.md +36 -0
- package/docs/SavedSnapshotListResponse.md +38 -0
- package/docs/SavedSnapshotSaveRequest.md +34 -0
- package/docs/SavedSnapshotSavingResponse.md +38 -0
- package/docs/UpdateCredentialProfileRequest.md +2 -0
- package/docs/UpdateSandboxEnvironmentRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +277 -15
- package/src/models/CreateSandboxRequest.ts +3 -3
- package/src/models/CredentialId.ts +3 -0
- package/src/models/CredentialProfile.ts +15 -0
- package/src/models/DeletionOperation.ts +1 -1
- package/src/models/ResourceAccess.ts +75 -0
- package/src/models/ResourceAccessUpdate.ts +74 -0
- package/src/models/Sandbox.ts +15 -0
- package/src/models/SandboxEnvironment.ts +15 -0
- package/src/models/SandboxLastReboot.ts +85 -0
- package/src/models/SandboxListResponse.ts +15 -0
- package/src/models/SandboxListResponseAllOfDeletedCost.ts +84 -0
- package/src/models/SavedSnapshot.ts +137 -0
- package/src/models/SavedSnapshotAllowance.ts +130 -0
- package/src/models/SavedSnapshotDeletedResponse.ts +111 -0
- package/src/models/SavedSnapshotInfoResponse.ts +102 -0
- package/src/models/SavedSnapshotListResponse.ts +117 -0
- package/src/models/SavedSnapshotSaveRequest.ts +75 -0
- package/src/models/SavedSnapshotSavingResponse.ts +119 -0
- package/src/models/SnapshotSummary.ts +1 -1
- package/src/models/UpdateCredentialProfileRequest.ts +16 -0
- package/src/models/UpdateSandboxEnvironmentRequest.ts +15 -0
- package/src/models/index.ts +11 -0
package/dist/apis/BoatApi.js
CHANGED
|
@@ -119,6 +119,11 @@ const SandboxEnvironmentResponse_1 = require("../models/SandboxEnvironmentRespon
|
|
|
119
119
|
const SandboxInfoResponse_1 = require("../models/SandboxInfoResponse");
|
|
120
120
|
const SandboxListResponse_1 = require("../models/SandboxListResponse");
|
|
121
121
|
const SandboxUsageResponse_1 = require("../models/SandboxUsageResponse");
|
|
122
|
+
const SavedSnapshotDeletedResponse_1 = require("../models/SavedSnapshotDeletedResponse");
|
|
123
|
+
const SavedSnapshotInfoResponse_1 = require("../models/SavedSnapshotInfoResponse");
|
|
124
|
+
const SavedSnapshotListResponse_1 = require("../models/SavedSnapshotListResponse");
|
|
125
|
+
const SavedSnapshotSaveRequest_1 = require("../models/SavedSnapshotSaveRequest");
|
|
126
|
+
const SavedSnapshotSavingResponse_1 = require("../models/SavedSnapshotSavingResponse");
|
|
122
127
|
const SecretsResponse_1 = require("../models/SecretsResponse");
|
|
123
128
|
const SecretsUpdateRequest_1 = require("../models/SecretsUpdateRequest");
|
|
124
129
|
const SetCredentialKeyRequest_1 = require("../models/SetCredentialKeyRequest");
|
|
@@ -948,7 +953,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
948
953
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
949
954
|
}
|
|
950
955
|
}
|
|
951
|
-
let urlPath = `/
|
|
956
|
+
let urlPath = `/saved-snapshots/{name}/shares`;
|
|
952
957
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
953
958
|
return {
|
|
954
959
|
path: urlPath,
|
|
@@ -958,8 +963,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
958
963
|
};
|
|
959
964
|
}
|
|
960
965
|
/**
|
|
961
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
962
|
-
* Share a
|
|
966
|
+
* Make a secret code that lets any Boat account create a sandbox from this saved snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
|
|
967
|
+
* Share a saved snapshot
|
|
963
968
|
*/
|
|
964
969
|
async createSnapshotShareRaw(requestParameters, initOverrides) {
|
|
965
970
|
const requestOptions = await this.createSnapshotShareRequestOpts(requestParameters);
|
|
@@ -967,8 +972,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
967
972
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamedSnapshotShareCreatedResponse_1.NamedSnapshotShareCreatedResponseFromJSON)(jsonValue));
|
|
968
973
|
}
|
|
969
974
|
/**
|
|
970
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
971
|
-
* Share a
|
|
975
|
+
* Make a secret code that lets any Boat account create a sandbox from this saved snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
|
|
976
|
+
* Share a saved snapshot
|
|
972
977
|
*/
|
|
973
978
|
async createSnapshotShare(requestParameters, initOverrides) {
|
|
974
979
|
const response = await this.createSnapshotShareRaw(requestParameters, initOverrides);
|
|
@@ -1446,6 +1451,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1446
1451
|
}
|
|
1447
1452
|
/**
|
|
1448
1453
|
* Creates request options for deleteNamedSnapshot without sending the request
|
|
1454
|
+
* @deprecated
|
|
1449
1455
|
*/
|
|
1450
1456
|
async deleteNamedSnapshotRequestOpts(requestParameters) {
|
|
1451
1457
|
if (requestParameters['name'] == null) {
|
|
@@ -1472,6 +1478,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1472
1478
|
/**
|
|
1473
1479
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1474
1480
|
* Remove a named snapshot
|
|
1481
|
+
* @deprecated
|
|
1475
1482
|
*/
|
|
1476
1483
|
async deleteNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
1477
1484
|
const requestOptions = await this.deleteNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -1481,6 +1488,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1481
1488
|
/**
|
|
1482
1489
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1483
1490
|
* Remove a named snapshot
|
|
1491
|
+
* @deprecated
|
|
1484
1492
|
*/
|
|
1485
1493
|
async deleteNamedSnapshot(requestParameters, initOverrides) {
|
|
1486
1494
|
const response = await this.deleteNamedSnapshotRaw(requestParameters, initOverrides);
|
|
@@ -1518,7 +1526,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1518
1526
|
};
|
|
1519
1527
|
}
|
|
1520
1528
|
/**
|
|
1521
|
-
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed.
|
|
1529
|
+
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed. Saved snapshots and other shared artifacts remain independent. Poll the returned operation until `completed`.
|
|
1522
1530
|
* Permanently delete sandbox data
|
|
1523
1531
|
*/
|
|
1524
1532
|
async deleteSandboxRaw(requestParameters, initOverrides) {
|
|
@@ -1527,7 +1535,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1527
1535
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeletionOperationResponse_1.DeletionOperationResponseFromJSON)(jsonValue));
|
|
1528
1536
|
}
|
|
1529
1537
|
/**
|
|
1530
|
-
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed.
|
|
1538
|
+
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed. Saved snapshots and other shared artifacts remain independent. Poll the returned operation until `completed`.
|
|
1531
1539
|
* Permanently delete sandbox data
|
|
1532
1540
|
*/
|
|
1533
1541
|
async deleteSandbox(requestParameters, initOverrides) {
|
|
@@ -1566,7 +1574,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1566
1574
|
};
|
|
1567
1575
|
}
|
|
1568
1576
|
/**
|
|
1569
|
-
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its
|
|
1577
|
+
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its saved 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.
|
|
1570
1578
|
* Permanently delete all snapshots of a sandbox
|
|
1571
1579
|
*/
|
|
1572
1580
|
async deleteSandboxSnapshotsRaw(requestParameters, initOverrides) {
|
|
@@ -1575,13 +1583,55 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1575
1583
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeletionOperationListResponse_1.DeletionOperationListResponseFromJSON)(jsonValue));
|
|
1576
1584
|
}
|
|
1577
1585
|
/**
|
|
1578
|
-
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its
|
|
1586
|
+
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its saved 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.
|
|
1579
1587
|
* Permanently delete all snapshots of a sandbox
|
|
1580
1588
|
*/
|
|
1581
1589
|
async deleteSandboxSnapshots(requestParameters, initOverrides) {
|
|
1582
1590
|
const response = await this.deleteSandboxSnapshotsRaw(requestParameters, initOverrides);
|
|
1583
1591
|
return await response.value();
|
|
1584
1592
|
}
|
|
1593
|
+
/**
|
|
1594
|
+
* Creates request options for deleteSavedSnapshot without sending the request
|
|
1595
|
+
*/
|
|
1596
|
+
async deleteSavedSnapshotRequestOpts(requestParameters) {
|
|
1597
|
+
if (requestParameters['name'] == null) {
|
|
1598
|
+
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling deleteSavedSnapshot().');
|
|
1599
|
+
}
|
|
1600
|
+
const queryParameters = {};
|
|
1601
|
+
const headerParameters = {};
|
|
1602
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1603
|
+
const token = this.configuration.accessToken;
|
|
1604
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
1605
|
+
if (tokenString) {
|
|
1606
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1607
|
+
}
|
|
1608
|
+
}
|
|
1609
|
+
let urlPath = `/saved-snapshots/{name}`;
|
|
1610
|
+
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
1611
|
+
return {
|
|
1612
|
+
path: urlPath,
|
|
1613
|
+
method: 'DELETE',
|
|
1614
|
+
headers: headerParameters,
|
|
1615
|
+
query: queryParameters,
|
|
1616
|
+
};
|
|
1617
|
+
}
|
|
1618
|
+
/**
|
|
1619
|
+
* Remove a saved snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1620
|
+
* Remove a saved snapshot
|
|
1621
|
+
*/
|
|
1622
|
+
async deleteSavedSnapshotRaw(requestParameters, initOverrides) {
|
|
1623
|
+
const requestOptions = await this.deleteSavedSnapshotRequestOpts(requestParameters);
|
|
1624
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1625
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, SavedSnapshotDeletedResponse_1.SavedSnapshotDeletedResponseFromJSON)(jsonValue));
|
|
1626
|
+
}
|
|
1627
|
+
/**
|
|
1628
|
+
* Remove a saved snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1629
|
+
* Remove a saved snapshot
|
|
1630
|
+
*/
|
|
1631
|
+
async deleteSavedSnapshot(requestParameters, initOverrides) {
|
|
1632
|
+
const response = await this.deleteSavedSnapshotRaw(requestParameters, initOverrides);
|
|
1633
|
+
return await response.value();
|
|
1634
|
+
}
|
|
1585
1635
|
/**
|
|
1586
1636
|
* Creates request options for deleteSnapshot without sending the request
|
|
1587
1637
|
*/
|
|
@@ -2211,6 +2261,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2211
2261
|
}
|
|
2212
2262
|
/**
|
|
2213
2263
|
* Creates request options for getNamedSnapshot without sending the request
|
|
2264
|
+
* @deprecated
|
|
2214
2265
|
*/
|
|
2215
2266
|
async getNamedSnapshotRequestOpts(requestParameters) {
|
|
2216
2267
|
if (requestParameters['name'] == null) {
|
|
@@ -2236,6 +2287,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2236
2287
|
}
|
|
2237
2288
|
/**
|
|
2238
2289
|
* Get a named snapshot
|
|
2290
|
+
* @deprecated
|
|
2239
2291
|
*/
|
|
2240
2292
|
async getNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
2241
2293
|
const requestOptions = await this.getNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -2244,6 +2296,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2244
2296
|
}
|
|
2245
2297
|
/**
|
|
2246
2298
|
* Get a named snapshot
|
|
2299
|
+
* @deprecated
|
|
2247
2300
|
*/
|
|
2248
2301
|
async getNamedSnapshot(requestParameters, initOverrides) {
|
|
2249
2302
|
const response = await this.getNamedSnapshotRaw(requestParameters, initOverrides);
|
|
@@ -2294,6 +2347,46 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2294
2347
|
const response = await this.getSandboxAiUsageRaw(requestParameters, initOverrides);
|
|
2295
2348
|
return await response.value();
|
|
2296
2349
|
}
|
|
2350
|
+
/**
|
|
2351
|
+
* Creates request options for getSavedSnapshot without sending the request
|
|
2352
|
+
*/
|
|
2353
|
+
async getSavedSnapshotRequestOpts(requestParameters) {
|
|
2354
|
+
if (requestParameters['name'] == null) {
|
|
2355
|
+
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling getSavedSnapshot().');
|
|
2356
|
+
}
|
|
2357
|
+
const queryParameters = {};
|
|
2358
|
+
const headerParameters = {};
|
|
2359
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
2360
|
+
const token = this.configuration.accessToken;
|
|
2361
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
2362
|
+
if (tokenString) {
|
|
2363
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
2364
|
+
}
|
|
2365
|
+
}
|
|
2366
|
+
let urlPath = `/saved-snapshots/{name}`;
|
|
2367
|
+
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
2368
|
+
return {
|
|
2369
|
+
path: urlPath,
|
|
2370
|
+
method: 'GET',
|
|
2371
|
+
headers: headerParameters,
|
|
2372
|
+
query: queryParameters,
|
|
2373
|
+
};
|
|
2374
|
+
}
|
|
2375
|
+
/**
|
|
2376
|
+
* Get a saved snapshot
|
|
2377
|
+
*/
|
|
2378
|
+
async getSavedSnapshotRaw(requestParameters, initOverrides) {
|
|
2379
|
+
const requestOptions = await this.getSavedSnapshotRequestOpts(requestParameters);
|
|
2380
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
2381
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, SavedSnapshotInfoResponse_1.SavedSnapshotInfoResponseFromJSON)(jsonValue));
|
|
2382
|
+
}
|
|
2383
|
+
/**
|
|
2384
|
+
* Get a saved snapshot
|
|
2385
|
+
*/
|
|
2386
|
+
async getSavedSnapshot(requestParameters, initOverrides) {
|
|
2387
|
+
const response = await this.getSavedSnapshotRaw(requestParameters, initOverrides);
|
|
2388
|
+
return await response.value();
|
|
2389
|
+
}
|
|
2297
2390
|
/**
|
|
2298
2391
|
* Creates request options for getSnapshotDownload without sending the request
|
|
2299
2392
|
*/
|
|
@@ -2775,6 +2868,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2775
2868
|
}
|
|
2776
2869
|
/**
|
|
2777
2870
|
* Creates request options for listNamedSnapshots without sending the request
|
|
2871
|
+
* @deprecated
|
|
2778
2872
|
*/
|
|
2779
2873
|
async listNamedSnapshotsRequestOpts() {
|
|
2780
2874
|
const queryParameters = {};
|
|
@@ -2797,6 +2891,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2797
2891
|
/**
|
|
2798
2892
|
* List your named snapshots, newest first.
|
|
2799
2893
|
* List named snapshots
|
|
2894
|
+
* @deprecated
|
|
2800
2895
|
*/
|
|
2801
2896
|
async listNamedSnapshotsRaw(initOverrides) {
|
|
2802
2897
|
const requestOptions = await this.listNamedSnapshotsRequestOpts();
|
|
@@ -2806,6 +2901,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2806
2901
|
/**
|
|
2807
2902
|
* List your named snapshots, newest first.
|
|
2808
2903
|
* List named snapshots
|
|
2904
|
+
* @deprecated
|
|
2809
2905
|
*/
|
|
2810
2906
|
async listNamedSnapshots(initOverrides) {
|
|
2811
2907
|
const response = await this.listNamedSnapshotsRaw(initOverrides);
|
|
@@ -2900,6 +2996,44 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2900
2996
|
const response = await this.listSandboxSnapshotsRaw(requestParameters, initOverrides);
|
|
2901
2997
|
return await response.value();
|
|
2902
2998
|
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Creates request options for listSavedSnapshots without sending the request
|
|
3001
|
+
*/
|
|
3002
|
+
async listSavedSnapshotsRequestOpts() {
|
|
3003
|
+
const queryParameters = {};
|
|
3004
|
+
const headerParameters = {};
|
|
3005
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3006
|
+
const token = this.configuration.accessToken;
|
|
3007
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
3008
|
+
if (tokenString) {
|
|
3009
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3010
|
+
}
|
|
3011
|
+
}
|
|
3012
|
+
let urlPath = `/saved-snapshots`;
|
|
3013
|
+
return {
|
|
3014
|
+
path: urlPath,
|
|
3015
|
+
method: 'GET',
|
|
3016
|
+
headers: headerParameters,
|
|
3017
|
+
query: queryParameters,
|
|
3018
|
+
};
|
|
3019
|
+
}
|
|
3020
|
+
/**
|
|
3021
|
+
* List your saved snapshots, newest first.
|
|
3022
|
+
* List saved snapshots
|
|
3023
|
+
*/
|
|
3024
|
+
async listSavedSnapshotsRaw(initOverrides) {
|
|
3025
|
+
const requestOptions = await this.listSavedSnapshotsRequestOpts();
|
|
3026
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
3027
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, SavedSnapshotListResponse_1.SavedSnapshotListResponseFromJSON)(jsonValue));
|
|
3028
|
+
}
|
|
3029
|
+
/**
|
|
3030
|
+
* List your saved snapshots, newest first.
|
|
3031
|
+
* List saved snapshots
|
|
3032
|
+
*/
|
|
3033
|
+
async listSavedSnapshots(initOverrides) {
|
|
3034
|
+
const response = await this.listSavedSnapshotsRaw(initOverrides);
|
|
3035
|
+
return await response.value();
|
|
3036
|
+
}
|
|
2903
3037
|
/**
|
|
2904
3038
|
* Creates request options for listSnapshotShares without sending the request
|
|
2905
3039
|
*/
|
|
@@ -2916,7 +3050,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2916
3050
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
2917
3051
|
}
|
|
2918
3052
|
}
|
|
2919
|
-
let urlPath = `/
|
|
3053
|
+
let urlPath = `/saved-snapshots/{name}/shares`;
|
|
2920
3054
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
2921
3055
|
return {
|
|
2922
3056
|
path: urlPath,
|
|
@@ -2926,8 +3060,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2926
3060
|
};
|
|
2927
3061
|
}
|
|
2928
3062
|
/**
|
|
2929
|
-
* List the share codes of a
|
|
2930
|
-
* List share codes of a
|
|
3063
|
+
* List the share codes of a saved snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
|
|
3064
|
+
* List share codes of a saved snapshot
|
|
2931
3065
|
*/
|
|
2932
3066
|
async listSnapshotSharesRaw(requestParameters, initOverrides) {
|
|
2933
3067
|
const requestOptions = await this.listSnapshotSharesRequestOpts(requestParameters);
|
|
@@ -2935,8 +3069,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2935
3069
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamedSnapshotShareListResponse_1.NamedSnapshotShareListResponseFromJSON)(jsonValue));
|
|
2936
3070
|
}
|
|
2937
3071
|
/**
|
|
2938
|
-
* List the share codes of a
|
|
2939
|
-
* List share codes of a
|
|
3072
|
+
* List the share codes of a saved snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
|
|
3073
|
+
* List share codes of a saved snapshot
|
|
2940
3074
|
*/
|
|
2941
3075
|
async listSnapshotShares(requestParameters, initOverrides) {
|
|
2942
3076
|
const response = await this.listSnapshotSharesRaw(requestParameters, initOverrides);
|
|
@@ -3454,7 +3588,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3454
3588
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3455
3589
|
}
|
|
3456
3590
|
}
|
|
3457
|
-
let urlPath = `/
|
|
3591
|
+
let urlPath = `/saved-snapshots/{name}/shares/{shareId}`;
|
|
3458
3592
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
3459
3593
|
urlPath = urlPath.replace('{shareId}', encodeURIComponent(String(requestParameters['shareId'])));
|
|
3460
3594
|
return {
|
|
@@ -3626,6 +3760,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3626
3760
|
}
|
|
3627
3761
|
/**
|
|
3628
3762
|
* Creates request options for saveNamedSnapshot without sending the request
|
|
3763
|
+
* @deprecated
|
|
3629
3764
|
*/
|
|
3630
3765
|
async saveNamedSnapshotRequestOpts(input) {
|
|
3631
3766
|
const requestParameters = runtime.unflattenBody(input, 'namedSnapshotSaveRequest', [], []);
|
|
@@ -3654,6 +3789,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3654
3789
|
/**
|
|
3655
3790
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
3656
3791
|
* Save a named snapshot
|
|
3792
|
+
* @deprecated
|
|
3657
3793
|
*/
|
|
3658
3794
|
async saveNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
3659
3795
|
const requestOptions = await this.saveNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -3663,11 +3799,56 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3663
3799
|
/**
|
|
3664
3800
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
3665
3801
|
* Save a named snapshot
|
|
3802
|
+
* @deprecated
|
|
3666
3803
|
*/
|
|
3667
3804
|
async saveNamedSnapshot(requestParameters, initOverrides) {
|
|
3668
3805
|
const response = await this.saveNamedSnapshotRaw(requestParameters, initOverrides);
|
|
3669
3806
|
return await response.value();
|
|
3670
3807
|
}
|
|
3808
|
+
/**
|
|
3809
|
+
* Creates request options for saveSavedSnapshot without sending the request
|
|
3810
|
+
*/
|
|
3811
|
+
async saveSavedSnapshotRequestOpts(input) {
|
|
3812
|
+
const requestParameters = runtime.unflattenBody(input, 'savedSnapshotSaveRequest', [], []);
|
|
3813
|
+
if (requestParameters['savedSnapshotSaveRequest'] == null) {
|
|
3814
|
+
throw new runtime.RequiredError('savedSnapshotSaveRequest', 'Required parameter "savedSnapshotSaveRequest" was null or undefined when calling saveSavedSnapshot().');
|
|
3815
|
+
}
|
|
3816
|
+
const queryParameters = {};
|
|
3817
|
+
const headerParameters = {};
|
|
3818
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
3819
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3820
|
+
const token = this.configuration.accessToken;
|
|
3821
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
3822
|
+
if (tokenString) {
|
|
3823
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3824
|
+
}
|
|
3825
|
+
}
|
|
3826
|
+
let urlPath = `/saved-snapshots`;
|
|
3827
|
+
return {
|
|
3828
|
+
path: urlPath,
|
|
3829
|
+
method: 'POST',
|
|
3830
|
+
headers: headerParameters,
|
|
3831
|
+
query: queryParameters,
|
|
3832
|
+
body: (0, SavedSnapshotSaveRequest_1.SavedSnapshotSaveRequestToJSON)(requestParameters['savedSnapshotSaveRequest']),
|
|
3833
|
+
};
|
|
3834
|
+
}
|
|
3835
|
+
/**
|
|
3836
|
+
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
3837
|
+
* Save a saved snapshot
|
|
3838
|
+
*/
|
|
3839
|
+
async saveSavedSnapshotRaw(requestParameters, initOverrides) {
|
|
3840
|
+
const requestOptions = await this.saveSavedSnapshotRequestOpts(requestParameters);
|
|
3841
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
3842
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, SavedSnapshotSavingResponse_1.SavedSnapshotSavingResponseFromJSON)(jsonValue));
|
|
3843
|
+
}
|
|
3844
|
+
/**
|
|
3845
|
+
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
3846
|
+
* Save a saved snapshot
|
|
3847
|
+
*/
|
|
3848
|
+
async saveSavedSnapshot(requestParameters, initOverrides) {
|
|
3849
|
+
const response = await this.saveSavedSnapshotRaw(requestParameters, initOverrides);
|
|
3850
|
+
return await response.value();
|
|
3851
|
+
}
|
|
3671
3852
|
/**
|
|
3672
3853
|
* Creates request options for secrets without sending the request
|
|
3673
3854
|
*/
|
|
@@ -82,6 +82,11 @@ import { type SandboxEnvironmentResponse } from '../models/SandboxEnvironmentRes
|
|
|
82
82
|
import { type SandboxInfoResponse } from '../models/SandboxInfoResponse';
|
|
83
83
|
import { type SandboxListResponse } from '../models/SandboxListResponse';
|
|
84
84
|
import { type SandboxUsageResponse } from '../models/SandboxUsageResponse';
|
|
85
|
+
import { type SavedSnapshotDeletedResponse } from '../models/SavedSnapshotDeletedResponse';
|
|
86
|
+
import { type SavedSnapshotInfoResponse } from '../models/SavedSnapshotInfoResponse';
|
|
87
|
+
import { type SavedSnapshotListResponse } from '../models/SavedSnapshotListResponse';
|
|
88
|
+
import { type SavedSnapshotSaveRequest } from '../models/SavedSnapshotSaveRequest';
|
|
89
|
+
import { type SavedSnapshotSavingResponse } from '../models/SavedSnapshotSavingResponse';
|
|
85
90
|
import { type SecretsResponse } from '../models/SecretsResponse';
|
|
86
91
|
import { type SecretsUpdateRequest } from '../models/SecretsUpdateRequest';
|
|
87
92
|
import { type SetCredentialKeyRequest } from '../models/SetCredentialKeyRequest';
|
|
@@ -246,6 +251,9 @@ export interface DeleteSandboxSnapshotsRequest {
|
|
|
246
251
|
sandboxId: string;
|
|
247
252
|
xAsciiConfirmDelete: string;
|
|
248
253
|
}
|
|
254
|
+
export interface DeleteSavedSnapshotRequest {
|
|
255
|
+
name: string;
|
|
256
|
+
}
|
|
249
257
|
export interface DeleteSnapshotRequest {
|
|
250
258
|
snapshotId: string;
|
|
251
259
|
xAsciiConfirmDelete: string;
|
|
@@ -305,6 +313,9 @@ export interface GetSandboxAiUsageRequest {
|
|
|
305
313
|
sandboxId: string;
|
|
306
314
|
days?: number;
|
|
307
315
|
}
|
|
316
|
+
export interface GetSavedSnapshotRequest {
|
|
317
|
+
name: string;
|
|
318
|
+
}
|
|
308
319
|
export interface GetSnapshotDownloadRequest {
|
|
309
320
|
snapshotId: string;
|
|
310
321
|
}
|
|
@@ -409,6 +420,9 @@ export interface SandboxesRequest {
|
|
|
409
420
|
export interface SaveNamedSnapshotRequest {
|
|
410
421
|
namedSnapshotSaveRequest: NamedSnapshotSaveRequest;
|
|
411
422
|
}
|
|
423
|
+
export interface SaveSavedSnapshotRequest {
|
|
424
|
+
savedSnapshotSaveRequest: SavedSnapshotSaveRequest;
|
|
425
|
+
}
|
|
412
426
|
export interface SelectRepoRequest {
|
|
413
427
|
repoSelectionRequest: RepoSelectionRequest;
|
|
414
428
|
}
|
|
@@ -750,13 +764,13 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
750
764
|
*/
|
|
751
765
|
createSnapshotShareRequestOpts(requestParameters: CreateSnapshotShareRequest): Promise<runtime.RequestOpts>;
|
|
752
766
|
/**
|
|
753
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
754
|
-
* Share a
|
|
767
|
+
* Make a secret code that lets any Boat account create a sandbox from this saved snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
|
|
768
|
+
* Share a saved snapshot
|
|
755
769
|
*/
|
|
756
770
|
createSnapshotShareRaw(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotShareCreatedResponse>>;
|
|
757
771
|
/**
|
|
758
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
759
|
-
* Share a
|
|
772
|
+
* Make a secret code that lets any Boat account create a sandbox from this saved snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
|
|
773
|
+
* Share a saved snapshot
|
|
760
774
|
*/
|
|
761
775
|
createSnapshotShare(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareCreatedResponse>;
|
|
762
776
|
/**
|
|
@@ -901,16 +915,19 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
901
915
|
deleteEnvironmentVar(requestParameters: DeleteEnvironmentVarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
902
916
|
/**
|
|
903
917
|
* Creates request options for deleteNamedSnapshot without sending the request
|
|
918
|
+
* @deprecated
|
|
904
919
|
*/
|
|
905
920
|
deleteNamedSnapshotRequestOpts(requestParameters: DeleteNamedSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
906
921
|
/**
|
|
907
922
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
908
923
|
* Remove a named snapshot
|
|
924
|
+
* @deprecated
|
|
909
925
|
*/
|
|
910
926
|
deleteNamedSnapshotRaw(requestParameters: DeleteNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotDeletedResponse>>;
|
|
911
927
|
/**
|
|
912
928
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
913
929
|
* Remove a named snapshot
|
|
930
|
+
* @deprecated
|
|
914
931
|
*/
|
|
915
932
|
deleteNamedSnapshot(requestParameters: DeleteNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotDeletedResponse>;
|
|
916
933
|
/**
|
|
@@ -918,12 +935,12 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
918
935
|
*/
|
|
919
936
|
deleteSandboxRequestOpts(requestParameters: DeleteSandboxRequest): Promise<runtime.RequestOpts>;
|
|
920
937
|
/**
|
|
921
|
-
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed.
|
|
938
|
+
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed. Saved snapshots and other shared artifacts remain independent. Poll the returned operation until `completed`.
|
|
922
939
|
* Permanently delete sandbox data
|
|
923
940
|
*/
|
|
924
941
|
deleteSandboxRaw(requestParameters: DeleteSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletionOperationResponse>>;
|
|
925
942
|
/**
|
|
926
|
-
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed.
|
|
943
|
+
* Accept irreversible background deletion of the sandbox machine, snapshots, and content-bearing records. This is not archive: the sandbox cannot be resumed. Saved snapshots and other shared artifacts remain independent. Poll the returned operation until `completed`.
|
|
927
944
|
* Permanently delete sandbox data
|
|
928
945
|
*/
|
|
929
946
|
deleteSandbox(requestParameters: DeleteSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationResponse>;
|
|
@@ -932,15 +949,29 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
932
949
|
*/
|
|
933
950
|
deleteSandboxSnapshotsRequestOpts(requestParameters: DeleteSandboxSnapshotsRequest): Promise<runtime.RequestOpts>;
|
|
934
951
|
/**
|
|
935
|
-
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its
|
|
952
|
+
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its saved 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.
|
|
936
953
|
* Permanently delete all snapshots of a sandbox
|
|
937
954
|
*/
|
|
938
955
|
deleteSandboxSnapshotsRaw(requestParameters: DeleteSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletionOperationListResponse>>;
|
|
939
956
|
/**
|
|
940
|
-
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its
|
|
957
|
+
* Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its saved 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.
|
|
941
958
|
* Permanently delete all snapshots of a sandbox
|
|
942
959
|
*/
|
|
943
960
|
deleteSandboxSnapshots(requestParameters: DeleteSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationListResponse>;
|
|
961
|
+
/**
|
|
962
|
+
* Creates request options for deleteSavedSnapshot without sending the request
|
|
963
|
+
*/
|
|
964
|
+
deleteSavedSnapshotRequestOpts(requestParameters: DeleteSavedSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
965
|
+
/**
|
|
966
|
+
* Remove a saved snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
967
|
+
* Remove a saved snapshot
|
|
968
|
+
*/
|
|
969
|
+
deleteSavedSnapshotRaw(requestParameters: DeleteSavedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSnapshotDeletedResponse>>;
|
|
970
|
+
/**
|
|
971
|
+
* Remove a saved snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
972
|
+
* Remove a saved snapshot
|
|
973
|
+
*/
|
|
974
|
+
deleteSavedSnapshot(requestParameters: DeleteSavedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSnapshotDeletedResponse>;
|
|
944
975
|
/**
|
|
945
976
|
* Creates request options for deleteSnapshot without sending the request
|
|
946
977
|
*/
|
|
@@ -1137,14 +1168,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1137
1168
|
getLatestSandboxSnapshot(requestParameters: GetLatestSandboxSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SnapshotLatestResponse>;
|
|
1138
1169
|
/**
|
|
1139
1170
|
* Creates request options for getNamedSnapshot without sending the request
|
|
1171
|
+
* @deprecated
|
|
1140
1172
|
*/
|
|
1141
1173
|
getNamedSnapshotRequestOpts(requestParameters: GetNamedSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
1142
1174
|
/**
|
|
1143
1175
|
* Get a named snapshot
|
|
1176
|
+
* @deprecated
|
|
1144
1177
|
*/
|
|
1145
1178
|
getNamedSnapshotRaw(requestParameters: GetNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotInfoResponse>>;
|
|
1146
1179
|
/**
|
|
1147
1180
|
* Get a named snapshot
|
|
1181
|
+
* @deprecated
|
|
1148
1182
|
*/
|
|
1149
1183
|
getNamedSnapshot(requestParameters: GetNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotInfoResponse>;
|
|
1150
1184
|
/**
|
|
@@ -1161,6 +1195,18 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1161
1195
|
* Get sandbox AI usage
|
|
1162
1196
|
*/
|
|
1163
1197
|
getSandboxAiUsage(requestParameters: GetSandboxAiUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxAiUsageResponse>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Creates request options for getSavedSnapshot without sending the request
|
|
1200
|
+
*/
|
|
1201
|
+
getSavedSnapshotRequestOpts(requestParameters: GetSavedSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
1202
|
+
/**
|
|
1203
|
+
* Get a saved snapshot
|
|
1204
|
+
*/
|
|
1205
|
+
getSavedSnapshotRaw(requestParameters: GetSavedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSnapshotInfoResponse>>;
|
|
1206
|
+
/**
|
|
1207
|
+
* Get a saved snapshot
|
|
1208
|
+
*/
|
|
1209
|
+
getSavedSnapshot(requestParameters: GetSavedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSnapshotInfoResponse>;
|
|
1164
1210
|
/**
|
|
1165
1211
|
* Creates request options for getSnapshotDownload without sending the request
|
|
1166
1212
|
*/
|
|
@@ -1317,16 +1363,19 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1317
1363
|
listCredentialProfiles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CredentialProfileListResponse>;
|
|
1318
1364
|
/**
|
|
1319
1365
|
* Creates request options for listNamedSnapshots without sending the request
|
|
1366
|
+
* @deprecated
|
|
1320
1367
|
*/
|
|
1321
1368
|
listNamedSnapshotsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1322
1369
|
/**
|
|
1323
1370
|
* List your named snapshots, newest first.
|
|
1324
1371
|
* List named snapshots
|
|
1372
|
+
* @deprecated
|
|
1325
1373
|
*/
|
|
1326
1374
|
listNamedSnapshotsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotListResponse>>;
|
|
1327
1375
|
/**
|
|
1328
1376
|
* List your named snapshots, newest first.
|
|
1329
1377
|
* List named snapshots
|
|
1378
|
+
* @deprecated
|
|
1330
1379
|
*/
|
|
1331
1380
|
listNamedSnapshots(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotListResponse>;
|
|
1332
1381
|
/**
|
|
@@ -1357,18 +1406,32 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1357
1406
|
* List boat snapshots
|
|
1358
1407
|
*/
|
|
1359
1408
|
listSandboxSnapshots(requestParameters: ListSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SnapshotListResponse>;
|
|
1409
|
+
/**
|
|
1410
|
+
* Creates request options for listSavedSnapshots without sending the request
|
|
1411
|
+
*/
|
|
1412
|
+
listSavedSnapshotsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1413
|
+
/**
|
|
1414
|
+
* List your saved snapshots, newest first.
|
|
1415
|
+
* List saved snapshots
|
|
1416
|
+
*/
|
|
1417
|
+
listSavedSnapshotsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSnapshotListResponse>>;
|
|
1418
|
+
/**
|
|
1419
|
+
* List your saved snapshots, newest first.
|
|
1420
|
+
* List saved snapshots
|
|
1421
|
+
*/
|
|
1422
|
+
listSavedSnapshots(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSnapshotListResponse>;
|
|
1360
1423
|
/**
|
|
1361
1424
|
* Creates request options for listSnapshotShares without sending the request
|
|
1362
1425
|
*/
|
|
1363
1426
|
listSnapshotSharesRequestOpts(requestParameters: ListSnapshotSharesRequest): Promise<runtime.RequestOpts>;
|
|
1364
1427
|
/**
|
|
1365
|
-
* List the share codes of a
|
|
1366
|
-
* List share codes of a
|
|
1428
|
+
* List the share codes of a saved snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
|
|
1429
|
+
* List share codes of a saved snapshot
|
|
1367
1430
|
*/
|
|
1368
1431
|
listSnapshotSharesRaw(requestParameters: ListSnapshotSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotShareListResponse>>;
|
|
1369
1432
|
/**
|
|
1370
|
-
* List the share codes of a
|
|
1371
|
-
* List share codes of a
|
|
1433
|
+
* List the share codes of a saved snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
|
|
1434
|
+
* List share codes of a saved snapshot
|
|
1372
1435
|
*/
|
|
1373
1436
|
listSnapshotShares(requestParameters: ListSnapshotSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareListResponse>;
|
|
1374
1437
|
/**
|
|
@@ -1581,18 +1644,35 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1581
1644
|
sandboxes(requestParameters?: SandboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxListResponse>;
|
|
1582
1645
|
/**
|
|
1583
1646
|
* Creates request options for saveNamedSnapshot without sending the request
|
|
1647
|
+
* @deprecated
|
|
1584
1648
|
*/
|
|
1585
1649
|
saveNamedSnapshotRequestOpts(input: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>): Promise<runtime.RequestOpts>;
|
|
1586
1650
|
/**
|
|
1587
1651
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1588
1652
|
* Save a named snapshot
|
|
1653
|
+
* @deprecated
|
|
1589
1654
|
*/
|
|
1590
1655
|
saveNamedSnapshotRaw(requestParameters: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotSavingResponse>>;
|
|
1591
1656
|
/**
|
|
1592
1657
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1593
1658
|
* Save a named snapshot
|
|
1659
|
+
* @deprecated
|
|
1594
1660
|
*/
|
|
1595
1661
|
saveNamedSnapshot(requestParameters: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotSavingResponse>;
|
|
1662
|
+
/**
|
|
1663
|
+
* Creates request options for saveSavedSnapshot without sending the request
|
|
1664
|
+
*/
|
|
1665
|
+
saveSavedSnapshotRequestOpts(input: SaveSavedSnapshotRequest | runtime.FlatBody<SaveSavedSnapshotRequest, 'savedSnapshotSaveRequest'>): Promise<runtime.RequestOpts>;
|
|
1666
|
+
/**
|
|
1667
|
+
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1668
|
+
* Save a saved snapshot
|
|
1669
|
+
*/
|
|
1670
|
+
saveSavedSnapshotRaw(requestParameters: SaveSavedSnapshotRequest | runtime.FlatBody<SaveSavedSnapshotRequest, 'savedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSnapshotSavingResponse>>;
|
|
1671
|
+
/**
|
|
1672
|
+
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1673
|
+
* Save a saved snapshot
|
|
1674
|
+
*/
|
|
1675
|
+
saveSavedSnapshot(requestParameters: SaveSavedSnapshotRequest | runtime.FlatBody<SaveSavedSnapshotRequest, 'savedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSnapshotSavingResponse>;
|
|
1596
1676
|
/**
|
|
1597
1677
|
* Creates request options for secrets without sending the request
|
|
1598
1678
|
*/
|