@boatdev/sdk 1.0.0

package/docs/SnapshotChunk.md

@@ -0,0 +1,44 @@
+
+# SnapshotChunk
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`snapshotId` | string
+`generation` | number
+`chunkIndex` | number
+`r2Key` | string
+`sizeBytes` | number
+`sha256` | string
+`signedUrl` | string
+
+## Example
+
+```typescript
+import type { SnapshotChunk } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "snapshotId": null,
+  "generation": null,
+  "chunkIndex": null,
+  "r2Key": null,
+  "sizeBytes": null,
+  "sha256": null,
+  "signedUrl": null,
+} satisfies SnapshotChunk
+
+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 SnapshotChunk
+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/SnapshotDownloadResponse.md

@@ -0,0 +1,50 @@
+
+# SnapshotDownloadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`snapshotId` | string
+`sandboxId` | string
+`kind` | string
+`generation` | number
+`expiresInSeconds` | number
+`reconstruct` | string
+`inventory` | [SnapshotDownloadResponseAllOfInventory](SnapshotDownloadResponseAllOfInventory.md)
+`chunks` | [Array<SnapshotChunk>](SnapshotChunk.md)
+
+## Example
+
+```typescript
+import type { SnapshotDownloadResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "snapshotId": null,
+  "sandboxId": null,
+  "kind": null,
+  "generation": null,
+  "expiresInSeconds": null,
+  "reconstruct": null,
+  "inventory": null,
+  "chunks": null,
+} satisfies SnapshotDownloadResponse
+
+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 SnapshotDownloadResponse
+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/SnapshotDownloadResponseAllOfInventory.md

@@ -0,0 +1,34 @@
+
+# SnapshotDownloadResponseAllOfInventory
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`r2Key` | string
+`signedUrl` | string
+
+## Example
+
+```typescript
+import type { SnapshotDownloadResponseAllOfInventory } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "r2Key": null,
+  "signedUrl": null,
+} satisfies SnapshotDownloadResponseAllOfInventory
+
+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 SnapshotDownloadResponseAllOfInventory
+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/SnapshotLatestResponse.md

@@ -0,0 +1,36 @@
+
+# SnapshotLatestResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`snapshot` | [SnapshotSummary](SnapshotSummary.md)
+
+## Example
+
+```typescript
+import type { SnapshotLatestResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "snapshot": null,
+} satisfies SnapshotLatestResponse
+
+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 SnapshotLatestResponse
+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/SnapshotListResponse.md

@@ -0,0 +1,38 @@
+
+# SnapshotListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`snapshots` | [Array<SnapshotSummary>](SnapshotSummary.md)
+`pageInfo` | [PageInfo](PageInfo.md)
+
+## Example
+
+```typescript
+import type { SnapshotListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "snapshots": null,
+  "pageInfo": null,
+} satisfies SnapshotListResponse
+
+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 SnapshotListResponse
+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/SnapshotSummary.md

@@ -0,0 +1,54 @@
+
+# SnapshotSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sandboxId` | string
+`status` | string
+`kind` | string
+`generation` | number
+`chainId` | string
+`createdAt` | Date
+`completedAt` | Date
+`sizeBytes` | number
+`fileCount` | number
+`contentSizeBytes` | number
+`contentFileCount` | number
+
+## Example
+
+```typescript
+import type { SnapshotSummary } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sandboxId": null,
+  "status": null,
+  "kind": null,
+  "generation": null,
+  "chainId": null,
+  "createdAt": null,
+  "completedAt": null,
+  "sizeBytes": null,
+  "fileCount": null,
+  "contentSizeBytes": null,
+  "contentFileCount": null,
+} satisfies SnapshotSummary
+
+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 SnapshotSummary
+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/SnapshotTreeEntry.md

@@ -0,0 +1,36 @@
+
+# SnapshotTreeEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`kind` | string
+`size` | number
+
+## Example
+
+```typescript
+import type { SnapshotTreeEntry } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "kind": null,
+  "size": null,
+} satisfies SnapshotTreeEntry
+
+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 SnapshotTreeEntry
+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/SnapshotTreeResponse.md

