@boatdev/sdk 1.0.1 → 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 +2 -0
- package/README.md +8 -26
- package/dist/apis/BoatApi.d.ts +99 -80
- package/dist/apis/BoatApi.js +103 -28
- package/dist/esm/apis/BoatApi.d.ts +99 -80
- package/dist/esm/apis/BoatApi.js +103 -28
- 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/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/runtime.d.ts +8 -0
- package/dist/esm/runtime.js +18 -0
- 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/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/runtime.d.ts +8 -0
- package/dist/runtime.js +19 -0
- package/docs/BoatApi.md +80 -1
- package/docs/DeletionOperation.md +4 -0
- package/docs/DeletionOperationListResponse.md +36 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +182 -80
- package/src/models/DeletionOperation.ts +29 -0
- package/src/models/DeletionOperationListResponse.ts +102 -0
- package/src/models/index.ts +1 -0
- package/src/runtime.ts +23 -0
package/dist/apis/BoatApi.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ import { type CreateSandboxResponse } from '../models/CreateSandboxResponse';
|
|
|
27
27
|
import { type CreateScopedApiKeyRequest } from '../models/CreateScopedApiKeyRequest';
|
|
28
28
|
import { type DataRetentionPolicyResponse } from '../models/DataRetentionPolicyResponse';
|
|
29
29
|
import { type DataRetentionUpdateRequest } from '../models/DataRetentionUpdateRequest';
|
|
30
|
+
import { type DeletionOperationListResponse } from '../models/DeletionOperationListResponse';
|
|
30
31
|
import { type DeletionOperationResponse } from '../models/DeletionOperationResponse';
|
|
31
32
|
import { type DesktopRequest } from '../models/DesktopRequest';
|
|
32
33
|
import { type DesktopResponse } from '../models/DesktopResponse';
|
|
@@ -142,6 +143,10 @@ export interface DeleteSandboxRequest {
|
|
|
142
143
|
xAsciiConfirmDelete: string;
|
|
143
144
|
sandboxId: string;
|
|
144
145
|
}
|
|
146
|
+
export interface DeleteSandboxSnapshotsRequest {
|
|
147
|
+
sandboxId: string;
|
|
148
|
+
xAsciiConfirmDelete: string;
|
|
149
|
+
}
|
|
145
150
|
export interface DeleteSnapshotRequest {
|
|
146
151
|
snapshotId: string;
|
|
147
152
|
xAsciiConfirmDelete: string;
|
|
@@ -326,17 +331,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
326
331
|
/**
|
|
327
332
|
* Creates request options for addEnvironmentRepo without sending the request
|
|
328
333
|
*/
|
|
329
|
-
addEnvironmentRepoRequestOpts(
|
|
334
|
+
addEnvironmentRepoRequestOpts(input: AddEnvironmentRepoOperationRequest | runtime.FlatBody<AddEnvironmentRepoOperationRequest, 'addEnvironmentRepoRequest'>): Promise<runtime.RequestOpts>;
|
|
330
335
|
/**
|
|
331
336
|
* Adds a repository (or updates its base branch) by database id from the repository list. Mints a new immutable version.
|
|
332
337
|
* Add a repository to an environment
|
|
333
338
|
*/
|
|
334
|
-
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>>;
|
|
335
340
|
/**
|
|
336
341
|
* Adds a repository (or updates its base branch) by database id from the repository list. Mints a new immutable version.
|
|
337
342
|
* Add a repository to an environment
|
|
338
343
|
*/
|
|
339
|
-
addEnvironmentRepo(requestParameters: AddEnvironmentRepoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
344
|
+
addEnvironmentRepo(requestParameters: AddEnvironmentRepoOperationRequest | runtime.FlatBody<AddEnvironmentRepoOperationRequest, 'addEnvironmentRepoRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
340
345
|
/**
|
|
341
346
|
* Creates request options for apiKeyUsage without sending the request
|
|
342
347
|
*/
|
|
@@ -380,17 +385,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
380
385
|
/**
|
|
381
386
|
* Creates request options for command without sending the request
|
|
382
387
|
*/
|
|
383
|
-
commandRequestOpts(
|
|
388
|
+
commandRequestOpts(input: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>): Promise<runtime.RequestOpts>;
|
|
384
389
|
/**
|
|
385
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.
|
|
386
391
|
* Execute a command in a sandbox
|
|
387
392
|
*/
|
|
388
|
-
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>>;
|
|
389
394
|
/**
|
|
390
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.
|
|
391
396
|
* Execute a command in a sandbox
|
|
392
397
|
*/
|
|
393
|
-
command(requestParameters: CommandOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Command200Response>;
|
|
398
|
+
command(requestParameters: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Command200Response>;
|
|
394
399
|
/**
|
|
395
400
|
* Creates request options for commandStatus without sending the request
|
|
396
401
|
*/
|
|
@@ -420,59 +425,59 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
420
425
|
/**
|
|
421
426
|
* Creates request options for create without sending the request
|
|
422
427
|
*/
|
|
423
|
-
createRequestOpts(
|
|
428
|
+
createRequestOpts(input: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>): Promise<runtime.RequestOpts>;
|
|
424
429
|
/**
|
|
425
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.
|
|
426
431
|
* Create sandbox
|
|
427
432
|
*/
|
|
428
|
-
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>>;
|
|
429
434
|
/**
|
|
430
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.
|
|
431
436
|
* Create sandbox
|
|
432
437
|
*/
|
|
433
|
-
create(requestParameters?: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
|
|
438
|
+
create(requestParameters?: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
|
|
434
439
|
/**
|
|
435
440
|
* Creates request options for createEnvironment without sending the request
|
|
436
441
|
*/
|
|
437
|
-
createEnvironmentRequestOpts(
|
|
442
|
+
createEnvironmentRequestOpts(input: CreateEnvironmentRequest | runtime.FlatBody<CreateEnvironmentRequest, 'createSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
438
443
|
/**
|
|
439
444
|
* Create a new named environment. It starts on version 1 with all fine-grained flags on and `safeForThirdParties` off.
|
|
440
445
|
* Create a sandbox environment
|
|
441
446
|
*/
|
|
442
|
-
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>>;
|
|
443
448
|
/**
|
|
444
449
|
* Create a new named environment. It starts on version 1 with all fine-grained flags on and `safeForThirdParties` off.
|
|
445
450
|
* Create a sandbox environment
|
|
446
451
|
*/
|
|
447
|
-
createEnvironment(requestParameters: CreateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentListResponse>;
|
|
452
|
+
createEnvironment(requestParameters: CreateEnvironmentRequest | runtime.FlatBody<CreateEnvironmentRequest, 'createSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentListResponse>;
|
|
448
453
|
/**
|
|
449
454
|
* Creates request options for createScopedApiKey without sending the request
|
|
450
455
|
*/
|
|
451
|
-
createScopedApiKeyRequestOpts(
|
|
456
|
+
createScopedApiKeyRequestOpts(input: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>): Promise<runtime.RequestOpts>;
|
|
452
457
|
/**
|
|
453
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.
|
|
454
459
|
* Create a scoped API key
|
|
455
460
|
*/
|
|
456
|
-
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>>;
|
|
457
462
|
/**
|
|
458
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.
|
|
459
464
|
* Create a scoped API key
|
|
460
465
|
*/
|
|
461
|
-
createScopedApiKey(requestParameters: CreateScopedApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeySecretResponse>;
|
|
466
|
+
createScopedApiKey(requestParameters: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeySecretResponse>;
|
|
462
467
|
/**
|
|
463
468
|
* Creates request options for createWebhook without sending the request
|
|
464
469
|
*/
|
|
465
|
-
createWebhookRequestOpts(
|
|
470
|
+
createWebhookRequestOpts(input: CreateWebhookRequest | runtime.FlatBody<CreateWebhookRequest, 'webhookCreateRequest'>): Promise<runtime.RequestOpts>;
|
|
466
471
|
/**
|
|
467
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.
|
|
468
473
|
* Create webhook
|
|
469
474
|
*/
|
|
470
|
-
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>>;
|
|
471
476
|
/**
|
|
472
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.
|
|
473
478
|
* Create webhook
|
|
474
479
|
*/
|
|
475
|
-
createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSecretResponse>;
|
|
480
|
+
createWebhook(requestParameters: CreateWebhookRequest | runtime.FlatBody<CreateWebhookRequest, 'webhookCreateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSecretResponse>;
|
|
476
481
|
/**
|
|
477
482
|
* Creates request options for deleteEnvironment without sending the request
|
|
478
483
|
*/
|
|
@@ -557,17 +562,31 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
557
562
|
* Permanently delete sandbox data
|
|
558
563
|
*/
|
|
559
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>;
|
|
560
579
|
/**
|
|
561
580
|
* Creates request options for deleteSnapshot without sending the request
|
|
562
581
|
*/
|
|
563
582
|
deleteSnapshotRequestOpts(requestParameters: DeleteSnapshotRequest): Promise<runtime.RequestOpts>;
|
|
564
583
|
/**
|
|
565
|
-
* 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.
|
|
566
585
|
* Permanently delete snapshot data
|
|
567
586
|
*/
|
|
568
587
|
deleteSnapshotRaw(requestParameters: DeleteSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletionOperationResponse>>;
|
|
569
588
|
/**
|
|
570
|
-
* 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.
|
|
571
590
|
* Permanently delete snapshot data
|
|
572
591
|
*/
|
|
573
592
|
deleteSnapshot(requestParameters: DeleteSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationResponse>;
|
|
@@ -588,17 +607,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
588
607
|
/**
|
|
589
608
|
* Creates request options for desktop without sending the request
|
|
590
609
|
*/
|
|
591
|
-
desktopRequestOpts(
|
|
610
|
+
desktopRequestOpts(input: DesktopOperationRequest | runtime.FlatBody<DesktopOperationRequest, 'desktopRequest'>): Promise<runtime.RequestOpts>;
|
|
592
611
|
/**
|
|
593
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.
|
|
594
613
|
* Get desktop streaming URL
|
|
595
614
|
*/
|
|
596
|
-
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>>;
|
|
597
616
|
/**
|
|
598
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.
|
|
599
618
|
* Get desktop streaming URL
|
|
600
619
|
*/
|
|
601
|
-
desktop(requestParameters: DesktopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DesktopResponse>;
|
|
620
|
+
desktop(requestParameters: DesktopOperationRequest | runtime.FlatBody<DesktopOperationRequest, 'desktopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DesktopResponse>;
|
|
602
621
|
/**
|
|
603
622
|
* Creates request options for environments without sending the request
|
|
604
623
|
*/
|
|
@@ -630,17 +649,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
630
649
|
/**
|
|
631
650
|
* Creates request options for fork without sending the request
|
|
632
651
|
*/
|
|
633
|
-
forkRequestOpts(
|
|
652
|
+
forkRequestOpts(input: ForkOperationRequest | runtime.FlatBody<ForkOperationRequest, 'forkRequest'>): Promise<runtime.RequestOpts>;
|
|
634
653
|
/**
|
|
635
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.
|
|
636
655
|
* Fork sandbox
|
|
637
656
|
*/
|
|
638
|
-
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>>;
|
|
639
658
|
/**
|
|
640
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.
|
|
641
660
|
* Fork sandbox
|
|
642
661
|
*/
|
|
643
|
-
fork(requestParameters: ForkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
662
|
+
fork(requestParameters: ForkOperationRequest | runtime.FlatBody<ForkOperationRequest, 'forkRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
644
663
|
/**
|
|
645
664
|
* Creates request options for get without sending the request
|
|
646
665
|
*/
|
|
@@ -768,17 +787,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
768
787
|
/**
|
|
769
788
|
* Creates request options for hostPort without sending the request
|
|
770
789
|
*/
|
|
771
|
-
hostPortRequestOpts(
|
|
790
|
+
hostPortRequestOpts(input: HostPortOperationRequest | runtime.FlatBody<HostPortOperationRequest, 'hostPortRequest'>): Promise<runtime.RequestOpts>;
|
|
772
791
|
/**
|
|
773
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.
|
|
774
793
|
* Expose a sandbox port on a public HTTPS URL
|
|
775
794
|
*/
|
|
776
|
-
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>>;
|
|
777
796
|
/**
|
|
778
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.
|
|
779
798
|
* Expose a sandbox port on a public HTTPS URL
|
|
780
799
|
*/
|
|
781
|
-
hostPort(requestParameters: HostPortOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HostPortResponse>;
|
|
800
|
+
hostPort(requestParameters: HostPortOperationRequest | runtime.FlatBody<HostPortOperationRequest, 'hostPortRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HostPortResponse>;
|
|
782
801
|
/**
|
|
783
802
|
* Creates request options for interrupt without sending the request
|
|
784
803
|
*/
|
|
@@ -894,17 +913,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
894
913
|
/**
|
|
895
914
|
* Creates request options for prompt without sending the request
|
|
896
915
|
*/
|
|
897
|
-
promptRequestOpts(
|
|
916
|
+
promptRequestOpts(input: PromptOperationRequest | runtime.FlatBody<PromptOperationRequest, 'promptRequest'>): Promise<runtime.RequestOpts>;
|
|
898
917
|
/**
|
|
899
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).
|
|
900
919
|
* Prompt Sandbox
|
|
901
920
|
*/
|
|
902
|
-
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>>;
|
|
903
922
|
/**
|
|
904
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).
|
|
905
924
|
* Prompt Sandbox
|
|
906
925
|
*/
|
|
907
|
-
prompt(requestParameters: PromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptResponse>;
|
|
926
|
+
prompt(requestParameters: PromptOperationRequest | runtime.FlatBody<PromptOperationRequest, 'promptRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptResponse>;
|
|
908
927
|
/**
|
|
909
928
|
* Creates request options for promptRunStatus without sending the request
|
|
910
929
|
*/
|
|
@@ -948,15 +967,15 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
948
967
|
/**
|
|
949
968
|
* Creates request options for resume without sending the request
|
|
950
969
|
*/
|
|
951
|
-
resumeRequestOpts(
|
|
970
|
+
resumeRequestOpts(input: ResumeOperationRequest | runtime.FlatBody<ResumeOperationRequest, 'resumeRequest'>): Promise<runtime.RequestOpts>;
|
|
952
971
|
/**
|
|
953
972
|
* Resume sandbox
|
|
954
973
|
*/
|
|
955
|
-
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>>;
|
|
956
975
|
/**
|
|
957
976
|
* Resume sandbox
|
|
958
977
|
*/
|
|
959
|
-
resume(requestParameters: ResumeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
978
|
+
resume(requestParameters: ResumeOperationRequest | runtime.FlatBody<ResumeOperationRequest, 'resumeRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
960
979
|
/**
|
|
961
980
|
* Creates request options for revokeApiKey without sending the request
|
|
962
981
|
*/
|
|
@@ -1014,17 +1033,17 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1014
1033
|
/**
|
|
1015
1034
|
* Creates request options for saveNamedSnapshot without sending the request
|
|
1016
1035
|
*/
|
|
1017
|
-
saveNamedSnapshotRequestOpts(
|
|
1036
|
+
saveNamedSnapshotRequestOpts(input: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>): Promise<runtime.RequestOpts>;
|
|
1018
1037
|
/**
|
|
1019
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.
|
|
1020
1039
|
* Save a named snapshot
|
|
1021
1040
|
*/
|
|
1022
|
-
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>>;
|
|
1023
1042
|
/**
|
|
1024
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.
|
|
1025
1044
|
* Save a named snapshot
|
|
1026
1045
|
*/
|
|
1027
|
-
saveNamedSnapshot(requestParameters: SaveNamedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotSavingResponse>;
|
|
1046
|
+
saveNamedSnapshot(requestParameters: SaveNamedSnapshotRequest | runtime.FlatBody<SaveNamedSnapshotRequest, 'namedSnapshotSaveRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotSavingResponse>;
|
|
1028
1047
|
/**
|
|
1029
1048
|
* Creates request options for secrets without sending the request
|
|
1030
1049
|
*/
|
|
@@ -1042,181 +1061,181 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1042
1061
|
/**
|
|
1043
1062
|
* Creates request options for selectRepo without sending the request
|
|
1044
1063
|
*/
|
|
1045
|
-
selectRepoRequestOpts(
|
|
1064
|
+
selectRepoRequestOpts(input: SelectRepoRequest | runtime.FlatBody<SelectRepoRequest, 'repoSelectionRequest'>): Promise<runtime.RequestOpts>;
|
|
1046
1065
|
/**
|
|
1047
1066
|
* Idempotently selects one repository for the sandbox environment. Use `databaseId` from `GET /repos` as `repositoryId`; selecting an already-selected repository updates its `baseBranch`.
|
|
1048
1067
|
* Select repository for sandboxes
|
|
1049
1068
|
*/
|
|
1050
|
-
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>>;
|
|
1051
1070
|
/**
|
|
1052
1071
|
* Idempotently selects one repository for the sandbox environment. Use `databaseId` from `GET /repos` as `repositoryId`; selecting an already-selected repository updates its `baseBranch`.
|
|
1053
1072
|
* Select repository for sandboxes
|
|
1054
1073
|
*/
|
|
1055
|
-
selectRepo(requestParameters: SelectRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoSelectionResponse>;
|
|
1074
|
+
selectRepo(requestParameters: SelectRepoRequest | runtime.FlatBody<SelectRepoRequest, 'repoSelectionRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoSelectionResponse>;
|
|
1056
1075
|
/**
|
|
1057
1076
|
* Creates request options for setActiveOrganization without sending the request
|
|
1058
1077
|
*/
|
|
1059
|
-
setActiveOrganizationRequestOpts(
|
|
1078
|
+
setActiveOrganizationRequestOpts(input: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1060
1079
|
/**
|
|
1061
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.
|
|
1062
1081
|
* Set the active organization
|
|
1063
1082
|
*/
|
|
1064
|
-
setActiveOrganizationRaw(requestParameters: SetActiveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActiveOrgResponse>>;
|
|
1083
|
+
setActiveOrganizationRaw(requestParameters: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActiveOrgResponse>>;
|
|
1065
1084
|
/**
|
|
1066
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.
|
|
1067
1086
|
* Set the active organization
|
|
1068
1087
|
*/
|
|
1069
|
-
setActiveOrganization(requestParameters: SetActiveOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActiveOrgResponse>;
|
|
1088
|
+
setActiveOrganization(requestParameters: SetActiveOrganizationRequest | runtime.FlatBody<SetActiveOrganizationRequest, 'activeOrgUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActiveOrgResponse>;
|
|
1070
1089
|
/**
|
|
1071
1090
|
* Creates request options for setEnvironmentSecretFile without sending the request
|
|
1072
1091
|
*/
|
|
1073
|
-
setEnvironmentSecretFileRequestOpts(
|
|
1092
|
+
setEnvironmentSecretFileRequestOpts(input: SetEnvironmentSecretFileOperationRequest | runtime.FlatBody<SetEnvironmentSecretFileOperationRequest, 'setEnvironmentSecretFileRequest'>): Promise<runtime.RequestOpts>;
|
|
1074
1093
|
/**
|
|
1075
1094
|
* Adds or replaces a single secret file by path. Mints a new immutable version.
|
|
1076
1095
|
* Write one secret file
|
|
1077
1096
|
*/
|
|
1078
|
-
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>>;
|
|
1079
1098
|
/**
|
|
1080
1099
|
* Adds or replaces a single secret file by path. Mints a new immutable version.
|
|
1081
1100
|
* Write one secret file
|
|
1082
1101
|
*/
|
|
1083
|
-
setEnvironmentSecretFile(requestParameters: SetEnvironmentSecretFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1102
|
+
setEnvironmentSecretFile(requestParameters: SetEnvironmentSecretFileOperationRequest | runtime.FlatBody<SetEnvironmentSecretFileOperationRequest, 'setEnvironmentSecretFileRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1084
1103
|
/**
|
|
1085
1104
|
* Creates request options for setEnvironmentVar without sending the request
|
|
1086
1105
|
*/
|
|
1087
|
-
setEnvironmentVarRequestOpts(
|
|
1106
|
+
setEnvironmentVarRequestOpts(input: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>): Promise<runtime.RequestOpts>;
|
|
1088
1107
|
/**
|
|
1089
1108
|
* Sets or replaces a single variable without reading or rewriting the rest. Mints a new immutable version.
|
|
1090
1109
|
* Set one environment variable
|
|
1091
1110
|
*/
|
|
1092
|
-
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>>;
|
|
1093
1112
|
/**
|
|
1094
1113
|
* Sets or replaces a single variable without reading or rewriting the rest. Mints a new immutable version.
|
|
1095
1114
|
* Set one environment variable
|
|
1096
1115
|
*/
|
|
1097
|
-
setEnvironmentVar(requestParameters: SetEnvironmentVarOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1116
|
+
setEnvironmentVar(requestParameters: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
|
|
1098
1117
|
/**
|
|
1099
1118
|
* Creates request options for sshKey without sending the request
|
|
1100
1119
|
*/
|
|
1101
|
-
sshKeyRequestOpts(
|
|
1120
|
+
sshKeyRequestOpts(input: SshKeyOperationRequest | runtime.FlatBody<SshKeyOperationRequest, 'sshKeyRequest'>): Promise<runtime.RequestOpts>;
|
|
1102
1121
|
/**
|
|
1103
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.
|
|
1104
1123
|
* Configure sandbox SSH key
|
|
1105
1124
|
*/
|
|
1106
|
-
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>>;
|
|
1107
1126
|
/**
|
|
1108
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.
|
|
1109
1128
|
* Configure sandbox SSH key
|
|
1110
1129
|
*/
|
|
1111
|
-
sshKey(requestParameters: SshKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SshKeyResponse>;
|
|
1130
|
+
sshKey(requestParameters: SshKeyOperationRequest | runtime.FlatBody<SshKeyOperationRequest, 'sshKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SshKeyResponse>;
|
|
1112
1131
|
/**
|
|
1113
1132
|
* Creates request options for steer without sending the request
|
|
1114
1133
|
*/
|
|
1115
|
-
steerRequestOpts(
|
|
1134
|
+
steerRequestOpts(input: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>): Promise<runtime.RequestOpts>;
|
|
1116
1135
|
/**
|
|
1117
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).
|
|
1118
1137
|
* Steer a running turn
|
|
1119
1138
|
*/
|
|
1120
|
-
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>>;
|
|
1121
1140
|
/**
|
|
1122
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).
|
|
1123
1142
|
* Steer a running turn
|
|
1124
1143
|
*/
|
|
1125
|
-
steer(requestParameters: SteerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SteerResponse>;
|
|
1144
|
+
steer(requestParameters: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SteerResponse>;
|
|
1126
1145
|
/**
|
|
1127
1146
|
* Creates request options for stop without sending the request
|
|
1128
1147
|
*/
|
|
1129
|
-
stopRequestOpts(
|
|
1148
|
+
stopRequestOpts(input: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>): Promise<runtime.RequestOpts>;
|
|
1130
1149
|
/**
|
|
1131
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.
|
|
1132
1151
|
* Stop and archive sandbox
|
|
1133
1152
|
*/
|
|
1134
|
-
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>>;
|
|
1135
1154
|
/**
|
|
1136
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.
|
|
1137
1156
|
* Stop and archive sandbox
|
|
1138
1157
|
*/
|
|
1139
|
-
stop(requestParameters: StopOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
1158
|
+
stop(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
|
|
1140
1159
|
/**
|
|
1141
1160
|
* Creates request options for update without sending the request
|
|
1142
1161
|
*/
|
|
1143
|
-
updateRequestOpts(
|
|
1162
|
+
updateRequestOpts(input: UpdateRequest | runtime.FlatBody<UpdateRequest, 'updateSandboxRequest'>): Promise<runtime.RequestOpts>;
|
|
1144
1163
|
/**
|
|
1145
1164
|
* Update sandbox
|
|
1146
1165
|
*/
|
|
1147
|
-
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>>;
|
|
1148
1167
|
/**
|
|
1149
1168
|
* Update sandbox
|
|
1150
1169
|
*/
|
|
1151
|
-
update(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxInfoResponse>;
|
|
1170
|
+
update(requestParameters: UpdateRequest | runtime.FlatBody<UpdateRequest, 'updateSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxInfoResponse>;
|
|
1152
1171
|
/**
|
|
1153
1172
|
* Creates request options for updateDataRetention without sending the request
|
|
1154
1173
|
*/
|
|
1155
|
-
updateDataRetentionRequestOpts(
|
|
1174
|
+
updateDataRetentionRequestOpts(input: UpdateDataRetentionRequest | runtime.FlatBody<UpdateDataRetentionRequest, 'dataRetentionUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1156
1175
|
/**
|
|
1157
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.
|
|
1158
1177
|
* Update account data-retention policy
|
|
1159
1178
|
*/
|
|
1160
|
-
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>>;
|
|
1161
1180
|
/**
|
|
1162
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.
|
|
1163
1182
|
* Update account data-retention policy
|
|
1164
1183
|
*/
|
|
1165
|
-
updateDataRetention(requestParameters: UpdateDataRetentionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataRetentionPolicyResponse>;
|
|
1184
|
+
updateDataRetention(requestParameters: UpdateDataRetentionRequest | runtime.FlatBody<UpdateDataRetentionRequest, 'dataRetentionUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataRetentionPolicyResponse>;
|
|
1166
1185
|
/**
|
|
1167
1186
|
* Creates request options for updateEnvironment without sending the request
|
|
1168
1187
|
*/
|
|
1169
|
-
updateEnvironmentRequestOpts(
|
|
1188
|
+
updateEnvironmentRequestOpts(input: UpdateEnvironmentRequest | runtime.FlatBody<UpdateEnvironmentRequest, 'updateSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
1170
1189
|
/**
|
|
1171
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.
|
|
1172
1191
|
* Update a sandbox environment
|
|
1173
1192
|
*/
|
|
1174
|
-
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>>;
|
|
1175
1194
|
/**
|
|
1176
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.
|
|
1177
1196
|
* Update a sandbox environment
|
|
1178
1197
|
*/
|
|
1179
|
-
updateEnvironment(requestParameters: UpdateEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentResponse>;
|
|
1198
|
+
updateEnvironment(requestParameters: UpdateEnvironmentRequest | runtime.FlatBody<UpdateEnvironmentRequest, 'updateSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxEnvironmentResponse>;
|
|
1180
1199
|
/**
|
|
1181
1200
|
* Creates request options for updateSecrets without sending the request
|
|
1182
1201
|
*/
|
|
1183
|
-
updateSecretsRequestOpts(
|
|
1202
|
+
updateSecretsRequestOpts(input: UpdateSecretsRequest | runtime.FlatBody<UpdateSecretsRequest, 'secretsUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1184
1203
|
/**
|
|
1185
1204
|
* Update Boat secrets setup
|
|
1186
1205
|
*/
|
|
1187
|
-
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>>;
|
|
1188
1207
|
/**
|
|
1189
1208
|
* Update Boat secrets setup
|
|
1190
1209
|
*/
|
|
1191
|
-
updateSecrets(requestParameters: UpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretsResponse>;
|
|
1210
|
+
updateSecrets(requestParameters: UpdateSecretsRequest | runtime.FlatBody<UpdateSecretsRequest, 'secretsUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretsResponse>;
|
|
1192
1211
|
/**
|
|
1193
1212
|
* Creates request options for updateWebhook without sending the request
|
|
1194
1213
|
*/
|
|
1195
|
-
updateWebhookRequestOpts(
|
|
1214
|
+
updateWebhookRequestOpts(input: UpdateWebhookRequest | runtime.FlatBody<UpdateWebhookRequest, 'webhookUpdateRequest'>): Promise<runtime.RequestOpts>;
|
|
1196
1215
|
/**
|
|
1197
1216
|
* Updates the name, endpoint URL, or subscribed events without changing the signing secret.
|
|
1198
1217
|
* Update webhook
|
|
1199
1218
|
*/
|
|
1200
|
-
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>>;
|
|
1201
1220
|
/**
|
|
1202
1221
|
* Updates the name, endpoint URL, or subscribed events without changing the signing secret.
|
|
1203
1222
|
* Update webhook
|
|
1204
1223
|
*/
|
|
1205
|
-
updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
1224
|
+
updateWebhook(requestParameters: UpdateWebhookRequest | runtime.FlatBody<UpdateWebhookRequest, 'webhookUpdateRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
1206
1225
|
/**
|
|
1207
1226
|
* Creates request options for upgradeEnvironment without sending the request
|
|
1208
1227
|
*/
|
|
1209
|
-
upgradeEnvironmentRequestOpts(
|
|
1228
|
+
upgradeEnvironmentRequestOpts(input: UpgradeEnvironmentRequest | runtime.FlatBody<UpgradeEnvironmentRequest, 'upgradeSandboxEnvironmentRequest'>): Promise<runtime.RequestOpts>;
|
|
1210
1229
|
/**
|
|
1211
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.
|
|
1212
1231
|
* Upgrade sandboxes to an environment\'s latest version
|
|
1213
1232
|
*/
|
|
1214
|
-
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>>;
|
|
1215
1234
|
/**
|
|
1216
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.
|
|
1217
1236
|
* Upgrade sandboxes to an environment\'s latest version
|
|
1218
1237
|
*/
|
|
1219
|
-
upgradeEnvironment(requestParameters: UpgradeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeSandboxEnvironmentResponse>;
|
|
1238
|
+
upgradeEnvironment(requestParameters: UpgradeEnvironmentRequest | runtime.FlatBody<UpgradeEnvironmentRequest, 'upgradeSandboxEnvironmentRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeSandboxEnvironmentResponse>;
|
|
1220
1239
|
/**
|
|
1221
1240
|
* Creates request options for usage without sending the request
|
|
1222
1241
|
*/
|
|
@@ -1234,15 +1253,15 @@ export declare class BoatApi extends runtime.BaseAPI {
|
|
|
1234
1253
|
/**
|
|
1235
1254
|
* Creates request options for writeFile without sending the request
|
|
1236
1255
|
*/
|
|
1237
|
-
writeFileRequestOpts(
|
|
1256
|
+
writeFileRequestOpts(input: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>): Promise<runtime.RequestOpts>;
|
|
1238
1257
|
/**
|
|
1239
1258
|
* Write a file in a sandbox
|
|
1240
1259
|
*/
|
|
1241
|
-
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>>;
|
|
1242
1261
|
/**
|
|
1243
1262
|
* Write a file in a sandbox
|
|
1244
1263
|
*/
|
|
1245
|
-
writeFile(requestParameters: WriteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;
|
|
1264
|
+
writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;
|
|
1246
1265
|
}
|
|
1247
1266
|
/**
|
|
1248
1267
|
* @export
|