@boatdev/sdk 1.0.0

package/docs/Sandbox.md

@@ -0,0 +1,76 @@
+
+# Sandbox
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`state` | string
+`type` | string
+`vcpu` | number
+`memoryGB` | number
+`billingMultiplier` | number
+`url` | string
+`ip` | string
+`createdAt` | Date
+`updatedAt` | Date
+`archiveAfter` | Date
+`desktopAvailable` | boolean
+`desktopUrl` | string
+`snapshotAvailable` | boolean
+`snapshotCompletedAt` | Date
+`subdomain` | string
+`lastSnapshotAttemptAt` | Date
+`lastSnapshotStatus` | string
+`setupStatus` | string
+`setupError` | string
+`environment` | string
+`environmentVersion` | number
+
+## Example
+
+```typescript
+import type { Sandbox } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "state": null,
+  "type": null,
+  "vcpu": null,
+  "memoryGB": null,
+  "billingMultiplier": null,
+  "url": null,
+  "ip": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "archiveAfter": null,
+  "desktopAvailable": null,
+  "desktopUrl": null,
+  "snapshotAvailable": null,
+  "snapshotCompletedAt": null,
+  "subdomain": null,
+  "lastSnapshotAttemptAt": null,
+  "lastSnapshotStatus": null,
+  "setupStatus": null,
+  "setupError": null,
+  "environment": null,
+  "environmentVersion": null,
+} satisfies Sandbox
+
+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 Sandbox
+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/SandboxActionResponse.md

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

@@ -0,0 +1,57 @@
+
+# SandboxEnvironment
+
+A named sandbox environment. All flags/contents reflect the latest version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`isDefault` | boolean
+`latestVersionId` | string
+`safeForThirdParties` | boolean
+`passGithub` | boolean
+`passSecrets` | boolean
+`passSandboxCredentials` | boolean
+`passAgentsCredentials` | boolean
+`envContents` | string
+`secretFiles` | [Array<SecretFile>](SecretFile.md)
+`selectedRepositories` | [Array<SelectedRepository>](SelectedRepository.md)
+`versions` | [Array<SandboxEnvironmentVersionSummary>](SandboxEnvironmentVersionSummary.md)
+
+## Example
+
+```typescript
+import type { SandboxEnvironment } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "isDefault": null,
+  "latestVersionId": null,
+  "safeForThirdParties": null,
+  "passGithub": null,
+  "passSecrets": null,
+  "passSandboxCredentials": null,
+  "passAgentsCredentials": null,
+  "envContents": null,
+  "secretFiles": null,
+  "selectedRepositories": null,
+  "versions": null,
+} satisfies SandboxEnvironment
+
+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 SandboxEnvironment
+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/SandboxEnvironmentListResponse.md

@@ -0,0 +1,32 @@
+
+# SandboxEnvironmentListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`environments` | [Array<SandboxEnvironment>](SandboxEnvironment.md)
+
+## Example
+
+```typescript
+import type { SandboxEnvironmentListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "environments": null,
+} satisfies SandboxEnvironmentListResponse
+
+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 SandboxEnvironmentListResponse
+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/SandboxEnvironmentResponse.md

@@ -0,0 +1,34 @@
+
+# SandboxEnvironmentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`environment` | [SandboxEnvironment](SandboxEnvironment.md)
+
+## Example
+
+```typescript
+import type { SandboxEnvironmentResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "environment": null,
+} satisfies SandboxEnvironmentResponse
+
+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 SandboxEnvironmentResponse
+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/SandboxEnvironmentVersionSummary.md

@@ -0,0 +1,39 @@
+
+# SandboxEnvironmentVersionSummary
+
+An immutable snapshot of an environment\'s config. Editing an environment mints a new version; sandboxes stay pinned to the version they were created on until upgraded.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`sandboxCount` | number
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { SandboxEnvironmentVersionSummary } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "sandboxCount": null,
+  "createdAt": null,
+} satisfies SandboxEnvironmentVersionSummary
+
+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 SandboxEnvironmentVersionSummary
+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/SandboxEvent.md

@@ -0,0 +1,42 @@
+
+# SandboxEvent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`timestamp` | number
+`taskId` | string
+`conversationId` | string
+`data` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SandboxEvent } 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 SandboxEvent
+
+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 SandboxEvent
+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/SandboxInfoResponse.md

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

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

@@ -0,0 +1,52 @@
+
+# SandboxUsageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`sandboxId` | string
+`sandboxType` | string
+`billingMultiplier` | number
+`since` | Date
+`until` | Date
+`seconds` | number
+`dollars` | number
+`secondsPerDollar` | number
+`running` | boolean
+
+## Example
+
+```typescript
+import type { SandboxUsageResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "sandboxId": null,
+  "sandboxType": null,
+  "billingMultiplier": null,
+  "since": null,
+  "until": null,
+  "seconds": null,
+  "dollars": null,
+  "secondsPerDollar": null,
+  "running": null,
+} satisfies SandboxUsageResponse
+
+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 SandboxUsageResponse
+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/SecretFile.md

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

@@ -0,0 +1,44 @@
+
+# SecretsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`environmentId` | string
+`envContents` | string
+`secretFiles` | [Array<SecretFile>](SecretFile.md)
+`pushed` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SecretsResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "environmentId": null,
+  "envContents": null,
+  "secretFiles": null,
+  "pushed": null,
+} satisfies SecretsResponse
+
+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 SecretsResponse
+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/SecretsUpdateRequest.md

@@ -0,0 +1,35 @@
+
+# SecretsUpdateRequest
+
+Full replacement for the sandbox secret setup. Omitted `envContents` or `secretFiles` are treated as empty values, and successful updates are pushed to active sandboxes.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`envContents` | string
+`secretFiles` | [Array<SecretFile>](SecretFile.md)
+
+## Example
+
+```typescript
+import type { SecretsUpdateRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "envContents": null,
+  "secretFiles": null,
+} satisfies SecretsUpdateRequest
+
+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 SecretsUpdateRequest
+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/SelectedRepository.md

@@ -0,0 +1,52 @@
+
+# SelectedRepository
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`databaseId` | string
+`name` | string
+`fullName` | string
+`_private` | boolean
+`permissions` | string
+`pushedAt` | Date
+`baseBranch` | string
+`setupRoutineId` | string
+`setupScript` | string
+`setupBlocking` | boolean
+
+## Example
+
+```typescript
+import type { SelectedRepository } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "databaseId": null,
+  "name": null,
+  "fullName": null,
+  "_private": null,
+  "permissions": null,
+  "pushedAt": null,
+  "baseBranch": null,
+  "setupRoutineId": null,
+  "setupScript": null,
+  "setupBlocking": null,
+} satisfies SelectedRepository
+
+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 SelectedRepository
+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/SetEnvironmentSecretFileRequest.md

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

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