@@ -0,0 +1,52 @@
+
+# SnapshotTreeResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`snapshotId` | string
+`sandboxId` | string
+`generation` | number
+`treeAvailable` | boolean
+`truncated` | boolean
+`fileCount` | number
+`totalSizeBytes` | number
+`entries` | [Array<SnapshotTreeEntry>](SnapshotTreeEntry.md)
+`reason` | string
+
+## Example
+
+```typescript
+import type { SnapshotTreeResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "snapshotId": null,
+  "sandboxId": null,
+  "generation": null,
+  "treeAvailable": null,
+  "truncated": null,
+  "fileCount": null,
+  "totalSizeBytes": null,
+  "entries": null,
+  "reason": null,
+} satisfies SnapshotTreeResponse
+
+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 SnapshotTreeResponse
+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/SshKeyRequest.md

@@ -0,0 +1,32 @@
+
+# SshKeyRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+
+## Example
+
+```typescript
+import type { SshKeyRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+} satisfies SshKeyRequest
+
+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 SshKeyRequest
+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/SshKeyResponse.md

@@ -0,0 +1,40 @@
+
+# SshKeyResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`machineIp` | string
+`sshUser` | string
+
+## Example
+
+```typescript
+import type { SshKeyResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "machineIp": null,
+  "sshUser": null,
+} satisfies SshKeyResponse
+
+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 SshKeyResponse
+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/StartWindowUsage.md

@@ -0,0 +1,37 @@
+
+# StartWindowUsage
+
+One rolling start window. Null when the account is unlimited.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`limit` | number
+`used` | number
+`remaining` | number
+
+## Example
+
+```typescript
+import type { StartWindowUsage } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "limit": null,
+  "used": null,
+  "remaining": null,
+} satisfies StartWindowUsage
+
+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 StartWindowUsage
+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/SteerEvent.md

@@ -0,0 +1,43 @@
+
+# SteerEvent
+
+A message sent into a turn that was already running, via `POST /sandboxes/{sandboxId}/steer`. It is not a prompt run; the output it causes belongs to the turn that was already running.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`timestamp` | number
+`taskId` | string
+`conversationId` | string
+`data` | [SteerEventData](SteerEventData.md)
+
+## Example
+
+```typescript
+import type { SteerEvent } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "timestamp": null,
+  "taskId": null,
+  "conversationId": null,
+  "data": null,
+} satisfies SteerEvent
+
+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 SteerEvent
+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/SteerEventData.md

@@ -0,0 +1,36 @@
+
+# SteerEventData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`_native` | boolean
+`mode` | string
+
+## Example
+
+```typescript
+import type { SteerEventData } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "_native": null,
+  "mode": null,
+} satisfies SteerEventData
+
+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 SteerEventData
+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/SteerRequest.md

@@ -0,0 +1,35 @@
+
+# SteerRequest
+
+A message for a turn that is ALREADY RUNNING. The agent takes it into account and keeps what it was doing, instead of queueing behind the turn (`POST /prompt`) or stopping it (`POST /interrupt`).  **Conversations:** omit `conversation` to steer the sandbox\'s most-recently-active conversation, exactly like `POST /prompt` chooses one. Pass a `conversation` id to steer a specific one while the others keep running.  The response\'s `native` says how the harness took it. See [Integrated agents](/integrated-agents). 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`conversation` | string
+
+## Example
+
+```typescript
+import type { SteerRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "conversation": null,
+} satisfies SteerRequest
+
+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 SteerRequest
+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/SteerResponse.md

@@ -0,0 +1,46 @@
+
+# SteerResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`id` | string
+`conversationId` | string
+`promptId` | string
+`_native` | boolean
+`mode` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { SteerResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "id": null,
+  "conversationId": null,
+  "promptId": null,
+  "_native": null,
+  "mode": null,
+  "status": null,
+} satisfies SteerResponse
+
+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 SteerResponse
+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/StopRequest.md

@@ -0,0 +1,33 @@
+
+# StopRequest
+
+Options for stopping a sandbox.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`force` | boolean
+
+## Example
+
+```typescript
+import type { StopRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "force": null,
+} satisfies StopRequest
+
+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 StopRequest
+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/SuccessBase.md

@@ -0,0 +1,34 @@
+
+# SuccessBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+
+## Example
+
+```typescript
+import type { SuccessBase } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+} satisfies SuccessBase
+
+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 SuccessBase
+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)