@boatdev/sdk 1.9.9 → 1.11.0

package/docs/CreateSandboxRequest.md

@@ -15,6 +15,7 @@ Name | Type
 `snapshots` | boolean
 `monitoring` | boolean
 `failFast` | boolean
+`count` | number
 `setupScript` | string
 `org` | string
 `teamId` | string
@@ -35,6 +36,7 @@ const example = {
   "snapshots": null,
   "monitoring": null,
   "failFast": null,
+  "count": null,
   "setupScript": null,
   "org": null,
   "teamId": null,

package/docs/CreateSandboxResponse.md

@@ -11,6 +11,7 @@ Name | Type
 `status` | string
 `ttlSeconds` | number
 `sandbox` | [Sandbox](Sandbox.md)
+`sandboxes` | [Array<Sandbox>](Sandbox.md)
 `giftLimitNotice` | string
 
 ## Example
@@ -25,6 +26,7 @@ const example = {
   "status": null,
   "ttlSeconds": null,
   "sandbox": null,
+  "sandboxes": null,
   "giftLimitNotice": null,
 } satisfies CreateSandboxResponse
 

package/docs/CredentialProfile.md

@@ -17,6 +17,7 @@ Name | Type
 `customApis` | Array<string>
 `createdAt` | Date
 `updatedAt` | Date
+`access` | [ResourceAccess](ResourceAccess.md)
 
 ## Example
 
@@ -35,6 +36,7 @@ const example = {
   "customApis": null,
   "createdAt": null,
   "updatedAt": null,
+  "access": null,
 } satisfies CredentialProfile
 
 console.log(example)

package/docs/ResourceAccess.md

@@ -0,0 +1,35 @@
+
+# ResourceAccess
+
+Which organization members can use this organization environment or profile. `restricted` false means every member. `restricted` true means owners, admins and `members` only. Others do not see it in lists. Personal environments and profiles always return `restricted` false.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`restricted` | boolean
+`members` | Array<string>
+
+## Example
+
+```typescript
+import type { ResourceAccess } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "restricted": null,
+  "members": null,
+} satisfies ResourceAccess
+
+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 ResourceAccess
+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/ResourceAccessUpdate.md

@@ -0,0 +1,35 @@
+
+# ResourceAccessUpdate
+
+Set who can use an organization environment (owner or admin) or profile (owner). A change does not touch running sandboxes. A bad list returns `400 invalid_access`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`restricted` | boolean
+`members` | Array<string>
+
+## Example
+
+```typescript
+import type { ResourceAccessUpdate } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "restricted": null,
+  "members": null,
+} satisfies ResourceAccessUpdate
+
+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 ResourceAccessUpdate
+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/Sandbox.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `state` | string
 `error` | string
+`dataExpiredAt` | Date
 `health` | string
 `healthReason` | string
 `degradedSince` | Date
@@ -40,10 +41,13 @@ Name | Type
 `createdById` | string
 `access` | string
 `holdsCreatorLogins` | boolean
+`visibility` | string
+`cost` | [SandboxCost](SandboxCost.md)
 `wipePendingUntilRestart` | boolean
 `subdomain` | string
 `lastSnapshotAttemptAt` | Date
 `lastSnapshotStatus` | string
+`lastReboot` | [SandboxLastReboot](SandboxLastReboot.md)
 `setupStatus` | string
 `setupError` | string
 `environment` | string
