@boatdev/sdk 1.9.9 → 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 +30 -0
- package/dist/apis/BoatApi.d.ts +144 -18
- package/dist/apis/BoatApi.js +305 -22
- package/dist/esm/apis/BoatApi.d.ts +144 -18
- package/dist/esm/apis/BoatApi.js +304 -21
- package/dist/esm/models/CreateSandboxRequest.d.ts +9 -3
- package/dist/esm/models/CreateSandboxRequest.js +2 -0
- package/dist/esm/models/CreateSandboxResponse.d.ts +6 -0
- package/dist/esm/models/CreateSandboxResponse.js +2 -0
- package/dist/esm/models/CreateScopedApiKeyRequest.d.ts +1 -1
- 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/LimitsFields.d.ts +1 -1
- package/dist/esm/models/LimitsResponse.d.ts +1 -1
- package/dist/esm/models/MeResponseAllOfUser.d.ts +1 -0
- package/dist/esm/models/MeResponseAllOfUser.js +1 -0
- 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/ResumeRequest.d.ts +1 -1
- package/dist/esm/models/Sandbox.d.ts +35 -1
- package/dist/esm/models/Sandbox.js +17 -0
- package/dist/esm/models/SandboxCost.d.ts +44 -0
- package/dist/esm/models/SandboxCost.js +51 -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/Unshare200Response.d.ts +39 -0
- package/dist/esm/models/Unshare200Response.js +44 -0
- package/dist/esm/models/UpdateCredentialProfileRequest.d.ts +7 -0
- package/dist/esm/models/UpdateCredentialProfileRequest.js +3 -0
- package/dist/esm/models/UpdateOrganization200Response.d.ts +50 -0
- package/dist/esm/models/UpdateOrganization200Response.js +47 -0
- package/dist/esm/models/UpdateOrganizationRequest.d.ts +32 -0
- package/dist/esm/models/UpdateOrganizationRequest.js +43 -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 +15 -0
- package/dist/esm/models/index.js +15 -0
- package/dist/models/CreateSandboxRequest.d.ts +9 -3
- package/dist/models/CreateSandboxRequest.js +2 -0
- package/dist/models/CreateSandboxResponse.d.ts +6 -0
- package/dist/models/CreateSandboxResponse.js +2 -0
- package/dist/models/CreateScopedApiKeyRequest.d.ts +1 -1
- 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/LimitsFields.d.ts +1 -1
- package/dist/models/LimitsResponse.d.ts +1 -1
- package/dist/models/MeResponseAllOfUser.d.ts +1 -0
- package/dist/models/MeResponseAllOfUser.js +1 -0
- 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/ResumeRequest.d.ts +1 -1
- package/dist/models/Sandbox.d.ts +35 -1
- package/dist/models/Sandbox.js +18 -1
- package/dist/models/SandboxCost.d.ts +44 -0
- package/dist/models/SandboxCost.js +58 -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/Unshare200Response.d.ts +39 -0
- package/dist/models/Unshare200Response.js +51 -0
- package/dist/models/UpdateCredentialProfileRequest.d.ts +7 -0
- package/dist/models/UpdateCredentialProfileRequest.js +3 -0
- package/dist/models/UpdateOrganization200Response.d.ts +50 -0
- package/dist/models/UpdateOrganization200Response.js +54 -0
- package/dist/models/UpdateOrganizationRequest.d.ts +32 -0
- package/dist/models/UpdateOrganizationRequest.js +50 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.d.ts +7 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.js +3 -0
- package/dist/models/index.d.ts +15 -0
- package/dist/models/index.js +15 -0
- package/docs/BoatApi.md +468 -19
- package/docs/CreateSandboxRequest.md +2 -0
- package/docs/CreateSandboxResponse.md +2 -0
- package/docs/CredentialProfile.md +2 -0
- package/docs/ResourceAccess.md +35 -0
- package/docs/ResourceAccessUpdate.md +35 -0
- package/docs/Sandbox.md +8 -0
- package/docs/SandboxCost.md +37 -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/Unshare200Response.md +34 -0
- package/docs/UpdateCredentialProfileRequest.md +2 -0
- package/docs/UpdateOrganization200Response.md +38 -0
- package/docs/UpdateOrganizationRequest.md +32 -0
- package/docs/UpdateSandboxEnvironmentRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +440 -21
- package/src/models/CreateSandboxRequest.ts +11 -3
- package/src/models/CreateSandboxResponse.ts +8 -0
- package/src/models/CreateScopedApiKeyRequest.ts +1 -1
- package/src/models/CredentialId.ts +3 -0
- package/src/models/CredentialProfile.ts +15 -0
- package/src/models/DeletionOperation.ts +1 -1
- package/src/models/LimitsFields.ts +1 -1
- package/src/models/LimitsResponse.ts +1 -1
- package/src/models/MeResponseAllOfUser.ts +1 -0
- package/src/models/ResourceAccess.ts +75 -0
- package/src/models/ResourceAccessUpdate.ts +74 -0
- package/src/models/ResumeRequest.ts +1 -1
- package/src/models/Sandbox.ts +56 -1
- package/src/models/SandboxCost.ts +84 -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/Unshare200Response.ts +81 -0
- package/src/models/UpdateCredentialProfileRequest.ts +16 -0
- package/src/models/UpdateOrganization200Response.ts +89 -0
- package/src/models/UpdateOrganizationRequest.ts +66 -0
- package/src/models/UpdateSandboxEnvironmentRequest.ts +15 -0
- package/src/models/index.ts +15 -0
package/dist/apis/BoatApi.js
CHANGED
|
@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
46
46
|
};
|
|
47
47
|
})();
|
|
48
48
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
-
exports.SandboxesSortEnum = exports.ReposSortEnum = exports.ReadFileEncodingEnum = exports.ListSnapshotsSortEnum = exports.ListSandboxSnapshotsSortEnum = exports.EventsSortEnum = exports.DesktopOperationThemeEnum = exports.DesktopOperationVncEnum = exports.CommandLogsEncodingEnum = exports.CommandLogsStreamEnum = exports.BoatApi = void 0;
|
|
49
|
+
exports.SandboxesIncludeEnum = exports.SandboxesSortEnum = exports.ReposSortEnum = exports.ReadFileEncodingEnum = exports.ListSnapshotsSortEnum = exports.ListSandboxSnapshotsSortEnum = exports.EventsSortEnum = exports.DesktopOperationThemeEnum = exports.DesktopOperationVncEnum = exports.CommandLogsEncodingEnum = exports.CommandLogsStreamEnum = exports.BoatApi = void 0;
|
|
50
50
|
const runtime = __importStar(require("../runtime"));
|
|
51
51
|
const AccountAiUsageResponse_1 = require("../models/AccountAiUsageResponse");
|
|
52
52
|
const ActiveOrgResponse_1 = require("../models/ActiveOrgResponse");
|
|
@@ -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");
|
|
@@ -140,8 +145,11 @@ const StopRequest_1 = require("../models/StopRequest");
|
|
|
140
145
|
const TelemetryResponse_1 = require("../models/TelemetryResponse");
|
|
141
146
|
const TelemetrySetRequest_1 = require("../models/TelemetrySetRequest");
|
|
142
147
|
const TelemetrySetResponse_1 = require("../models/TelemetrySetResponse");
|
|
148
|
+
const Unshare200Response_1 = require("../models/Unshare200Response");
|
|
143
149
|
const UpdateAiProxyRequest_1 = require("../models/UpdateAiProxyRequest");
|
|
144
150
|
const UpdateCredentialProfileRequest_1 = require("../models/UpdateCredentialProfileRequest");
|
|
151
|
+
const UpdateOrganization200Response_1 = require("../models/UpdateOrganization200Response");
|
|
152
|
+
const UpdateOrganizationRequest_1 = require("../models/UpdateOrganizationRequest");
|
|
145
153
|
const UpdateSandboxEnvironmentRequest_1 = require("../models/UpdateSandboxEnvironmentRequest");
|
|
146
154
|
const UpdateSandboxRequest_1 = require("../models/UpdateSandboxRequest");
|
|
147
155
|
const UpgradeSandboxEnvironmentRequest_1 = require("../models/UpgradeSandboxEnvironmentRequest");
|
|
@@ -945,7 +953,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
945
953
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
946
954
|
}
|
|
947
955
|
}
|
|
948
|
-
let urlPath = `/
|
|
956
|
+
let urlPath = `/saved-snapshots/{name}/shares`;
|
|
949
957
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
950
958
|
return {
|
|
951
959
|
path: urlPath,
|
|
@@ -955,8 +963,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
955
963
|
};
|
|
956
964
|
}
|
|
957
965
|
/**
|
|
958
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
959
|
-
* 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
|
|
960
968
|
*/
|
|
961
969
|
async createSnapshotShareRaw(requestParameters, initOverrides) {
|
|
962
970
|
const requestOptions = await this.createSnapshotShareRequestOpts(requestParameters);
|
|
@@ -964,8 +972,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
964
972
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamedSnapshotShareCreatedResponse_1.NamedSnapshotShareCreatedResponseFromJSON)(jsonValue));
|
|
965
973
|
}
|
|
966
974
|
/**
|
|
967
|
-
* Make a secret code that lets any Boat account create a sandbox from this
|
|
968
|
-
* 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
|
|
969
977
|
*/
|
|
970
978
|
async createSnapshotShare(requestParameters, initOverrides) {
|
|
971
979
|
const response = await this.createSnapshotShareRaw(requestParameters, initOverrides);
|
|
@@ -1443,6 +1451,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1443
1451
|
}
|
|
1444
1452
|
/**
|
|
1445
1453
|
* Creates request options for deleteNamedSnapshot without sending the request
|
|
1454
|
+
* @deprecated
|
|
1446
1455
|
*/
|
|
1447
1456
|
async deleteNamedSnapshotRequestOpts(requestParameters) {
|
|
1448
1457
|
if (requestParameters['name'] == null) {
|
|
@@ -1469,6 +1478,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1469
1478
|
/**
|
|
1470
1479
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1471
1480
|
* Remove a named snapshot
|
|
1481
|
+
* @deprecated
|
|
1472
1482
|
*/
|
|
1473
1483
|
async deleteNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
1474
1484
|
const requestOptions = await this.deleteNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -1478,6 +1488,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1478
1488
|
/**
|
|
1479
1489
|
* Remove a named snapshot and release its storage (`boat snapshot rm <name>` in the CLI). Sandboxes already deployed from it are unaffected.
|
|
1480
1490
|
* Remove a named snapshot
|
|
1491
|
+
* @deprecated
|
|
1481
1492
|
*/
|
|
1482
1493
|
async deleteNamedSnapshot(requestParameters, initOverrides) {
|
|
1483
1494
|
const response = await this.deleteNamedSnapshotRaw(requestParameters, initOverrides);
|
|
@@ -1515,7 +1526,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1515
1526
|
};
|
|
1516
1527
|
}
|
|
1517
1528
|
/**
|
|
1518
|
-
* 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`.
|
|
1519
1530
|
* Permanently delete sandbox data
|
|
1520
1531
|
*/
|
|
1521
1532
|
async deleteSandboxRaw(requestParameters, initOverrides) {
|
|
@@ -1524,7 +1535,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1524
1535
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeletionOperationResponse_1.DeletionOperationResponseFromJSON)(jsonValue));
|
|
1525
1536
|
}
|
|
1526
1537
|
/**
|
|
1527
|
-
* 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`.
|
|
1528
1539
|
* Permanently delete sandbox data
|
|
1529
1540
|
*/
|
|
1530
1541
|
async deleteSandbox(requestParameters, initOverrides) {
|
|
@@ -1563,7 +1574,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1563
1574
|
};
|
|
1564
1575
|
}
|
|
1565
1576
|
/**
|
|
1566
|
-
* 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.
|
|
1567
1578
|
* Permanently delete all snapshots of a sandbox
|
|
1568
1579
|
*/
|
|
1569
1580
|
async deleteSandboxSnapshotsRaw(requestParameters, initOverrides) {
|
|
@@ -1572,13 +1583,55 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1572
1583
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeletionOperationListResponse_1.DeletionOperationListResponseFromJSON)(jsonValue));
|
|
1573
1584
|
}
|
|
1574
1585
|
/**
|
|
1575
|
-
* 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.
|
|
1576
1587
|
* Permanently delete all snapshots of a sandbox
|
|
1577
1588
|
*/
|
|
1578
1589
|
async deleteSandboxSnapshots(requestParameters, initOverrides) {
|
|
1579
1590
|
const response = await this.deleteSandboxSnapshotsRaw(requestParameters, initOverrides);
|
|
1580
1591
|
return await response.value();
|
|
1581
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
|
+
}
|
|
1582
1635
|
/**
|
|
1583
1636
|
* Creates request options for deleteSnapshot without sending the request
|
|
1584
1637
|
*/
|
|
@@ -2208,6 +2261,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2208
2261
|
}
|
|
2209
2262
|
/**
|
|
2210
2263
|
* Creates request options for getNamedSnapshot without sending the request
|
|
2264
|
+
* @deprecated
|
|
2211
2265
|
*/
|
|
2212
2266
|
async getNamedSnapshotRequestOpts(requestParameters) {
|
|
2213
2267
|
if (requestParameters['name'] == null) {
|
|
@@ -2233,6 +2287,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2233
2287
|
}
|
|
2234
2288
|
/**
|
|
2235
2289
|
* Get a named snapshot
|
|
2290
|
+
* @deprecated
|
|
2236
2291
|
*/
|
|
2237
2292
|
async getNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
2238
2293
|
const requestOptions = await this.getNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -2241,6 +2296,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2241
2296
|
}
|
|
2242
2297
|
/**
|
|
2243
2298
|
* Get a named snapshot
|
|
2299
|
+
* @deprecated
|
|
2244
2300
|
*/
|
|
2245
2301
|
async getNamedSnapshot(requestParameters, initOverrides) {
|
|
2246
2302
|
const response = await this.getNamedSnapshotRaw(requestParameters, initOverrides);
|
|
@@ -2275,7 +2331,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2275
2331
|
};
|
|
2276
2332
|
}
|
|
2277
2333
|
/**
|
|
2278
|
-
* One sandbox\'s proxied AI usage per UTC day, credential and model, and whether it is blocked. Needs an API key with `
|
|
2334
|
+
* One sandbox\'s proxied AI usage per UTC day, credential and model, and whether it is blocked. Needs an API key with `sandbox.read` on the sandbox.
|
|
2279
2335
|
* Get sandbox AI usage
|
|
2280
2336
|
*/
|
|
2281
2337
|
async getSandboxAiUsageRaw(requestParameters, initOverrides) {
|
|
@@ -2284,13 +2340,53 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2284
2340
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, SandboxAiUsageResponse_1.SandboxAiUsageResponseFromJSON)(jsonValue));
|
|
2285
2341
|
}
|
|
2286
2342
|
/**
|
|
2287
|
-
* One sandbox\'s proxied AI usage per UTC day, credential and model, and whether it is blocked. Needs an API key with `
|
|
2343
|
+
* One sandbox\'s proxied AI usage per UTC day, credential and model, and whether it is blocked. Needs an API key with `sandbox.read` on the sandbox.
|
|
2288
2344
|
* Get sandbox AI usage
|
|
2289
2345
|
*/
|
|
2290
2346
|
async getSandboxAiUsage(requestParameters, initOverrides) {
|
|
2291
2347
|
const response = await this.getSandboxAiUsageRaw(requestParameters, initOverrides);
|
|
2292
2348
|
return await response.value();
|
|
2293
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
|
+
}
|
|
2294
2390
|
/**
|
|
2295
2391
|
* Creates request options for getSnapshotDownload without sending the request
|
|
2296
2392
|
*/
|
|
@@ -2772,6 +2868,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2772
2868
|
}
|
|
2773
2869
|
/**
|
|
2774
2870
|
* Creates request options for listNamedSnapshots without sending the request
|
|
2871
|
+
* @deprecated
|
|
2775
2872
|
*/
|
|
2776
2873
|
async listNamedSnapshotsRequestOpts() {
|
|
2777
2874
|
const queryParameters = {};
|
|
@@ -2794,6 +2891,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2794
2891
|
/**
|
|
2795
2892
|
* List your named snapshots, newest first.
|
|
2796
2893
|
* List named snapshots
|
|
2894
|
+
* @deprecated
|
|
2797
2895
|
*/
|
|
2798
2896
|
async listNamedSnapshotsRaw(initOverrides) {
|
|
2799
2897
|
const requestOptions = await this.listNamedSnapshotsRequestOpts();
|
|
@@ -2803,6 +2901,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2803
2901
|
/**
|
|
2804
2902
|
* List your named snapshots, newest first.
|
|
2805
2903
|
* List named snapshots
|
|
2904
|
+
* @deprecated
|
|
2806
2905
|
*/
|
|
2807
2906
|
async listNamedSnapshots(initOverrides) {
|
|
2808
2907
|
const response = await this.listNamedSnapshotsRaw(initOverrides);
|
|
@@ -2897,6 +2996,44 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2897
2996
|
const response = await this.listSandboxSnapshotsRaw(requestParameters, initOverrides);
|
|
2898
2997
|
return await response.value();
|
|
2899
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
|
+
}
|
|
2900
3037
|
/**
|
|
2901
3038
|
* Creates request options for listSnapshotShares without sending the request
|
|
2902
3039
|
*/
|
|
@@ -2913,7 +3050,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2913
3050
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
2914
3051
|
}
|
|
2915
3052
|
}
|
|
2916
|
-
let urlPath = `/
|
|
3053
|
+
let urlPath = `/saved-snapshots/{name}/shares`;
|
|
2917
3054
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
2918
3055
|
return {
|
|
2919
3056
|
path: urlPath,
|
|
@@ -2923,8 +3060,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2923
3060
|
};
|
|
2924
3061
|
}
|
|
2925
3062
|
/**
|
|
2926
|
-
* List the share codes of a
|
|
2927
|
-
* 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
|
|
2928
3065
|
*/
|
|
2929
3066
|
async listSnapshotSharesRaw(requestParameters, initOverrides) {
|
|
2930
3067
|
const requestOptions = await this.listSnapshotSharesRequestOpts(requestParameters);
|
|
@@ -2932,8 +3069,8 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2932
3069
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamedSnapshotShareListResponse_1.NamedSnapshotShareListResponseFromJSON)(jsonValue));
|
|
2933
3070
|
}
|
|
2934
3071
|
/**
|
|
2935
|
-
* List the share codes of a
|
|
2936
|
-
* 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
|
|
2937
3074
|
*/
|
|
2938
3075
|
async listSnapshotShares(requestParameters, initOverrides) {
|
|
2939
3076
|
const response = await this.listSnapshotSharesRaw(requestParameters, initOverrides);
|
|
@@ -3275,7 +3412,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3275
3412
|
};
|
|
3276
3413
|
}
|
|
3277
3414
|
/**
|
|
3278
|
-
* Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does. Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to answer, or resume it from its last snapshot. - `reset_failed`: the power-cycle failed. Reply to the incident email.
|
|
3415
|
+
* Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does. Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to answer, or stop it with `{\"force\": true}` and resume it from its last good snapshot. With no snapshot, a forced stop loses everything. - `reset_failed`: the power-cycle failed. Reply to the incident email.
|
|
3279
3416
|
* Recover a sandbox that stopped responding
|
|
3280
3417
|
*/
|
|
3281
3418
|
async recoverRaw(requestParameters, initOverrides) {
|
|
@@ -3284,7 +3421,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3284
3421
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Recover200Response_1.Recover200ResponseFromJSON)(jsonValue));
|
|
3285
3422
|
}
|
|
3286
3423
|
/**
|
|
3287
|
-
* Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does. Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to answer, or resume it from its last snapshot. - `reset_failed`: the power-cycle failed. Reply to the incident email.
|
|
3424
|
+
* Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does. Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to answer, or stop it with `{\"force\": true}` and resume it from its last good snapshot. With no snapshot, a forced stop loses everything. - `reset_failed`: the power-cycle failed. Reply to the incident email.
|
|
3288
3425
|
* Recover a sandbox that stopped responding
|
|
3289
3426
|
*/
|
|
3290
3427
|
async recover(requestParameters, initOverrides) {
|
|
@@ -3451,7 +3588,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3451
3588
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3452
3589
|
}
|
|
3453
3590
|
}
|
|
3454
|
-
let urlPath = `/
|
|
3591
|
+
let urlPath = `/saved-snapshots/{name}/shares/{shareId}`;
|
|
3455
3592
|
urlPath = urlPath.replace('{name}', encodeURIComponent(String(requestParameters['name'])));
|
|
3456
3593
|
urlPath = urlPath.replace('{shareId}', encodeURIComponent(String(requestParameters['shareId'])));
|
|
3457
3594
|
return {
|
|
@@ -3582,6 +3719,9 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3582
3719
|
if (requestParameters['state'] != null) {
|
|
3583
3720
|
queryParameters['state'] = requestParameters['state'];
|
|
3584
3721
|
}
|
|
3722
|
+
if (requestParameters['include'] != null) {
|
|
3723
|
+
queryParameters['include'] = requestParameters['include'];
|
|
3724
|
+
}
|
|
3585
3725
|
const headerParameters = {};
|
|
3586
3726
|
if (requestParameters['xBoatOrg'] != null) {
|
|
3587
3727
|
headerParameters['X-Boat-Org'] = String(requestParameters['xBoatOrg']);
|
|
@@ -3620,6 +3760,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3620
3760
|
}
|
|
3621
3761
|
/**
|
|
3622
3762
|
* Creates request options for saveNamedSnapshot without sending the request
|
|
3763
|
+
* @deprecated
|
|
3623
3764
|
*/
|
|
3624
3765
|
async saveNamedSnapshotRequestOpts(input) {
|
|
3625
3766
|
const requestParameters = runtime.unflattenBody(input, 'namedSnapshotSaveRequest', [], []);
|
|
@@ -3648,6 +3789,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3648
3789
|
/**
|
|
3649
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.
|
|
3650
3791
|
* Save a named snapshot
|
|
3792
|
+
* @deprecated
|
|
3651
3793
|
*/
|
|
3652
3794
|
async saveNamedSnapshotRaw(requestParameters, initOverrides) {
|
|
3653
3795
|
const requestOptions = await this.saveNamedSnapshotRequestOpts(requestParameters);
|
|
@@ -3657,11 +3799,56 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3657
3799
|
/**
|
|
3658
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.
|
|
3659
3801
|
* Save a named snapshot
|
|
3802
|
+
* @deprecated
|
|
3660
3803
|
*/
|
|
3661
3804
|
async saveNamedSnapshot(requestParameters, initOverrides) {
|
|
3662
3805
|
const response = await this.saveNamedSnapshotRaw(requestParameters, initOverrides);
|
|
3663
3806
|
return await response.value();
|
|
3664
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
|
+
}
|
|
3665
3852
|
/**
|
|
3666
3853
|
* Creates request options for secrets without sending the request
|
|
3667
3854
|
*/
|
|
@@ -4116,7 +4303,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
4116
4303
|
};
|
|
4117
4304
|
}
|
|
4118
4305
|
/**
|
|
4119
|
-
* Let every member of the organization that pays for this sandbox use it.
|
|
4306
|
+
* Let every member of the organization that pays for this sandbox use it. A sandbox that holds none of your personal logins is shared at once. A sandbox that holds them: your personal logins (GitHub token, Claude and Codex logins, environment secrets, the sandbox\'s own CLI key) are never pushed to it again and are wiped off its disk at its next start, so a teammate never acts as you. Files you wrote stay. The wipe is one-way: the sandbox stays like a `noEnv` sandbox from then on. A running sandbox stays `view` for the organization until you stop and resume it (`restartRequired`): its running programs hold your logins in memory. Teammates never read history recorded before the share. Only the person who created the sandbox can share it, and only a sandbox billed to an organization. Sharing an already shared sandbox is a no-op. Undo with `POST /sandboxes/{sandboxId}/unshare`.
|
|
4120
4307
|
* Share sandbox with the organization
|
|
4121
4308
|
*/
|
|
4122
4309
|
async shareRaw(requestParameters, initOverrides) {
|
|
@@ -4125,7 +4312,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
4125
4312
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Share200Response_1.Share200ResponseFromJSON)(jsonValue));
|
|
4126
4313
|
}
|
|
4127
4314
|
/**
|
|
4128
|
-
* Let every member of the organization that pays for this sandbox use it.
|
|
4315
|
+
* Let every member of the organization that pays for this sandbox use it. A sandbox that holds none of your personal logins is shared at once. A sandbox that holds them: your personal logins (GitHub token, Claude and Codex logins, environment secrets, the sandbox\'s own CLI key) are never pushed to it again and are wiped off its disk at its next start, so a teammate never acts as you. Files you wrote stay. The wipe is one-way: the sandbox stays like a `noEnv` sandbox from then on. A running sandbox stays `view` for the organization until you stop and resume it (`restartRequired`): its running programs hold your logins in memory. Teammates never read history recorded before the share. Only the person who created the sandbox can share it, and only a sandbox billed to an organization. Sharing an already shared sandbox is a no-op. Undo with `POST /sandboxes/{sandboxId}/unshare`.
|
|
4129
4316
|
* Share sandbox with the organization
|
|
4130
4317
|
*/
|
|
4131
4318
|
async share(requestParameters, initOverrides) {
|
|
@@ -4372,6 +4559,48 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
4372
4559
|
const response = await this.switchCredentialAccountRaw(requestParameters, initOverrides);
|
|
4373
4560
|
return await response.value();
|
|
4374
4561
|
}
|
|
4562
|
+
/**
|
|
4563
|
+
* Creates request options for unshare without sending the request
|
|
4564
|
+
*/
|
|
4565
|
+
async unshareRequestOpts(requestParameters) {
|
|
4566
|
+
if (requestParameters['sandboxId'] == null) {
|
|
4567
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling unshare().');
|
|
4568
|
+
}
|
|
4569
|
+
const queryParameters = {};
|
|
4570
|
+
const headerParameters = {};
|
|
4571
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
4572
|
+
const token = this.configuration.accessToken;
|
|
4573
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
4574
|
+
if (tokenString) {
|
|
4575
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
4576
|
+
}
|
|
4577
|
+
}
|
|
4578
|
+
let urlPath = `/sandboxes/{sandboxId}/unshare`;
|
|
4579
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
4580
|
+
return {
|
|
4581
|
+
path: urlPath,
|
|
4582
|
+
method: 'POST',
|
|
4583
|
+
headers: headerParameters,
|
|
4584
|
+
query: queryParameters,
|
|
4585
|
+
};
|
|
4586
|
+
}
|
|
4587
|
+
/**
|
|
4588
|
+
* Make a shared organization sandbox private again, at once. Only you can then use it. Teammates still see it in their list and can stop it. Their SSH keys are removed from the running machine. Nothing on the sandbox changes: files, installs and its environment stay. Undo with `POST /sandboxes/{sandboxId}/share`. Only the person who created the sandbox can make it private, and only a sandbox billed to an organization. Making a private sandbox private is a no-op.
|
|
4589
|
+
* Make an organization sandbox private
|
|
4590
|
+
*/
|
|
4591
|
+
async unshareRaw(requestParameters, initOverrides) {
|
|
4592
|
+
const requestOptions = await this.unshareRequestOpts(requestParameters);
|
|
4593
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
4594
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Unshare200Response_1.Unshare200ResponseFromJSON)(jsonValue));
|
|
4595
|
+
}
|
|
4596
|
+
/**
|
|
4597
|
+
* Make a shared organization sandbox private again, at once. Only you can then use it. Teammates still see it in their list and can stop it. Their SSH keys are removed from the running machine. Nothing on the sandbox changes: files, installs and its environment stay. Undo with `POST /sandboxes/{sandboxId}/share`. Only the person who created the sandbox can make it private, and only a sandbox billed to an organization. Making a private sandbox private is a no-op.
|
|
4598
|
+
* Make an organization sandbox private
|
|
4599
|
+
*/
|
|
4600
|
+
async unshare(requestParameters, initOverrides) {
|
|
4601
|
+
const response = await this.unshareRaw(requestParameters, initOverrides);
|
|
4602
|
+
return await response.value();
|
|
4603
|
+
}
|
|
4375
4604
|
/**
|
|
4376
4605
|
* Creates request options for update without sending the request
|
|
4377
4606
|
*/
|
|
@@ -4611,6 +4840,54 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
4611
4840
|
const response = await this.updateEnvironmentRaw(requestParameters, initOverrides);
|
|
4612
4841
|
return await response.value();
|
|
4613
4842
|
}
|
|
4843
|
+
/**
|
|
4844
|
+
* Creates request options for updateOrganization without sending the request
|
|
4845
|
+
*/
|
|
4846
|
+
async updateOrganizationRequestOpts(input) {
|
|
4847
|
+
const requestParameters = runtime.unflattenBody(input, 'updateOrganizationRequest', ['org'], []);
|
|
4848
|
+
if (requestParameters['org'] == null) {
|
|
4849
|
+
throw new runtime.RequiredError('org', 'Required parameter "org" was null or undefined when calling updateOrganization().');
|
|
4850
|
+
}
|
|
4851
|
+
if (requestParameters['updateOrganizationRequest'] == null) {
|
|
4852
|
+
throw new runtime.RequiredError('updateOrganizationRequest', 'Required parameter "updateOrganizationRequest" was null or undefined when calling updateOrganization().');
|
|
4853
|
+
}
|
|
4854
|
+
const queryParameters = {};
|
|
4855
|
+
const headerParameters = {};
|
|
4856
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
4857
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
4858
|
+
const token = this.configuration.accessToken;
|
|
4859
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
4860
|
+
if (tokenString) {
|
|
4861
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
4862
|
+
}
|
|
4863
|
+
}
|
|
4864
|
+
let urlPath = `/orgs/{org}`;
|
|
4865
|
+
urlPath = urlPath.replace('{org}', encodeURIComponent(String(requestParameters['org'])));
|
|
4866
|
+
return {
|
|
4867
|
+
path: urlPath,
|
|
4868
|
+
method: 'PATCH',
|
|
4869
|
+
headers: headerParameters,
|
|
4870
|
+
query: queryParameters,
|
|
4871
|
+
body: (0, UpdateOrganizationRequest_1.UpdateOrganizationRequestToJSON)(requestParameters['updateOrganizationRequest']),
|
|
4872
|
+
};
|
|
4873
|
+
}
|
|
4874
|
+
/**
|
|
4875
|
+
* Owners and admins set whether new sandboxes of the organization start private (only their creator can use them) or shared (every member can use those that hold none of their creator\'s logins). The default is shared. Existing sandboxes keep their setting; their creators change it with `POST /sandboxes/{sandboxId}/share` and `POST /sandboxes/{sandboxId}/unshare`. A fork of a private sandbox is private.
|
|
4876
|
+
* Update organization settings
|
|
4877
|
+
*/
|
|
4878
|
+
async updateOrganizationRaw(requestParameters, initOverrides) {
|
|
4879
|
+
const requestOptions = await this.updateOrganizationRequestOpts(requestParameters);
|
|
4880
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
4881
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, UpdateOrganization200Response_1.UpdateOrganization200ResponseFromJSON)(jsonValue));
|
|
4882
|
+
}
|
|
4883
|
+
/**
|
|
4884
|
+
* Owners and admins set whether new sandboxes of the organization start private (only their creator can use them) or shared (every member can use those that hold none of their creator\'s logins). The default is shared. Existing sandboxes keep their setting; their creators change it with `POST /sandboxes/{sandboxId}/share` and `POST /sandboxes/{sandboxId}/unshare`. A fork of a private sandbox is private.
|
|
4885
|
+
* Update organization settings
|
|
4886
|
+
*/
|
|
4887
|
+
async updateOrganization(requestParameters, initOverrides) {
|
|
4888
|
+
const response = await this.updateOrganizationRaw(requestParameters, initOverrides);
|
|
4889
|
+
return await response.value();
|
|
4890
|
+
}
|
|
4614
4891
|
/**
|
|
4615
4892
|
* Creates request options for updateSecrets without sending the request
|
|
4616
4893
|
*/
|
|
@@ -4916,3 +5193,9 @@ exports.SandboxesSortEnum = {
|
|
|
4916
5193
|
Asc: 'asc',
|
|
4917
5194
|
Desc: 'desc'
|
|
4918
5195
|
};
|
|
5196
|
+
/**
|
|
5197
|
+
* @export
|
|
5198
|
+
*/
|
|
5199
|
+
exports.SandboxesIncludeEnum = {
|
|
5200
|
+
Cost: 'cost'
|
|
5201
|
+
};
|