@boatdev/sdk 1.9.1 → 1.9.3

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.
Files changed (152) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/dist/apis/BoatApi.d.ts +192 -4
  3. package/dist/apis/BoatApi.js +452 -5
  4. package/dist/esm/apis/BoatApi.d.ts +192 -4
  5. package/dist/esm/apis/BoatApi.js +451 -4
  6. package/dist/esm/models/CommandAttachFrame.d.ts +121 -0
  7. package/dist/esm/models/CommandAttachFrame.js +83 -0
  8. package/dist/esm/models/CommandInfoResponse.d.ts +52 -0
  9. package/dist/esm/models/CommandInfoResponse.js +58 -0
  10. package/dist/esm/models/CommandListResponse.d.ts +58 -0
  11. package/dist/esm/models/CommandListResponse.js +62 -0
  12. package/dist/esm/models/CommandLogsResponse.d.ts +109 -0
  13. package/dist/esm/models/CommandLogsResponse.js +99 -0
  14. package/dist/esm/models/CommandRecord.d.ts +132 -0
  15. package/dist/esm/models/CommandRecord.js +105 -0
  16. package/dist/esm/models/CommandResponse.d.ts +6 -0
  17. package/dist/esm/models/CommandResponse.js +2 -0
  18. package/dist/esm/models/CommandStartedResponse.d.ts +6 -0
  19. package/dist/esm/models/CommandStartedResponse.js +2 -0
  20. package/dist/esm/models/CommandStatusResponse.d.ts +32 -2
  21. package/dist/esm/models/CommandStatusResponse.js +10 -0
  22. package/dist/esm/models/CommandStopResponse.d.ts +70 -0
  23. package/dist/esm/models/CommandStopResponse.js +70 -0
  24. package/dist/esm/models/CommandStreamFrame.d.ts +6 -0
  25. package/dist/esm/models/CommandStreamFrame.js +2 -0
  26. package/dist/esm/models/CreateSandboxRequest.d.ts +6 -0
  27. package/dist/esm/models/CreateSandboxRequest.js +2 -0
  28. package/dist/esm/models/DataRetentionPolicyResponse.d.ts +12 -0
  29. package/dist/esm/models/DataRetentionPolicyResponse.js +4 -0
  30. package/dist/esm/models/DataRetentionUpdateRequest.d.ts +7 -1
  31. package/dist/esm/models/DataRetentionUpdateRequest.js +2 -0
  32. package/dist/esm/models/ForkRequest.d.ts +6 -0
  33. package/dist/esm/models/ForkRequest.js +2 -0
  34. package/dist/esm/models/ProcessListResponse.d.ts +70 -0
  35. package/dist/esm/models/ProcessListResponse.js +70 -0
  36. package/dist/esm/models/Sandbox.d.ts +6 -0
  37. package/dist/esm/models/Sandbox.js +2 -0
  38. package/dist/esm/models/SandboxProcess.d.ts +74 -0
  39. package/dist/esm/models/SandboxProcess.js +59 -0
  40. package/dist/esm/models/TelemetryConfig.d.ts +57 -0
  41. package/dist/esm/models/TelemetryConfig.js +60 -0
  42. package/dist/esm/models/TelemetryConfigLastError.d.ts +44 -0
  43. package/dist/esm/models/TelemetryConfigLastError.js +51 -0
  44. package/dist/esm/models/TelemetryResponse.d.ts +45 -0
  45. package/dist/esm/models/TelemetryResponse.js +52 -0
  46. package/dist/esm/models/TelemetrySetRequest.d.ts +40 -0
  47. package/dist/esm/models/TelemetrySetRequest.js +45 -0
  48. package/dist/esm/models/TelemetrySetResponse.d.ts +52 -0
  49. package/dist/esm/models/TelemetrySetResponse.js +57 -0
  50. package/dist/esm/models/TelemetryTestResult.d.ts +44 -0
  51. package/dist/esm/models/TelemetryTestResult.js +51 -0
  52. package/dist/esm/models/index.d.ts +14 -0
  53. package/dist/esm/models/index.js +14 -0
  54. package/dist/models/CommandAttachFrame.d.ts +121 -0
  55. package/dist/models/CommandAttachFrame.js +91 -0
  56. package/dist/models/CommandInfoResponse.d.ts +52 -0
  57. package/dist/models/CommandInfoResponse.js +66 -0
  58. package/dist/models/CommandListResponse.d.ts +58 -0
  59. package/dist/models/CommandListResponse.js +70 -0
  60. package/dist/models/CommandLogsResponse.d.ts +109 -0
  61. package/dist/models/CommandLogsResponse.js +107 -0
  62. package/dist/models/CommandRecord.d.ts +132 -0
  63. package/dist/models/CommandRecord.js +113 -0
  64. package/dist/models/CommandResponse.d.ts +6 -0
  65. package/dist/models/CommandResponse.js +2 -0
  66. package/dist/models/CommandStartedResponse.d.ts +6 -0
  67. package/dist/models/CommandStartedResponse.js +2 -0
  68. package/dist/models/CommandStatusResponse.d.ts +32 -2
  69. package/dist/models/CommandStatusResponse.js +10 -0
  70. package/dist/models/CommandStopResponse.d.ts +70 -0
  71. package/dist/models/CommandStopResponse.js +78 -0
  72. package/dist/models/CommandStreamFrame.d.ts +6 -0
  73. package/dist/models/CommandStreamFrame.js +2 -0
  74. package/dist/models/CreateSandboxRequest.d.ts +6 -0
  75. package/dist/models/CreateSandboxRequest.js +2 -0
  76. package/dist/models/DataRetentionPolicyResponse.d.ts +12 -0
  77. package/dist/models/DataRetentionPolicyResponse.js +4 -0
  78. package/dist/models/DataRetentionUpdateRequest.d.ts +7 -1
  79. package/dist/models/DataRetentionUpdateRequest.js +2 -0
  80. package/dist/models/ForkRequest.d.ts +6 -0
  81. package/dist/models/ForkRequest.js +2 -0
  82. package/dist/models/ProcessListResponse.d.ts +70 -0
  83. package/dist/models/ProcessListResponse.js +78 -0
  84. package/dist/models/Sandbox.d.ts +6 -0
  85. package/dist/models/Sandbox.js +2 -0
  86. package/dist/models/SandboxProcess.d.ts +74 -0
  87. package/dist/models/SandboxProcess.js +66 -0
  88. package/dist/models/TelemetryConfig.d.ts +57 -0
  89. package/dist/models/TelemetryConfig.js +67 -0
  90. package/dist/models/TelemetryConfigLastError.d.ts +44 -0
  91. package/dist/models/TelemetryConfigLastError.js +58 -0
  92. package/dist/models/TelemetryResponse.d.ts +45 -0
  93. package/dist/models/TelemetryResponse.js +59 -0
  94. package/dist/models/TelemetrySetRequest.d.ts +40 -0
  95. package/dist/models/TelemetrySetRequest.js +52 -0
  96. package/dist/models/TelemetrySetResponse.d.ts +52 -0
  97. package/dist/models/TelemetrySetResponse.js +64 -0
  98. package/dist/models/TelemetryTestResult.d.ts +44 -0
  99. package/dist/models/TelemetryTestResult.js +58 -0
  100. package/dist/models/index.d.ts +14 -0
  101. package/dist/models/index.js +14 -0
  102. package/docs/BoatApi.md +715 -11
  103. package/docs/Command200Response.md +2 -0
  104. package/docs/CommandAttachFrame.md +53 -0
  105. package/docs/CommandInfoResponse.md +36 -0
  106. package/docs/CommandListResponse.md +38 -0
  107. package/docs/CommandLogsResponse.md +50 -0
  108. package/docs/CommandRecord.md +59 -0
  109. package/docs/CommandResponse.md +2 -0
  110. package/docs/CommandStartedResponse.md +2 -0
  111. package/docs/CommandStatusResponse.md +10 -0
  112. package/docs/CommandStopResponse.md +42 -0
  113. package/docs/CommandStreamFrame.md +2 -0
  114. package/docs/CreateSandboxRequest.md +2 -0
  115. package/docs/DataRetentionPolicyResponse.md +4 -0
  116. package/docs/DataRetentionUpdateRequest.md +3 -1
  117. package/docs/ForkRequest.md +2 -0
  118. package/docs/ProcessListResponse.md +42 -0
  119. package/docs/Sandbox.md +2 -0
  120. package/docs/SandboxProcess.md +46 -0
  121. package/docs/TelemetryConfig.md +40 -0
  122. package/docs/TelemetryConfigLastError.md +37 -0
  123. package/docs/TelemetryResponse.md +36 -0
  124. package/docs/TelemetrySetRequest.md +34 -0
  125. package/docs/TelemetrySetResponse.md +38 -0
  126. package/docs/TelemetryTestResult.md +36 -0
  127. package/package.json +1 -1
  128. package/src/apis/BoatApi.ts +671 -4
  129. package/src/models/CommandAttachFrame.ts +179 -0
  130. package/src/models/CommandInfoResponse.ts +102 -0
  131. package/src/models/CommandListResponse.ts +111 -0
  132. package/src/models/CommandLogsResponse.ts +175 -0
  133. package/src/models/CommandRecord.ts +204 -0
  134. package/src/models/CommandResponse.ts +8 -0
  135. package/src/models/CommandStartedResponse.ts +8 -0
  136. package/src/models/CommandStatusResponse.ts +42 -2
  137. package/src/models/CommandStopResponse.ts +129 -0
  138. package/src/models/CommandStreamFrame.ts +8 -0
  139. package/src/models/CreateSandboxRequest.ts +8 -0
  140. package/src/models/DataRetentionPolicyResponse.ts +16 -0
  141. package/src/models/DataRetentionUpdateRequest.ts +9 -1
  142. package/src/models/ForkRequest.ts +8 -0
  143. package/src/models/ProcessListResponse.ts +129 -0
  144. package/src/models/Sandbox.ts +8 -0
  145. package/src/models/SandboxProcess.ts +123 -0
  146. package/src/models/TelemetryConfig.ts +110 -0
  147. package/src/models/TelemetryConfigLastError.ts +84 -0
  148. package/src/models/TelemetryResponse.ts +92 -0
  149. package/src/models/TelemetrySetRequest.ts +74 -0
  150. package/src/models/TelemetrySetResponse.ts +108 -0
  151. package/src/models/TelemetryTestResult.ts +84 -0
  152. package/src/models/index.ts +14 -0
