@boatdev/sdk 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +22 -0
- package/README.md +8 -26
- package/dist/apis/BoatApi.d.ts +132 -79
- package/dist/apis/BoatApi.js +188 -29
- package/dist/esm/apis/BoatApi.d.ts +132 -79
- package/dist/esm/apis/BoatApi.js +188 -29
- 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/DeletionOperation.d.ts +24 -0
- package/dist/esm/models/DeletionOperation.js +15 -0
- package/dist/esm/models/DeletionOperationListResponse.d.ts +52 -0
- package/dist/esm/models/DeletionOperationListResponse.js +58 -0
- 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 +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/runtime.d.ts +8 -0
- package/dist/esm/runtime.js +18 -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/DeletionOperation.d.ts +24 -0
- package/dist/models/DeletionOperation.js +16 -1
- package/dist/models/DeletionOperationListResponse.d.ts +52 -0
- package/dist/models/DeletionOperationListResponse.js +66 -0
- 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 +11 -0
- package/dist/models/index.js +11 -0
- package/dist/runtime.d.ts +8 -0
- package/dist/runtime.js +19 -0
- package/docs/ActiveOrgResponse.md +36 -0
- package/docs/ActiveOrgResponseAllOfActive.md +36 -0
- package/docs/ActiveOrgUpdateRequest.md +32 -0
- package/docs/BoatApi.md +228 -8
- 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/DeletionOperation.md +4 -0
- package/docs/DeletionOperationListResponse.md +36 -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 +304 -79
- 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/DeletionOperation.ts +29 -0
- package/src/models/DeletionOperationListResponse.ts +102 -0
- 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 +11 -0
- package/src/runtime.ts +23 -0
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';
|
|
@@ -28,6 +31,7 @@ export * from './CreateScopedApiKeyRequest';
|
|
|
28
31
|
export * from './DataRetentionPolicyResponse';
|
|
29
32
|
export * from './DataRetentionUpdateRequest';
|
|
30
33
|
export * from './DeletionOperation';
|
|
34
|
+
export * from './DeletionOperationListResponse';
|
|
31
35
|
export * from './DeletionOperationResponse';
|
|
32
36
|
export * from './DesktopRequest';
|
|
33
37
|
export * from './DesktopResponse';
|
|
@@ -44,6 +48,8 @@ export * from './HostPortRequest';
|
|
|
44
48
|
export * from './HostPortResponse';
|
|
45
49
|
export * from './LimitsFields';
|
|
46
50
|
export * from './LimitsFieldsCurrentLimits';
|
|
51
|
+
export * from './LimitsFieldsGiftLimit';
|
|
52
|
+
export * from './LimitsFieldsSandboxPlanTiersInner';
|
|
47
53
|
export * from './LimitsFieldsStartLimits';
|
|
48
54
|
export * from './LimitsFieldsStarts';
|
|
49
55
|
export * from './LimitsResponse';
|
|
@@ -55,9 +61,13 @@ export * from './NamedSnapshotInfoResponse';
|
|
|
55
61
|
export * from './NamedSnapshotListResponse';
|
|
56
62
|
export * from './NamedSnapshotSaveRequest';
|
|
57
63
|
export * from './NamedSnapshotSavingResponse';
|
|
64
|
+
export * from './Org';
|
|
65
|
+
export * from './OrgListResponse';
|
|
58
66
|
export * from './PageInfo';
|
|
59
67
|
export * from './PromptEvent';
|
|
60
68
|
export * from './PromptEventData';
|
|
69
|
+
export * from './PromptEventDataAttachmentsInner';
|
|
70
|
+
export * from './PromptEventDataCitationsInner';
|
|
61
71
|
export * from './PromptRequest';
|
|
62
72
|
export * from './PromptResponse';
|
|
63
73
|
export * from './PromptRun';
|
|
@@ -80,6 +90,7 @@ export * from './SandboxEnvironmentVersionSummary';
|
|
|
80
90
|
export * from './SandboxEvent';
|
|
81
91
|
export * from './SandboxInfoResponse';
|
|
82
92
|
export * from './SandboxListResponse';
|
|
93
|
+
export * from './SandboxTeam';
|
|
83
94
|
export * from './SandboxUsageResponse';
|
|
84
95
|
export * from './SecretFile';
|
|
85
96
|
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);
|
|
@@ -46,6 +49,7 @@ __exportStar(require("./CreateScopedApiKeyRequest"), exports);
|
|
|
46
49
|
__exportStar(require("./DataRetentionPolicyResponse"), exports);
|
|
47
50
|
__exportStar(require("./DataRetentionUpdateRequest"), exports);
|
|
48
51
|
__exportStar(require("./DeletionOperation"), exports);
|
|
52
|
+
__exportStar(require("./DeletionOperationListResponse"), exports);
|
|
49
53
|
__exportStar(require("./DeletionOperationResponse"), exports);
|
|
50
54
|
__exportStar(require("./DesktopRequest"), exports);
|
|
51
55
|
__exportStar(require("./DesktopResponse"), exports);
|
|
@@ -62,6 +66,8 @@ __exportStar(require("./HostPortRequest"), exports);
|
|
|
62
66
|
__exportStar(require("./HostPortResponse"), exports);
|
|
63
67
|
__exportStar(require("./LimitsFields"), exports);
|
|
64
68
|
__exportStar(require("./LimitsFieldsCurrentLimits"), exports);
|
|
69
|
+
__exportStar(require("./LimitsFieldsGiftLimit"), exports);
|
|
70
|
+
__exportStar(require("./LimitsFieldsSandboxPlanTiersInner"), exports);
|
|
65
71
|
__exportStar(require("./LimitsFieldsStartLimits"), exports);
|
|
66
72
|
__exportStar(require("./LimitsFieldsStarts"), exports);
|
|
67
73
|
__exportStar(require("./LimitsResponse"), exports);
|
|
@@ -73,9 +79,13 @@ __exportStar(require("./NamedSnapshotInfoResponse"), exports);
|
|
|
73
79
|
__exportStar(require("./NamedSnapshotListResponse"), exports);
|
|
74
80
|
__exportStar(require("./NamedSnapshotSaveRequest"), exports);
|
|
75
81
|
__exportStar(require("./NamedSnapshotSavingResponse"), exports);
|
|
82
|
+
__exportStar(require("./Org"), exports);
|
|
83
|
+
__exportStar(require("./OrgListResponse"), exports);
|
|
76
84
|
__exportStar(require("./PageInfo"), exports);
|
|
77
85
|
__exportStar(require("./PromptEvent"), exports);
|
|
78
86
|
__exportStar(require("./PromptEventData"), exports);
|
|
87
|
+
__exportStar(require("./PromptEventDataAttachmentsInner"), exports);
|
|
88
|
+
__exportStar(require("./PromptEventDataCitationsInner"), exports);
|
|
79
89
|
__exportStar(require("./PromptRequest"), exports);
|
|
80
90
|
__exportStar(require("./PromptResponse"), exports);
|
|
81
91
|
__exportStar(require("./PromptRun"), exports);
|
|
@@ -98,6 +108,7 @@ __exportStar(require("./SandboxEnvironmentVersionSummary"), exports);
|
|
|
98
108
|
__exportStar(require("./SandboxEvent"), exports);
|
|
99
109
|
__exportStar(require("./SandboxInfoResponse"), exports);
|
|
100
110
|
__exportStar(require("./SandboxListResponse"), exports);
|
|
111
|
+
__exportStar(require("./SandboxTeam"), exports);
|
|
101
112
|
__exportStar(require("./SandboxUsageResponse"), exports);
|
|
102
113
|
__exportStar(require("./SecretFile"), exports);
|
|
103
114
|
__exportStar(require("./SecretsResponse"), exports);
|
package/dist/runtime.d.ts
CHANGED
|
@@ -182,3 +182,11 @@ export declare class TextApiResponse {
|
|
|
182
182
|
constructor(raw: Response);
|
|
183
183
|
value(): Promise<string>;
|
|
184
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* A body-taking call's parameters with the body's fields inline, next to the
|
|
187
|
+
* path/query/header parameters: `fork({ sandboxId, type: 'small' })` is
|
|
188
|
+
* `fork({ sandboxId, forkRequest: { type: 'small' } })`. Both shapes are accepted.
|
|
189
|
+
*/
|
|
190
|
+
export type FlatBody<R, K extends keyof R> = Omit<R, K> & NonNullable<R[K]>;
|
|
191
|
+
/** Turns either call shape into the wrapped one the generated code sends. */
|
|
192
|
+
export declare function unflattenBody<R>(input: object, bodyKey: string, paramKeys: string[], sharedKeys: string[]): R;
|
package/dist/runtime.js
CHANGED
|
@@ -18,6 +18,7 @@ exports.querystring = querystring;
|
|
|
18
18
|
exports.exists = exists;
|
|
19
19
|
exports.mapValues = mapValues;
|
|
20
20
|
exports.canConsumeForm = canConsumeForm;
|
|
21
|
+
exports.unflattenBody = unflattenBody;
|
|
21
22
|
exports.BASE_PATH = "https://boat.dev/api/v1".replace(/\/+$/, "");
|
|
22
23
|
class Configuration {
|
|
23
24
|
constructor(configuration = {}) {
|
|
@@ -351,3 +352,21 @@ class TextApiResponse {
|
|
|
351
352
|
;
|
|
352
353
|
}
|
|
353
354
|
exports.TextApiResponse = TextApiResponse;
|
|
355
|
+
/** Turns either call shape into the wrapped one the generated code sends. */
|
|
356
|
+
function unflattenBody(input, bodyKey, paramKeys, sharedKeys) {
|
|
357
|
+
if (input == null || bodyKey in input)
|
|
358
|
+
return input;
|
|
359
|
+
const params = {};
|
|
360
|
+
const body = {};
|
|
361
|
+
for (const [k, v] of Object.entries(input)) {
|
|
362
|
+
const isParam = paramKeys.indexOf(k) !== -1;
|
|
363
|
+
if (isParam)
|
|
364
|
+
params[k] = v;
|
|
365
|
+
if (!isParam || sharedKeys.indexOf(k) !== -1)
|
|
366
|
+
body[k] = v;
|
|
367
|
+
}
|
|
368
|
+
// No body field given: send no body, exactly like the wrapped call with the key omitted.
|
|
369
|
+
if (Object.keys(body).length > 0)
|
|
370
|
+
params[bodyKey] = body;
|
|
371
|
+
return params;
|
|
372
|
+
}
|
|
@@ -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
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://boat.dev/api/v1*
|
|
|
21
21
|
| [**deleteEnvironmentVar**](BoatApi.md#deleteenvironmentvar) | **DELETE** /environments/{environmentId}/vars/{key} | Remove one environment variable |
|
|
22
22
|
| [**deleteNamedSnapshot**](BoatApi.md#deletenamedsnapshot) | **DELETE** /named-snapshots/{name} | Remove a named snapshot |
|
|
23
23
|
| [**deleteSandbox**](BoatApi.md#deletesandbox) | **DELETE** /sandboxes/{sandboxId} | Permanently delete sandbox data |
|
|
24
|
+
| [**deleteSandboxSnapshots**](BoatApi.md#deletesandboxsnapshots) | **DELETE** /sandboxes/{sandboxId}/snapshots | Permanently delete all snapshots of a sandbox |
|
|
24
25
|
| [**deleteSnapshot**](BoatApi.md#deletesnapshot) | **DELETE** /snapshots/{snapshotId} | Permanently delete snapshot data |
|
|
25
26
|
| [**deleteWebhook**](BoatApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook |
|
|
26
27
|
| [**desktop**](BoatApi.md#desktopoperation) | **POST** /sandboxes/{sandboxId}/desktop | Get desktop streaming URL |
|
|
@@ -40,6 +41,7 @@ All URIs are relative to *https://boat.dev/api/v1*
|
|
|
40
41
|
| [**interrupt**](BoatApi.md#interrupt) | **POST** /sandboxes/{sandboxId}/interrupt | Interrupt running work |
|
|
41
42
|
| [**limits**](BoatApi.md#limits) | **GET** /limits | Get Boat limits |
|
|
42
43
|
| [**listNamedSnapshots**](BoatApi.md#listnamedsnapshots) | **GET** /named-snapshots | List named snapshots |
|
|
44
|
+
| [**listOrganizations**](BoatApi.md#listorganizations) | **GET** /orgs | List organizations |
|
|
43
45
|
| [**listSandboxSnapshots**](BoatApi.md#listsandboxsnapshots) | **GET** /sandboxes/{sandboxId}/snapshots | List boat snapshots |
|
|
44
46
|
| [**listSnapshots**](BoatApi.md#listsnapshots) | **GET** /snapshots | List snapshots |
|
|
45
47
|
| [**listWebhooks**](BoatApi.md#listwebhooks) | **GET** /webhooks | List webhooks |
|
|
@@ -56,6 +58,7 @@ All URIs are relative to *https://boat.dev/api/v1*
|
|
|
56
58
|
| [**saveNamedSnapshot**](BoatApi.md#savenamedsnapshot) | **POST** /named-snapshots | Save a named snapshot |
|
|
57
59
|
| [**secrets**](BoatApi.md#secrets) | **GET** /secrets | Get Boat secrets setup |
|
|
58
60
|
| [**selectRepo**](BoatApi.md#selectrepo) | **POST** /repos | Select repository for sandboxes |
|
|
61
|
+
| [**setActiveOrganization**](BoatApi.md#setactiveorganization) | **PATCH** /orgs/active | Set the active organization |
|
|
59
62
|
| [**setEnvironmentSecretFile**](BoatApi.md#setenvironmentsecretfileoperation) | **PUT** /environments/{environmentId}/secret-files | Write one secret file |
|
|
60
63
|
| [**setEnvironmentVar**](BoatApi.md#setenvironmentvaroperation) | **PUT** /environments/{environmentId}/vars/{key} | Set one environment variable |
|
|
61
64
|
| [**sshKey**](BoatApi.md#sshkeyoperation) | **POST** /sandboxes/{sandboxId}/sshkey | Configure sandbox SSH key |
|
|
@@ -465,7 +468,7 @@ async function example() {
|
|
|
465
468
|
sandboxId: sandboxId_example,
|
|
466
469
|
// number | Process id returned by a detached command start.
|
|
467
470
|
processId: 56,
|
|
468
|
-
// number | Cap each returned log to its last N bytes. Defaults to
|
|
471
|
+
// number | Cap each returned log to its last N bytes. Defaults to 8388608 (8 MiB). (optional)
|
|
469
472
|
tailBytes: 56,
|
|
470
473
|
} satisfies CommandStatusRequest;
|
|
471
474
|
|
|
@@ -488,7 +491,7 @@ example().catch(console.error);
|
|
|
488
491
|
|------------- | ------------- | ------------- | -------------|
|
|
489
492
|
| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
|
|
490
493
|
| **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
|
|
494
|
+
| **tailBytes** | `number` | Cap each returned log to its last N bytes. Defaults to 8388608 (8 MiB). | [Optional] [Defaults to `undefined`] |
|
|
492
495
|
|
|
493
496
|
### Return type
|
|
494
497
|
|
|
@@ -617,7 +620,7 @@ async function example() {
|
|
|
617
620
|
const body = {
|
|
618
621
|
// 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
622
|
idempotencyKey: idempotencyKey_example,
|
|
620
|
-
// string | Billing wallet for this request
|
|
623
|
+
// 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
624
|
org: org_example,
|
|
622
625
|
// string | Same as the `org` query parameter. Query wins when both are set. (optional)
|
|
623
626
|
xBoatOrg: xBoatOrg_example,
|
|
@@ -643,7 +646,7 @@ example().catch(console.error);
|
|
|
643
646
|
| Name | Type | Description | Notes |
|
|
644
647
|
|------------- | ------------- | ------------- | -------------|
|
|
645
648
|
| **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
|
|
649
|
+
| **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
650
|
| **xBoatOrg** | `string` | Same as the `org` query parameter. Query wins when both are set. | [Optional] [Defaults to `undefined`] |
|
|
648
651
|
| **createSandboxRequest** | [CreateSandboxRequest](CreateSandboxRequest.md) | | [Optional] |
|
|
649
652
|
|
|
@@ -1350,13 +1353,91 @@ example().catch(console.error);
|
|
|
1350
1353
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1351
1354
|
|
|
1352
1355
|
|
|
1356
|
+
## deleteSandboxSnapshots
|
|
1357
|
+
|
|
1358
|
+
> DeletionOperationListResponse deleteSandboxSnapshots(sandboxId, xAsciiConfirmDelete)
|
|
1359
|
+
|
|
1360
|
+
Permanently delete all snapshots of a sandbox
|
|
1361
|
+
|
|
1362
|
+
Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its named snapshots stay. Snapshots disappear from lists, restores and forks immediately; their stored data is purged in the background. Set `X-Ascii-Confirm-Delete` to the sandbox id.
|
|
1363
|
+
|
|
1364
|
+
### Example
|
|
1365
|
+
|
|
1366
|
+
```ts
|
|
1367
|
+
import {
|
|
1368
|
+
Configuration,
|
|
1369
|
+
BoatApi,
|
|
1370
|
+
} from '@boatdev/sdk';
|
|
1371
|
+
import type { DeleteSandboxSnapshotsRequest } from '@boatdev/sdk';
|
|
1372
|
+
|
|
1373
|
+
async function example() {
|
|
1374
|
+
console.log("🚀 Testing @boatdev/sdk SDK...");
|
|
1375
|
+
const config = new Configuration({
|
|
1376
|
+
// Configure HTTP bearer authorization: BoatBearerAuth
|
|
1377
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1378
|
+
});
|
|
1379
|
+
const api = new BoatApi(config);
|
|
1380
|
+
|
|
1381
|
+
const body = {
|
|
1382
|
+
// string | Public Sandbox id returned by create/list/get sandbox calls.
|
|
1383
|
+
sandboxId: sandboxId_example,
|
|
1384
|
+
// string | Must exactly equal the target `sandboxId` or `snapshotId`. A missing or mismatched value returns `409` without accepting deletion.
|
|
1385
|
+
xAsciiConfirmDelete: xAsciiConfirmDelete_example,
|
|
1386
|
+
} satisfies DeleteSandboxSnapshotsRequest;
|
|
1387
|
+
|
|
1388
|
+
try {
|
|
1389
|
+
const data = await api.deleteSandboxSnapshots(body);
|
|
1390
|
+
console.log(data);
|
|
1391
|
+
} catch (error) {
|
|
1392
|
+
console.error(error);
|
|
1393
|
+
}
|
|
1394
|
+
}
|
|
1395
|
+
|
|
1396
|
+
// Run the test
|
|
1397
|
+
example().catch(console.error);
|
|
1398
|
+
```
|
|
1399
|
+
|
|
1400
|
+
### Parameters
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
| Name | Type | Description | Notes |
|
|
1404
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1405
|
+
| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
|
|
1406
|
+
| **xAsciiConfirmDelete** | `string` | Must exactly equal the target `sandboxId` or `snapshotId`. A missing or mismatched value returns `409` without accepting deletion. | [Defaults to `undefined`] |
|
|
1407
|
+
|
|
1408
|
+
### Return type
|
|
1409
|
+
|
|
1410
|
+
[**DeletionOperationListResponse**](DeletionOperationListResponse.md)
|
|
1411
|
+
|
|
1412
|
+
### Authorization
|
|
1413
|
+
|
|
1414
|
+
[BoatBearerAuth](../README.md#BoatBearerAuth)
|
|
1415
|
+
|
|
1416
|
+
### HTTP request headers
|
|
1417
|
+
|
|
1418
|
+
- **Content-Type**: Not defined
|
|
1419
|
+
- **Accept**: `application/json`
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
### HTTP response details
|
|
1423
|
+
| Status code | Description | Response headers |
|
|
1424
|
+
|-------------|-------------|------------------|
|
|
1425
|
+
| **202** | One accepted deletion operation per snapshot. | - |
|
|
1426
|
+
| **401** | Missing or invalid bearer token. | - |
|
|
1427
|
+
| **403** | Authenticated token is not allowed to perform this action. | - |
|
|
1428
|
+
| **404** | Resource not found. | - |
|
|
1429
|
+
| **409** | Request conflicts with current account or sandbox state. | - |
|
|
1430
|
+
|
|
1431
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1432
|
+
|
|
1433
|
+
|
|
1353
1434
|
## deleteSnapshot
|
|
1354
1435
|
|
|
1355
1436
|
> DeletionOperationResponse deleteSnapshot(snapshotId, xAsciiConfirmDelete)
|
|
1356
1437
|
|
|
1357
1438
|
Permanently delete snapshot data
|
|
1358
1439
|
|
|
1359
|
-
Accept irreversible
|
|
1440
|
+
Accept irreversible deletion of an unpinned snapshot owned by the authenticated account. Any such snapshot is accepted: it disappears from lists, restores and forks immediately, and its stored data is purged in the background once nothing still reads it (see the operation\'s `stage`). `409` only means `X-Ascii-Confirm-Delete` is missing or wrong.
|
|
1360
1441
|
|
|
1361
1442
|
### Example
|
|
1362
1443
|
|
|
@@ -2633,7 +2714,7 @@ example().catch(console.error);
|
|
|
2633
2714
|
|
|
2634
2715
|
Get Boat limits
|
|
2635
2716
|
|
|
2636
|
-
Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the
|
|
2717
|
+
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
2718
|
|
|
2638
2719
|
### Example
|
|
2639
2720
|
|
|
@@ -2653,7 +2734,7 @@ async function example() {
|
|
|
2653
2734
|
const api = new BoatApi(config);
|
|
2654
2735
|
|
|
2655
2736
|
const body = {
|
|
2656
|
-
// string | Billing wallet for this request
|
|
2737
|
+
// 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
2738
|
org: org_example,
|
|
2658
2739
|
// string | Same as the `org` query parameter. Query wins when both are set. (optional)
|
|
2659
2740
|
xBoatOrg: xBoatOrg_example,
|
|
@@ -2678,7 +2759,7 @@ example().catch(console.error);
|
|
|
2678
2759
|
|
|
2679
2760
|
| Name | Type | Description | Notes |
|
|
2680
2761
|
|------------- | ------------- | ------------- | -------------|
|
|
2681
|
-
| **org** | `string` | Billing wallet for this request
|
|
2762
|
+
| **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
2763
|
| **xBoatOrg** | `string` | Same as the `org` query parameter. Query wins when both are set. | [Optional] [Defaults to `undefined`] |
|
|
2683
2764
|
| **teamId** | `string` | Legacy alias for `org`. Takes precedence over `org` / `X-Boat-Org` when set. | [Optional] [Defaults to `undefined`] |
|
|
2684
2765
|
|
|
@@ -2769,6 +2850,70 @@ This endpoint does not need any parameter.
|
|
|
2769
2850
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2770
2851
|
|
|
2771
2852
|
|
|
2853
|
+
## listOrganizations
|
|
2854
|
+
|
|
2855
|
+
> OrgListResponse listOrganizations()
|
|
2856
|
+
|
|
2857
|
+
List organizations
|
|
2858
|
+
|
|
2859
|
+
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`.
|
|
2860
|
+
|
|
2861
|
+
### Example
|
|
2862
|
+
|
|
2863
|
+
```ts
|
|
2864
|
+
import {
|
|
2865
|
+
Configuration,
|
|
2866
|
+
BoatApi,
|
|
2867
|
+
} from '@boatdev/sdk';
|
|
2868
|
+
import type { ListOrganizationsRequest } from '@boatdev/sdk';
|
|
2869
|
+
|
|
2870
|
+
async function example() {
|
|
2871
|
+
console.log("🚀 Testing @boatdev/sdk SDK...");
|
|
2872
|
+
const config = new Configuration({
|
|
2873
|
+
// Configure HTTP bearer authorization: BoatBearerAuth
|
|
2874
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2875
|
+
});
|
|
2876
|
+
const api = new BoatApi(config);
|
|
2877
|
+
|
|
2878
|
+
try {
|
|
2879
|
+
const data = await api.listOrganizations();
|
|
2880
|
+
console.log(data);
|
|
2881
|
+
} catch (error) {
|
|
2882
|
+
console.error(error);
|
|
2883
|
+
}
|
|
2884
|
+
}
|
|
2885
|
+
|
|
2886
|
+
// Run the test
|
|
2887
|
+
example().catch(console.error);
|
|
2888
|
+
```
|
|
2889
|
+
|
|
2890
|
+
### Parameters
|
|
2891
|
+
|
|
2892
|
+
This endpoint does not need any parameter.
|
|
2893
|
+
|
|
2894
|
+
### Return type
|
|
2895
|
+
|
|
2896
|
+
[**OrgListResponse**](OrgListResponse.md)
|
|
2897
|
+
|
|
2898
|
+
### Authorization
|
|
2899
|
+
|
|
2900
|
+
[BoatBearerAuth](../README.md#BoatBearerAuth)
|
|
2901
|
+
|
|
2902
|
+
### HTTP request headers
|
|
2903
|
+
|
|
2904
|
+
- **Content-Type**: Not defined
|
|
2905
|
+
- **Accept**: `application/json`
|
|
2906
|
+
|
|
2907
|
+
|
|
2908
|
+
### HTTP response details
|
|
2909
|
+
| Status code | Description | Response headers |
|
|
2910
|
+
|-------------|-------------|------------------|
|
|
2911
|
+
| **200** | Personal account and organizations. | - |
|
|
2912
|
+
| **401** | Missing or invalid bearer token. | - |
|
|
2913
|
+
|
|
2914
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2915
|
+
|
|
2916
|
+
|
|
2772
2917
|
## listSandboxSnapshots
|
|
2773
2918
|
|
|
2774
2919
|
> SnapshotListResponse listSandboxSnapshots(sandboxId, limit, cursor, sort)
|
|
@@ -3969,6 +4114,81 @@ example().catch(console.error);
|
|
|
3969
4114
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3970
4115
|
|
|
3971
4116
|
|
|
4117
|
+
## setActiveOrganization
|
|
4118
|
+
|
|
4119
|
+
> ActiveOrgResponse setActiveOrganization(activeOrgUpdateRequest)
|
|
4120
|
+
|
|
4121
|
+
Set the active organization
|
|
4122
|
+
|
|
4123
|
+
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.
|
|
4124
|
+
|
|
4125
|
+
### Example
|
|
4126
|
+
|
|
4127
|
+
```ts
|
|
4128
|
+
import {
|
|
4129
|
+
Configuration,
|
|
4130
|
+
BoatApi,
|
|
4131
|
+
} from '@boatdev/sdk';
|
|
4132
|
+
import type { SetActiveOrganizationRequest } from '@boatdev/sdk';
|
|
4133
|
+
|
|
4134
|
+
async function example() {
|
|
4135
|
+
console.log("🚀 Testing @boatdev/sdk SDK...");
|
|
4136
|
+
const config = new Configuration({
|
|
4137
|
+
// Configure HTTP bearer authorization: BoatBearerAuth
|
|
4138
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
4139
|
+
});
|
|
4140
|
+
const api = new BoatApi(config);
|
|
4141
|
+
|
|
4142
|
+
const body = {
|
|
4143
|
+
// ActiveOrgUpdateRequest
|
|
4144
|
+
activeOrgUpdateRequest: {"org":"acme"},
|
|
4145
|
+
} satisfies SetActiveOrganizationRequest;
|
|
4146
|
+
|
|
4147
|
+
try {
|
|
4148
|
+
const data = await api.setActiveOrganization(body);
|
|
4149
|
+
console.log(data);
|
|
4150
|
+
} catch (error) {
|
|
4151
|
+
console.error(error);
|
|
4152
|
+
}
|
|
4153
|
+
}
|
|
4154
|
+
|
|
4155
|
+
// Run the test
|
|
4156
|
+
example().catch(console.error);
|
|
4157
|
+
```
|
|
4158
|
+
|
|
4159
|
+
### Parameters
|
|
4160
|
+
|
|
4161
|
+
|
|
4162
|
+
| Name | Type | Description | Notes |
|
|
4163
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4164
|
+
| **activeOrgUpdateRequest** | [ActiveOrgUpdateRequest](ActiveOrgUpdateRequest.md) | | |
|
|
4165
|
+
|
|
4166
|
+
### Return type
|
|
4167
|
+
|
|
4168
|
+
[**ActiveOrgResponse**](ActiveOrgResponse.md)
|
|
4169
|
+
|
|
4170
|
+
### Authorization
|
|
4171
|
+
|
|
4172
|
+
[BoatBearerAuth](../README.md#BoatBearerAuth)
|
|
4173
|
+
|
|
4174
|
+
### HTTP request headers
|
|
4175
|
+
|
|
4176
|
+
- **Content-Type**: `application/json`
|
|
4177
|
+
- **Accept**: `application/json`
|
|
4178
|
+
|
|
4179
|
+
|
|
4180
|
+
### HTTP response details
|
|
4181
|
+
| Status code | Description | Response headers |
|
|
4182
|
+
|-------------|-------------|------------------|
|
|
4183
|
+
| **200** | The wallet now active. | - |
|
|
4184
|
+
| **400** | Invalid request body or parameters. | - |
|
|
4185
|
+
| **401** | Missing or invalid bearer token. | - |
|
|
4186
|
+
| **403** | `not_org_member`: no organization with that id or name that you belong to. | - |
|
|
4187
|
+
| **409** | `ambiguous_org`: several of your organizations share that name; pass the id. | - |
|
|
4188
|
+
|
|
4189
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4190
|
+
|
|
4191
|
+
|
|
3972
4192
|
## setEnvironmentSecretFile
|
|
3973
4193
|
|
|
3974
4194
|
> 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,
|
package/docs/CommandResponse.md
CHANGED
|
@@ -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
|
|
@@ -32,6 +33,7 @@ const example = {
|
|
|
32
33
|
"success": null,
|
|
33
34
|
"exitCode": null,
|
|
34
35
|
"signal": null,
|
|
36
|
+
"oomKilled": null,
|
|
35
37
|
"stdout": null,
|
|
36
38
|
"stderr": null,
|
|
37
39
|
"stdoutTruncated": null,
|
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`running` | boolean
|
|
17
17
|
`exitCode` | number
|
|
18
18
|
`signal` | string
|
|
19
|
+
`oomKilled` | boolean
|
|
19
20
|
`command` | string
|
|
20
21
|
`cwd` | string
|
|
21
22
|
`startedAt` | Date
|
|
@@ -44,6 +45,7 @@ const example = {
|
|
|
44
45
|
"running": null,
|
|
45
46
|
"exitCode": null,
|
|
46
47
|
"signal": null,
|
|
48
|
+
"oomKilled": null,
|
|
47
49
|
"command": null,
|
|
48
50
|
"cwd": null,
|
|
49
51
|
"startedAt": null,
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`status` | string
|
|
12
12
|
`ttlSeconds` | number
|
|
13
13
|
`sandbox` | [Sandbox](Sandbox.md)
|
|
14
|
+
`giftLimitNotice` | string
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"status": null,
|
|
25
26
|
"ttlSeconds": null,
|
|
26
27
|
"sandbox": null,
|
|
28
|
+
"giftLimitNotice": null,
|
|
27
29
|
} satisfies CreateSandboxResponse
|
|
28
30
|
|
|
29
31
|
console.log(example)
|
|
@@ -11,6 +11,8 @@ Name | Type
|
|
|
11
11
|
`targetId` | string
|
|
12
12
|
`reason` | string
|
|
13
13
|
`status` | string
|
|
14
|
+
`stage` | string
|
|
15
|
+
`expectedBy` | Date
|
|
14
16
|
`attemptCount` | number
|
|
15
17
|
`requestedAt` | Date
|
|
16
18
|
`completedAt` | Date
|
|
@@ -27,6 +29,8 @@ const example = {
|
|
|
27
29
|
"targetId": null,
|
|
28
30
|
"reason": null,
|
|
29
31
|
"status": null,
|
|
32
|
+
"stage": null,
|
|
33
|
+
"expectedBy": null,
|
|
30
34
|
"attemptCount": null,
|
|
31
35
|
"requestedAt": null,
|
|
32
36
|
"completedAt": null,
|