@boatdev/sdk 1.0.0

package/docs/UnknownEvent.md

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

@@ -0,0 +1,51 @@
+
+# UpdateSandboxEnvironmentRequest
+
+Rename, set-default, and/or edit flags and contents. Any flag or content change mints a new immutable version; existing sandboxes are not touched until you call upgrade.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`isDefault` | boolean
+`safeForThirdParties` | boolean
+`passGithub` | boolean
+`passSecrets` | boolean
+`passSandboxCredentials` | boolean
+`passAgentsCredentials` | boolean
+`envContents` | string
+`secretFiles` | [Array<SecretFile>](SecretFile.md)
+`repositories` | [Array<UpdateSandboxEnvironmentRequestRepositoriesInner>](UpdateSandboxEnvironmentRequestRepositoriesInner.md)
+
+## Example
+
+```typescript
+import type { UpdateSandboxEnvironmentRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "isDefault": null,
+  "safeForThirdParties": null,
+  "passGithub": null,
+  "passSecrets": null,
+  "passSandboxCredentials": null,
+  "passAgentsCredentials": null,
+  "envContents": null,
+  "secretFiles": null,
+  "repositories": null,
+} satisfies UpdateSandboxEnvironmentRequest
+
+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 UpdateSandboxEnvironmentRequest
+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/UpdateSandboxEnvironmentRequestRepositoriesInner.md

@@ -0,0 +1,38 @@
+
+# UpdateSandboxEnvironmentRequestRepositoriesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`repositoryId` | string
+`baseBranch` | string
+`setupScript` | string
+`setupBlocking` | boolean
+
+## Example
+
+```typescript
+import type { UpdateSandboxEnvironmentRequestRepositoriesInner } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "repositoryId": null,
+  "baseBranch": null,
+  "setupScript": null,
+  "setupBlocking": null,
+} satisfies UpdateSandboxEnvironmentRequestRepositoriesInner
+
+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 UpdateSandboxEnvironmentRequestRepositoriesInner
+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/UpdateSandboxRequest.md

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

@@ -0,0 +1,33 @@
+
+# UpgradeSandboxEnvironmentRequest
+
+Repoint active sandboxes to the environment\'s latest version, scrubbing any owner secrets the new version drops and hot-pushing the new config.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`agentIds` | Array<string>
+
+## Example
+
+```typescript
+import type { UpgradeSandboxEnvironmentRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "agentIds": null,
+} satisfies UpgradeSandboxEnvironmentRequest
+
+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 UpgradeSandboxEnvironmentRequest
+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/UpgradeSandboxEnvironmentResponse.md

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

@@ -0,0 +1,42 @@
+
+# Webhook
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`url` | string
+`events` | [Set<WebhookEventType>](WebhookEventType.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { Webhook } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "url": null,
+  "events": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Webhook
+
+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 Webhook
+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/WebhookCreateRequest.md

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

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

@@ -0,0 +1,39 @@
+
+# WebhookEvent
+
+JSON body sent to the registered endpoint. This is not a v1 success envelope.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | [WebhookEventType](WebhookEventType.md)
+`createdAt` | Date
+`data` | [WebhookEventData](WebhookEventData.md)
+
+## Example
+
+```typescript
+import type { WebhookEvent } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "createdAt": null,
+  "data": null,
+} satisfies WebhookEvent
+
+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 WebhookEvent
+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/WebhookEventData.md

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

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

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

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

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

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

@@ -0,0 +1,36 @@
+
+# WebhookUpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`url` | string
+`events` | [Set<WebhookEventType>](WebhookEventType.md)
+
+## Example
+
+```typescript
+import type { WebhookUpdateRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "url": null,
+  "events": null,
+} satisfies WebhookUpdateRequest
+
+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 WebhookUpdateRequest
+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/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@boatdev/sdk",
+  "version": "1.0.0",
+  "description": "OpenAPI client for @boatdev/sdk",
+  "author": "OpenAPI-Generator",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "7.0.2"
+  },
+  "homepage": "https://docs.boat.dev/sdks"
+}