@boatdev/sdk 1.10.0 → 1.12.0

package/docs/LimitsFields.md

@@ -22,12 +22,16 @@ Name | Type
 `maxCreationRequestsPerMinute` | number
 `maxCreationRequestsPerDay` | number
 `startLimits` | [LimitsFieldsStartLimits](LimitsFieldsStartLimits.md)
+`wallet` | [LimitsFieldsWallet](LimitsFieldsWallet.md)
+`planIncluded` | [LimitsFieldsPlanIncluded](LimitsFieldsPlanIncluded.md)
+`overagePrices` | [LimitsFieldsOveragePrices](LimitsFieldsOveragePrices.md)
+`nextStartDollars` | number
+`startLimitsWithWallet` | [LimitsFieldsStartLimitsWithWallet](LimitsFieldsStartLimitsWithWallet.md)
 `starts` | [LimitsFieldsStarts](LimitsFieldsStarts.md)
 `creditBalanceHours` | number
 `packBalanceHours` | number
 `packBalanceDollars` | number
 `hasPaymentHistory` | boolean
-`_package` | { [key: string]: any; }
 `subscriptionQuotaSeconds` | number
 `subscriptionRemainingSeconds` | number
 `packBalanceSeconds` | number
@@ -46,6 +50,7 @@ Name | Type
 `hasSeatPlan` | boolean
 `last24hUsageSeconds` | number
 `trialComputeCapSeconds` | number
+`trialComputeUsedSeconds` | number
 `trialLine` | string
 `machineTypes` | [Array<LimitsFieldsMachineTypesInner>](LimitsFieldsMachineTypesInner.md)
 `giftLimit` | [LimitsFieldsGiftLimit](LimitsFieldsGiftLimit.md)
@@ -82,12 +87,16 @@ const example = {
   "maxCreationRequestsPerMinute": null,
   "maxCreationRequestsPerDay": null,
   "startLimits": null,
+  "wallet": null,
+  "planIncluded": null,
+  "overagePrices": null,
+  "nextStartDollars": null,
+  "startLimitsWithWallet": null,
   "starts": null,
   "creditBalanceHours": null,
   "packBalanceHours": null,
   "packBalanceDollars": null,
   "hasPaymentHistory": null,
-  "_package": null,
   "subscriptionQuotaSeconds": null,
   "subscriptionRemainingSeconds": null,
   "packBalanceSeconds": null,
@@ -106,6 +115,7 @@ const example = {
   "hasSeatPlan": null,
   "last24hUsageSeconds": null,
   "trialComputeCapSeconds": null,
+  "trialComputeUsedSeconds": null,
   "trialLine": null,
   "machineTypes": null,
   "giftLimit": null,

package/docs/LimitsFieldsOveragePrices.md

@@ -0,0 +1,39 @@
+
+# LimitsFieldsOveragePrices
+
+What the wallet pays past the plan.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vmHourDollars` | number
+`savedSnapshotDayDollars` | number
+`startBrackets` | [Array<LimitsFieldsOveragePricesStartBracketsInner>](LimitsFieldsOveragePricesStartBracketsInner.md)
+`startLimitMultiplier` | number
+
+## Example
+
+```typescript
+import type { LimitsFieldsOveragePrices } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vmHourDollars": null,
+  "savedSnapshotDayDollars": null,
+  "startBrackets": null,
+  "startLimitMultiplier": null,
+} satisfies LimitsFieldsOveragePrices
+
+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 LimitsFieldsOveragePrices
+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/LimitsFieldsOveragePricesStartBracketsInner.md

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

@@ -0,0 +1,37 @@
+
+# LimitsFieldsPlanIncluded
+
+What the plan includes this billing period. Null on unlimited accounts.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vmHours` | number
+`vmHoursRemaining` | number
+`periodEnd` | Date
+
+## Example
+
+```typescript
+import type { LimitsFieldsPlanIncluded } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vmHours": null,
+  "vmHoursRemaining": null,
+  "periodEnd": null,
+} satisfies LimitsFieldsPlanIncluded
+
+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 LimitsFieldsPlanIncluded
+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/LimitsFieldsStartLimitsWithWallet.md

@@ -0,0 +1,37 @@
+
+# LimitsFieldsStartLimitsWithWallet
+
+Start ceilings with paid starts: each start limit times `overagePrices.startLimitMultiplier`. Starts above `startLimits` and up to these ceilings are paid from the wallet at the `overagePrices.startBrackets` prices. Null when paid starts are not available now (before the first payment, an empty wallet, or an unlimited account).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`perMinute` | number
+`perHour` | number
+`perDay` | number
+
+## Example
+
+```typescript
+import type { LimitsFieldsStartLimitsWithWallet } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "perMinute": null,
+  "perHour": null,
+  "perDay": null,
+} satisfies LimitsFieldsStartLimitsWithWallet
+
+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 LimitsFieldsStartLimitsWithWallet
+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/LimitsFieldsWallet.md

@@ -0,0 +1,33 @@
+
+# LimitsFieldsWallet
+
+The one wallet of this account or organization, in US dollars. It pays overage only: VM time past the plan, saved snapshots past the included count, paid starts and the AI proxy. It never pays the plan. Null on unlimited accounts.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`balanceDollars` | number
+
+## Example
+
+```typescript
+import type { LimitsFieldsWallet } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "balanceDollars": null,
+} satisfies LimitsFieldsWallet
+
+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 LimitsFieldsWallet
+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/LimitsResponse.md