@@ -18,8 +18,13 @@ import { type ApiKeySecretResponse } from '../models/ApiKeySecretResponse';
18
18
  import { type ApiKeyUsageResponse } from '../models/ApiKeyUsageResponse';
19
19
  import { type ApiKeysResponse } from '../models/ApiKeysResponse';
20
20
  import { type Command200Response } from '../models/Command200Response';
21
+ import { type CommandAttachFrame } from '../models/CommandAttachFrame';
22
+ import { type CommandInfoResponse } from '../models/CommandInfoResponse';
23
+ import { type CommandListResponse } from '../models/CommandListResponse';
24
+ import { type CommandLogsResponse } from '../models/CommandLogsResponse';
21
25
  import { type CommandRequest } from '../models/CommandRequest';
22
26
  import { type CommandStatusResponse } from '../models/CommandStatusResponse';
27
+ import { type CommandStopResponse } from '../models/CommandStopResponse';
23
28
  import { type ConversationsResponse } from '../models/ConversationsResponse';
24
29
  import { type CreateSandboxEnvironmentRequest } from '../models/CreateSandboxEnvironmentRequest';
25
30
  import { type CreateSandboxRequest } from '../models/CreateSandboxRequest';
@@ -50,6 +55,7 @@ import { type NamedSnapshotShareCreatedResponse } from '../models/NamedSnapshotS
50
55
  import { type NamedSnapshotShareListResponse } from '../models/NamedSnapshotShareListResponse';
