@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/apis/BoatApi.d.ts
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
+
import { type ActiveOrgResponse } from '../models/ActiveOrgResponse';
|
|
14
|
+
import { type ActiveOrgUpdateRequest } from '../models/ActiveOrgUpdateRequest';
|
|
13
15
|
import { type AddEnvironmentRepoRequest } from '../models/AddEnvironmentRepoRequest';
|
|
14
16
|
import { type ApiKeyRevokeResponse } from '../models/ApiKeyRevokeResponse';
|
|
15
17
|
import { type ApiKeySecretResponse } from '../models/ApiKeySecretResponse';
|
|
@@ -25,6 +27,7 @@ import { type CreateSandboxResponse } from '../models/CreateSandboxResponse';
|
|
|
25
27
|
import { type CreateScopedApiKeyRequest } from '../models/CreateScopedApiKeyRequest';
|
|
26
28
|
import { type DataRetentionPolicyResponse } from '../models/DataRetentionPolicyResponse';
|
|
27
29
|
import { type DataRetentionUpdateRequest } from '../models/DataRetentionUpdateRequest';
|
|
30
|
+
import { type DeletionOperationListResponse } from '../models/DeletionOperationListResponse';
|
|
28
31
|
import { type DeletionOperationResponse } from '../models/DeletionOperationResponse';
|
|
29
32
|
import { type DesktopRequest } from '../models/DesktopRequest';
|
|
30
33
|
import { type DesktopResponse } from '../models/DesktopResponse';
|
|
@@ -43,6 +46,7 @@ import { type NamedSnapshotInfoResponse } from '../models/NamedSnapshotInfoRespo
|
|
|
43
46
|
import { type NamedSnapshotListResponse } from '../models/NamedSnapshotListResponse';
|
|
44
47
|
import { type NamedSnapshotSaveRequest } from '../models/NamedSnapshotSaveRequest';
|
|
45
48
|
import { type NamedSnapshotSavingResponse } from '../models/NamedSnapshotSavingResponse';
|
|
49
|
+
import { type OrgListResponse } from '../models/OrgListResponse';
|
|
46
50
|
import { type PromptRequest } from '../models/PromptRequest';
|
|
47
51
|
import { type PromptResponse } from '../models/PromptResponse';
|
|
48
52
|
import { type PromptRunResponse } from '../models/PromptRunResponse';
|
|
@@ -139,6 +143,10 @@ export interface DeleteSandboxRequest {
|
|
|
139
143
|
xAsciiConfirmDelete: string;
|
|
140
144
|
sandboxId: string;
|
|
141
145
|
}
|
|
146
|
+
export interface DeleteSandboxSnapshotsRequest {
|
|
147
|
+
sandboxId: string;
|
|
148
|
+
xAsciiConfirmDelete: string;
|
|
149
|
+
}
|
|
142
150
|
export interface DeleteSnapshotRequest {
|
|
143
151
|
snapshotId: string;
|
|
144
152
|
xAsciiConfirmDelete: string;
|
|
@@ -260,6 +268,9 @@ export interface SaveNamedSnapshotRequest {
|
|
|
260
268
|
export interface SelectRepoRequest {
|
|
261
269
|
repoSelectionRequest: RepoSelectionRequest;
|
|
262
270
|
}
|
|
271
|
+
export interface SetActiveOrganizationRequest {
|
|
272
|
+
activeOrgUpdateRequest: ActiveOrgUpdateRequest;
|
|
273
|
+
}
|
|
263
274
|
export interface SetEnvironmentSecretFileOperationRequest {
|
|
264
275
|
environmentId: string;
|
|
265
276
|
setEnvironmentSecretFileRequest: SetEnvironmentSecretFileRequest;
|
|
@@ -320,17 +331,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
320
331
|
/**
|
|
321
332
|
* Creates request options for addEnvironmentRepo without sending the request
|
|
322
333
|
*/
|
|
323
|
-
addEnvironmentRepoRequestOpts(
|
|
334
|
+
addEnvironmentRepoRequestOpts(input: AddEnvironmentRepoOperationRequest | runtime.FlatBody<AddEnvironmentRepoOperationRequest, 'addEnvironmentRepoRequest'>): Promise<runtime.RequestOpts>;
|
|
324
335
|
/**
|
|
325
336
|
* Adds a repository (or updates its base branch) by database id from the repository list. Mints a new immutable version.
|
|
326
337
|
* Add a repository to an environment
|
|
327
338
|
*/
|
|
328
|
-
addEnvironmentRepoRaw(requestParameters: AddEnvironmentRepoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
339
|
+
addEnvironmentRepoRaw(requestParameters: AddEnvironmentRepoOperationRequest | runtime.FlatBody<AddEnvironmentRepoOperationRequest, 'addEnvironmentRepoRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
329
340
|
/**
|
|
330
341
|
* Adds a repository (or updates its base branch) by database id from the repository list. Mints a new immutable version.
|
|
331
342
|
* Add a repository to an environment
|
|
332
343
|
*/
|
|
333
|
-
addEnvironmentRepo(requestParameters: AddEnvironmentRepoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
344
|
+
addEnvironmentRepo(requestParameters: AddEnvironmentRepoOperationRequest | runtime.FlatBody<AddEnvironmentRepoOperationRequest, 'addEnvironmentRepoRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
334
345
|
/**
|
|
335
346
|
* Creates request options for apiKeyUsage without sending the request
|
|
336
347
|
*/
|
|
@@ -374,17 +385,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
374
385
|
/**
|
|
375
386
|
* Creates request options for command without sending the request
|
|
376
387
|
*/
|
|
377
|
-
commandRequestOpts(
|
|
388
|
+
commandRequestOpts(input: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>): Promise<runtime.RequestOpts>;
|
|
378
389
|
/**
|
|
379
390
|
* Runs the command synchronously by default (timeout configurable via `timeoutSeconds`, 600s cap). With `detached: true` the command starts in the background and a process id is returned immediately; poll `/sandboxes/{sandboxId}/commands/{processId}` for status and logs. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. Returns 409 boat_starting (retryable) while the sandbox is still provisioning -- wait until the sandbox state is ready before running commands. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox.
|
|
380
391
|
* Execute a command in a sandbox
|
|
381
392
|
*/
|
|
382
|
-
commandRaw(requestParameters: CommandOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Command200Response>>;
|
|
393
|
+
commandRaw(requestParameters: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Command200Response>>;
|
|
383
394
|
/**
|
|
384
395
|
* Runs the command synchronously by default (timeout configurable via `timeoutSeconds`, 600s cap). With `detached: true` the command starts in the background and a process id is returned immediately; poll `/sandboxes/{sandboxId}/commands/{processId}` for status and logs. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. Returns 409 boat_starting (retryable) while the sandbox is still provisioning -- wait until the sandbox state is ready before running commands. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox.
|
|
385
396
|
* Execute a command in a sandbox
|
|
386
397
|
*/
|
|
387
|
-
command(requestParameters: CommandOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Command200Response>;
|
|
398
|
+
command(requestParameters: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Command200Response>;
|
|
388
399
|
/**
|
|
389
400
|
* Creates request options for commandStatus without sending the request
|
|
390
401
|
*/
|
|
@@ -414,59 +425,59 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
414
425
|
/**
|
|
415
426
|
* Creates request options for create without sending the request
|
|
416
427
|
*/
|
|
417
|
-
createRequestOpts(
|
|
428
|
+
createRequestOpts(input: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>): Promise<runtime.RequestOpts>;
|
|
418
429
|
/**
|
|
419
430
|
* Provision a new cloud computer. Store the returned `sandbox.id` with your product job/session record. Send an `Idempotency-Key` header to make this call safe to retry after a lost response without creating a second billable sandbox.
|
|
420
431
|
* Create sandbox
|
|
421
432
|
*/
|
|
422
|
-
createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSandboxResponse>>;
|
|
433
|
+
createRaw(requestParameters: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSandboxResponse>>;
|
|
423
434
|
/**
|
|
424
435
|
* Provision a new cloud computer. Store the returned `sandbox.id` with your product job/session record. Send an `Idempotency-Key` header to make this call safe to retry after a lost response without creating a second billable sandbox.
|
|
425
436
|
* Create sandbox
|
|
426
437
|
*/
|
|
427
|
-
create(requestParameters?: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
|
|
438
|
+
create(requestParameters?: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
|
|
428
439
|
/**
|
|
429
440
|
* Creates request options for createEnvironment without sending the request
|
|
430
441
|
*/
|
|
431
|
-
createEnvironmentRequestOpts(
|
|
442
|
+
createEnvironmentRequestOpts(input: CreateEnvironmentRequest | runtime.FlatBody<CreateEnvironmentRequest, 'createSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
432
443
|
/**
|
|
433
444
|
* Create a new named environment. It starts on version 1 with all fine-grained flags on and `safeForThirdParties` off.
|
|
434
445
|
* Create a sandbox environment
|
|
435
446
|
*/
|
|
436
|
-
createEnvironmentRaw(requestParameters: CreateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxEnvironmentListResponse>>;
|
|
447
|
+
createEnvironmentRaw(requestParameters: CreateEnvironmentRequest | runtime.FlatBody<CreateEnvironmentRequest, 'createSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxEnvironmentListResponse>>;
|
|
437
448
|
/**
|
|
438
449
|
* Create a new named environment. It starts on version 1 with all fine-grained flags on and `safeForThirdParties` off.
|
|
439
450
|
* Create a sandbox environment
|
|
440
451
|
*/
|
|
441
|
-
createEnvironment(requestParameters: CreateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentListResponse>;
|
|
452
|
+
createEnvironment(requestParameters: CreateEnvironmentRequest | runtime.FlatBody<CreateEnvironmentRequest, 'createSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentListResponse>;
|
|
442
453
|
/**
|
|
443
454
|
* Creates request options for createScopedApiKey without sending the request
|
|
444
455
|
*/
|
|
445
|
-
createScopedApiKeyRequestOpts(
|
|
456
|
+
createScopedApiKeyRequestOpts(input: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>): Promise<runtime.RequestOpts>;
|
|
446
457
|
/**
|
|
447
458
|
* Creates a scoped, expiring API key. Requires a dashboard/CLI session or an admin-scoped token. The secret is returned once. This dedicated path returns a typed 503 until scoped credential creation is activated.
|
|
448
459
|
* Create a scoped API key
|
|
449
460
|
*/
|
|
450
|
-
createScopedApiKeyRaw(requestParameters: CreateScopedApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeySecretResponse>>;
|
|
461
|
+
createScopedApiKeyRaw(requestParameters: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeySecretResponse>>;
|
|
451
462
|
/**
|
|
452
463
|
* Creates a scoped, expiring API key. Requires a dashboard/CLI session or an admin-scoped token. The secret is returned once. This dedicated path returns a typed 503 until scoped credential creation is activated.
|
|
453
464
|
* Create a scoped API key
|
|
454
465
|
*/
|
|
455
|
-
createScopedApiKey(requestParameters: CreateScopedApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeySecretResponse>;
|
|
466
|
+
createScopedApiKey(requestParameters: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeySecretResponse>;
|
|
456
467
|
/**
|
|
457
468
|
* Creates request options for createWebhook without sending the request
|
|
458
469
|
*/
|
|
459
|
-
createWebhookRequestOpts(
|
|
470
|
+
createWebhookRequestOpts(input: CreateWebhookRequest | runtime.FlatBody<CreateWebhookRequest, 'webhookCreateRequest'>): Promise<runtime.RequestOpts>;
|
|
460
471
|
/**
|
|
461
472
|
* Registers an account-wide endpoint for sandbox lifecycle events. The endpoint must use HTTPS on port 443 and resolve only to public addresses. Redirects are not followed during delivery. The signing secret is returned only in this response. An account can register at most 10 unique endpoint URLs.
|
|
462
473
|
* Create webhook
|
|
463
474
|
*/
|
|
464
|
-
createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookSecretResponse>>;
|
|
475
|
+
createWebhookRaw(requestParameters: CreateWebhookRequest | runtime.FlatBody<CreateWebhookRequest, 'webhookCreateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookSecretResponse>>;
|
|
465
476
|
/**
|
|
466
477
|
* Registers an account-wide endpoint for sandbox lifecycle events. The endpoint must use HTTPS on port 443 and resolve only to public addresses. Redirects are not followed during delivery. The signing secret is returned only in this response. An account can register at most 10 unique endpoint URLs.
|
|
467
478
|
* Create webhook
|
|
468
479
|
*/
|
|
469
|
-
createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSecretResponse>;
|
|
480
|
+
createWebhook(requestParameters: CreateWebhookRequest | runtime.FlatBody<CreateWebhookRequest, 'webhookCreateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSecretResponse>;
|
|
470
481
|
/**
|
|
471
482
|
* Creates request options for deleteEnvironment without sending the request
|
|
472
483
|
*/
|
|
@@ -551,17 +562,31 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
551
562
|
* Permanently delete sandbox data
|
|
552
563
|
*/
|
|
553
564
|
deleteSandbox(requestParameters: DeleteSandboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationResponse>;
|
|
565
|
+
/**
|
|
566
|
+
* Creates request options for deleteSandboxSnapshots without sending the request
|
|
567
|
+
*/
|
|
568
|
+
deleteSandboxSnapshotsRequestOpts(requestParameters: DeleteSandboxSnapshotsRequest): Promise<runtime.RequestOpts>;
|
|
569
|
+
/**
|
|
570
|
+
* 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.
|
|
571
|
+
* Permanently delete all snapshots of a sandbox
|
|
572
|
+
*/
|
|
573
|
+
deleteSandboxSnapshotsRaw(requestParameters: DeleteSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletionOperationListResponse>>;
|
|
574
|
+
/**
|
|
575
|
+
* 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.
|
|
576
|
+
* Permanently delete all snapshots of a sandbox
|
|
577
|
+
*/
|
|
578
|
+
deleteSandboxSnapshots(requestParameters: DeleteSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationListResponse>;
|
|
554
579
|
/**
|
|
555
580
|
* Creates request options for deleteSnapshot without sending the request
|
|
556
581
|
*/
|
|
557
582
|
deleteSnapshotRequestOpts(requestParameters: DeleteSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
558
583
|
/**
|
|
559
|
-
* Accept irreversible
|
|
584
|
+
* 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.
|
|
560
585
|
* Permanently delete snapshot data
|
|
561
586
|
*/
|
|
562
587
|
deleteSnapshotRaw(requestParameters: DeleteSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletionOperationResponse>>;
|
|
563
588
|
/**
|
|
564
|
-
* Accept irreversible
|
|
589
|
+
* 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.
|
|
565
590
|
* Permanently delete snapshot data
|
|
566
591
|
*/
|
|
567
592
|
deleteSnapshot(requestParameters: DeleteSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationResponse>;
|
|
@@ -582,17 +607,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
582
607
|
/**
|
|
583
608
|
* Creates request options for desktop without sending the request
|
|
584
609
|
*/
|
|
585
|
-
desktopRequestOpts(
|
|
610
|
+
desktopRequestOpts(input: DesktopOperationRequest | runtime.FlatBody<DesktopOperationRequest, 'desktopRequest'>): Promise<runtime.RequestOpts>;
|
|
586
611
|
/**
|
|
587
612
|
* Create or fetch a secret-bearing desktop/noVNC URL for live computer-use visibility. Use `?vnc=1` for noVNC; a `provisioning: true` response means poll again.
|
|
588
613
|
* Get desktop streaming URL
|
|
589
614
|
*/
|
|
590
|
-
desktopRaw(requestParameters: DesktopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DesktopResponse>>;
|
|
615
|
+
desktopRaw(requestParameters: DesktopOperationRequest | runtime.FlatBody<DesktopOperationRequest, 'desktopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DesktopResponse>>;
|
|
591
616
|
/**
|
|
592
617
|
* Create or fetch a secret-bearing desktop/noVNC URL for live computer-use visibility. Use `?vnc=1` for noVNC; a `provisioning: true` response means poll again.
|
|
593
618
|
* Get desktop streaming URL
|
|
594
619
|
*/
|
|
595
|
-
desktop(requestParameters: DesktopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DesktopResponse>;
|
|
620
|
+
desktop(requestParameters: DesktopOperationRequest | runtime.FlatBody<DesktopOperationRequest, 'desktopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DesktopResponse>;
|
|
596
621
|
/**
|
|
597
622
|
* Creates request options for environments without sending the request
|
|
598
623
|
*/
|
|
@@ -624,17 +649,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
624
649
|
/**
|
|
625
650
|
* Creates request options for fork without sending the request
|
|
626
651
|
*/
|
|
627
|
-
forkRequestOpts(
|
|
652
|
+
forkRequestOpts(input: ForkOperationRequest | runtime.FlatBody<ForkOperationRequest, 'forkRequest'>): Promise<runtime.RequestOpts>;
|
|
628
653
|
/**
|
|
629
654
|
* Provision a new sandbox from an existing one. Send an `Idempotency-Key` header to make this call safe to retry after a lost response without creating a second billable fork.
|
|
630
655
|
* Fork sandbox
|
|
631
656
|
*/
|
|
632
|
-
forkRaw(requestParameters: ForkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
657
|
+
forkRaw(requestParameters: ForkOperationRequest | runtime.FlatBody<ForkOperationRequest, 'forkRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
633
658
|
/**
|
|
634
659
|
* Provision a new sandbox from an existing one. Send an `Idempotency-Key` header to make this call safe to retry after a lost response without creating a second billable fork.
|
|
635
660
|
* Fork sandbox
|
|
636
661
|
*/
|
|
637
|
-
fork(requestParameters: ForkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
662
|
+
fork(requestParameters: ForkOperationRequest | runtime.FlatBody<ForkOperationRequest, 'forkRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
638
663
|
/**
|
|
639
664
|
* Creates request options for get without sending the request
|
|
640
665
|
*/
|
|
@@ -762,17 +787,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
762
787
|
/**
|
|
763
788
|
* Creates request options for hostPort without sending the request
|
|
764
789
|
*/
|
|
765
|
-
hostPortRequestOpts(
|
|
790
|
+
hostPortRequestOpts(input: HostPortOperationRequest | runtime.FlatBody<HostPortOperationRequest, 'hostPortRequest'>): Promise<runtime.RequestOpts>;
|
|
766
791
|
/**
|
|
767
792
|
* Registers a stable `https://<sandbox-subdomain>-<port>.on.boat.dev` route for a port inside the sandbox and opens the sandbox firewall for it. Idempotent: calling it again for the same sandbox and port returns the same URL and token.
|
|
768
793
|
* Expose a sandbox port on a public HTTPS URL
|
|
769
794
|
*/
|
|
770
|
-
hostPortRaw(requestParameters: HostPortOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HostPortResponse>>;
|
|
795
|
+
hostPortRaw(requestParameters: HostPortOperationRequest | runtime.FlatBody<HostPortOperationRequest, 'hostPortRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HostPortResponse>>;
|
|
771
796
|
/**
|
|
772
797
|
* Registers a stable `https://<sandbox-subdomain>-<port>.on.boat.dev` route for a port inside the sandbox and opens the sandbox firewall for it. Idempotent: calling it again for the same sandbox and port returns the same URL and token.
|
|
773
798
|
* Expose a sandbox port on a public HTTPS URL
|
|
774
799
|
*/
|
|
775
|
-
hostPort(requestParameters: HostPortOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HostPortResponse>;
|
|
800
|
+
hostPort(requestParameters: HostPortOperationRequest | runtime.FlatBody<HostPortOperationRequest, 'hostPortRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HostPortResponse>;
|
|
776
801
|
/**
|
|
777
802
|
* Creates request options for interrupt without sending the request
|
|
778
803
|
*/
|
|
@@ -792,12 +817,12 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
792
817
|
*/
|
|
793
818
|
limitsRequestOpts(requestParameters: LimitsRequest): Promise<runtime.RequestOpts>;
|
|
794
819
|
/**
|
|
795
|
-
* Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the
|
|
820
|
+
* 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.
|
|
796
821
|
* Get Boat limits
|
|
797
822
|
*/
|
|
798
823
|
limitsRaw(requestParameters: LimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LimitsResponse>>;
|
|
799
824
|
/**
|
|
800
|
-
* Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the
|
|
825
|
+
* 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.
|
|
801
826
|
* Get Boat limits
|
|
802
827
|
*/
|
|
803
828
|
limits(requestParameters?: LimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LimitsResponse>;
|
|
@@ -815,6 +840,20 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
815
840
|
* List named snapshots
|
|
816
841
|
*/
|
|
817
842
|
listNamedSnapshots(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotListResponse>;
|
|
843
|
+
/**
|
|
844
|
+
* Creates request options for listOrganizations without sending the request
|
|
845
|
+
*/
|
|
846
|
+
listOrganizationsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
847
|
+
/**
|
|
848
|
+
* 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`.
|
|
849
|
+
* List organizations
|
|
850
|
+
*/
|
|
851
|
+
listOrganizationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrgListResponse>>;
|
|
852
|
+
/**
|
|
853
|
+
* 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`.
|
|
854
|
+
* List organizations
|
|
855
|
+
*/
|
|
856
|
+
listOrganizations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrgListResponse>;
|
|
818
857
|
/**
|
|
819
858
|
* Creates request options for listSandboxSnapshots without sending the request
|
|
820
859
|
*/
|
|
@@ -874,17 +913,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
874
913
|
/**
|
|
875
914
|
* Creates request options for prompt without sending the request
|
|
876
915
|
*/
|
|
877
|
-
promptRequestOpts(
|
|
916
|
+
promptRequestOpts(input: PromptOperationRequest | runtime.FlatBody<PromptOperationRequest, 'promptRequest'>): Promise<runtime.RequestOpts>;
|
|
878
917
|
/**
|
|
879
918
|
* Queue a natural-language work item for an agent harness (Codex, Claude Code, pi, OpenCode, or Prime Agent) inside the sandbox. Observe progress with `GET /sandboxes/{sandboxId}/events`. A Sandbox runs many conversations in parallel. Set `new: true` to start a fresh one, `conversationId` to continue a specific one, or omit both to continue the most-recently-active conversation; the response returns the `conversationId`. See [Integrated agents](/integrated-agents).
|
|
880
919
|
* Prompt Sandbox
|
|
881
920
|
*/
|
|
882
|
-
promptRaw(requestParameters: PromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptResponse>>;
|
|
921
|
+
promptRaw(requestParameters: PromptOperationRequest | runtime.FlatBody<PromptOperationRequest, 'promptRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptResponse>>;
|
|
883
922
|
/**
|
|
884
923
|
* Queue a natural-language work item for an agent harness (Codex, Claude Code, pi, OpenCode, or Prime Agent) inside the sandbox. Observe progress with `GET /sandboxes/{sandboxId}/events`. A Sandbox runs many conversations in parallel. Set `new: true` to start a fresh one, `conversationId` to continue a specific one, or omit both to continue the most-recently-active conversation; the response returns the `conversationId`. See [Integrated agents](/integrated-agents).
|
|
885
924
|
* Prompt Sandbox
|
|
886
925
|
*/
|
|
887
|
-
prompt(requestParameters: PromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptResponse>;
|
|
926
|
+
prompt(requestParameters: PromptOperationRequest | runtime.FlatBody<PromptOperationRequest, 'promptRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptResponse>;
|
|
888
927
|
/**
|
|
889
928
|
* Creates request options for promptRunStatus without sending the request
|
|
890
929
|
*/
|
|
@@ -928,15 +967,15 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
928
967
|
/**
|
|
929
968
|
* Creates request options for resume without sending the request
|
|
930
969
|
*/
|
|
931
|
-
resumeRequestOpts(
|
|
970
|
+
resumeRequestOpts(input: ResumeOperationRequest | runtime.FlatBody<ResumeOperationRequest, 'resumeRequest'>): Promise<runtime.RequestOpts>;
|
|
932
971
|
/**
|
|
933
972
|
* Resume sandbox
|
|
934
973
|
*/
|
|
935
|
-
resumeRaw(requestParameters: ResumeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
974
|
+
resumeRaw(requestParameters: ResumeOperationRequest | runtime.FlatBody<ResumeOperationRequest, 'resumeRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
936
975
|
/**
|
|
937
976
|
* Resume sandbox
|
|
938
977
|
*/
|
|
939
|
-
resume(requestParameters: ResumeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
978
|
+
resume(requestParameters: ResumeOperationRequest | runtime.FlatBody<ResumeOperationRequest, 'resumeRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
940
979
|
/**
|
|
941
980
|
* Creates request options for revokeApiKey without sending the request
|
|
942
981
|
*/
|
|
@@ -994,17 +1033,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
994
1033
|
/**
|
|
995
1034
|
* Creates request options for saveNamedSnapshot without sending the request
|
|
996
1035
|
*/
|
|
997
|
-
saveNamedSnapshotRequestOpts(
|
|
1036
|
+
saveNamedSnapshotRequestOpts(input: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>): Promise<runtime.RequestOpts>;
|
|
998
1037
|
/**
|
|
999
1038
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1000
1039
|
* Save a named snapshot
|
|
1001
1040
|
*/
|
|
1002
|
-
saveNamedSnapshotRaw(requestParameters: SaveNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotSavingResponse>>;
|
|
1041
|
+
saveNamedSnapshotRaw(requestParameters: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotSavingResponse>>;
|
|
1003
1042
|
/**
|
|
1004
1043
|
* Freeze a sandbox\'s current state under a name (`boat snapshot <id> <name>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /named-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot\'s artifact once the new save is ready.
|
|
1005
1044
|
* Save a named snapshot
|
|
1006
1045
|
*/
|
|
1007
|
-
saveNamedSnapshot(requestParameters: SaveNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotSavingResponse>;
|
|
1046
|
+
saveNamedSnapshot(requestParameters: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotSavingResponse>;
|
|
1008
1047
|
/**
|
|
1009
1048
|
* Creates request options for secrets without sending the request
|
|
1010
1049
|
*/
|
|
@@ -1022,167 +1061,181 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1022
1061
|
/**
|
|
1023
1062
|
* Creates request options for selectRepo without sending the request
|
|
1024
1063
|
*/
|
|
1025
|
-
selectRepoRequestOpts(
|
|
1064
|
+
selectRepoRequestOpts(input: SelectRepoRequest | runtime.FlatBody<SelectRepoRequest, 'repoSelectionRequest'>): Promise<runtime.RequestOpts>;
|
|
1026
1065
|
/**
|
|
1027
1066
|
* Idempotently selects one repository for the sandbox environment. Use `databaseId` from `GET /repos` as `repositoryId`; selecting an already-selected repository updates its `baseBranch`.
|
|
1028
1067
|
* Select repository for sandboxes
|
|
1029
1068
|
*/
|
|
1030
|
-
selectRepoRaw(requestParameters: SelectRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoSelectionResponse>>;
|
|
1069
|
+
selectRepoRaw(requestParameters: SelectRepoRequest | runtime.FlatBody<SelectRepoRequest, 'repoSelectionRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoSelectionResponse>>;
|
|
1031
1070
|
/**
|
|
1032
1071
|
* Idempotently selects one repository for the sandbox environment. Use `databaseId` from `GET /repos` as `repositoryId`; selecting an already-selected repository updates its `baseBranch`.
|
|
1033
1072
|
* Select repository for sandboxes
|
|
1034
1073
|
*/
|
|
1035
|
-
selectRepo(requestParameters: SelectRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoSelectionResponse>;
|
|
1074
|
+
selectRepo(requestParameters: SelectRepoRequest | runtime.FlatBody<SelectRepoRequest, 'repoSelectionRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoSelectionResponse>;
|
|
1075
|
+
/**
|
|
1076
|
+
* Creates request options for setActiveOrganization without sending the request
|
|
1077
|
+
*/
|
|
1078
|
+
setActiveOrganizationRequestOpts(input: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1079
|
+
/**
|
|
1080
|
+
* 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.
|
|
1081
|
+
* Set the active organization
|
|
1082
|
+
*/
|
|
1083
|
+
setActiveOrganizationRaw(requestParameters: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActiveOrgResponse>>;
|
|
1084
|
+
/**
|
|
1085
|
+
* 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.
|
|
1086
|
+
* Set the active organization
|
|
1087
|
+
*/
|
|
1088
|
+
setActiveOrganization(requestParameters: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActiveOrgResponse>;
|
|
1036
1089
|
/**
|
|
1037
1090
|
* Creates request options for setEnvironmentSecretFile without sending the request
|
|
1038
1091
|
*/
|
|
1039
|
-
setEnvironmentSecretFileRequestOpts(
|
|
1092
|
+
setEnvironmentSecretFileRequestOpts(input: SetEnvironmentSecretFileOperationRequest | runtime.FlatBody<SetEnvironmentSecretFileOperationRequest, 'setEnvironmentSecretFileRequest'>): Promise<runtime.RequestOpts>;
|
|
1040
1093
|
/**
|
|
1041
1094
|
* Adds or replaces a single secret file by path. Mints a new immutable version.
|
|
1042
1095
|
* Write one secret file
|
|
1043
1096
|
*/
|
|
1044
|
-
setEnvironmentSecretFileRaw(requestParameters: SetEnvironmentSecretFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
1097
|
+
setEnvironmentSecretFileRaw(requestParameters: SetEnvironmentSecretFileOperationRequest | runtime.FlatBody<SetEnvironmentSecretFileOperationRequest, 'setEnvironmentSecretFileRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
1045
1098
|
/**
|
|
1046
1099
|
* Adds or replaces a single secret file by path. Mints a new immutable version.
|
|
1047
1100
|
* Write one secret file
|
|
1048
1101
|
*/
|
|
1049
|
-
setEnvironmentSecretFile(requestParameters: SetEnvironmentSecretFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1102
|
+
setEnvironmentSecretFile(requestParameters: SetEnvironmentSecretFileOperationRequest | runtime.FlatBody<SetEnvironmentSecretFileOperationRequest, 'setEnvironmentSecretFileRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1050
1103
|
/**
|
|
1051
1104
|
* Creates request options for setEnvironmentVar without sending the request
|
|
1052
1105
|
*/
|
|
1053
|
-
setEnvironmentVarRequestOpts(
|
|
1106
|
+
setEnvironmentVarRequestOpts(input: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>): Promise<runtime.RequestOpts>;
|
|
1054
1107
|
/**
|
|
1055
1108
|
* Sets or replaces a single variable without reading or rewriting the rest. Mints a new immutable version.
|
|
1056
1109
|
* Set one environment variable
|
|
1057
1110
|
*/
|
|
1058
|
-
setEnvironmentVarRaw(requestParameters: SetEnvironmentVarOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
1111
|
+
setEnvironmentVarRaw(requestParameters: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnvironmentItemChangeResponse>>;
|
|
1059
1112
|
/**
|
|
1060
1113
|
* Sets or replaces a single variable without reading or rewriting the rest. Mints a new immutable version.
|
|
1061
1114
|
* Set one environment variable
|
|
1062
1115
|
*/
|
|
1063
|
-
setEnvironmentVar(requestParameters: SetEnvironmentVarOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1116
|
+
setEnvironmentVar(requestParameters: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1064
1117
|
/**
|
|
1065
1118
|
* Creates request options for sshKey without sending the request
|
|
1066
1119
|
*/
|
|
1067
|
-
sshKeyRequestOpts(
|
|
1120
|
+
sshKeyRequestOpts(input: SshKeyOperationRequest | runtime.FlatBody<SshKeyOperationRequest, 'sshKeyRequest'>): Promise<runtime.RequestOpts>;
|
|
1068
1121
|
/**
|
|
1069
1122
|
* Adds an OpenSSH public key to the running sandbox so the caller can SSH as user `user`. The response carries `machineIp`, which is the host to connect to on port 22. This is also how you reach your own machine from inside a sandbox without the CLI: authorize the key, then open a reverse tunnel with stock OpenSSH, and a port on your machine answers at `127.0.0.1:<port>` inside the sandbox for as long as the ssh process runs. ```bash ssh -o ExitOnForwardFailure=yes -i ~/.ssh/id_ed25519 -N -R 7777:127.0.0.1:7777 user@<machineIp> ``` `boat forward <id> --reverse --local 7777` is the same tunnel with the key handling and redial done for you.
|
|
1070
1123
|
* Configure sandbox SSH key
|
|
1071
1124
|
*/
|
|
1072
|
-
sshKeyRaw(requestParameters: SshKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SshKeyResponse>>;
|
|
1125
|
+
sshKeyRaw(requestParameters: SshKeyOperationRequest | runtime.FlatBody<SshKeyOperationRequest, 'sshKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SshKeyResponse>>;
|
|
1073
1126
|
/**
|
|
1074
1127
|
* Adds an OpenSSH public key to the running sandbox so the caller can SSH as user `user`. The response carries `machineIp`, which is the host to connect to on port 22. This is also how you reach your own machine from inside a sandbox without the CLI: authorize the key, then open a reverse tunnel with stock OpenSSH, and a port on your machine answers at `127.0.0.1:<port>` inside the sandbox for as long as the ssh process runs. ```bash ssh -o ExitOnForwardFailure=yes -i ~/.ssh/id_ed25519 -N -R 7777:127.0.0.1:7777 user@<machineIp> ``` `boat forward <id> --reverse --local 7777` is the same tunnel with the key handling and redial done for you.
|
|
1075
1128
|
* Configure sandbox SSH key
|
|
1076
1129
|
*/
|
|
1077
|
-
sshKey(requestParameters: SshKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SshKeyResponse>;
|
|
1130
|
+
sshKey(requestParameters: SshKeyOperationRequest | runtime.FlatBody<SshKeyOperationRequest, 'sshKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SshKeyResponse>;
|
|
1078
1131
|
/**
|
|
1079
1132
|
* Creates request options for steer without sending the request
|
|
1080
1133
|
*/
|
|
1081
|
-
steerRequestOpts(
|
|
1134
|
+
steerRequestOpts(input: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>): Promise<runtime.RequestOpts>;
|
|
1082
1135
|
/**
|
|
1083
1136
|
* Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues. Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`. Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
|
|
1084
1137
|
* Steer a running turn
|
|
1085
1138
|
*/
|
|
1086
|
-
steerRaw(requestParameters: SteerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SteerResponse>>;
|
|
1139
|
+
steerRaw(requestParameters: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SteerResponse>>;
|
|
1087
1140
|
/**
|
|
1088
1141
|
* Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues. Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`. Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
|
|
1089
1142
|
* Steer a running turn
|
|
1090
1143
|
*/
|
|
1091
|
-
steer(requestParameters: SteerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SteerResponse>;
|
|
1144
|
+
steer(requestParameters: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SteerResponse>;
|
|
1092
1145
|
/**
|
|
1093
1146
|
* Creates request options for stop without sending the request
|
|
1094
1147
|
*/
|
|
1095
|
-
stopRequestOpts(
|
|
1148
|
+
stopRequestOpts(input: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>): Promise<runtime.RequestOpts>;
|
|
1096
1149
|
/**
|
|
1097
1150
|
* Stop active work and archive/snapshot the sandbox for later resume or fork. A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state. Set `force: true` to stop anyway, accepting the loss of everything written since the last successful snapshot. This is irreversible; only reach for it after a stop has already failed.
|
|
1098
1151
|
* Stop and archive sandbox
|
|
1099
1152
|
*/
|
|
1100
|
-
stopRaw(requestParameters: StopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
1153
|
+
stopRaw(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
|
|
1101
1154
|
/**
|
|
1102
1155
|
* Stop active work and archive/snapshot the sandbox for later resume or fork. A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state. Set `force: true` to stop anyway, accepting the loss of everything written since the last successful snapshot. This is irreversible; only reach for it after a stop has already failed.
|
|
1103
1156
|
* Stop and archive sandbox
|
|
1104
1157
|
*/
|
|
1105
|
-
stop(requestParameters: StopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
1158
|
+
stop(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
1106
1159
|
/**
|
|
1107
1160
|
* Creates request options for update without sending the request
|
|
1108
1161
|
*/
|
|
1109
|
-
updateRequestOpts(
|
|
1162
|
+
updateRequestOpts(input: UpdateRequest | runtime.FlatBody<UpdateRequest, 'updateSandboxRequest'>): Promise<runtime.RequestOpts>;
|
|
1110
1163
|
/**
|
|
1111
1164
|
* Update sandbox
|
|
1112
1165
|
*/
|
|
1113
|
-
updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxInfoResponse>>;
|
|
1166
|
+
updateRaw(requestParameters: UpdateRequest | runtime.FlatBody<UpdateRequest, 'updateSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxInfoResponse>>;
|
|
1114
1167
|
/**
|
|
1115
1168
|
* Update sandbox
|
|
1116
1169
|
*/
|
|
1117
|
-
update(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxInfoResponse>;
|
|
1170
|
+
update(requestParameters: UpdateRequest | runtime.FlatBody<UpdateRequest, 'updateSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxInfoResponse>;
|
|
1118
1171
|
/**
|
|
1119
1172
|
* Creates request options for updateDataRetention without sending the request
|
|
1120
1173
|
*/
|
|
1121
|
-
updateDataRetentionRequestOpts(
|
|
1174
|
+
updateDataRetentionRequestOpts(input: UpdateDataRetentionRequest | runtime.FlatBody<UpdateDataRetentionRequest, 'dataRetentionUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1122
1175
|
/**
|
|
1123
1176
|
* Requires an interactive sandbox session; API keys and legacy permanent tokens are refused. Enabling requires the exact confirmation phrase `delete archived sandbox data`. Disabling affects future archives only and cannot cancel deletion operations already accepted.
|
|
1124
1177
|
* Update account data-retention policy
|
|
1125
1178
|
*/
|
|
1126
|
-
updateDataRetentionRaw(requestParameters: UpdateDataRetentionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataRetentionPolicyResponse>>;
|
|
1179
|
+
updateDataRetentionRaw(requestParameters: UpdateDataRetentionRequest | runtime.FlatBody<UpdateDataRetentionRequest, 'dataRetentionUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataRetentionPolicyResponse>>;
|
|
1127
1180
|
/**
|
|
1128
1181
|
* Requires an interactive sandbox session; API keys and legacy permanent tokens are refused. Enabling requires the exact confirmation phrase `delete archived sandbox data`. Disabling affects future archives only and cannot cancel deletion operations already accepted.
|
|
1129
1182
|
* Update account data-retention policy
|
|
1130
1183
|
*/
|
|
1131
|
-
updateDataRetention(requestParameters: UpdateDataRetentionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataRetentionPolicyResponse>;
|
|
1184
|
+
updateDataRetention(requestParameters: UpdateDataRetentionRequest | runtime.FlatBody<UpdateDataRetentionRequest, 'dataRetentionUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataRetentionPolicyResponse>;
|
|
1132
1185
|
/**
|
|
1133
1186
|
* Creates request options for updateEnvironment without sending the request
|
|
1134
1187
|
*/
|
|
1135
|
-
updateEnvironmentRequestOpts(
|
|
1188
|
+
updateEnvironmentRequestOpts(input: UpdateEnvironmentRequest | runtime.FlatBody<UpdateEnvironmentRequest, 'updateSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
1136
1189
|
/**
|
|
1137
1190
|
* Rename, set as default, and/or edit flags and contents. Any flag or content change mints a new immutable version; existing sandboxes stay on their pinned version until you call upgrade.
|
|
1138
1191
|
* Update a sandbox environment
|
|
1139
1192
|
*/
|
|
1140
|
-
updateEnvironmentRaw(requestParameters: UpdateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxEnvironmentResponse>>;
|
|
1193
|
+
updateEnvironmentRaw(requestParameters: UpdateEnvironmentRequest | runtime.FlatBody<UpdateEnvironmentRequest, 'updateSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxEnvironmentResponse>>;
|
|
1141
1194
|
/**
|
|
1142
1195
|
* Rename, set as default, and/or edit flags and contents. Any flag or content change mints a new immutable version; existing sandboxes stay on their pinned version until you call upgrade.
|
|
1143
1196
|
* Update a sandbox environment
|
|
1144
1197
|
*/
|
|
1145
|
-
updateEnvironment(requestParameters: UpdateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentResponse>;
|
|
1198
|
+
updateEnvironment(requestParameters: UpdateEnvironmentRequest | runtime.FlatBody<UpdateEnvironmentRequest, 'updateSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentResponse>;
|
|
1146
1199
|
/**
|
|
1147
1200
|
* Creates request options for updateSecrets without sending the request
|
|
1148
1201
|
*/
|
|
1149
|
-
updateSecretsRequestOpts(
|
|
1202
|
+
updateSecretsRequestOpts(input: UpdateSecretsRequest | runtime.FlatBody<UpdateSecretsRequest, 'secretsUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1150
1203
|
/**
|
|
1151
1204
|
* Update Boat secrets setup
|
|
1152
1205
|
*/
|
|
1153
|
-
updateSecretsRaw(requestParameters: UpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecretsResponse>>;
|
|
1206
|
+
updateSecretsRaw(requestParameters: UpdateSecretsRequest | runtime.FlatBody<UpdateSecretsRequest, 'secretsUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecretsResponse>>;
|
|
1154
1207
|
/**
|
|
1155
1208
|
* Update Boat secrets setup
|
|
1156
1209
|
*/
|
|
1157
|
-
updateSecrets(requestParameters: UpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretsResponse>;
|
|
1210
|
+
updateSecrets(requestParameters: UpdateSecretsRequest | runtime.FlatBody<UpdateSecretsRequest, 'secretsUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretsResponse>;
|
|
1158
1211
|
/**
|
|
1159
1212
|
* Creates request options for updateWebhook without sending the request
|
|
1160
1213
|
*/
|
|
1161
|
-
updateWebhookRequestOpts(
|
|
1214
|
+
updateWebhookRequestOpts(input: UpdateWebhookRequest | runtime.FlatBody<UpdateWebhookRequest, 'webhookUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1162
1215
|
/**
|
|
1163
1216
|
* Updates the name, endpoint URL, or subscribed events without changing the signing secret.
|
|
1164
1217
|
* Update webhook
|
|
1165
1218
|
*/
|
|
1166
|
-
updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookResponse>>;
|
|
1219
|
+
updateWebhookRaw(requestParameters: UpdateWebhookRequest | runtime.FlatBody<UpdateWebhookRequest, 'webhookUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookResponse>>;
|
|
1167
1220
|
/**
|
|
1168
1221
|
* Updates the name, endpoint URL, or subscribed events without changing the signing secret.
|
|
1169
1222
|
* Update webhook
|
|
1170
1223
|
*/
|
|
1171
|
-
updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
1224
|
+
updateWebhook(requestParameters: UpdateWebhookRequest | runtime.FlatBody<UpdateWebhookRequest, 'webhookUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
1172
1225
|
/**
|
|
1173
1226
|
* Creates request options for upgradeEnvironment without sending the request
|
|
1174
1227
|
*/
|
|
1175
|
-
upgradeEnvironmentRequestOpts(
|
|
1228
|
+
upgradeEnvironmentRequestOpts(input: UpgradeEnvironmentRequest | runtime.FlatBody<UpgradeEnvironmentRequest, 'upgradeSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
1176
1229
|
/**
|
|
1177
1230
|
* Repoints the caller\'s active sandboxes from an older version of this environment to its latest version, scrubbing any owner secrets the new version drops and hot-pushing the new config.
|
|
1178
1231
|
* Upgrade sandboxes to an environment\'s latest version
|
|
1179
1232
|
*/
|
|
1180
|
-
upgradeEnvironmentRaw(requestParameters: UpgradeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpgradeSandboxEnvironmentResponse>>;
|
|
1233
|
+
upgradeEnvironmentRaw(requestParameters: UpgradeEnvironmentRequest | runtime.FlatBody<UpgradeEnvironmentRequest, 'upgradeSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpgradeSandboxEnvironmentResponse>>;
|
|
1181
1234
|
/**
|
|
1182
1235
|
* Repoints the caller\'s active sandboxes from an older version of this environment to its latest version, scrubbing any owner secrets the new version drops and hot-pushing the new config.
|
|
1183
1236
|
* Upgrade sandboxes to an environment\'s latest version
|
|
1184
1237
|
*/
|
|
1185
|
-
upgradeEnvironment(requestParameters: UpgradeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeSandboxEnvironmentResponse>;
|
|
1238
|
+
upgradeEnvironment(requestParameters: UpgradeEnvironmentRequest | runtime.FlatBody<UpgradeEnvironmentRequest, 'upgradeSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeSandboxEnvironmentResponse>;
|
|
1186
1239
|
/**
|
|
1187
1240
|
* Creates request options for usage without sending the request
|
|
1188
1241
|
*/
|
|
@@ -1200,15 +1253,15 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1200
1253
|
/**
|
|
1201
1254
|
* Creates request options for writeFile without sending the request
|
|
1202
1255
|
*/
|
|
1203
|
-
writeFileRequestOpts(
|
|
1256
|
+
writeFileRequestOpts(input: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>): Promise<runtime.RequestOpts>;
|
|
1204
1257
|
/**
|
|
1205
1258
|
* Write a file in a sandbox
|
|
1206
1259
|
*/
|
|
1207
|
-
writeFileRaw(requestParameters: WriteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWriteResponse>>;
|
|
1260
|
+
writeFileRaw(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWriteResponse>>;
|
|
1208
1261
|
/**
|
|
1209
1262
|
* Write a file in a sandbox
|
|
1210
1263
|
*/
|
|
1211
|
-
writeFile(requestParameters: WriteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;
|
|
1264
|
+
writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;
|
|
1212
1265
|
}
|
|
1213
1266
|
/**
|
|
1214
1267
|
* @export
|