@boatdev/sdk 1.9.2 → 1.9.3

package/docs/Command200Response.md

@@ -9,6 +9,7 @@ Name | Type
 `ok` | boolean
 `type` | string
 `success` | boolean
+`commandId` | string
 `exitCode` | number
 `signal` | string
 `oomKilled` | boolean
@@ -36,6 +37,7 @@ const example = {
   "ok": null,
   "type": null,
   "success": null,
+  "commandId": null,
   "exitCode": null,
   "signal": null,
   "oomKilled": null,

package/docs/CommandAttachFrame.md

@@ -0,0 +1,53 @@
+
+# CommandAttachFrame
+
+One line of `GET /sandboxes/{sandboxId}/commands/{processId}/stream` (application/x-ndjson). - `attached`: first line. `processId`, `stdoutOffset`, `stderrOffset` (where the output starts). - `stdout` / `stderr`: a chunk. `data`, and `nextOffset` for that stream. - `heartbeat`: sent after 15 s with no other line. - `exit`: last line when the command ended and all its output was sent. `status`, `exitCode`, `signal`, `stdoutOffset`, `stderrOffset`. - `reconnect`: last line after 10 minutes. Open the stream again with its `stdoutOffset` and `stderrOffset`. Nothing is lost or repeated. - `error`: last line on a failure. `error`, `message`, `stdoutOffset`, `stderrOffset`. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`processId` | number
+`data` | string
+`nextOffset` | number
+`stdoutOffset` | number
+`stderrOffset` | number
+`status` | string
+`exitCode` | number
+`signal` | string
+`error` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CommandAttachFrame } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "processId": null,
+  "data": null,
+  "nextOffset": null,
+  "stdoutOffset": null,
+  "stderrOffset": null,
+  "status": null,
+  "exitCode": null,
+  "signal": null,
+  "error": null,
+  "message": null,
+} satisfies CommandAttachFrame
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandAttachFrame
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandInfoResponse.md

@@ -0,0 +1,36 @@
+
+# CommandInfoResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`command` | [CommandRecord](CommandRecord.md)
+
+## Example
+
+```typescript
+import type { CommandInfoResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "command": null,
+} satisfies CommandInfoResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandInfoResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandListResponse.md

@@ -0,0 +1,38 @@
+
+# CommandListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`commands` | [Array<CommandRecord>](CommandRecord.md)
+`nextCursor` | string
+
+## Example
+
+```typescript
+import type { CommandListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "commands": null,
+  "nextCursor": null,
+} satisfies CommandListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandLogsResponse.md

@@ -0,0 +1,50 @@
+
+# CommandLogsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`commandId` | string
+`stream` | string
+`offset` | number
+`nextOffset` | number
+`size` | number
+`encoding` | string
+`data` | string
+`done` | boolean
+
+## Example
+
+```typescript
+import type { CommandLogsResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "commandId": null,
+  "stream": null,
+  "offset": null,
+  "nextOffset": null,
+  "size": null,
+  "encoding": null,
+  "data": null,
+  "done": null,
+} satisfies CommandLogsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandLogsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandRecord.md

@@ -0,0 +1,59 @@
+
+# CommandRecord
+
+One command run through the commands endpoint (kept 90 days), or one process of the sandbox with mode `process` (kept 72 hours). Readable while the sandbox is stopped.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`commandId` | string
+`sandboxId` | string
+`command` | string
+`cwd` | string
+`mode` | string
+`processId` | number
+`status` | string
+`exitCode` | number
+`signal` | string
+`stdoutBytes` | number
+`stderrBytes` | number
+`outputTruncated` | boolean
+`startedAt` | Date
+`finishedAt` | Date
+
+## Example
+
+```typescript
+import type { CommandRecord } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "commandId": null,
+  "sandboxId": null,
+  "command": null,
+  "cwd": null,
+  "mode": null,
+  "processId": null,
+  "status": null,
+  "exitCode": null,
+  "signal": null,
+  "stdoutBytes": null,
+  "stderrBytes": null,
+  "outputTruncated": null,
+  "startedAt": null,
+  "finishedAt": null,
+} satisfies CommandRecord
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandRecord
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandResponse.md