51
56
  import { type NamedSnapshotShareRevokedResponse } from '../models/NamedSnapshotShareRevokedResponse';
52
57
  import { type OrgListResponse } from '../models/OrgListResponse';
58
+ import { type ProcessListResponse } from '../models/ProcessListResponse';
53
59
  import { type PromptRequest } from '../models/PromptRequest';
54
60
  import { type PromptResponse } from '../models/PromptResponse';
55
61
  import { type PromptRunResponse } from '../models/PromptRunResponse';
@@ -79,6 +85,9 @@ import { type SteerRequest } from '../models/SteerRequest';
79
85
  import { type SteerResponse } from '../models/SteerResponse';
80
86
  import { type StopOperationResponse } from '../models/StopOperationResponse';
81
87
  import { type StopRequest } from '../models/StopRequest';
88
+ import { type TelemetryResponse } from '../models/TelemetryResponse';
89
+ import { type TelemetrySetRequest } from '../models/TelemetrySetRequest';
90
+ import { type TelemetrySetResponse } from '../models/TelemetrySetResponse';
82
91
  import { type UpdateSandboxEnvironmentRequest } from '../models/UpdateSandboxEnvironmentRequest';
83
92
  import { type UpdateSandboxRequest } from '../models/UpdateSandboxRequest';
84
93
  import { type UpgradeSandboxEnvironmentRequest } from '../models/UpgradeSandboxEnvironmentRequest';
@@ -100,14 +109,37 @@ export interface ArtifactRequest {
100
109
  sandboxId: string;
101
110
  path: string;
102
111
  }
