@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.
- package/.openapi-generator/FILES +28 -0
- package/dist/apis/BoatApi.d.ts +192 -4
- package/dist/apis/BoatApi.js +452 -5
- package/dist/esm/apis/BoatApi.d.ts +192 -4
- package/dist/esm/apis/BoatApi.js +451 -4
- package/dist/esm/models/CommandAttachFrame.d.ts +121 -0
- package/dist/esm/models/CommandAttachFrame.js +83 -0
- package/dist/esm/models/CommandInfoResponse.d.ts +52 -0
- package/dist/esm/models/CommandInfoResponse.js +58 -0
- package/dist/esm/models/CommandListResponse.d.ts +58 -0
- package/dist/esm/models/CommandListResponse.js +62 -0
- package/dist/esm/models/CommandLogsResponse.d.ts +109 -0
- package/dist/esm/models/CommandLogsResponse.js +99 -0
- package/dist/esm/models/CommandRecord.d.ts +132 -0
- package/dist/esm/models/CommandRecord.js +105 -0
- package/dist/esm/models/CommandResponse.d.ts +6 -0
- package/dist/esm/models/CommandResponse.js +2 -0
- package/dist/esm/models/CommandStartedResponse.d.ts +6 -0
- package/dist/esm/models/CommandStartedResponse.js +2 -0
- package/dist/esm/models/CommandStatusResponse.d.ts +32 -2
- package/dist/esm/models/CommandStatusResponse.js +10 -0
- package/dist/esm/models/CommandStopResponse.d.ts +70 -0
- package/dist/esm/models/CommandStopResponse.js +70 -0
- package/dist/esm/models/CommandStreamFrame.d.ts +6 -0
- package/dist/esm/models/CommandStreamFrame.js +2 -0
- package/dist/esm/models/CreateSandboxRequest.d.ts +6 -0
- package/dist/esm/models/CreateSandboxRequest.js +2 -0
- package/dist/esm/models/DataRetentionPolicyResponse.d.ts +12 -0
- package/dist/esm/models/DataRetentionPolicyResponse.js +4 -0
- package/dist/esm/models/DataRetentionUpdateRequest.d.ts +7 -1
- package/dist/esm/models/DataRetentionUpdateRequest.js +2 -0
- package/dist/esm/models/ForkRequest.d.ts +6 -0
- package/dist/esm/models/ForkRequest.js +2 -0
- package/dist/esm/models/ProcessListResponse.d.ts +70 -0
- package/dist/esm/models/ProcessListResponse.js +70 -0
- package/dist/esm/models/Sandbox.d.ts +6 -0
- package/dist/esm/models/Sandbox.js +2 -0
- package/dist/esm/models/SandboxProcess.d.ts +74 -0
- package/dist/esm/models/SandboxProcess.js +59 -0
- package/dist/esm/models/TelemetryConfig.d.ts +57 -0
- package/dist/esm/models/TelemetryConfig.js +60 -0
- package/dist/esm/models/TelemetryConfigLastError.d.ts +44 -0
- package/dist/esm/models/TelemetryConfigLastError.js +51 -0
- package/dist/esm/models/TelemetryResponse.d.ts +45 -0
- package/dist/esm/models/TelemetryResponse.js +52 -0
- package/dist/esm/models/TelemetrySetRequest.d.ts +40 -0
- package/dist/esm/models/TelemetrySetRequest.js +45 -0
- package/dist/esm/models/TelemetrySetResponse.d.ts +52 -0
- package/dist/esm/models/TelemetrySetResponse.js +57 -0
- package/dist/esm/models/TelemetryTestResult.d.ts +44 -0
- package/dist/esm/models/TelemetryTestResult.js +51 -0
- package/dist/esm/models/index.d.ts +14 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/models/CommandAttachFrame.d.ts +121 -0
- package/dist/models/CommandAttachFrame.js +91 -0
- package/dist/models/CommandInfoResponse.d.ts +52 -0
- package/dist/models/CommandInfoResponse.js +66 -0
- package/dist/models/CommandListResponse.d.ts +58 -0
- package/dist/models/CommandListResponse.js +70 -0
- package/dist/models/CommandLogsResponse.d.ts +109 -0
- package/dist/models/CommandLogsResponse.js +107 -0
- package/dist/models/CommandRecord.d.ts +132 -0
- package/dist/models/CommandRecord.js +113 -0
- package/dist/models/CommandResponse.d.ts +6 -0
- package/dist/models/CommandResponse.js +2 -0
- package/dist/models/CommandStartedResponse.d.ts +6 -0
- package/dist/models/CommandStartedResponse.js +2 -0
- package/dist/models/CommandStatusResponse.d.ts +32 -2
- package/dist/models/CommandStatusResponse.js +10 -0
- package/dist/models/CommandStopResponse.d.ts +70 -0
- package/dist/models/CommandStopResponse.js +78 -0
- package/dist/models/CommandStreamFrame.d.ts +6 -0
- package/dist/models/CommandStreamFrame.js +2 -0
- package/dist/models/CreateSandboxRequest.d.ts +6 -0
- package/dist/models/CreateSandboxRequest.js +2 -0
- package/dist/models/DataRetentionPolicyResponse.d.ts +12 -0
- package/dist/models/DataRetentionPolicyResponse.js +4 -0
- package/dist/models/DataRetentionUpdateRequest.d.ts +7 -1
- package/dist/models/DataRetentionUpdateRequest.js +2 -0
- package/dist/models/ForkRequest.d.ts +6 -0
- package/dist/models/ForkRequest.js +2 -0
- package/dist/models/ProcessListResponse.d.ts +70 -0
- package/dist/models/ProcessListResponse.js +78 -0
- package/dist/models/Sandbox.d.ts +6 -0
- package/dist/models/Sandbox.js +2 -0
- package/dist/models/SandboxProcess.d.ts +74 -0
- package/dist/models/SandboxProcess.js +66 -0
- package/dist/models/TelemetryConfig.d.ts +57 -0
- package/dist/models/TelemetryConfig.js +67 -0
- package/dist/models/TelemetryConfigLastError.d.ts +44 -0
- package/dist/models/TelemetryConfigLastError.js +58 -0
- package/dist/models/TelemetryResponse.d.ts +45 -0
- package/dist/models/TelemetryResponse.js +59 -0
- package/dist/models/TelemetrySetRequest.d.ts +40 -0
- package/dist/models/TelemetrySetRequest.js +52 -0
- package/dist/models/TelemetrySetResponse.d.ts +52 -0
- package/dist/models/TelemetrySetResponse.js +64 -0
- package/dist/models/TelemetryTestResult.d.ts +44 -0
- package/dist/models/TelemetryTestResult.js +58 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/docs/BoatApi.md +715 -11
- package/docs/Command200Response.md +2 -0
- package/docs/CommandAttachFrame.md +53 -0
- package/docs/CommandInfoResponse.md +36 -0
- package/docs/CommandListResponse.md +38 -0
- package/docs/CommandLogsResponse.md +50 -0
- package/docs/CommandRecord.md +59 -0
- package/docs/CommandResponse.md +2 -0
- package/docs/CommandStartedResponse.md +2 -0
- package/docs/CommandStatusResponse.md +10 -0
- package/docs/CommandStopResponse.md +42 -0
- package/docs/CommandStreamFrame.md +2 -0
- package/docs/CreateSandboxRequest.md +2 -0
- package/docs/DataRetentionPolicyResponse.md +4 -0
- package/docs/DataRetentionUpdateRequest.md +3 -1
- package/docs/ForkRequest.md +2 -0
- package/docs/ProcessListResponse.md +42 -0
- package/docs/Sandbox.md +2 -0
- package/docs/SandboxProcess.md +46 -0
- package/docs/TelemetryConfig.md +40 -0
- package/docs/TelemetryConfigLastError.md +37 -0
- package/docs/TelemetryResponse.md +36 -0
- package/docs/TelemetrySetRequest.md +34 -0
- package/docs/TelemetrySetResponse.md +38 -0
- package/docs/TelemetryTestResult.md +36 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +671 -4
- package/src/models/CommandAttachFrame.ts +179 -0
- package/src/models/CommandInfoResponse.ts +102 -0
- package/src/models/CommandListResponse.ts +111 -0
- package/src/models/CommandLogsResponse.ts +175 -0
- package/src/models/CommandRecord.ts +204 -0
- package/src/models/CommandResponse.ts +8 -0
- package/src/models/CommandStartedResponse.ts +8 -0
- package/src/models/CommandStatusResponse.ts +42 -2
- package/src/models/CommandStopResponse.ts +129 -0
- package/src/models/CommandStreamFrame.ts +8 -0
- package/src/models/CreateSandboxRequest.ts +8 -0
- package/src/models/DataRetentionPolicyResponse.ts +16 -0
- package/src/models/DataRetentionUpdateRequest.ts +9 -1
- package/src/models/ForkRequest.ts +8 -0
- package/src/models/ProcessListResponse.ts +129 -0
- package/src/models/Sandbox.ts +8 -0
- package/src/models/SandboxProcess.ts +123 -0
- package/src/models/TelemetryConfig.ts +110 -0
- package/src/models/TelemetryConfigLastError.ts +84 -0
- package/src/models/TelemetryResponse.ts +92 -0
- package/src/models/TelemetrySetRequest.ts +74 -0
- package/src/models/TelemetrySetResponse.ts +108 -0
- package/src/models/TelemetryTestResult.ts +84 -0
- package/src/models/index.ts +14 -0
package/dist/apis/BoatApi.js
CHANGED
|
@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
46
46
|
};
|
|
47
47
|
})();
|
|
48
48
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
-
exports.SandboxesSortEnum = exports.ReposSortEnum = exports.ReadFileEncodingEnum = exports.ListSnapshotsSortEnum = exports.ListSandboxSnapshotsSortEnum = exports.EventsSortEnum = exports.DesktopOperationThemeEnum = exports.DesktopOperationVncEnum = exports.BoatApi = void 0;
|
|
49
|
+
exports.SandboxesSortEnum = exports.ReposSortEnum = exports.ReadFileEncodingEnum = exports.ListSnapshotsSortEnum = exports.ListSandboxSnapshotsSortEnum = exports.EventsSortEnum = exports.DesktopOperationThemeEnum = exports.DesktopOperationVncEnum = exports.CommandLogsEncodingEnum = exports.CommandLogsStreamEnum = exports.BoatApi = void 0;
|
|
50
50
|
const runtime = __importStar(require("../runtime"));
|
|
51
51
|
const ActiveOrgResponse_1 = require("../models/ActiveOrgResponse");
|
|
52
52
|
const ActiveOrgUpdateRequest_1 = require("../models/ActiveOrgUpdateRequest");
|
|
@@ -56,8 +56,13 @@ const ApiKeySecretResponse_1 = require("../models/ApiKeySecretResponse");
|
|
|
56
56
|
const ApiKeyUsageResponse_1 = require("../models/ApiKeyUsageResponse");
|
|
57
57
|
const ApiKeysResponse_1 = require("../models/ApiKeysResponse");
|
|
58
58
|
const Command200Response_1 = require("../models/Command200Response");
|
|
59
|
+
const CommandAttachFrame_1 = require("../models/CommandAttachFrame");
|
|
60
|
+
const CommandInfoResponse_1 = require("../models/CommandInfoResponse");
|
|
61
|
+
const CommandListResponse_1 = require("../models/CommandListResponse");
|
|
62
|
+
const CommandLogsResponse_1 = require("../models/CommandLogsResponse");
|
|
59
63
|
const CommandRequest_1 = require("../models/CommandRequest");
|
|
60
64
|
const CommandStatusResponse_1 = require("../models/CommandStatusResponse");
|
|
65
|
+
const CommandStopResponse_1 = require("../models/CommandStopResponse");
|
|
61
66
|
const ConversationsResponse_1 = require("../models/ConversationsResponse");
|
|
62
67
|
const CreateSandboxEnvironmentRequest_1 = require("../models/CreateSandboxEnvironmentRequest");
|
|
63
68
|
const CreateSandboxRequest_1 = require("../models/CreateSandboxRequest");
|
|
@@ -88,6 +93,7 @@ const NamedSnapshotShareCreatedResponse_1 = require("../models/NamedSnapshotShar
|
|
|
88
93
|
const NamedSnapshotShareListResponse_1 = require("../models/NamedSnapshotShareListResponse");
|
|
89
94
|
const NamedSnapshotShareRevokedResponse_1 = require("../models/NamedSnapshotShareRevokedResponse");
|
|
90
95
|
const OrgListResponse_1 = require("../models/OrgListResponse");
|
|
96
|
+
const ProcessListResponse_1 = require("../models/ProcessListResponse");
|
|
91
97
|
const PromptRequest_1 = require("../models/PromptRequest");
|
|
92
98
|
const PromptResponse_1 = require("../models/PromptResponse");
|
|
93
99
|
const PromptRunResponse_1 = require("../models/PromptRunResponse");
|
|
@@ -117,6 +123,9 @@ const SteerRequest_1 = require("../models/SteerRequest");
|
|
|
117
123
|
const SteerResponse_1 = require("../models/SteerResponse");
|
|
118
124
|
const StopOperationResponse_1 = require("../models/StopOperationResponse");
|
|
119
125
|
const StopRequest_1 = require("../models/StopRequest");
|
|
126
|
+
const TelemetryResponse_1 = require("../models/TelemetryResponse");
|
|
127
|
+
const TelemetrySetRequest_1 = require("../models/TelemetrySetRequest");
|
|
128
|
+
const TelemetrySetResponse_1 = require("../models/TelemetrySetResponse");
|
|
120
129
|
const UpdateSandboxEnvironmentRequest_1 = require("../models/UpdateSandboxEnvironmentRequest");
|
|
121
130
|
const UpdateSandboxRequest_1 = require("../models/UpdateSandboxRequest");
|
|
122
131
|
const UpgradeSandboxEnvironmentRequest_1 = require("../models/UpgradeSandboxEnvironmentRequest");
|
|
@@ -307,6 +316,58 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
307
316
|
const response = await this.artifactRaw(requestParameters, initOverrides);
|
|
308
317
|
return await response.value();
|
|
309
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* Creates request options for attachCommand without sending the request
|
|
321
|
+
*/
|
|
322
|
+
async attachCommandRequestOpts(requestParameters) {
|
|
323
|
+
if (requestParameters['sandboxId'] == null) {
|
|
324
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling attachCommand().');
|
|
325
|
+
}
|
|
326
|
+
if (requestParameters['processId'] == null) {
|
|
327
|
+
throw new runtime.RequiredError('processId', 'Required parameter "processId" was null or undefined when calling attachCommand().');
|
|
328
|
+
}
|
|
329
|
+
const queryParameters = {};
|
|
330
|
+
if (requestParameters['stdoutOffset'] != null) {
|
|
331
|
+
queryParameters['stdoutOffset'] = requestParameters['stdoutOffset'];
|
|
332
|
+
}
|
|
333
|
+
if (requestParameters['stderrOffset'] != null) {
|
|
334
|
+
queryParameters['stderrOffset'] = requestParameters['stderrOffset'];
|
|
335
|
+
}
|
|
336
|
+
const headerParameters = {};
|
|
337
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
338
|
+
const token = this.configuration.accessToken;
|
|
339
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
340
|
+
if (tokenString) {
|
|
341
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
let urlPath = `/sandboxes/{sandboxId}/commands/{processId}/stream`;
|
|
345
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
346
|
+
urlPath = urlPath.replace('{processId}', encodeURIComponent(String(requestParameters['processId'])));
|
|
347
|
+
return {
|
|
348
|
+
path: urlPath,
|
|
349
|
+
method: 'GET',
|
|
350
|
+
headers: headerParameters,
|
|
351
|
+
query: queryParameters,
|
|
352
|
+
};
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* 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.
|
|
356
|
+
* Attach to a detached command
|
|
357
|
+
*/
|
|
358
|
+
async attachCommandRaw(requestParameters, initOverrides) {
|
|
359
|
+
const requestOptions = await this.attachCommandRequestOpts(requestParameters);
|
|
360
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
361
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandAttachFrame_1.CommandAttachFrameFromJSON)(jsonValue));
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* 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.
|
|
365
|
+
* Attach to a detached command
|
|
366
|
+
*/
|
|
367
|
+
async attachCommand(requestParameters, initOverrides) {
|
|
368
|
+
const response = await this.attachCommandRaw(requestParameters, initOverrides);
|
|
369
|
+
return await response.value();
|
|
370
|
+
}
|
|
310
371
|
/**
|
|
311
372
|
* Creates request options for command without sending the request
|
|
312
373
|
*/
|
|
@@ -339,7 +400,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
339
400
|
};
|
|
340
401
|
}
|
|
341
402
|
/**
|
|
342
|
-
* 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.
|
|
403
|
+
* 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.
|
|
343
404
|
* Execute a command in a sandbox
|
|
344
405
|
*/
|
|
345
406
|
async commandRaw(requestParameters, initOverrides) {
|
|
@@ -348,13 +409,125 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
348
409
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Command200Response_1.Command200ResponseFromJSON)(jsonValue));
|
|
349
410
|
}
|
|
350
411
|
/**
|
|
351
|
-
* 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.
|
|
412
|
+
* 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.
|
|
352
413
|
* Execute a command in a sandbox
|
|
353
414
|
*/
|
|
354
415
|
async command(requestParameters, initOverrides) {
|
|
355
416
|
const response = await this.commandRaw(requestParameters, initOverrides);
|
|
356
417
|
return await response.value();
|
|
357
418
|
}
|
|
419
|
+
/**
|
|
420
|
+
* Creates request options for commandHistory without sending the request
|
|
421
|
+
*/
|
|
422
|
+
async commandHistoryRequestOpts(requestParameters) {
|
|
423
|
+
if (requestParameters['sandboxId'] == null) {
|
|
424
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling commandHistory().');
|
|
425
|
+
}
|
|
426
|
+
const queryParameters = {};
|
|
427
|
+
if (requestParameters['mode'] != null) {
|
|
428
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
429
|
+
}
|
|
430
|
+
if (requestParameters['q'] != null) {
|
|
431
|
+
queryParameters['q'] = requestParameters['q'];
|
|
432
|
+
}
|
|
433
|
+
if (requestParameters['limit'] != null) {
|
|
434
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
435
|
+
}
|
|
436
|
+
if (requestParameters['cursor'] != null) {
|
|
437
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
438
|
+
}
|
|
439
|
+
const headerParameters = {};
|
|
440
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
441
|
+
const token = this.configuration.accessToken;
|
|
442
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
443
|
+
if (tokenString) {
|
|
444
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
let urlPath = `/sandboxes/{sandboxId}/command-history`;
|
|
448
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
449
|
+
return {
|
|
450
|
+
path: urlPath,
|
|
451
|
+
method: 'GET',
|
|
452
|
+
headers: headerParameters,
|
|
453
|
+
query: queryParameters,
|
|
454
|
+
};
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* 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.
|
|
458
|
+
* List the command and process history
|
|
459
|
+
*/
|
|
460
|
+
async commandHistoryRaw(requestParameters, initOverrides) {
|
|
461
|
+
const requestOptions = await this.commandHistoryRequestOpts(requestParameters);
|
|
462
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
463
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandListResponse_1.CommandListResponseFromJSON)(jsonValue));
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* 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.
|
|
467
|
+
* List the command and process history
|
|
468
|
+
*/
|
|
469
|
+
async commandHistory(requestParameters, initOverrides) {
|
|
470
|
+
const response = await this.commandHistoryRaw(requestParameters, initOverrides);
|
|
471
|
+
return await response.value();
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* Creates request options for commandLogs without sending the request
|
|
475
|
+
*/
|
|
476
|
+
async commandLogsRequestOpts(requestParameters) {
|
|
477
|
+
if (requestParameters['sandboxId'] == null) {
|
|
478
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling commandLogs().');
|
|
479
|
+
}
|
|
480
|
+
if (requestParameters['commandId'] == null) {
|
|
481
|
+
throw new runtime.RequiredError('commandId', 'Required parameter "commandId" was null or undefined when calling commandLogs().');
|
|
482
|
+
}
|
|
483
|
+
const queryParameters = {};
|
|
484
|
+
if (requestParameters['stream'] != null) {
|
|
485
|
+
queryParameters['stream'] = requestParameters['stream'];
|
|
486
|
+
}
|
|
487
|
+
if (requestParameters['offset'] != null) {
|
|
488
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
489
|
+
}
|
|
490
|
+
if (requestParameters['limit'] != null) {
|
|
491
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
492
|
+
}
|
|
493
|
+
if (requestParameters['encoding'] != null) {
|
|
494
|
+
queryParameters['encoding'] = requestParameters['encoding'];
|
|
495
|
+
}
|
|
496
|
+
const headerParameters = {};
|
|
497
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
498
|
+
const token = this.configuration.accessToken;
|
|
499
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
500
|
+
if (tokenString) {
|
|
501
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
let urlPath = `/sandboxes/{sandboxId}/command-history/{commandId}/logs`;
|
|
505
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
506
|
+
urlPath = urlPath.replace('{commandId}', encodeURIComponent(String(requestParameters['commandId'])));
|
|
507
|
+
return {
|
|
508
|
+
path: urlPath,
|
|
509
|
+
method: 'GET',
|
|
510
|
+
headers: headerParameters,
|
|
511
|
+
query: queryParameters,
|
|
512
|
+
};
|
|
513
|
+
}
|
|
514
|
+
/**
|
|
515
|
+
* 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.
|
|
516
|
+
* Read a command\'s stored output
|
|
517
|
+
*/
|
|
518
|
+
async commandLogsRaw(requestParameters, initOverrides) {
|
|
519
|
+
const requestOptions = await this.commandLogsRequestOpts(requestParameters);
|
|
520
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
521
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandLogsResponse_1.CommandLogsResponseFromJSON)(jsonValue));
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* 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.
|
|
525
|
+
* Read a command\'s stored output
|
|
526
|
+
*/
|
|
527
|
+
async commandLogs(requestParameters, initOverrides) {
|
|
528
|
+
const response = await this.commandLogsRaw(requestParameters, initOverrides);
|
|
529
|
+
return await response.value();
|
|
530
|
+
}
|
|
358
531
|
/**
|
|
359
532
|
* Creates request options for commandStatus without sending the request
|
|
360
533
|
*/
|
|
@@ -369,6 +542,12 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
369
542
|
if (requestParameters['tailBytes'] != null) {
|
|
370
543
|
queryParameters['tailBytes'] = requestParameters['tailBytes'];
|
|
371
544
|
}
|
|
545
|
+
if (requestParameters['stdoutOffset'] != null) {
|
|
546
|
+
queryParameters['stdoutOffset'] = requestParameters['stdoutOffset'];
|
|
547
|
+
}
|
|
548
|
+
if (requestParameters['stderrOffset'] != null) {
|
|
549
|
+
queryParameters['stderrOffset'] = requestParameters['stderrOffset'];
|
|
550
|
+
}
|
|
372
551
|
const headerParameters = {};
|
|
373
552
|
if (this.configuration && this.configuration.accessToken) {
|
|
374
553
|
const token = this.configuration.accessToken;
|
|
@@ -388,6 +567,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
388
567
|
};
|
|
389
568
|
}
|
|
390
569
|
/**
|
|
570
|
+
* 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`.
|
|
391
571
|
* Get detached command status and logs
|
|
392
572
|
*/
|
|
393
573
|
async commandStatusRaw(requestParameters, initOverrides) {
|
|
@@ -396,6 +576,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
396
576
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandStatusResponse_1.CommandStatusResponseFromJSON)(jsonValue));
|
|
397
577
|
}
|
|
398
578
|
/**
|
|
579
|
+
* 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`.
|
|
399
580
|
* Get detached command status and logs
|
|
400
581
|
*/
|
|
401
582
|
async commandStatus(requestParameters, initOverrides) {
|
|
@@ -1036,6 +1217,44 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1036
1217
|
const response = await this.deleteSnapshotRaw(requestParameters, initOverrides);
|
|
1037
1218
|
return await response.value();
|
|
1038
1219
|
}
|
|
1220
|
+
/**
|
|
1221
|
+
* Creates request options for deleteTelemetry without sending the request
|
|
1222
|
+
*/
|
|
1223
|
+
async deleteTelemetryRequestOpts() {
|
|
1224
|
+
const queryParameters = {};
|
|
1225
|
+
const headerParameters = {};
|
|
1226
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1227
|
+
const token = this.configuration.accessToken;
|
|
1228
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
1229
|
+
if (tokenString) {
|
|
1230
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1231
|
+
}
|
|
1232
|
+
}
|
|
1233
|
+
let urlPath = `/telemetry`;
|
|
1234
|
+
return {
|
|
1235
|
+
path: urlPath,
|
|
1236
|
+
method: 'DELETE',
|
|
1237
|
+
headers: headerParameters,
|
|
1238
|
+
query: queryParameters,
|
|
1239
|
+
};
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* Removes the export and its queued deliveries. Needs an API key with `account.admin`.
|
|
1243
|
+
* Remove OpenTelemetry export
|
|
1244
|
+
*/
|
|
1245
|
+
async deleteTelemetryRaw(initOverrides) {
|
|
1246
|
+
const requestOptions = await this.deleteTelemetryRequestOpts();
|
|
1247
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1248
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, TelemetryResponse_1.TelemetryResponseFromJSON)(jsonValue));
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* Removes the export and its queued deliveries. Needs an API key with `account.admin`.
|
|
1252
|
+
* Remove OpenTelemetry export
|
|
1253
|
+
*/
|
|
1254
|
+
async deleteTelemetry(initOverrides) {
|
|
1255
|
+
const response = await this.deleteTelemetryRaw(initOverrides);
|
|
1256
|
+
return await response.value();
|
|
1257
|
+
}
|
|
1039
1258
|
/**
|
|
1040
1259
|
* Creates request options for deleteWebhook without sending the request
|
|
1041
1260
|
*/
|
|
@@ -1314,6 +1533,50 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1314
1533
|
const response = await this.getRaw(requestParameters, initOverrides);
|
|
1315
1534
|
return await response.value();
|
|
1316
1535
|
}
|
|
1536
|
+
/**
|
|
1537
|
+
* Creates request options for getCommand without sending the request
|
|
1538
|
+
*/
|
|
1539
|
+
async getCommandRequestOpts(requestParameters) {
|
|
1540
|
+
if (requestParameters['sandboxId'] == null) {
|
|
1541
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling getCommand().');
|
|
1542
|
+
}
|
|
1543
|
+
if (requestParameters['commandId'] == null) {
|
|
1544
|
+
throw new runtime.RequiredError('commandId', 'Required parameter "commandId" was null or undefined when calling getCommand().');
|
|
1545
|
+
}
|
|
1546
|
+
const queryParameters = {};
|
|
1547
|
+
const headerParameters = {};
|
|
1548
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1549
|
+
const token = this.configuration.accessToken;
|
|
1550
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
1551
|
+
if (tokenString) {
|
|
1552
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1553
|
+
}
|
|
1554
|
+
}
|
|
1555
|
+
let urlPath = `/sandboxes/{sandboxId}/command-history/{commandId}`;
|
|
1556
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
1557
|
+
urlPath = urlPath.replace('{commandId}', encodeURIComponent(String(requestParameters['commandId'])));
|
|
1558
|
+
return {
|
|
1559
|
+
path: urlPath,
|
|
1560
|
+
method: 'GET',
|
|
1561
|
+
headers: headerParameters,
|
|
1562
|
+
query: queryParameters,
|
|
1563
|
+
};
|
|
1564
|
+
}
|
|
1565
|
+
/**
|
|
1566
|
+
* Get one command from the history
|
|
1567
|
+
*/
|
|
1568
|
+
async getCommandRaw(requestParameters, initOverrides) {
|
|
1569
|
+
const requestOptions = await this.getCommandRequestOpts(requestParameters);
|
|
1570
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1571
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandInfoResponse_1.CommandInfoResponseFromJSON)(jsonValue));
|
|
1572
|
+
}
|
|
1573
|
+
/**
|
|
1574
|
+
* Get one command from the history
|
|
1575
|
+
*/
|
|
1576
|
+
async getCommand(requestParameters, initOverrides) {
|
|
1577
|
+
const response = await this.getCommandRaw(requestParameters, initOverrides);
|
|
1578
|
+
return await response.value();
|
|
1579
|
+
}
|
|
1317
1580
|
/**
|
|
1318
1581
|
* Creates request options for getDataRetention without sending the request
|
|
1319
1582
|
*/
|
|
@@ -1547,7 +1810,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1547
1810
|
};
|
|
1548
1811
|
}
|
|
1549
1812
|
/**
|
|
1550
|
-
* 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`).
|
|
1813
|
+
* 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.
|
|
1551
1814
|
* Download a file or folder from a snapshot
|
|
1552
1815
|
*/
|
|
1553
1816
|
async getSnapshotFileRaw(requestParameters, initOverrides) {
|
|
@@ -1556,7 +1819,7 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1556
1819
|
return new runtime.BlobApiResponse(response);
|
|
1557
1820
|
}
|
|
1558
1821
|
/**
|
|
1559
|
-
* 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`).
|
|
1822
|
+
* 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.
|
|
1560
1823
|
* Download a file or folder from a snapshot
|
|
1561
1824
|
*/
|
|
1562
1825
|
async getSnapshotFile(requestParameters, initOverrides) {
|
|
@@ -1651,6 +1914,44 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
1651
1914
|
const response = await this.getStopRaw(requestParameters, initOverrides);
|
|
1652
1915
|
return await response.value();
|
|
1653
1916
|
}
|
|
1917
|
+
/**
|
|
1918
|
+
* Creates request options for getTelemetry without sending the request
|
|
1919
|
+
*/
|
|
1920
|
+
async getTelemetryRequestOpts() {
|
|
1921
|
+
const queryParameters = {};
|
|
1922
|
+
const headerParameters = {};
|
|
1923
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1924
|
+
const token = this.configuration.accessToken;
|
|
1925
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
1926
|
+
if (tokenString) {
|
|
1927
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1928
|
+
}
|
|
1929
|
+
}
|
|
1930
|
+
let urlPath = `/telemetry`;
|
|
1931
|
+
return {
|
|
1932
|
+
path: urlPath,
|
|
1933
|
+
method: 'GET',
|
|
1934
|
+
headers: headerParameters,
|
|
1935
|
+
query: queryParameters,
|
|
1936
|
+
};
|
|
1937
|
+
}
|
|
1938
|
+
/**
|
|
1939
|
+
* 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`.
|
|
1940
|
+
* Get OpenTelemetry export
|
|
1941
|
+
*/
|
|
1942
|
+
async getTelemetryRaw(initOverrides) {
|
|
1943
|
+
const requestOptions = await this.getTelemetryRequestOpts();
|
|
1944
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1945
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, TelemetryResponse_1.TelemetryResponseFromJSON)(jsonValue));
|
|
1946
|
+
}
|
|
1947
|
+
/**
|
|
1948
|
+
* 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`.
|
|
1949
|
+
* Get OpenTelemetry export
|
|
1950
|
+
*/
|
|
1951
|
+
async getTelemetry(initOverrides) {
|
|
1952
|
+
const response = await this.getTelemetryRaw(initOverrides);
|
|
1953
|
+
return await response.value();
|
|
1954
|
+
}
|
|
1654
1955
|
/**
|
|
1655
1956
|
* Creates request options for getWebhook without sending the request
|
|
1656
1957
|
*/
|
|
@@ -2125,6 +2426,48 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2125
2426
|
const response = await this.meRaw(initOverrides);
|
|
2126
2427
|
return await response.value();
|
|
2127
2428
|
}
|
|
2429
|
+
/**
|
|
2430
|
+
* Creates request options for processes without sending the request
|
|
2431
|
+
*/
|
|
2432
|
+
async processesRequestOpts(requestParameters) {
|
|
2433
|
+
if (requestParameters['sandboxId'] == null) {
|
|
2434
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling processes().');
|
|
2435
|
+
}
|
|
2436
|
+
const queryParameters = {};
|
|
2437
|
+
const headerParameters = {};
|
|
2438
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
2439
|
+
const token = this.configuration.accessToken;
|
|
2440
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
2441
|
+
if (tokenString) {
|
|
2442
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
2443
|
+
}
|
|
2444
|
+
}
|
|
2445
|
+
let urlPath = `/sandboxes/{sandboxId}/processes`;
|
|
2446
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
2447
|
+
return {
|
|
2448
|
+
path: urlPath,
|
|
2449
|
+
method: 'GET',
|
|
2450
|
+
headers: headerParameters,
|
|
2451
|
+
query: queryParameters,
|
|
2452
|
+
};
|
|
2453
|
+
}
|
|
2454
|
+
/**
|
|
2455
|
+
* A running sandbox: every user-space process, read now, busiest first. A stopped sandbox: the last sample kept (`live: false`).
|
|
2456
|
+
* List the processes in a sandbox
|
|
2457
|
+
*/
|
|
2458
|
+
async processesRaw(requestParameters, initOverrides) {
|
|
2459
|
+
const requestOptions = await this.processesRequestOpts(requestParameters);
|
|
2460
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
2461
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, ProcessListResponse_1.ProcessListResponseFromJSON)(jsonValue));
|
|
2462
|
+
}
|
|
2463
|
+
/**
|
|
2464
|
+
* A running sandbox: every user-space process, read now, busiest first. A stopped sandbox: the last sample kept (`live: false`).
|
|
2465
|
+
* List the processes in a sandbox
|
|
2466
|
+
*/
|
|
2467
|
+
async processes(requestParameters, initOverrides) {
|
|
2468
|
+
const response = await this.processesRaw(requestParameters, initOverrides);
|
|
2469
|
+
return await response.value();
|
|
2470
|
+
}
|
|
2128
2471
|
/**
|
|
2129
2472
|
* Creates request options for prompt without sending the request
|
|
2130
2473
|
*/
|
|
@@ -2909,6 +3252,50 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
2909
3252
|
const response = await this.setEnvironmentVarRaw(requestParameters, initOverrides);
|
|
2910
3253
|
return await response.value();
|
|
2911
3254
|
}
|
|
3255
|
+
/**
|
|
3256
|
+
* Creates request options for setTelemetry without sending the request
|
|
3257
|
+
*/
|
|
3258
|
+
async setTelemetryRequestOpts(input) {
|
|
3259
|
+
const requestParameters = runtime.unflattenBody(input, 'telemetrySetRequest', [], []);
|
|
3260
|
+
if (requestParameters['telemetrySetRequest'] == null) {
|
|
3261
|
+
throw new runtime.RequiredError('telemetrySetRequest', 'Required parameter "telemetrySetRequest" was null or undefined when calling setTelemetry().');
|
|
3262
|
+
}
|
|
3263
|
+
const queryParameters = {};
|
|
3264
|
+
const headerParameters = {};
|
|
3265
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
3266
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3267
|
+
const token = this.configuration.accessToken;
|
|
3268
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
3269
|
+
if (tokenString) {
|
|
3270
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3271
|
+
}
|
|
3272
|
+
}
|
|
3273
|
+
let urlPath = `/telemetry`;
|
|
3274
|
+
return {
|
|
3275
|
+
path: urlPath,
|
|
3276
|
+
method: 'PUT',
|
|
3277
|
+
headers: headerParameters,
|
|
3278
|
+
query: queryParameters,
|
|
3279
|
+
body: (0, TelemetrySetRequest_1.TelemetrySetRequestToJSON)(requestParameters['telemetrySetRequest']),
|
|
3280
|
+
};
|
|
3281
|
+
}
|
|
3282
|
+
/**
|
|
3283
|
+
* 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`.
|
|
3284
|
+
* Set OpenTelemetry export
|
|
3285
|
+
*/
|
|
3286
|
+
async setTelemetryRaw(requestParameters, initOverrides) {
|
|
3287
|
+
const requestOptions = await this.setTelemetryRequestOpts(requestParameters);
|
|
3288
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
3289
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, TelemetrySetResponse_1.TelemetrySetResponseFromJSON)(jsonValue));
|
|
3290
|
+
}
|
|
3291
|
+
/**
|
|
3292
|
+
* 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`.
|
|
3293
|
+
* Set OpenTelemetry export
|
|
3294
|
+
*/
|
|
3295
|
+
async setTelemetry(requestParameters, initOverrides) {
|
|
3296
|
+
const response = await this.setTelemetryRaw(requestParameters, initOverrides);
|
|
3297
|
+
return await response.value();
|
|
3298
|
+
}
|
|
2912
3299
|
/**
|
|
2913
3300
|
* Creates request options for share without sending the request
|
|
2914
3301
|
*/
|
|
@@ -3095,6 +3482,52 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3095
3482
|
const response = await this.stopRaw(requestParameters, initOverrides);
|
|
3096
3483
|
return await response.value();
|
|
3097
3484
|
}
|
|
3485
|
+
/**
|
|
3486
|
+
* Creates request options for stopCommand without sending the request
|
|
3487
|
+
*/
|
|
3488
|
+
async stopCommandRequestOpts(requestParameters) {
|
|
3489
|
+
if (requestParameters['sandboxId'] == null) {
|
|
3490
|
+
throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling stopCommand().');
|
|
3491
|
+
}
|
|
3492
|
+
if (requestParameters['processId'] == null) {
|
|
3493
|
+
throw new runtime.RequiredError('processId', 'Required parameter "processId" was null or undefined when calling stopCommand().');
|
|
3494
|
+
}
|
|
3495
|
+
const queryParameters = {};
|
|
3496
|
+
const headerParameters = {};
|
|
3497
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3498
|
+
const token = this.configuration.accessToken;
|
|
3499
|
+
const tokenString = await token("BoatBearerAuth", []);
|
|
3500
|
+
if (tokenString) {
|
|
3501
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3502
|
+
}
|
|
3503
|
+
}
|
|
3504
|
+
let urlPath = `/sandboxes/{sandboxId}/commands/{processId}`;
|
|
3505
|
+
urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
|
|
3506
|
+
urlPath = urlPath.replace('{processId}', encodeURIComponent(String(requestParameters['processId'])));
|
|
3507
|
+
return {
|
|
3508
|
+
path: urlPath,
|
|
3509
|
+
method: 'DELETE',
|
|
3510
|
+
headers: headerParameters,
|
|
3511
|
+
query: queryParameters,
|
|
3512
|
+
};
|
|
3513
|
+
}
|
|
3514
|
+
/**
|
|
3515
|
+
* 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.
|
|
3516
|
+
* Stop a detached command
|
|
3517
|
+
*/
|
|
3518
|
+
async stopCommandRaw(requestParameters, initOverrides) {
|
|
3519
|
+
const requestOptions = await this.stopCommandRequestOpts(requestParameters);
|
|
3520
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
3521
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, CommandStopResponse_1.CommandStopResponseFromJSON)(jsonValue));
|
|
3522
|
+
}
|
|
3523
|
+
/**
|
|
3524
|
+
* 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.
|
|
3525
|
+
* Stop a detached command
|
|
3526
|
+
*/
|
|
3527
|
+
async stopCommand(requestParameters, initOverrides) {
|
|
3528
|
+
const response = await this.stopCommandRaw(requestParameters, initOverrides);
|
|
3529
|
+
return await response.value();
|
|
3530
|
+
}
|
|
3098
3531
|
/**
|
|
3099
3532
|
* Creates request options for update without sending the request
|
|
3100
3533
|
*/
|
|
@@ -3466,6 +3899,20 @@ class BoatApi extends runtime.BaseAPI {
|
|
|
3466
3899
|
}
|
|
3467
3900
|
}
|
|
3468
3901
|
exports.BoatApi = BoatApi;
|
|
3902
|
+
/**
|
|
3903
|
+
* @export
|
|
3904
|
+
*/
|
|
3905
|
+
exports.CommandLogsStreamEnum = {
|
|
3906
|
+
Stdout: 'stdout',
|
|
3907
|
+
Stderr: 'stderr'
|
|
3908
|
+
};
|
|
3909
|
+
/**
|
|
3910
|
+
* @export
|
|
3911
|
+
*/
|
|
3912
|
+
exports.CommandLogsEncodingEnum = {
|
|
3913
|
+
Utf8: 'utf8',
|
|
3914
|
+
Base64: 'base64'
|
|
3915
|
+
};
|
|
3469
3916
|
/**
|
|
3470
3917
|
* @export
|
|
3471
3918
|
*/
|