@boatdev/sdk 1.0.0 → 1.0.1
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 +20 -0
- package/dist/apis/BoatApi.d.ts +36 -2
- package/dist/apis/BoatApi.js +86 -2
- package/dist/esm/apis/BoatApi.d.ts +36 -2
- package/dist/esm/apis/BoatApi.js +86 -2
- package/dist/esm/models/ActiveOrgResponse.d.ts +52 -0
- package/dist/esm/models/ActiveOrgResponse.js +58 -0
- package/dist/esm/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
- package/dist/esm/models/ActiveOrgResponseAllOfActive.js +58 -0
- package/dist/esm/models/ActiveOrgUpdateRequest.d.ts +32 -0
- package/dist/esm/models/ActiveOrgUpdateRequest.js +43 -0
- package/dist/esm/models/CommandResponse.d.ts +6 -0
- package/dist/esm/models/CommandResponse.js +2 -0
- package/dist/esm/models/CommandStatusResponse.d.ts +6 -0
- package/dist/esm/models/CommandStatusResponse.js +2 -0
- package/dist/esm/models/CreateSandboxRequest.d.ts +2 -3
- package/dist/esm/models/CreateSandboxRequest.js +1 -2
- package/dist/esm/models/CreateSandboxResponse.d.ts +8 -1
- package/dist/esm/models/CreateSandboxResponse.js +4 -1
- package/dist/esm/models/ForkRequest.d.ts +1 -2
- package/dist/esm/models/ForkRequest.js +1 -2
- package/dist/esm/models/LimitsFields.d.ts +80 -0
- package/dist/esm/models/LimitsFields.js +28 -0
- package/dist/esm/models/LimitsFieldsCurrentLimits.d.ts +6 -0
- package/dist/esm/models/LimitsFieldsCurrentLimits.js +2 -0
- package/dist/esm/models/LimitsFieldsGiftLimit.d.ts +50 -0
- package/dist/esm/models/LimitsFieldsGiftLimit.js +47 -0
- package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
- package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.js +57 -0
- package/dist/esm/models/LimitsResponse.d.ts +80 -0
- package/dist/esm/models/LimitsResponse.js +28 -0
- package/dist/esm/models/MeResponseAllOfUser.d.ts +109 -0
- package/dist/esm/models/MeResponseAllOfUser.js +47 -0
- package/dist/esm/models/Org.d.ts +84 -0
- package/dist/esm/models/Org.js +79 -0
- package/dist/esm/models/OrgListResponse.d.ts +58 -0
- package/dist/esm/models/OrgListResponse.js +62 -0
- package/dist/esm/models/PromptEventData.d.ts +20 -0
- package/dist/esm/models/PromptEventData.js +8 -0
- package/dist/esm/models/PromptEventDataAttachmentsInner.d.ts +44 -0
- package/dist/esm/models/PromptEventDataAttachmentsInner.js +45 -0
- package/dist/esm/models/PromptEventDataCitationsInner.d.ts +50 -0
- package/dist/esm/models/PromptEventDataCitationsInner.js +47 -0
- package/dist/esm/models/RepoSelectionResponse.d.ts +6 -0
- package/dist/esm/models/RepoSelectionResponse.js +2 -0
- package/dist/esm/models/ReposResponse.d.ts +6 -0
- package/dist/esm/models/ReposResponse.js +2 -0
- package/dist/esm/models/Repository.d.ts +18 -0
- package/dist/esm/models/Repository.js +6 -0
- package/dist/esm/models/ResponseEventData.d.ts +6 -0
- package/dist/esm/models/ResponseEventData.js +2 -0
- package/dist/esm/models/ResumeRequest.d.ts +1 -2
- package/dist/esm/models/ResumeRequest.js +1 -2
- package/dist/esm/models/Sandbox.d.ts +43 -4
- package/dist/esm/models/Sandbox.js +21 -3
- package/dist/esm/models/SandboxActionResponse.d.ts +12 -0
- package/dist/esm/models/SandboxActionResponse.js +4 -0
- package/dist/esm/models/SandboxEnvironment.d.ts +12 -0
- package/dist/esm/models/SandboxEnvironment.js +4 -0
- package/dist/esm/models/SandboxEnvironmentListResponse.d.ts +26 -0
- package/dist/esm/models/SandboxEnvironmentListResponse.js +16 -0
- package/dist/esm/models/SandboxInfoResponse.d.ts +6 -0
- package/dist/esm/models/SandboxInfoResponse.js +2 -0
- package/dist/esm/models/SandboxTeam.d.ts +38 -0
- package/dist/esm/models/SandboxTeam.js +47 -0
- package/dist/esm/models/SandboxUsageResponse.d.ts +1 -2
- package/dist/esm/models/SandboxUsageResponse.js +1 -2
- package/dist/esm/models/SecretsResponse.d.ts +6 -0
- package/dist/esm/models/SecretsResponse.js +2 -0
- package/dist/esm/models/SelectedRepository.d.ts +18 -0
- package/dist/esm/models/SelectedRepository.js +6 -0
- package/dist/esm/models/SnapshotChunk.d.ts +2 -2
- package/dist/esm/models/SnapshotSummary.d.ts +3 -3
- package/dist/esm/models/SshKeyResponse.d.ts +12 -0
- package/dist/esm/models/SshKeyResponse.js +4 -0
- package/dist/esm/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
- package/dist/esm/models/UpgradeSandboxEnvironmentResponse.js +6 -0
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/models/ActiveOrgResponse.d.ts +52 -0
- package/dist/models/ActiveOrgResponse.js +66 -0
- package/dist/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
- package/dist/models/ActiveOrgResponseAllOfActive.js +66 -0
- package/dist/models/ActiveOrgUpdateRequest.d.ts +32 -0
- package/dist/models/ActiveOrgUpdateRequest.js +50 -0
- package/dist/models/CommandResponse.d.ts +6 -0
- package/dist/models/CommandResponse.js +2 -0
- package/dist/models/CommandStatusResponse.d.ts +6 -0
- package/dist/models/CommandStatusResponse.js +2 -0
- package/dist/models/CreateSandboxRequest.d.ts +2 -3
- package/dist/models/CreateSandboxRequest.js +1 -2
- package/dist/models/CreateSandboxResponse.d.ts +8 -1
- package/dist/models/CreateSandboxResponse.js +4 -1
- package/dist/models/ForkRequest.d.ts +1 -2
- package/dist/models/ForkRequest.js +1 -2
- package/dist/models/LimitsFields.d.ts +80 -0
- package/dist/models/LimitsFields.js +28 -0
- package/dist/models/LimitsFieldsCurrentLimits.d.ts +6 -0
- package/dist/models/LimitsFieldsCurrentLimits.js +2 -0
- package/dist/models/LimitsFieldsGiftLimit.d.ts +50 -0
- package/dist/models/LimitsFieldsGiftLimit.js +54 -0
- package/dist/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
- package/dist/models/LimitsFieldsSandboxPlanTiersInner.js +64 -0
- package/dist/models/LimitsResponse.d.ts +80 -0
- package/dist/models/LimitsResponse.js +28 -0
- package/dist/models/MeResponseAllOfUser.d.ts +109 -0
- package/dist/models/MeResponseAllOfUser.js +48 -0
- package/dist/models/Org.d.ts +84 -0
- package/dist/models/Org.js +87 -0
- package/dist/models/OrgListResponse.d.ts +58 -0
- package/dist/models/OrgListResponse.js +70 -0
- package/dist/models/PromptEventData.d.ts +20 -0
- package/dist/models/PromptEventData.js +8 -0
- package/dist/models/PromptEventDataAttachmentsInner.d.ts +44 -0
- package/dist/models/PromptEventDataAttachmentsInner.js +52 -0
- package/dist/models/PromptEventDataCitationsInner.d.ts +50 -0
- package/dist/models/PromptEventDataCitationsInner.js +54 -0
- package/dist/models/RepoSelectionResponse.d.ts +6 -0
- package/dist/models/RepoSelectionResponse.js +2 -0
- package/dist/models/ReposResponse.d.ts +6 -0
- package/dist/models/ReposResponse.js +2 -0
- package/dist/models/Repository.d.ts +18 -0
- package/dist/models/Repository.js +6 -0
- package/dist/models/ResponseEventData.d.ts +6 -0
- package/dist/models/ResponseEventData.js +2 -0
- package/dist/models/ResumeRequest.d.ts +1 -2
- package/dist/models/ResumeRequest.js +1 -2
- package/dist/models/Sandbox.d.ts +43 -4
- package/dist/models/Sandbox.js +22 -4
- package/dist/models/SandboxActionResponse.d.ts +12 -0
- package/dist/models/SandboxActionResponse.js +4 -0
- package/dist/models/SandboxEnvironment.d.ts +12 -0
- package/dist/models/SandboxEnvironment.js +4 -0
- package/dist/models/SandboxEnvironmentListResponse.d.ts +26 -0
- package/dist/models/SandboxEnvironmentListResponse.js +17 -0
- package/dist/models/SandboxInfoResponse.d.ts +6 -0
- package/dist/models/SandboxInfoResponse.js +2 -0
- package/dist/models/SandboxTeam.d.ts +38 -0
- package/dist/models/SandboxTeam.js +54 -0
- package/dist/models/SandboxUsageResponse.d.ts +1 -2
- package/dist/models/SandboxUsageResponse.js +1 -2
- package/dist/models/SecretsResponse.d.ts +6 -0
- package/dist/models/SecretsResponse.js +2 -0
- package/dist/models/SelectedRepository.d.ts +18 -0
- package/dist/models/SelectedRepository.js +6 -0
- package/dist/models/SnapshotChunk.d.ts +2 -2
- package/dist/models/SnapshotSummary.d.ts +3 -3
- package/dist/models/SshKeyResponse.d.ts +12 -0
- package/dist/models/SshKeyResponse.js +4 -0
- package/dist/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
- package/dist/models/UpgradeSandboxEnvironmentResponse.js +6 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/docs/ActiveOrgResponse.md +36 -0
- package/docs/ActiveOrgResponseAllOfActive.md +36 -0
- package/docs/ActiveOrgUpdateRequest.md +32 -0
- package/docs/BoatApi.md +148 -7
- package/docs/Command200Response.md +2 -0
- package/docs/CommandResponse.md +2 -0
- package/docs/CommandStatusResponse.md +2 -0
- package/docs/CreateSandboxResponse.md +2 -0
- package/docs/LimitsFields.md +26 -0
- package/docs/LimitsFieldsCurrentLimits.md +2 -0
- package/docs/LimitsFieldsGiftLimit.md +39 -0
- package/docs/LimitsFieldsSandboxPlanTiersInner.md +48 -0
- package/docs/LimitsResponse.md +26 -0
- package/docs/MeResponseAllOfUser.md +30 -0
- package/docs/Org.md +44 -0
- package/docs/OrgListResponse.md +38 -0
- package/docs/PromptEventData.md +6 -0
- package/docs/PromptEventDataAttachmentsInner.md +36 -0
- package/docs/PromptEventDataCitationsInner.md +38 -0
- package/docs/RepoSelectionResponse.md +2 -0
- package/docs/ReposResponse.md +2 -0
- package/docs/Repository.md +6 -0
- package/docs/ResponseEventData.md +2 -0
- package/docs/Sandbox.md +10 -0
- package/docs/SandboxActionResponse.md +4 -0
- package/docs/SandboxEnvironment.md +4 -0
- package/docs/SandboxEnvironmentListResponse.md +4 -0
- package/docs/SandboxInfoResponse.md +2 -0
- package/docs/SandboxTeam.md +35 -0
- package/docs/SecretsResponse.md +2 -0
- package/docs/SelectedRepository.md +6 -0
- package/docs/SshKeyResponse.md +4 -0
- package/docs/UpgradeSandboxEnvironmentResponse.md +6 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +125 -2
- package/src/models/ActiveOrgResponse.ts +102 -0
- package/src/models/ActiveOrgResponseAllOfActive.ts +95 -0
- package/src/models/ActiveOrgUpdateRequest.ts +66 -0
- package/src/models/CommandResponse.ts +8 -0
- package/src/models/CommandStatusResponse.ts +8 -0
- package/src/models/CreateSandboxRequest.ts +3 -4
- package/src/models/CreateSandboxResponse.ts +11 -2
- package/src/models/ForkRequest.ts +2 -3
- package/src/models/LimitsFields.ts +118 -0
- package/src/models/LimitsFieldsCurrentLimits.ts +8 -0
- package/src/models/LimitsFieldsGiftLimit.ts +89 -0
- package/src/models/LimitsFieldsSandboxPlanTiersInner.ts +129 -0
- package/src/models/LimitsResponse.ts +118 -0
- package/src/models/MeResponseAllOfUser.ts +143 -0
- package/src/models/Org.ts +139 -0
- package/src/models/OrgListResponse.ts +111 -0
- package/src/models/PromptEventData.ts +39 -0
- package/src/models/PromptEventDataAttachmentsInner.ts +81 -0
- package/src/models/PromptEventDataCitationsInner.ts +89 -0
- package/src/models/RepoSelectionResponse.ts +8 -0
- package/src/models/ReposResponse.ts +8 -0
- package/src/models/Repository.ts +24 -0
- package/src/models/ResponseEventData.ts +8 -0
- package/src/models/ResumeRequest.ts +2 -3
- package/src/models/Sandbox.ts +63 -6
- package/src/models/SandboxActionResponse.ts +16 -0
- package/src/models/SandboxEnvironment.ts +16 -0
- package/src/models/SandboxEnvironmentListResponse.ts +34 -0
- package/src/models/SandboxInfoResponse.ts +8 -0
- package/src/models/SandboxTeam.ts +75 -0
- package/src/models/SandboxUsageResponse.ts +2 -3
- package/src/models/SecretsResponse.ts +8 -0
- package/src/models/SelectedRepository.ts +24 -0
- package/src/models/SnapshotChunk.ts +2 -2
- package/src/models/SnapshotSummary.ts +3 -3
- package/src/models/SshKeyResponse.ts +16 -0
- package/src/models/UpgradeSandboxEnvironmentResponse.ts +24 -0
- package/src/models/index.ts +10 -0
|
@@ -40,6 +40,12 @@ export interface SecretsResponse {
|
|
|
40
40
|
* @memberof SecretsResponse
|
|
41
41
|
*/
|
|
42
42
|
environmentId: string;
|
|
43
|
+
/**
|
|
44
|
+
* Id of the default environment. `environmentId` is the id of its latest version.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof SecretsResponse
|
|
47
|
+
*/
|
|
48
|
+
subenvironmentId?: string;
|
|
43
49
|
/**
|
|
44
50
|
*
|
|
45
51
|
* @type {string}
|
|
@@ -47,6 +47,7 @@ function SecretsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
47
|
'type': json['type'],
|
|
48
48
|
'success': json['success'] == null ? undefined : json['success'],
|
|
49
49
|
'environmentId': json['environmentId'],
|
|
50
|
+
'subenvironmentId': json['subenvironmentId'] == null ? undefined : json['subenvironmentId'],
|
|
50
51
|
'envContents': json['envContents'],
|
|
51
52
|
'secretFiles': (json['secretFiles'].map(SecretFile_1.SecretFileFromJSON)),
|
|
52
53
|
'pushed': json['pushed'] == null ? undefined : json['pushed'],
|
|
@@ -64,6 +65,7 @@ function SecretsResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
64
65
|
'type': value['type'],
|
|
65
66
|
'success': value['success'],
|
|
66
67
|
'environmentId': value['environmentId'],
|
|
68
|
+
'subenvironmentId': value['subenvironmentId'],
|
|
67
69
|
'envContents': value['envContents'],
|
|
68
70
|
'secretFiles': (value['secretFiles'].map(SecretFile_1.SecretFileToJSON)),
|
|
69
71
|
'pushed': value['pushed'],
|
|
@@ -39,6 +39,18 @@ export interface SelectedRepository {
|
|
|
39
39
|
* @memberof SelectedRepository
|
|
40
40
|
*/
|
|
41
41
|
fullName?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof SelectedRepository
|
|
46
|
+
*/
|
|
47
|
+
description?: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof SelectedRepository
|
|
52
|
+
*/
|
|
53
|
+
url?: string;
|
|
42
54
|
/**
|
|
43
55
|
*
|
|
44
56
|
* @type {boolean}
|
|
@@ -57,6 +69,12 @@ export interface SelectedRepository {
|
|
|
57
69
|
* @memberof SelectedRepository
|
|
58
70
|
*/
|
|
59
71
|
pushedAt?: Date;
|
|
72
|
+
/**
|
|
73
|
+
* Reserved; always null.
|
|
74
|
+
* @type {Date}
|
|
75
|
+
* @memberof SelectedRepository
|
|
76
|
+
*/
|
|
77
|
+
lastUserCommitAt?: Date;
|
|
60
78
|
/**
|
|
61
79
|
*
|
|
62
80
|
* @type {string}
|
|
@@ -36,9 +36,12 @@ function SelectedRepositoryFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
36
36
|
'databaseId': json['databaseId'] == null ? undefined : json['databaseId'],
|
|
37
37
|
'name': json['name'] == null ? undefined : json['name'],
|
|
38
38
|
'fullName': json['fullName'] == null ? undefined : json['fullName'],
|
|
39
|
+
'description': json['description'] == null ? undefined : json['description'],
|
|
40
|
+
'url': json['url'] == null ? undefined : json['url'],
|
|
39
41
|
'_private': json['private'] == null ? undefined : json['private'],
|
|
40
42
|
'permissions': json['permissions'] == null ? undefined : json['permissions'],
|
|
41
43
|
'pushedAt': json['pushedAt'] == null ? undefined : (new Date(json['pushedAt'])),
|
|
44
|
+
'lastUserCommitAt': json['lastUserCommitAt'] == null ? undefined : (new Date(json['lastUserCommitAt'])),
|
|
42
45
|
'baseBranch': json['baseBranch'] == null ? undefined : json['baseBranch'],
|
|
43
46
|
'setupRoutineId': json['setupRoutineId'] == null ? undefined : json['setupRoutineId'],
|
|
44
47
|
'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
|
|
@@ -57,9 +60,12 @@ function SelectedRepositoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
57
60
|
'databaseId': value['databaseId'],
|
|
58
61
|
'name': value['name'],
|
|
59
62
|
'fullName': value['fullName'],
|
|
63
|
+
'description': value['description'],
|
|
64
|
+
'url': value['url'],
|
|
60
65
|
'private': value['_private'],
|
|
61
66
|
'permissions': value['permissions'],
|
|
62
67
|
'pushedAt': value['pushedAt'] == null ? value['pushedAt'] : value['pushedAt'].toISOString(),
|
|
68
|
+
'lastUserCommitAt': value['lastUserCommitAt'] == null ? value['lastUserCommitAt'] : value['lastUserCommitAt'].toISOString(),
|
|
63
69
|
'baseBranch': value['baseBranch'],
|
|
64
70
|
'setupRoutineId': value['setupRoutineId'],
|
|
65
71
|
'setupScript': value['setupScript'],
|
|
@@ -44,13 +44,13 @@ export interface SnapshotChunk {
|
|
|
44
44
|
* @type {number}
|
|
45
45
|
* @memberof SnapshotChunk
|
|
46
46
|
*/
|
|
47
|
-
sizeBytes: number;
|
|
47
|
+
sizeBytes: number | null;
|
|
48
48
|
/**
|
|
49
49
|
*
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof SnapshotChunk
|
|
52
52
|
*/
|
|
53
|
-
sha256: string;
|
|
53
|
+
sha256: string | null;
|
|
54
54
|
/**
|
|
55
55
|
* Time-limited download URL (see `expiresInSeconds`).
|
|
56
56
|
* @type {string}
|
|
@@ -44,7 +44,7 @@ export interface SnapshotSummary {
|
|
|
44
44
|
* @type {number}
|
|
45
45
|
* @memberof SnapshotSummary
|
|
46
46
|
*/
|
|
47
|
-
generation: number;
|
|
47
|
+
generation: number | null;
|
|
48
48
|
/**
|
|
49
49
|
*
|
|
50
50
|
* @type {string}
|
|
@@ -68,13 +68,13 @@ export interface SnapshotSummary {
|
|
|
68
68
|
* @type {number}
|
|
69
69
|
* @memberof SnapshotSummary
|
|
70
70
|
*/
|
|
71
|
-
sizeBytes: number;
|
|
71
|
+
sizeBytes: number | null;
|
|
72
72
|
/**
|
|
73
73
|
* Inventory entries alive in the chain at this generation (includes base-image system entries).
|
|
74
74
|
* @type {number}
|
|
75
75
|
* @memberof SnapshotSummary
|
|
76
76
|
*/
|
|
77
|
-
fileCount: number;
|
|
77
|
+
fileCount: number | null;
|
|
78
78
|
/**
|
|
79
79
|
* Total bytes of your data restored by this snapshot (what resume/download returns; base image excluded). `null` on legacy snapshots.
|
|
80
80
|
* @type {number}
|
|
@@ -45,6 +45,18 @@ export interface SshKeyResponse {
|
|
|
45
45
|
* @memberof SshKeyResponse
|
|
46
46
|
*/
|
|
47
47
|
sshUser?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Public IPv4 `host:port` that forwards to the sandbox SSH server, set only when the machine has no public IPv4 of its own. Connect with `ssh -p <port> user@<host>`.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof SshKeyResponse
|
|
52
|
+
*/
|
|
53
|
+
sshEndpoint?: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The sandbox SSH server's public host key. Pin it in `known_hosts`.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof SshKeyResponse
|
|
58
|
+
*/
|
|
59
|
+
hostKey?: string;
|
|
48
60
|
}
|
|
49
61
|
/**
|
|
50
62
|
* Check if a given object implements the SshKeyResponse interface.
|
|
@@ -41,6 +41,8 @@ function SshKeyResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
41
|
'success': json['success'] == null ? undefined : json['success'],
|
|
42
42
|
'machineIp': json['machineIp'] == null ? undefined : json['machineIp'],
|
|
43
43
|
'sshUser': json['sshUser'] == null ? undefined : json['sshUser'],
|
|
44
|
+
'sshEndpoint': json['sshEndpoint'] == null ? undefined : json['sshEndpoint'],
|
|
45
|
+
'hostKey': json['hostKey'] == null ? undefined : json['hostKey'],
|
|
44
46
|
};
|
|
45
47
|
}
|
|
46
48
|
function SshKeyResponseToJSON(json) {
|
|
@@ -56,5 +58,7 @@ function SshKeyResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
56
58
|
'success': value['success'],
|
|
57
59
|
'machineIp': value['machineIp'],
|
|
58
60
|
'sshUser': value['sshUser'],
|
|
61
|
+
'sshEndpoint': value['sshEndpoint'],
|
|
62
|
+
'hostKey': value['hostKey'],
|
|
59
63
|
};
|
|
60
64
|
}
|
|
@@ -27,12 +27,30 @@ export interface UpgradeSandboxEnvironmentResponse {
|
|
|
27
27
|
* @memberof UpgradeSandboxEnvironmentResponse
|
|
28
28
|
*/
|
|
29
29
|
upgraded: number;
|
|
30
|
+
/**
|
|
31
|
+
* Running sandboxes that received the new configuration now.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof UpgradeSandboxEnvironmentResponse
|
|
34
|
+
*/
|
|
35
|
+
upgradedLive?: number;
|
|
36
|
+
/**
|
|
37
|
+
* Stopped sandboxes moved to the latest version; they pick it up when they next resume.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof UpgradeSandboxEnvironmentResponse
|
|
40
|
+
*/
|
|
41
|
+
upgradedStopped?: number;
|
|
30
42
|
/**
|
|
31
43
|
*
|
|
32
44
|
* @type {number}
|
|
33
45
|
* @memberof UpgradeSandboxEnvironmentResponse
|
|
34
46
|
*/
|
|
35
47
|
failed: number;
|
|
48
|
+
/**
|
|
49
|
+
* Id of the version the sandboxes were moved to.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof UpgradeSandboxEnvironmentResponse
|
|
52
|
+
*/
|
|
53
|
+
latestVersionId?: string;
|
|
36
54
|
}
|
|
37
55
|
/**
|
|
38
56
|
* Check if a given object implements the UpgradeSandboxEnvironmentResponse interface.
|
|
@@ -40,7 +40,10 @@ function UpgradeSandboxEnvironmentResponseFromJSONTyped(json, ignoreDiscriminato
|
|
|
40
40
|
return {
|
|
41
41
|
'success': json['success'],
|
|
42
42
|
'upgraded': json['upgraded'],
|
|
43
|
+
'upgradedLive': json['upgradedLive'] == null ? undefined : json['upgradedLive'],
|
|
44
|
+
'upgradedStopped': json['upgradedStopped'] == null ? undefined : json['upgradedStopped'],
|
|
43
45
|
'failed': json['failed'],
|
|
46
|
+
'latestVersionId': json['latestVersionId'] == null ? undefined : json['latestVersionId'],
|
|
44
47
|
};
|
|
45
48
|
}
|
|
46
49
|
function UpgradeSandboxEnvironmentResponseToJSON(json) {
|
|
@@ -53,6 +56,9 @@ function UpgradeSandboxEnvironmentResponseToJSONTyped(value, ignoreDiscriminator
|
|
|
53
56
|
return {
|
|
54
57
|
'success': value['success'],
|
|
55
58
|
'upgraded': value['upgraded'],
|
|
59
|
+
'upgradedLive': value['upgradedLive'],
|
|
60
|
+
'upgradedStopped': value['upgradedStopped'],
|
|
56
61
|
'failed': value['failed'],
|
|
62
|
+
'latestVersionId': value['latestVersionId'],
|
|
57
63
|
};
|
|
58
64
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
export * from './ActiveOrgResponse';
|
|
2
|
+
export * from './ActiveOrgResponseAllOfActive';
|
|
3
|
+
export * from './ActiveOrgUpdateRequest';
|
|
1
4
|
export * from './AddEnvironmentRepoRequest';
|
|
2
5
|
export * from './ApiKey';
|
|
3
6
|
export * from './ApiKeyCatalog';
|
|
@@ -44,6 +47,8 @@ export * from './HostPortRequest';
|
|
|
44
47
|
export * from './HostPortResponse';
|
|
45
48
|
export * from './LimitsFields';
|
|
46
49
|
export * from './LimitsFieldsCurrentLimits';
|
|
50
|
+
export * from './LimitsFieldsGiftLimit';
|
|
51
|
+
export * from './LimitsFieldsSandboxPlanTiersInner';
|
|
47
52
|
export * from './LimitsFieldsStartLimits';
|
|
48
53
|
export * from './LimitsFieldsStarts';
|
|
49
54
|
export * from './LimitsResponse';
|
|
@@ -55,9 +60,13 @@ export * from './NamedSnapshotInfoResponse';
|
|
|
55
60
|
export * from './NamedSnapshotListResponse';
|
|
56
61
|
export * from './NamedSnapshotSaveRequest';
|
|
57
62
|
export * from './NamedSnapshotSavingResponse';
|
|
63
|
+
export * from './Org';
|
|
64
|
+
export * from './OrgListResponse';
|
|
58
65
|
export * from './PageInfo';
|
|
59
66
|
export * from './PromptEvent';
|
|
60
67
|
export * from './PromptEventData';
|
|
68
|
+
export * from './PromptEventDataAttachmentsInner';
|
|
69
|
+
export * from './PromptEventDataCitationsInner';
|
|
61
70
|
export * from './PromptRequest';
|
|
62
71
|
export * from './PromptResponse';
|
|
63
72
|
export * from './PromptRun';
|
|
@@ -80,6 +89,7 @@ export * from './SandboxEnvironmentVersionSummary';
|
|
|
80
89
|
export * from './SandboxEvent';
|
|
81
90
|
export * from './SandboxInfoResponse';
|
|
82
91
|
export * from './SandboxListResponse';
|
|
92
|
+
export * from './SandboxTeam';
|
|
83
93
|
export * from './SandboxUsageResponse';
|
|
84
94
|
export * from './SecretFile';
|
|
85
95
|
export * from './SecretsResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -16,6 +16,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
|
+
__exportStar(require("./ActiveOrgResponse"), exports);
|
|
20
|
+
__exportStar(require("./ActiveOrgResponseAllOfActive"), exports);
|
|
21
|
+
__exportStar(require("./ActiveOrgUpdateRequest"), exports);
|
|
19
22
|
__exportStar(require("./AddEnvironmentRepoRequest"), exports);
|
|
20
23
|
__exportStar(require("./ApiKey"), exports);
|
|
21
24
|
__exportStar(require("./ApiKeyCatalog"), exports);
|
|
@@ -62,6 +65,8 @@ __exportStar(require("./HostPortRequest"), exports);
|
|
|
62
65
|
__exportStar(require("./HostPortResponse"), exports);
|
|
63
66
|
__exportStar(require("./LimitsFields"), exports);
|
|
64
67
|
__exportStar(require("./LimitsFieldsCurrentLimits"), exports);
|
|
68
|
+
__exportStar(require("./LimitsFieldsGiftLimit"), exports);
|
|
69
|
+
__exportStar(require("./LimitsFieldsSandboxPlanTiersInner"), exports);
|
|
65
70
|
__exportStar(require("./LimitsFieldsStartLimits"), exports);
|
|
66
71
|
__exportStar(require("./LimitsFieldsStarts"), exports);
|
|
67
72
|
__exportStar(require("./LimitsResponse"), exports);
|
|
@@ -73,9 +78,13 @@ __exportStar(require("./NamedSnapshotInfoResponse"), exports);
|
|
|
73
78
|
__exportStar(require("./NamedSnapshotListResponse"), exports);
|
|
74
79
|
__exportStar(require("./NamedSnapshotSaveRequest"), exports);
|
|
75
80
|
__exportStar(require("./NamedSnapshotSavingResponse"), exports);
|
|
81
|
+
__exportStar(require("./Org"), exports);
|
|
82
|
+
__exportStar(require("./OrgListResponse"), exports);
|
|
76
83
|
__exportStar(require("./PageInfo"), exports);
|
|
77
84
|
__exportStar(require("./PromptEvent"), exports);
|
|
78
85
|
__exportStar(require("./PromptEventData"), exports);
|
|
86
|
+
__exportStar(require("./PromptEventDataAttachmentsInner"), exports);
|
|
87
|
+
__exportStar(require("./PromptEventDataCitationsInner"), exports);
|
|
79
88
|
__exportStar(require("./PromptRequest"), exports);
|
|
80
89
|
__exportStar(require("./PromptResponse"), exports);
|
|
81
90
|
__exportStar(require("./PromptRun"), exports);
|
|
@@ -98,6 +107,7 @@ __exportStar(require("./SandboxEnvironmentVersionSummary"), exports);
|
|
|
98
107
|
__exportStar(require("./SandboxEvent"), exports);
|
|
99
108
|
__exportStar(require("./SandboxInfoResponse"), exports);
|
|
100
109
|
__exportStar(require("./SandboxListResponse"), exports);
|
|
110
|
+
__exportStar(require("./SandboxTeam"), exports);
|
|
101
111
|
__exportStar(require("./SandboxUsageResponse"), exports);
|
|
102
112
|
__exportStar(require("./SecretFile"), exports);
|
|
103
113
|
__exportStar(require("./SecretsResponse"), exports);
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ActiveOrgResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`ok` | boolean
|
|
10
|
+
`type` | string
|
|
11
|
+
`active` | [ActiveOrgResponseAllOfActive](ActiveOrgResponseAllOfActive.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ActiveOrgResponse } from '@boatdev/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"ok": null,
|
|
21
|
+
"type": null,
|
|
22
|
+
"active": null,
|
|
23
|
+
} satisfies ActiveOrgResponse
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ActiveOrgResponse
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ActiveOrgResponseAllOfActive
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`name` | string
|
|
11
|
+
`type` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ActiveOrgResponseAllOfActive } from '@boatdev/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
"type": null,
|
|
23
|
+
} satisfies ActiveOrgResponseAllOfActive
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ActiveOrgResponseAllOfActive
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
|
|
2
|
+
# ActiveOrgUpdateRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`org` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ActiveOrgUpdateRequest } from '@boatdev/sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"org": null,
|
|
19
|
+
} satisfies ActiveOrgUpdateRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ActiveOrgUpdateRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
package/docs/BoatApi.md
CHANGED
|
@@ -40,6 +40,7 @@ All URIs are relative to *https://boat.dev/api/v1*
|
|
|
40
40
|
| [**interrupt**](BoatApi.md#interrupt) | **POST** /sandboxes/{sandboxId}/interrupt | Interrupt running work |
|
|
41
41
|
| [**limits**](BoatApi.md#limits) | **GET** /limits | Get Boat limits |
|
|
42
42
|
| [**listNamedSnapshots**](BoatApi.md#listnamedsnapshots) | **GET** /named-snapshots | List named snapshots |
|
|
43
|
+
| [**listOrganizations**](BoatApi.md#listorganizations) | **GET** /orgs | List organizations |
|
|
43
44
|
| [**listSandboxSnapshots**](BoatApi.md#listsandboxsnapshots) | **GET** /sandboxes/{sandboxId}/snapshots | List boat snapshots |
|
|
44
45
|
| [**listSnapshots**](BoatApi.md#listsnapshots) | **GET** /snapshots | List snapshots |
|
|
45
46
|
| [**listWebhooks**](BoatApi.md#listwebhooks) | **GET** /webhooks | List webhooks |
|
|
@@ -56,6 +57,7 @@ All URIs are relative to *https://boat.dev/api/v1*
|
|
|
56
57
|
| [**saveNamedSnapshot**](BoatApi.md#savenamedsnapshot) | **POST** /named-snapshots | Save a named snapshot |
|
|
57
58
|
| [**secrets**](BoatApi.md#secrets) | **GET** /secrets | Get Boat secrets setup |
|
|
58
59
|
| [**selectRepo**](BoatApi.md#selectrepo) | **POST** /repos | Select repository for sandboxes |
|
|
60
|
+
| [**setActiveOrganization**](BoatApi.md#setactiveorganization) | **PATCH** /orgs/active | Set the active organization |
|
|
59
61
|
| [**setEnvironmentSecretFile**](BoatApi.md#setenvironmentsecretfileoperation) | **PUT** /environments/{environmentId}/secret-files | Write one secret file |
|
|
60
62
|
| [**setEnvironmentVar**](BoatApi.md#setenvironmentvaroperation) | **PUT** /environments/{environmentId}/vars/{key} | Set one environment variable |
|
|
61
63
|
| [**sshKey**](BoatApi.md#sshkeyoperation) | **POST** /sandboxes/{sandboxId}/sshkey | Configure sandbox SSH key |
|
|
@@ -465,7 +467,7 @@ async function example() {
|
|
|
465
467
|
sandboxId: sandboxId_example,
|
|
466
468
|
// number | Process id returned by a detached command start.
|
|
467
469
|
processId: 56,
|
|
468
|
-
// number | Cap each returned log to its last N bytes. Defaults to
|
|
470
|
+
// number | Cap each returned log to its last N bytes. Defaults to 8388608 (8 MiB). (optional)
|
|
469
471
|
tailBytes: 56,
|
|
470
472
|
} satisfies CommandStatusRequest;
|
|
471
473
|
|
|
@@ -488,7 +490,7 @@ example().catch(console.error);
|
|
|
488
490
|
|------------- | ------------- | ------------- | -------------|
|
|
489
491
|
| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
|
|
490
492
|
| **processId** | `number` | Process id returned by a detached command start. | [Defaults to `undefined`] |
|
|
491
|
-
| **tailBytes** | `number` | Cap each returned log to its last N bytes. Defaults to
|
|
493
|
+
| **tailBytes** | `number` | Cap each returned log to its last N bytes. Defaults to 8388608 (8 MiB). | [Optional] [Defaults to `undefined`] |
|
|
492
494
|
|
|
493
495
|
### Return type
|
|
494
496
|
|
|
@@ -617,7 +619,7 @@ async function example() {
|
|
|
617
619
|
const body = {
|
|
618
620
|
// string | Optional exactly-once key for creating a sandbox. Send your own opaque, account-unique value (a UUID) to make `POST /sandboxes` safe to retry when the response is lost (network timeout, 5xx): the first request creates the sandbox and binds it to the key; every later request with the **same account, key, and request body** returns that same sandbox instead of creating a second, billable one. Behavior: keys are retained for **24 hours**; a concurrent or early retry while the first sandbox is still being minted returns `409` `idempotency_in_progress` (retry shortly, same key); reusing a key with a **different body** returns `409` `idempotency_key_reused`; timeouts and 5xx are safe to retry with the same key; a create that fails before the sandbox exists releases the key within ~2 minutes so a retry can create the sandbox. Omit the header to keep the default (non-idempotent) behavior. (optional)
|
|
619
621
|
idempotencyKey: idempotencyKey_example,
|
|
620
|
-
// string | Billing wallet for this request
|
|
622
|
+
// string | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. (optional)
|
|
621
623
|
org: org_example,
|
|
622
624
|
// string | Same as the `org` query parameter. Query wins when both are set. (optional)
|
|
623
625
|
xBoatOrg: xBoatOrg_example,
|
|
@@ -643,7 +645,7 @@ example().catch(console.error);
|
|
|
643
645
|
| Name | Type | Description | Notes |
|
|
644
646
|
|------------- | ------------- | ------------- | -------------|
|
|
645
647
|
| **idempotencyKey** | `string` | Optional exactly-once key for creating a sandbox. Send your own opaque, account-unique value (a UUID) to make `POST /sandboxes` safe to retry when the response is lost (network timeout, 5xx): the first request creates the sandbox and binds it to the key; every later request with the **same account, key, and request body** returns that same sandbox instead of creating a second, billable one. Behavior: keys are retained for **24 hours**; a concurrent or early retry while the first sandbox is still being minted returns `409` `idempotency_in_progress` (retry shortly, same key); reusing a key with a **different body** returns `409` `idempotency_key_reused`; timeouts and 5xx are safe to retry with the same key; a create that fails before the sandbox exists releases the key within ~2 minutes so a retry can create the sandbox. Omit the header to keep the default (non-idempotent) behavior. | [Optional] [Defaults to `undefined`] |
|
|
646
|
-
| **org** | `string` | Billing wallet for this request
|
|
648
|
+
| **org** | `string` | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. | [Optional] [Defaults to `undefined`] |
|
|
647
649
|
| **xBoatOrg** | `string` | Same as the `org` query parameter. Query wins when both are set. | [Optional] [Defaults to `undefined`] |
|
|
648
650
|
| **createSandboxRequest** | [CreateSandboxRequest](CreateSandboxRequest.md) | | [Optional] |
|
|
649
651
|
|
|
@@ -2633,7 +2635,7 @@ example().catch(console.error);
|
|
|
2633
2635
|
|
|
2634
2636
|
Get Boat limits
|
|
2635
2637
|
|
|
2636
|
-
Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the
|
|
2638
|
+
Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the wallet a create would bill: the `org` / `X-Boat-Org` you pass (id or name), else the account\'s active wallet, else personal. The response carries `teamId` when an organization wallet was read.
|
|
2637
2639
|
|
|
2638
2640
|
### Example
|
|
2639
2641
|
|
|
@@ -2653,7 +2655,7 @@ async function example() {
|
|
|
2653
2655
|
const api = new BoatApi(config);
|
|
2654
2656
|
|
|
2655
2657
|
const body = {
|
|
2656
|
-
// string | Billing wallet for this request
|
|
2658
|
+
// string | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. (optional)
|
|
2657
2659
|
org: org_example,
|
|
2658
2660
|
// string | Same as the `org` query parameter. Query wins when both are set. (optional)
|
|
2659
2661
|
xBoatOrg: xBoatOrg_example,
|
|
@@ -2678,7 +2680,7 @@ example().catch(console.error);
|
|
|
2678
2680
|
|
|
2679
2681
|
| Name | Type | Description | Notes |
|
|
2680
2682
|
|------------- | ------------- | ------------- | -------------|
|
|
2681
|
-
| **org** | `string` | Billing wallet for this request
|
|
2683
|
+
| **org** | `string` | Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account\'s active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. | [Optional] [Defaults to `undefined`] |
|
|
2682
2684
|
| **xBoatOrg** | `string` | Same as the `org` query parameter. Query wins when both are set. | [Optional] [Defaults to `undefined`] |
|
|
2683
2685
|
| **teamId** | `string` | Legacy alias for `org`. Takes precedence over `org` / `X-Boat-Org` when set. | [Optional] [Defaults to `undefined`] |
|
|
2684
2686
|
|
|
@@ -2769,6 +2771,70 @@ This endpoint does not need any parameter.
|
|
|
2769
2771
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2770
2772
|
|
|
2771
2773
|
|
|
2774
|
+
## listOrganizations
|
|
2775
|
+
|
|
2776
|
+
> OrgListResponse listOrganizations()
|
|
2777
|
+
|
|
2778
|
+
List organizations
|
|
2779
|
+
|
|
2780
|
+
The wallets this account can bill: your personal account first, then every organization you belong to, each with its id and name. Either spelling works wherever an org is passed (`org`, `X-Boat-Org`, `teamId`). `active` marks the wallet new sandboxes bill when a request names none; change it with `PATCH /orgs/active`.
|
|
2781
|
+
|
|
2782
|
+
### Example
|
|
2783
|
+
|
|
2784
|
+
```ts
|
|
2785
|
+
import {
|
|
2786
|
+
Configuration,
|
|
2787
|
+
BoatApi,
|
|
2788
|
+
} from '@boatdev/sdk';
|
|
2789
|
+
import type { ListOrganizationsRequest } from '@boatdev/sdk';
|
|
2790
|
+
|
|
2791
|
+
async function example() {
|
|
2792
|
+
console.log("🚀 Testing @boatdev/sdk SDK...");
|
|
2793
|
+
const config = new Configuration({
|
|
2794
|
+
// Configure HTTP bearer authorization: BoatBearerAuth
|
|
2795
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2796
|
+
});
|
|
2797
|
+
const api = new BoatApi(config);
|
|
2798
|
+
|
|
2799
|
+
try {
|
|
2800
|
+
const data = await api.listOrganizations();
|
|
2801
|
+
console.log(data);
|
|
2802
|
+
} catch (error) {
|
|
2803
|
+
console.error(error);
|
|
2804
|
+
}
|
|
2805
|
+
}
|
|
2806
|
+
|
|
2807
|
+
// Run the test
|
|
2808
|
+
example().catch(console.error);
|
|
2809
|
+
```
|
|
2810
|
+
|
|
2811
|
+
### Parameters
|
|
2812
|
+
|
|
2813
|
+
This endpoint does not need any parameter.
|
|
2814
|
+
|
|
2815
|
+
### Return type
|
|
2816
|
+
|
|
2817
|
+
[**OrgListResponse**](OrgListResponse.md)
|
|
2818
|
+
|
|
2819
|
+
### Authorization
|
|
2820
|
+
|
|
2821
|
+
[BoatBearerAuth](../README.md#BoatBearerAuth)
|
|
2822
|
+
|
|
2823
|
+
### HTTP request headers
|
|
2824
|
+
|
|
2825
|
+
- **Content-Type**: Not defined
|
|
2826
|
+
- **Accept**: `application/json`
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
### HTTP response details
|
|
2830
|
+
| Status code | Description | Response headers |
|
|
2831
|
+
|-------------|-------------|------------------|
|
|
2832
|
+
| **200** | Personal account and organizations. | - |
|
|
2833
|
+
| **401** | Missing or invalid bearer token. | - |
|
|
2834
|
+
|
|
2835
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2836
|
+
|
|
2837
|
+
|
|
2772
2838
|
## listSandboxSnapshots
|
|
2773
2839
|
|
|
2774
2840
|
> SnapshotListResponse listSandboxSnapshots(sandboxId, limit, cursor, sort)
|
|
@@ -3969,6 +4035,81 @@ example().catch(console.error);
|
|
|
3969
4035
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3970
4036
|
|
|
3971
4037
|
|
|
4038
|
+
## setActiveOrganization
|
|
4039
|
+
|
|
4040
|
+
> ActiveOrgResponse setActiveOrganization(activeOrgUpdateRequest)
|
|
4041
|
+
|
|
4042
|
+
Set the active organization
|
|
4043
|
+
|
|
4044
|
+
Set the wallet new sandboxes bill when a request names none, for this account on every client: the API, the CLI (`boat org switch` sets the same value) and the dashboard. Pass an organization id or name you belong to, or `personal` (or `null`) for your own account. `GET /limits` follows it. Sandboxes already running keep the wallet they were created with; leaving or deleting the organization resets the account to personal.
|
|
4045
|
+
|
|
4046
|
+
### Example
|
|
4047
|
+
|
|
4048
|
+
```ts
|
|
4049
|
+
import {
|
|
4050
|
+
Configuration,
|
|
4051
|
+
BoatApi,
|
|
4052
|
+
} from '@boatdev/sdk';
|
|
4053
|
+
import type { SetActiveOrganizationRequest } from '@boatdev/sdk';
|
|
4054
|
+
|
|
4055
|
+
async function example() {
|
|
4056
|
+
console.log("🚀 Testing @boatdev/sdk SDK...");
|
|
4057
|
+
const config = new Configuration({
|
|
4058
|
+
// Configure HTTP bearer authorization: BoatBearerAuth
|
|
4059
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
4060
|
+
});
|
|
4061
|
+
const api = new BoatApi(config);
|
|
4062
|
+
|
|
4063
|
+
const body = {
|
|
4064
|
+
// ActiveOrgUpdateRequest
|
|
4065
|
+
activeOrgUpdateRequest: {"org":"acme"},
|
|
4066
|
+
} satisfies SetActiveOrganizationRequest;
|
|
4067
|
+
|
|
4068
|
+
try {
|
|
4069
|
+
const data = await api.setActiveOrganization(body);
|
|
4070
|
+
console.log(data);
|
|
4071
|
+
} catch (error) {
|
|
4072
|
+
console.error(error);
|
|
4073
|
+
}
|
|
4074
|
+
}
|
|
4075
|
+
|
|
4076
|
+
// Run the test
|
|
4077
|
+
example().catch(console.error);
|
|
4078
|
+
```
|
|
4079
|
+
|
|
4080
|
+
### Parameters
|
|
4081
|
+
|
|
4082
|
+
|
|
4083
|
+
| Name | Type | Description | Notes |
|
|
4084
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4085
|
+
| **activeOrgUpdateRequest** | [ActiveOrgUpdateRequest](ActiveOrgUpdateRequest.md) | | |
|
|
4086
|
+
|
|
4087
|
+
### Return type
|
|
4088
|
+
|
|
4089
|
+
[**ActiveOrgResponse**](ActiveOrgResponse.md)
|
|
4090
|
+
|
|
4091
|
+
### Authorization
|
|
4092
|
+
|
|
4093
|
+
[BoatBearerAuth](../README.md#BoatBearerAuth)
|
|
4094
|
+
|
|
4095
|
+
### HTTP request headers
|
|
4096
|
+
|
|
4097
|
+
- **Content-Type**: `application/json`
|
|
4098
|
+
- **Accept**: `application/json`
|
|
4099
|
+
|
|
4100
|
+
|
|
4101
|
+
### HTTP response details
|
|
4102
|
+
| Status code | Description | Response headers |
|
|
4103
|
+
|-------------|-------------|------------------|
|
|
4104
|
+
| **200** | The wallet now active. | - |
|
|
4105
|
+
| **400** | Invalid request body or parameters. | - |
|
|
4106
|
+
| **401** | Missing or invalid bearer token. | - |
|
|
4107
|
+
| **403** | `not_org_member`: no organization with that id or name that you belong to. | - |
|
|
4108
|
+
| **409** | `ambiguous_org`: several of your organizations share that name; pass the id. | - |
|
|
4109
|
+
|
|
4110
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4111
|
+
|
|
4112
|
+
|
|
3972
4113
|
## setEnvironmentSecretFile
|
|
3973
4114
|
|
|
3974
4115
|
> EnvironmentItemChangeResponse setEnvironmentSecretFile(environmentId, setEnvironmentSecretFileRequest)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`success` | boolean
|
|
12
12
|
`exitCode` | number
|
|
13
13
|
`signal` | string
|
|
14
|
+
`oomKilled` | boolean
|
|
14
15
|
`stdout` | string
|
|
15
16
|
`stderr` | string
|
|
16
17
|
`stdoutTruncated` | boolean
|
|
@@ -37,6 +38,7 @@ const example = {
|
|
|
37
38
|
"success": null,
|
|
38
39
|
"exitCode": null,
|
|
39
40
|
"signal": null,
|
|
41
|
+
"oomKilled": null,
|
|
40
42
|
"stdout": null,
|
|
41
43
|
"stderr": null,
|
|
42
44
|
"stdoutTruncated": null,
|