112
+ export interface AttachCommandRequest {
113
+ sandboxId: string;
114
+ processId: number;
115
+ stdoutOffset?: number;
116
+ stderrOffset?: number;
117
+ }
103
118
  export interface CommandOperationRequest {
104
119
  sandboxId: string;
105
120
  commandRequest: CommandRequest;
106
121
  }
122
+ export interface CommandHistoryRequest {
123
+ sandboxId: string;
124
+ mode?: string;
125
+ q?: string;
126
+ limit?: number;
127
+ cursor?: string;
128
+ }
129
+ export interface CommandLogsRequest {
130
+ sandboxId: string;
131
+ commandId: string;
132
+ stream?: CommandLogsStreamEnum;
133
+ offset?: number;
134
+ limit?: number;
135
+ encoding?: CommandLogsEncodingEnum;
136
+ }
107
137
  export interface CommandStatusRequest {
108
138
  sandboxId: string;
109
139
  processId: number;
110
140
  tailBytes?: number;
141
+ stdoutOffset?: number;
142
+ stderrOffset?: number;
111
143
  }
112
144
  export interface ConversationsRequest {
113
145
  sandboxId: string;
@@ -185,6 +217,10 @@ export interface ForkOperationRequest {
185
217
  export interface GetRequest {
186
218
  sandboxId: string;
187
219
  }
220
+ export interface GetCommandRequest {
221
+ sandboxId: string;
222
+ commandId: string;
223
+ }
188
224
  export interface GetDeletionOperationRequest {
189
225
  operationId: string;
190
226
  }
@@ -238,6 +274,9 @@ export interface ListSnapshotsRequest {
238
274
  cursor?: string | null;
239
275
  sort?: ListSnapshotsSortEnum;
240
276
  }
277
+ export interface ProcessesRequest {
278
+ sandboxId: string;
279
+ }
241
280
  export interface PromptOperationRequest {
242
281
  sandboxId: string;
243
282
  promptRequest: PromptRequest;
@@ -305,6 +344,9 @@ export interface SetEnvironmentVarOperationRequest {
305
344
  key: string;
306
345
  setEnvironmentVarRequest: SetEnvironmentVarRequest;
307
346
  }
347
+ export interface SetTelemetryRequest {
348
+ telemetrySetRequest: TelemetrySetRequest;
349
+ }
308
350
  export interface ShareRequest {
309
351
  sandboxId: string;
310
352
  }
@@ -321,6 +363,10 @@ export interface StopOperationRequest {
321
363
  sandboxId: string;
322
364
  stopRequest?: StopRequest;
323
365
  }
366
+ export interface StopCommandRequest {
367
+ sandboxId: string;
368
+ processId: number;
369
+ }
324
370
  export interface UpdateRequest {
325
371
  sandboxId: string;
326
372
  updateSandboxRequest: UpdateSandboxRequest;
@@ -412,29 +458,73 @@ export declare class BoatApi extends runtime.BaseAPI {
412
458
  * Download a sandbox artifact
413
459
  */
414
460
  artifact(requestParameters: ArtifactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
461
+ /**
462
+ * Creates request options for attachCommand without sending the request
463
+ */
464
+ attachCommandRequestOpts(requestParameters: AttachCommandRequest): Promise<runtime.RequestOpts>;
465
+ /**
466
+ * The output of a detached command as it is written, one JSON object per line, until the command ends. After 10 minutes the stream ends with a `reconnect` line: open it again with its offsets to continue with no gap. One open stream replaces polling. Needs the `exec` key scope.
467
+ * Attach to a detached command
468
+ */
469
+ attachCommandRaw(requestParameters: AttachCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandAttachFrame>>;
470
+ /**
471
+ * The output of a detached command as it is written, one JSON object per line, until the command ends. After 10 minutes the stream ends with a `reconnect` line: open it again with its offsets to continue with no gap. One open stream replaces polling. Needs the `exec` key scope.
472
+ * Attach to a detached command
473
+ */
474
+ attachCommand(requestParameters: AttachCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandAttachFrame>;
415
475
  /**
416
476
  * Creates request options for command without sending the request
417
477
  */
418
478
  commandRequestOpts(input: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>): Promise<runtime.RequestOpts>;
419
479
  /**
420
- * 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. With `stream: true` the output arrives as the command writes it, as newline-delimited JSON (`application/x-ndjson`): `{\"type\":\"started\"}`, then `{\"type\":\"stdout\"|\"stderr\",\"data\":\"...\"}` per chunk, and last `{\"type\":\"exit\",...}` (the synchronous result without stdout/stderr) or `{\"type\":\"error\",\"error\":\"...\",\"message\":\"...\"}`. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. A command sent while the sandbox is still starting (right after a resume) waits up to 60s for it to be ready instead of failing; 409 boat_starting (retryable) is returned only if it is still not ready by then. A sandbox that is not starting (`error`, `stopped`) returns 409 sandbox_not_ready with `retryable: false` and its `state` at once: resume or recover it first. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox.
480
+ * 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. With `stream: true` the output arrives as the command writes it, as newline-delimited JSON (`application/x-ndjson`): `{\"type\":\"started\"}`, then `{\"type\":\"stdout\"|\"stderr\",\"data\":\"...\"}` per chunk, and last `{\"type\":\"exit\",...}` (the synchronous result without stdout/stderr) or `{\"type\":\"error\",\"error\":\"...\",\"message\":\"...\"}`. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. A command sent while the sandbox is still starting (right after a resume) waits up to 60s for it to be ready instead of failing; 409 boat_starting (retryable) is returned only if it is still not ready by then. A sandbox that is not starting (`error`, `stopped`) returns 409 sandbox_not_ready with `retryable: false` and its `state` at once: resume or recover it first. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox. Every command and its output are kept 90 days in the command history (`/sandboxes/{sandboxId}/command-history`), readable while the sandbox is stopped.
421
481
  * Execute a command in a sandbox
422
482
  */
423
483
  commandRaw(requestParameters: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Command200Response>>;
424
484
  /**
425
- * 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. With `stream: true` the output arrives as the command writes it, as newline-delimited JSON (`application/x-ndjson`): `{\"type\":\"started\"}`, then `{\"type\":\"stdout\"|\"stderr\",\"data\":\"...\"}` per chunk, and last `{\"type\":\"exit\",...}` (the synchronous result without stdout/stderr) or `{\"type\":\"error\",\"error\":\"...\",\"message\":\"...\"}`. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. A command sent while the sandbox is still starting (right after a resume) waits up to 60s for it to be ready instead of failing; 409 boat_starting (retryable) is returned only if it is still not ready by then. A sandbox that is not starting (`error`, `stopped`) returns 409 sandbox_not_ready with `retryable: false` and its `state` at once: resume or recover it first. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox.
485
+ * 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. With `stream: true` the output arrives as the command writes it, as newline-delimited JSON (`application/x-ndjson`): `{\"type\":\"started\"}`, then `{\"type\":\"stdout\"|\"stderr\",\"data\":\"...\"}` per chunk, and last `{\"type\":\"exit\",...}` (the synchronous result without stdout/stderr) or `{\"type\":\"error\",\"error\":\"...\",\"message\":\"...\"}`. Returns 400 invalid_timeout when `timeoutSeconds` is not an integer in 1-600. A command sent while the sandbox is still starting (right after a resume) waits up to 60s for it to be ready instead of failing; 409 boat_starting (retryable) is returned only if it is still not ready by then. A sandbox that is not starting (`error`, `stopped`) returns 409 sandbox_not_ready with `retryable: false` and its `state` at once: resume or recover it first. Command execution is never retried automatically: a 502 boat_direct_failed means the command may already be running on the sandbox. Every command and its output are kept 90 days in the command history (`/sandboxes/{sandboxId}/command-history`), readable while the sandbox is stopped.
426
486
  * Execute a command in a sandbox
427
487
  */
428
488
  command(requestParameters: CommandOperationRequest | runtime.FlatBody<CommandOperationRequest, 'commandRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Command200Response>;
489
+ /**
490
+ * Creates request options for commandHistory without sending the request
491
+ */
492
+ commandHistoryRequestOpts(requestParameters: CommandHistoryRequest): Promise<runtime.RequestOpts>;
493
+ /**
494
+ * Every command run through `POST /sandboxes/{sandboxId}/commands` in the last 90 days, and every other process that wrote to its stdout/stderr in the last 72 hours (mode `process`), newest first. Works while the sandbox is stopped.
495
+ * List the command and process history
496
+ */
497
+ commandHistoryRaw(requestParameters: CommandHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandListResponse>>;
498
+ /**
499
+ * Every command run through `POST /sandboxes/{sandboxId}/commands` in the last 90 days, and every other process that wrote to its stdout/stderr in the last 72 hours (mode `process`), newest first. Works while the sandbox is stopped.
500
+ * List the command and process history
501
+ */
502
+ commandHistory(requestParameters: CommandHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandListResponse>;
503
+ /**
504
+ * Creates request options for commandLogs without sending the request
505
+ */
506
+ commandLogsRequestOpts(requestParameters: CommandLogsRequest): Promise<runtime.RequestOpts>;
507
+ /**
508
+ * Reads stdout or stderr from a byte offset, at most 1 MiB per call. Read on with `nextOffset` until `done`. A running detached command gains output every 30 s; a streamed one every 2 s. Works while the sandbox is stopped.
509
+ * Read a command\'s stored output
510
+ */
511
+ commandLogsRaw(requestParameters: CommandLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandLogsResponse>>;
512
+ /**
513
+ * Reads stdout or stderr from a byte offset, at most 1 MiB per call. Read on with `nextOffset` until `done`. A running detached command gains output every 30 s; a streamed one every 2 s. Works while the sandbox is stopped.
514
+ * Read a command\'s stored output
515
+ */
516
+ commandLogs(requestParameters: CommandLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandLogsResponse>;
429
517
  /**
430
518
  * Creates request options for commandStatus without sending the request
431
519
  */
432
520
  commandStatusRequestOpts(requestParameters: CommandStatusRequest): Promise<runtime.RequestOpts>;
433
521
  /**
522
+ * Without offsets, the answer holds the end of each log. With `stdoutOffset` or `stderrOffset`, it holds only the output written since those byte offsets, so each poll returns only new output. A sandbox agent too old for offsets answers 409 `agent_outdated`.
434
523
  * Get detached command status and logs
435
524
  */
436
525
  commandStatusRaw(requestParameters: CommandStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandStatusResponse>>;
437
526
  /**
527
+ * Without offsets, the answer holds the end of each log. With `stdoutOffset` or `stderrOffset`, it holds only the output written since those byte offsets, so each poll returns only new output. A sandbox agent too old for offsets answers 409 `agent_outdated`.
438
528
  * Get detached command status and logs
439
529
  */
440
530
  commandStatus(requestParameters: CommandStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandStatusResponse>;
@@ -634,6 +724,20 @@ export declare class BoatApi extends runtime.BaseAPI {
634
724
  * Permanently delete snapshot data
635
725
  */
636
726
  deleteSnapshot(requestParameters: DeleteSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletionOperationResponse>;
727
+ /**
728
+ * Creates request options for deleteTelemetry without sending the request
729
+ */
730
+ deleteTelemetryRequestOpts(): Promise<runtime.RequestOpts>;
731
+ /**
732
+ * Removes the export and its queued deliveries. Needs an API key with `account.admin`.
733
+ * Remove OpenTelemetry export
734
+ */
735
+ deleteTelemetryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TelemetryResponse>>;
736
+ /**
737
+ * Removes the export and its queued deliveries. Needs an API key with `account.admin`.
738
+ * Remove OpenTelemetry export
739
+ */
740
+ deleteTelemetry(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TelemetryResponse>;
637
741
  /**
638
742
  * Creates request options for deleteWebhook without sending the request
639
743
  */
@@ -718,6 +822,18 @@ export declare class BoatApi extends runtime.BaseAPI {
718
822
  * Get sandbox
719
823
  */
720
824
  get(requestParameters: GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxInfoResponse>;
825
+ /**
826
+ * Creates request options for getCommand without sending the request
827
+ */
828
+ getCommandRequestOpts(requestParameters: GetCommandRequest): Promise<runtime.RequestOpts>;
829
+ /**
830
+ * Get one command from the history
831
+ */
832
+ getCommandRaw(requestParameters: GetCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandInfoResponse>>;
833
+ /**
834
+ * Get one command from the history
835
+ */
836
+ getCommand(requestParameters: GetCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandInfoResponse>;
721
837
  /**
722
838
  * Creates request options for getDataRetention without sending the request
723
839
  */
@@ -791,12 +907,12 @@ export declare class BoatApi extends runtime.BaseAPI {
791
907
  */
792
908
  getSnapshotFileRequestOpts(requestParameters: GetSnapshotFileRequest): Promise<runtime.RequestOpts>;
793
909
  /**
794
- * Stream a single file\'s bytes, or a folder subtree as a tar archive, directly out of a snapshot, the sandbox can be stopped or archived; the machine is never contacted. Use `GET /snapshots/{snapshotId}/tree` to list paths, then pass one here. Paths are relative to the snapshot root (same space as `tree` entries; docker volumes under `__dockervol__/`). An empty or `/` path downloads the whole snapshot as a tar. Folder responses set `X-Snapshot-File-Count`, `X-Snapshot-Total-Size-Bytes` and `X-Snapshot-Skipped-Base-Image-Files` headers; both response shapes set `X-Snapshot-Entry-Kind` (`file` or `dir`).
910
+ * Stream a single file\'s bytes, or a folder subtree as a tar archive, directly out of a snapshot, the sandbox can be stopped or archived; the machine is never contacted. Use `GET /snapshots/{snapshotId}/tree` to list paths, then pass one here. Paths are relative to the snapshot root (same space as `tree` entries; docker volumes under `__dockervol__/`). An empty or `/` path downloads the whole snapshot as a tar. Folder responses set `X-Snapshot-File-Count`, `X-Snapshot-Total-Size-Bytes` and `X-Snapshot-Skipped-Base-Image-Files` headers; both response shapes set `X-Snapshot-Entry-Kind` (`file` or `dir`). File responses accept a single `Range: bytes=` header and answer 206 with `Content-Range`, so large files can be downloaded in parts and resumed.
795
911
  * Download a file or folder from a snapshot
796
912
  */
797
913
  getSnapshotFileRaw(requestParameters: GetSnapshotFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
798
914
  /**
799
- * Stream a single file\'s bytes, or a folder subtree as a tar archive, directly out of a snapshot, the sandbox can be stopped or archived; the machine is never contacted. Use `GET /snapshots/{snapshotId}/tree` to list paths, then pass one here. Paths are relative to the snapshot root (same space as `tree` entries; docker volumes under `__dockervol__/`). An empty or `/` path downloads the whole snapshot as a tar. Folder responses set `X-Snapshot-File-Count`, `X-Snapshot-Total-Size-Bytes` and `X-Snapshot-Skipped-Base-Image-Files` headers; both response shapes set `X-Snapshot-Entry-Kind` (`file` or `dir`).
915
+ * Stream a single file\'s bytes, or a folder subtree as a tar archive, directly out of a snapshot, the sandbox can be stopped or archived; the machine is never contacted. Use `GET /snapshots/{snapshotId}/tree` to list paths, then pass one here. Paths are relative to the snapshot root (same space as `tree` entries; docker volumes under `__dockervol__/`). An empty or `/` path downloads the whole snapshot as a tar. Folder responses set `X-Snapshot-File-Count`, `X-Snapshot-Total-Size-Bytes` and `X-Snapshot-Skipped-Base-Image-Files` headers; both response shapes set `X-Snapshot-Entry-Kind` (`file` or `dir`). File responses accept a single `Range: bytes=` header and answer 206 with `Content-Range`, so large files can be downloaded in parts and resumed.
800
916
  * Download a file or folder from a snapshot
801
917
  */
802
918
  getSnapshotFile(requestParameters: GetSnapshotFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
@@ -828,6 +944,20 @@ export declare class BoatApi extends runtime.BaseAPI {
828
944
  * Get a stop by id
829
945
  */
830
946
  getStop(requestParameters: GetStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopOperationResponse>;
947
+ /**
948
+ * Creates request options for getTelemetry without sending the request
949
+ */
950
+ getTelemetryRequestOpts(): Promise<runtime.RequestOpts>;
951
+ /**
952
+ * Returns the account\'s OpenTelemetry export, or `telemetry` null when none is set. Header values are never included. Needs an API key with `account.admin`.
953
+ * Get OpenTelemetry export
954
+ */
955
+ getTelemetryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TelemetryResponse>>;
956
+ /**
957
+ * Returns the account\'s OpenTelemetry export, or `telemetry` null when none is set. Header values are never included. Needs an API key with `account.admin`.
958
+ * Get OpenTelemetry export
959
+ */
960
+ getTelemetry(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TelemetryResponse>;
831
961
  /**
832
962
  * Creates request options for getWebhook without sending the request
833
963
  */
@@ -982,6 +1112,20 @@ export declare class BoatApi extends runtime.BaseAPI {
982
1112
  * Get current Boat user
983
1113
  */
984
1114
  me(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MeResponse>;
1115
+ /**
1116
+ * Creates request options for processes without sending the request
1117
+ */
1118
+ processesRequestOpts(requestParameters: ProcessesRequest): Promise<runtime.RequestOpts>;
1119
+ /**
1120
+ * A running sandbox: every user-space process, read now, busiest first. A stopped sandbox: the last sample kept (`live: false`).
1121
+ * List the processes in a sandbox
1122
+ */
1123
+ processesRaw(requestParameters: ProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessListResponse>>;
1124
+ /**
1125
+ * A running sandbox: every user-space process, read now, busiest first. A stopped sandbox: the last sample kept (`live: false`).
1126
+ * List the processes in a sandbox
1127
+ */
1128
+ processes(requestParameters: ProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessListResponse>;
985
1129
  /**
986
1130
  * Creates request options for prompt without sending the request
987
1131
  */
@@ -1218,6 +1362,20 @@ export declare class BoatApi extends runtime.BaseAPI {
1218
1362
  * Set one environment variable
1219
1363
  */
1220
1364
  setEnvironmentVar(requestParameters: SetEnvironmentVarOperationRequest | runtime.FlatBody<SetEnvironmentVarOperationRequest, 'setEnvironmentVarRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnvironmentItemChangeResponse>;
1365
+ /**
1366
+ * Creates request options for setTelemetry without sending the request
1367
+ */
1368
+ setTelemetryRequestOpts(input: SetTelemetryRequest | runtime.FlatBody<SetTelemetryRequest, 'telemetrySetRequest'>): Promise<runtime.RequestOpts>;
1369
+ /**
1370
+ * Sets the account\'s one OTLP/HTTP destination, or replaces it. Boat then sends one metrics export at once and returns the collector\'s answer in `test`. Every 60 seconds Boat sends the sandbox and account gauges to `<endpoint>/v1/metrics`. Each sandbox lifecycle event goes to `<endpoint>/v1/logs`. The endpoint must use HTTPS on port 443 or 4318 and resolve only to public addresses. Needs an API key with `account.admin`.
1371
+ * Set OpenTelemetry export
1372
+ */
1373
+ setTelemetryRaw(requestParameters: SetTelemetryRequest | runtime.FlatBody<SetTelemetryRequest, 'telemetrySetRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TelemetrySetResponse>>;
1374
+ /**
1375
+ * Sets the account\'s one OTLP/HTTP destination, or replaces it. Boat then sends one metrics export at once and returns the collector\'s answer in `test`. Every 60 seconds Boat sends the sandbox and account gauges to `<endpoint>/v1/metrics`. Each sandbox lifecycle event goes to `<endpoint>/v1/logs`. The endpoint must use HTTPS on port 443 or 4318 and resolve only to public addresses. Needs an API key with `account.admin`.
1376
+ * Set OpenTelemetry export
1377
+ */
1378
+ setTelemetry(requestParameters: SetTelemetryRequest | runtime.FlatBody<SetTelemetryRequest, 'telemetrySetRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TelemetrySetResponse>;
1221
1379
  /**
1222
1380
  * Creates request options for share without sending the request
1223
1381
  */
@@ -1274,6 +1432,20 @@ export declare class BoatApi extends runtime.BaseAPI {
1274
1432
  * Stop and archive sandbox
1275
1433
  */
1276
1434
  stop(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
1435
+ /**
1436
+ * Creates request options for stopCommand without sending the request
1437
+ */
1438
+ stopCommandRequestOpts(requestParameters: StopCommandRequest): Promise<runtime.RequestOpts>;
1439
+ /**
1440
+ * Sends SIGTERM to the command and every process it started, then SIGKILL to what is left after 5 s. Only a process started with `detached` can be stopped. The response carries the command\'s history record with its final state and output.
1441
+ * Stop a detached command
1442
+ */
1443
+ stopCommandRaw(requestParameters: StopCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommandStopResponse>>;
1444
+ /**
1445
+ * Sends SIGTERM to the command and every process it started, then SIGKILL to what is left after 5 s. Only a process started with `detached` can be stopped. The response carries the command\'s history record with its final state and output.
1446
+ * Stop a detached command
1447
+ */
1448
+ stopCommand(requestParameters: StopCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommandStopResponse>;
1277
1449
  /**
1278
1450
  * Creates request options for update without sending the request
1279
1451
  */
@@ -1383,6 +1555,22 @@ export declare class BoatApi extends runtime.BaseAPI {
1383
1555
  */
1384
1556
  writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;
1385
1557
  }
1558
+ /**
1559
+ * @export
1560
+ */
1561
+ export declare const CommandLogsStreamEnum: {
1562
+ readonly Stdout: 'stdout';
1563
+ readonly Stderr: 'stderr';
1564
+ };
1565
+ export type CommandLogsStreamEnum = typeof CommandLogsStreamEnum[keyof typeof CommandLogsStreamEnum];
1566
+ /**
1567
+ * @export
1568
+ */
1569
+ export declare const CommandLogsEncodingEnum: {
1570
+ readonly Utf8: 'utf8';
1571
+ readonly Base64: 'base64';
1572
+ };
1573
+ export type CommandLogsEncodingEnum = typeof CommandLogsEncodingEnum[keyof typeof CommandLogsEncodingEnum];
1386
1574
  /**
1387
1575
  * @export
1388
1576
  */