@@ -24,12 +24,16 @@ Name | Type
 `maxCreationRequestsPerMinute` | number
 `maxCreationRequestsPerDay` | number
 `startLimits` | [LimitsFieldsStartLimits](LimitsFieldsStartLimits.md)
+`wallet` | [LimitsFieldsWallet](LimitsFieldsWallet.md)
+`planIncluded` | [LimitsFieldsPlanIncluded](LimitsFieldsPlanIncluded.md)
+`overagePrices` | [LimitsFieldsOveragePrices](LimitsFieldsOveragePrices.md)
+`nextStartDollars` | number
+`startLimitsWithWallet` | [LimitsFieldsStartLimitsWithWallet](LimitsFieldsStartLimitsWithWallet.md)
 `starts` | [LimitsFieldsStarts](LimitsFieldsStarts.md)
 `creditBalanceHours` | number
 `packBalanceHours` | number
 `packBalanceDollars` | number
 `hasPaymentHistory` | boolean
-`_package` | { [key: string]: any; }
 `subscriptionQuotaSeconds` | number
 `subscriptionRemainingSeconds` | number
 `packBalanceSeconds` | number
@@ -48,6 +52,7 @@ Name | Type
 `hasSeatPlan` | boolean
 `last24hUsageSeconds` | number
 `trialComputeCapSeconds` | number
+`trialComputeUsedSeconds` | number
 `trialLine` | string
 `machineTypes` | [Array<LimitsFieldsMachineTypesInner>](LimitsFieldsMachineTypesInner.md)
 `giftLimit` | [LimitsFieldsGiftLimit](LimitsFieldsGiftLimit.md)
@@ -86,12 +91,16 @@ const example = {
   "maxCreationRequestsPerMinute": null,
   "maxCreationRequestsPerDay": null,
   "startLimits": null,
+  "wallet": null,
+  "planIncluded": null,
+  "overagePrices": null,
+  "nextStartDollars": null,
+  "startLimitsWithWallet": null,
   "starts": null,
   "creditBalanceHours": null,
   "packBalanceHours": null,
   "packBalanceDollars": null,
   "hasPaymentHistory": null,
-  "_package": null,
   "subscriptionQuotaSeconds": null,
   "subscriptionRemainingSeconds": null,
   "packBalanceSeconds": null,
@@ -110,6 +119,7 @@ const example = {
   "hasSeatPlan": null,
   "last24hUsageSeconds": null,
   "trialComputeCapSeconds": null,
+  "trialComputeUsedSeconds": null,
   "trialLine": null,
   "machineTypes": null,
   "giftLimit": null,

package/docs/NamedSnapshotAllowance.md

@@ -1,7 +1,7 @@
 
 # NamedSnapshotAllowance
 
-What the request\'s wallet (your active organization, `?org=`, or personal) pays for named 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.
+What the request\'s wallet (your active organization, `?org=`, or personal) pays for named snapshots. The plan includes some; each one above costs $0.056 a day from the wallet. An organization\'s count includes every member\'s names billed to it.
 
 ## Properties
 
@@ -15,6 +15,7 @@ Name | Type
 `extraMonthlyDollars` | number
 `extraDailyDollars` | number
 `pricePerExtraMonthlyDollars` | number
+`pricePerExtraDailyDollars` | number
 
 ## Example
 
@@ -31,6 +32,7 @@ const example = {
   "extraMonthlyDollars": null,
   "extraDailyDollars": null,
   "pricePerExtraMonthlyDollars": null,
+  "pricePerExtraDailyDollars": null,
 } satisfies NamedSnapshotAllowance
 
 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

@@ -47,6 +47,7 @@ Name | Type
 `subdomain` | string
 `lastSnapshotAttemptAt` | Date
 `lastSnapshotStatus` | string
+`lastReboot` | [SandboxLastReboot](SandboxLastReboot.md)
 `setupStatus` | string
 `setupError` | string
 `environment` | string
@@ -101,6 +102,7 @@ const example = {
   "subdomain": null,
   "lastSnapshotAttemptAt": null,
   "lastSnapshotStatus": null,
+  "lastReboot": null,
   "setupStatus": null,
   "setupError": null,
   "environment": null,

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,51 @@
+
+# SavedSnapshotAllowance
+
+What the request\'s wallet (your active organization, `?org=`, or personal) pays for saved snapshots. The plan includes some; each one above costs $0.056 a day from the wallet. 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
+`pricePerExtraDailyDollars` | 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,
+  "pricePerExtraDailyDollars": 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)