@boatdev/sdk 1.0.0

package/docs/Command200Response.md

@@ -0,0 +1,66 @@
+
+# Command200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`exitCode` | number
+`signal` | string
+`stdout` | string
+`stderr` | string
+`stdoutTruncated` | boolean
+`stderrTruncated` | boolean
+`timedOut` | boolean
+`cwd` | string
+`startedAt` | Date
+`finishedAt` | Date
+`processId` | number
+`pid` | number
+`command` | string
+`logPath` | string
+`errLogPath` | string
+
+## Example
+
+```typescript
+import type { Command200Response } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "exitCode": null,
+  "signal": null,
+  "stdout": null,
+  "stderr": null,
+  "stdoutTruncated": null,
+  "stderrTruncated": null,
+  "timedOut": null,
+  "cwd": null,
+  "startedAt": null,
+  "finishedAt": null,
+  "processId": null,
+  "pid": null,
+  "command": null,
+  "logPath": null,
+  "errLogPath": null,
+} satisfies Command200Response
+
+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 Command200Response
+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/CommandRequest.md

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

@@ -0,0 +1,56 @@
+
+# CommandResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`exitCode` | number
+`signal` | string
+`stdout` | string
+`stderr` | string
+`stdoutTruncated` | boolean
+`stderrTruncated` | boolean
+`timedOut` | boolean
+`cwd` | string
+`startedAt` | Date
+`finishedAt` | Date
+
+## Example
+
+```typescript
+import type { CommandResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "exitCode": null,
+  "signal": null,
+  "stdout": null,
+  "stderr": null,
+  "stdoutTruncated": null,
+  "stderrTruncated": null,
+  "timedOut": null,
+  "cwd": null,
+  "startedAt": null,
+  "finishedAt": null,
+} satisfies CommandResponse
+
+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 CommandResponse
+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/CommandStartedResponse.md

@@ -0,0 +1,50 @@
+
+# CommandStartedResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`processId` | number
+`pid` | number
+`command` | string
+`cwd` | string
+`startedAt` | Date
+`logPath` | string
+`errLogPath` | string
+
+## Example
+
+```typescript
+import type { CommandStartedResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "processId": null,
+  "pid": null,
+  "command": null,
+  "cwd": null,
+  "startedAt": null,
+  "logPath": null,
+  "errLogPath": null,
+} satisfies CommandStartedResponse
+
+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 CommandStartedResponse
+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/CommandStatusResponse.md

@@ -0,0 +1,70 @@
+
+# CommandStatusResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`processId` | number
+`pid` | number
+`status` | string
+`known` | boolean
+`running` | boolean
+`exitCode` | number
+`signal` | string
+`command` | string
+`cwd` | string
+`startedAt` | Date
+`finishedAt` | Date
+`stdout` | string
+`stderr` | string
+`stdoutTruncated` | boolean
+`stderrTruncated` | boolean
+`logPath` | string
+`errLogPath` | string
+
+## Example
+
+```typescript
+import type { CommandStatusResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "processId": null,
+  "pid": null,
+  "status": null,
+  "known": null,
+  "running": null,
+  "exitCode": null,
+  "signal": null,
+  "command": null,
+  "cwd": null,
+  "startedAt": null,
+  "finishedAt": null,
+  "stdout": null,
+  "stderr": null,
+  "stdoutTruncated": null,
+  "stderrTruncated": null,
+  "logPath": null,
+  "errLogPath": null,
+} satisfies CommandStatusResponse
+
+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 CommandStatusResponse
+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/CompletionEvent.md

@@ -0,0 +1,40 @@
+
+# CompletionEvent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`timestamp` | number
+`taskId` | string
+`data` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CompletionEvent } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "timestamp": null,
+  "taskId": null,
+  "data": null,
+} satisfies CompletionEvent
+
+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 CompletionEvent
+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/Conversation.md

@@ -0,0 +1,48 @@
+
+# Conversation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`createdAt` | Date
+`lastPromptAt` | Date
+`prompts` | number
+`running` | boolean
+`lastHarness` | string
+`lastModel` | string
+`lastPromptPreview` | string
+`current` | boolean
+
+## Example
+
+```typescript
+import type { Conversation } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "lastPromptAt": null,
+  "prompts": null,
+  "running": null,
+  "lastHarness": null,
+  "lastModel": null,
+  "lastPromptPreview": null,
+  "current": null,
+} satisfies Conversation
+
+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 Conversation
+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/ConversationsResponse.md

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

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

@@ -0,0 +1,49 @@
+
+# CreateSandboxRequest
+
+Options for provisioning a new cloud computer.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`ttlSeconds` | number
+`env` | { [key: string]: string; }
+`environment` | string
+`noEnv` | boolean
+`setupScript` | string
+`org` | string
+`teamId` | string
+`from` | string
+
+## Example
+
+```typescript
+import type { CreateSandboxRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "ttlSeconds": null,
+  "env": null,
+  "environment": null,
+  "noEnv": null,
+  "setupScript": null,
+  "org": null,
+  "teamId": null,
+  "from": null,
+} satisfies CreateSandboxRequest
+
+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 CreateSandboxRequest
+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/CreateSandboxResponse.md

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

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

@@ -0,0 +1,42 @@
+
+# CreateScopedApiKeyRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`ttl` | string
+`preset` | string
+`actions` | Array<string>
+`sandboxIds` | Array<string>
+`environmentIds` | Array<string>
+
+## Example
+
+```typescript
+import type { CreateScopedApiKeyRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "ttl": null,
+  "preset": null,
+  "actions": null,
+  "sandboxIds": null,
+  "environmentIds": null,
+} satisfies CreateScopedApiKeyRequest
+
+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 CreateScopedApiKeyRequest
+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/DataRetentionPolicyResponse.md

@@ -0,0 +1,42 @@
+
+# DataRetentionPolicyResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`enabled` | boolean
+`enabledAt` | Date
+`queuedSandboxes` | number
+`acceptedDeletionOperationsIrreversible` | boolean
+
+## Example
+
+```typescript
+import type { DataRetentionPolicyResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "enabled": null,
+  "enabledAt": null,
+  "queuedSandboxes": null,
+  "acceptedDeletionOperationsIrreversible": null,
+} satisfies DataRetentionPolicyResponse
+
+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 DataRetentionPolicyResponse
+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/DataRetentionUpdateRequest.md

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