@@ -61,6 +65,7 @@ const example = {
   "name": null,
   "state": null,
   "error": null,
+  "dataExpiredAt": null,
   "health": null,
   "healthReason": null,
   "degradedSince": null,
@@ -91,10 +96,13 @@ const example = {
   "createdById": null,
   "access": null,
   "holdsCreatorLogins": null,
+  "visibility": null,
+  "cost": null,
   "wipePendingUntilRestart": null,
   "subdomain": null,
   "lastSnapshotAttemptAt": null,
   "lastSnapshotStatus": null,
+  "lastReboot": null,
   "setupStatus": null,
   "setupError": null,
   "environment": null,

package/docs/SandboxCost.md

@@ -0,0 +1,37 @@
+
+# SandboxCost
+
+Only with `include=cost` on `GET /sandboxes`. Machine time this sandbox used this calendar month (UTC), at list price. Same meter as `GET /sandboxes/{sandboxId}/usage`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`since` | Date
+`seconds` | number
+`dollars` | number
+
+## Example
+
+```typescript
+import type { SandboxCost } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "since": null,
+  "seconds": null,
+  "dollars": null,
+} satisfies SandboxCost
+
+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 SandboxCost
+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

@@ -20,6 +20,7 @@ Name | Type
 `passAgentsCredentials` | boolean
 `credentialProfileId` | string
 `proxyAiCredentials` | boolean
+`access` | [ResourceAccess](ResourceAccess.md)
 `envContents` | string
 `secretFiles` | [Array<SecretFile>](SecretFile.md)
 `selectedRepositories` | [Array<SelectedRepository>](SelectedRepository.md)
@@ -45,6 +46,7 @@ const example = {
   "passAgentsCredentials": null,
   "credentialProfileId": null,
   "proxyAiCredentials": null,
+  "access": null,
   "envContents": null,
   "secretFiles": null,
   "selectedRepositories": null,

package/docs/SandboxLastReboot.md

@@ -0,0 +1,35 @@
+
+# SandboxLastReboot
+
+The last time the sandbox\'s kernel restarted on its machine, or null if it never did. Every process running at that time ended. `crash` means the system log ended with no shutdown, for example after a kernel panic.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`at` | Date
+`reason` | string
+
+## Example
+
+```typescript
+import type { SandboxLastReboot } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "at": null,
+  "reason": null,
+} satisfies SandboxLastReboot
+
+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 SandboxLastReboot
+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

@@ -10,6 +10,7 @@ Name | Type
 `type` | string
 `sandboxes` | [Array<Sandbox>](Sandbox.md)
 `pageInfo` | [PageInfo](PageInfo.md)
+`deletedCost` | [SandboxListResponseAllOfDeletedCost](SandboxListResponseAllOfDeletedCost.md)
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "type": null,
   "sandboxes": null,
   "pageInfo": null,
+  "deletedCost": null,
 } satisfies SandboxListResponse
 
 console.log(example)

package/docs/SandboxListResponseAllOfDeletedCost.md

@@ -0,0 +1,37 @@
+
+# SandboxListResponseAllOfDeletedCost
+
+Only with `include=cost`, and not for an API key limited to some sandboxes. Machine time this calendar month (UTC) of deleted sandboxes this list would otherwise show. They are not in the list, but their time was billed. Add it to the sandboxes\' `cost` to get the full total.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`since` | Date
+`seconds` | number
+`dollars` | number
+
+## Example
+
+```typescript
+import type { SandboxListResponseAllOfDeletedCost } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "since": null,
+  "seconds": null,
+  "dollars": null,
+} satisfies SandboxListResponseAllOfDeletedCost
+
+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 SandboxListResponseAllOfDeletedCost
+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/SavedSnapshot.md

@@ -0,0 +1,47 @@
+
+# SavedSnapshot
+
+A saved snapshot: a frozen copy of a sandbox\'s disk at one moment, saved under a name you pick. Independent of the source sandbox\'s later life: the sandbox can change, stop, or be deleted and the saved snapshot still deploys. Saved snapshots never expire; re-saving a name replaces its artifact.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`status` | string
+`error` | string
+`sourceSandboxId` | string
+`snapshotId` | string
+`type` | string
+`sizeBytes` | number
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { SavedSnapshot } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "status": null,
+  "error": null,
+  "sourceSandboxId": null,
+  "snapshotId": null,
+  "type": null,
+  "sizeBytes": null,
+  "createdAt": null,
+} satisfies SavedSnapshot
+
+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 SavedSnapshot
+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/SavedSnapshotAllowance.md

@@ -0,0 +1,49 @@
+
+# SavedSnapshotAllowance
+
+What the request\'s wallet (your active organization, `?org=`, or personal) pays for saved snapshots. 10 are free per wallet; each one above costs $1.70 a month, charged daily from usage. An organization\'s count includes every member\'s names billed to it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`org` | string
+`orgName` | string
+`included` | number
+`free` | number
+`used` | number
+`extra` | number
+`extraMonthlyDollars` | number
+`extraDailyDollars` | number
+`pricePerExtraMonthlyDollars` | number
+
+## Example
+
+```typescript
+import type { SavedSnapshotAllowance } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "org": null,
+  "orgName": null,
+  "included": null,
+  "free": null,
+  "used": null,
+  "extra": null,
+  "extraMonthlyDollars": null,
+  "extraDailyDollars": null,
+  "pricePerExtraMonthlyDollars": null,
+} satisfies SavedSnapshotAllowance
+
+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 SavedSnapshotAllowance
+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/SavedSnapshotDeletedResponse.md

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

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

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

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

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

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

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `isDefault` | boolean
+`access` | [ResourceAccessUpdate](ResourceAccessUpdate.md)
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { UpdateCredentialProfileRequest } from '@boatdev/sdk'
 const example = {
   "name": null,
   "isDefault": null,
+  "access": null,
 } satisfies UpdateCredentialProfileRequest
 
 console.log(example)

package/docs/UpdateOrganization200Response.md

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