@boatdev/sdk 1.10.0 → 1.11.0

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/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/UpdateSandboxEnvironmentRequest.md

@@ -16,6 +16,7 @@ Name | Type
 `passAgentsCredentials` | boolean
 `credentialProfileId` | string
 `proxyAiCredentials` | boolean
+`access` | [ResourceAccessUpdate](ResourceAccessUpdate.md)
 `envContents` | string
 `secretFiles` | [Array<SecretFile>](SecretFile.md)
 `repositories` | [Array<UpdateSandboxEnvironmentRequestRepositoriesInner>](UpdateSandboxEnvironmentRequestRepositoriesInner.md)
@@ -36,6 +37,7 @@ const example = {
   "passAgentsCredentials": null,
   "credentialProfileId": null,
   "proxyAiCredentials": null,
+  "access": null,
   "envContents": null,
   "secretFiles": null,
   "repositories": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boatdev/sdk",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "OpenAPI client for @boatdev/sdk",
   "author": "OpenAPI-Generator",
   "license": "MIT",