@@ -9,6 +9,7 @@ Name | Type
 `ok` | boolean
 `type` | string
 `success` | boolean
+`commandId` | string
 `exitCode` | number
 `signal` | string
 `oomKilled` | boolean
@@ -31,6 +32,7 @@ const example = {
   "ok": null,
   "type": null,
   "success": null,
+  "commandId": null,
   "exitCode": null,
   "signal": null,
   "oomKilled": null,

package/docs/CommandStartedResponse.md

@@ -9,6 +9,7 @@ Name | Type
 `ok` | boolean
 `type` | string
 `success` | boolean
+`commandId` | string
 `processId` | number
 `pid` | number
 `command` | string
@@ -27,6 +28,7 @@ const example = {
   "ok": null,
   "type": null,
   "success": null,
+  "commandId": null,
   "processId": null,
   "pid": null,
   "command": null,

package/docs/CommandStatusResponse.md

@@ -27,6 +27,11 @@ Name | Type
 `stderrTruncated` | boolean
 `logPath` | string
 `errLogPath` | string
+`stdoutOffset` | number
+`stderrOffset` | number
+`stdoutNextOffset` | number
+`stderrNextOffset` | number
+`more` | boolean
 
 ## Example
 
@@ -56,6 +61,11 @@ const example = {
   "stderrTruncated": null,
   "logPath": null,
   "errLogPath": null,
+  "stdoutOffset": null,
+  "stderrOffset": null,
+  "stdoutNextOffset": null,
+  "stderrNextOffset": null,
+  "more": null,
 } satisfies CommandStatusResponse
 
 console.log(example)

package/docs/CommandStopResponse.md

@@ -0,0 +1,42 @@
+
+# CommandStopResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`processId` | number
+`running` | boolean
+`signaled` | boolean
+`command` | [CommandRecord](CommandRecord.md)
+
+## Example
+
+```typescript
+import type { CommandStopResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "processId": null,
+  "running": null,
+  "signaled": null,
+  "command": null,
+} satisfies CommandStopResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CommandStopResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/CommandStreamFrame.md

@@ -8,6 +8,7 @@ One line of a streamed command. `started` first, then `stdout`/`stderr` chunks,
 Name | Type
 ------------ | -------------
 `type` | string
+`commandId` | string
 `data` | string
 `exitCode` | number
 `success` | boolean
@@ -24,6 +25,7 @@ import type { CommandStreamFrame } from '@boatdev/sdk'
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
+  "commandId": null,
   "data": null,
   "exitCode": null,
   "success": null,

package/docs/CreateSandboxRequest.md

@@ -13,6 +13,7 @@ Name | Type
 `environment` | string
 `noEnv` | boolean
 `snapshots` | boolean
+`monitoring` | boolean
 `failFast` | boolean
 `setupScript` | string
 `org` | string
@@ -32,6 +33,7 @@ const example = {
   "environment": null,
   "noEnv": null,
   "snapshots": null,
+  "monitoring": null,
   "failFast": null,
   "setupScript": null,
   "org": null,

package/docs/DataRetentionPolicyResponse.md

@@ -14,6 +14,8 @@ Name | Type
 `acceptedDeletionOperationsIrreversible` | boolean
 `snapshotsOff` | boolean
 `snapshotsOffAt` | Date
+`monitoringOff` | boolean
+`monitoringOffAt` | Date
 
 ## Example
 
@@ -30,6 +32,8 @@ const example = {
   "acceptedDeletionOperationsIrreversible": null,
   "snapshotsOff": null,
   "snapshotsOffAt": null,
+  "monitoringOff": null,
+  "monitoringOffAt": null,
 } satisfies DataRetentionPolicyResponse
 
 console.log(example)

package/docs/DataRetentionUpdateRequest.md

@@ -1,7 +1,7 @@
 
 # DataRetentionUpdateRequest
 
-Pass `enabled` to change zero data retention, or `snapshotsOff` alone to change the account\'s snapshots-off setting.
+Pass `enabled` to change zero data retention, or `snapshotsOff` or `monitoringOff` alone to change that account setting.
 
 ## Properties
 
@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `enabled` | boolean
 `snapshotsOff` | boolean
+`monitoringOff` | boolean
 `confirmation` | string
 
 ## Example
@@ -20,6 +21,7 @@ import type { DataRetentionUpdateRequest } from '@boatdev/sdk'
 const example = {
   "enabled": null,
   "snapshotsOff": null,
+  "monitoringOff": null,
   "confirmation": null,
 } satisfies DataRetentionUpdateRequest
 

package/docs/ForkRequest.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `failFast` | boolean
+`monitoring` | boolean
 `env` | { [key: string]: string; }
 `environment` | string
 `noEnv` | boolean
@@ -21,6 +22,7 @@ import type { ForkRequest } from '@boatdev/sdk'
 // TODO: Update the object below with actual values
 const example = {
   "failFast": null,
+  "monitoring": null,
   "env": null,
   "environment": null,
   "noEnv": null,

package/docs/ProcessListResponse.md

@@ -0,0 +1,42 @@
+
+# ProcessListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`live` | boolean
+`sampledAt` | Date
+`total` | number
+`processes` | [Array<SandboxProcess>](SandboxProcess.md)
+
+## Example
+
+```typescript
+import type { ProcessListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "live": null,
+  "sampledAt": null,
+  "total": null,
+  "processes": null,
+} satisfies ProcessListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProcessListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/Sandbox.md

@@ -29,6 +29,7 @@ Name | Type
 `desktopAvailable` | boolean
 `desktopUrl` | string
 `snapshots` | boolean
+`monitoring` | boolean
 `snapshotAvailable` | boolean
 `snapshotCompletedAt` | Date
 `snapshotVerifiedAt` | Date
@@ -77,6 +78,7 @@ const example = {
   "desktopAvailable": null,
   "desktopUrl": null,
   "snapshots": null,
+  "monitoring": null,
   "snapshotAvailable": null,
   "snapshotCompletedAt": null,
   "snapshotVerifiedAt": null,

package/docs/SandboxProcess.md

@@ -0,0 +1,46 @@
+
+# SandboxProcess
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pid` | number
+`parentPid` | number
+`user` | string
+`cpuPercent` | number
+`memoryMB` | number
+`startedAt` | Date
+`command` | string
+`commandId` | string
+
+## Example
+
+```typescript
+import type { SandboxProcess } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pid": null,
+  "parentPid": null,
+  "user": null,
+  "cpuPercent": null,
+  "memoryMB": null,
+  "startedAt": null,
+  "command": null,
+  "commandId": null,
+} satisfies SandboxProcess
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SandboxProcess
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/TelemetryConfig.md

@@ -0,0 +1,40 @@
+
+# TelemetryConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`endpoint` | string
+`headers` | Array<string>
+`lastExportAt` | Date
+`lastError` | [TelemetryConfigLastError](TelemetryConfigLastError.md)
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { TelemetryConfig } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "endpoint": null,
+  "headers": null,
+  "lastExportAt": null,
+  "lastError": null,
+  "createdAt": null,
+} satisfies TelemetryConfig
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TelemetryConfig
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/TelemetryConfigLastError.md

@@ -0,0 +1,37 @@
+
+# TelemetryConfigLastError
+
+The most recent error from the collector, for metrics or events.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`status` | number
+`at` | Date
+
+## Example
+
+```typescript
+import type { TelemetryConfigLastError } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "status": null,
+  "at": null,
+} satisfies TelemetryConfigLastError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TelemetryConfigLastError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/TelemetryResponse.md

@@ -0,0 +1,36 @@
+
+# TelemetryResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`telemetry` | [TelemetryConfig](TelemetryConfig.md)
+
+## Example
+
+```typescript
+import type { TelemetryResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "telemetry": null,
+} satisfies TelemetryResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TelemetryResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)