@boatdev/sdk 1.0.0

package/docs/DeletionOperation.md

@@ -0,0 +1,46 @@
+
+# DeletionOperation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`kind` | string
+`targetId` | string
+`reason` | string
+`status` | string
+`attemptCount` | number
+`requestedAt` | Date
+`completedAt` | Date
+
+## Example
+
+```typescript
+import type { DeletionOperation } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "kind": null,
+  "targetId": null,
+  "reason": null,
+  "status": null,
+  "attemptCount": null,
+  "requestedAt": null,
+  "completedAt": null,
+} satisfies DeletionOperation
+
+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 DeletionOperation
+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/DeletionOperationResponse.md

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

@@ -0,0 +1,33 @@
+
+# DesktopRequest
+
+Optional desktop/VNC setup options used by the Boat dashboard and CLI. Most callers send an empty body.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`publicAccess` | boolean
+
+## Example
+
+```typescript
+import type { DesktopRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "publicAccess": null,
+} satisfies DesktopRequest
+
+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 DesktopRequest
+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/DesktopResponse.md

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

@@ -0,0 +1,37 @@
+
+# EnvironmentItemChangeResponse
+
+Result of a granular environment change. Every change mints a new immutable version holding just that delta; existing sandboxes stay pinned until upgraded.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`versionId` | string
+`versionNumber` | number
+
+## Example
+
+```typescript
+import type { EnvironmentItemChangeResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "versionId": null,
+  "versionNumber": null,
+} satisfies EnvironmentItemChangeResponse
+
+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 EnvironmentItemChangeResponse
+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/ErrorEnvelope.md

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

@@ -0,0 +1,38 @@
+
+# ErrorEnvelopeError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`status` | number
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ErrorEnvelopeError } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "status": null,
+  "details": null,
+} satisfies ErrorEnvelopeError
+
+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 ErrorEnvelopeError
+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/ErrorEvent.md

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

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

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

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

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

@@ -0,0 +1,40 @@
+
+# ForkRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`env` | { [key: string]: string; }
+`environment` | string
+`noEnv` | boolean
+`type` | string
+`ttlSeconds` | number
+
+## Example
+
+```typescript
+import type { ForkRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "env": null,
+  "environment": null,
+  "noEnv": null,
+  "type": null,
+  "ttlSeconds": null,
+} satisfies ForkRequest
+
+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 ForkRequest
+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/HostPortRequest.md

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

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