@boatdev/sdk 1.0.0

package/docs/LimitsFields.md

@@ -0,0 +1,106 @@
+
+# LimitsFields
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessTier` | string
+`blockedReason` | string
+`currentLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`standardLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`trialLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`upgradeEffects` | { [key: string]: any; }
+`canStart` | boolean
+`checkoutRequired` | boolean
+`startBlockedReason` | string
+`contactMessage` | string
+`activeSandboxes` | number
+`activeStates` | Array<string>
+`maxActiveSandboxes` | number
+`maxCreationRequestsPerMinute` | number
+`maxCreationRequestsPerDay` | number
+`startLimits` | [LimitsFieldsStartLimits](LimitsFieldsStartLimits.md)
+`starts` | [LimitsFieldsStarts](LimitsFieldsStarts.md)
+`creditBalanceHours` | number
+`packBalanceHours` | number
+`packBalanceDollars` | number
+`hasPaymentHistory` | boolean
+`_package` | { [key: string]: any; }
+`subscriptionQuotaSeconds` | number
+`subscriptionRemainingSeconds` | number
+`packBalanceSeconds` | number
+`creditPurchasedSeconds` | number
+`creditUsedSeconds` | number
+`liveUsageSeconds` | number
+`creditSecondsPerDollar` | number
+`billingStatus` | string
+`subscriptionStatus` | string
+`subscriptionCancelAtPeriodEnd` | boolean
+`hasSubscription` | boolean
+`subscriptionTrialEndsAt` | Date
+`subscriptionCurrentPeriodEnd` | Date
+`creditBalanceSeconds` | number
+`teamId` | string
+`teamRole` | string
+
+## Example
+
+```typescript
+import type { LimitsFields } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessTier": null,
+  "blockedReason": null,
+  "currentLimits": null,
+  "standardLimits": null,
+  "trialLimits": null,
+  "upgradeEffects": null,
+  "canStart": null,
+  "checkoutRequired": null,
+  "startBlockedReason": null,
+  "contactMessage": null,
+  "activeSandboxes": null,
+  "activeStates": null,
+  "maxActiveSandboxes": null,
+  "maxCreationRequestsPerMinute": null,
+  "maxCreationRequestsPerDay": null,
+  "startLimits": null,
+  "starts": null,
+  "creditBalanceHours": null,
+  "packBalanceHours": null,
+  "packBalanceDollars": null,
+  "hasPaymentHistory": null,
+  "_package": null,
+  "subscriptionQuotaSeconds": null,
+  "subscriptionRemainingSeconds": null,
+  "packBalanceSeconds": null,
+  "creditPurchasedSeconds": null,
+  "creditUsedSeconds": null,
+  "liveUsageSeconds": null,
+  "creditSecondsPerDollar": null,
+  "billingStatus": null,
+  "subscriptionStatus": null,
+  "subscriptionCancelAtPeriodEnd": null,
+  "hasSubscription": null,
+  "subscriptionTrialEndsAt": null,
+  "subscriptionCurrentPeriodEnd": null,
+  "creditBalanceSeconds": null,
+  "teamId": null,
+  "teamRole": null,
+} satisfies LimitsFields
+
+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 LimitsFields
+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/LimitsFieldsCurrentLimits.md

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

@@ -0,0 +1,37 @@
+
+# LimitsFieldsStartLimits
+
+Plan caps for machine starts. Null on unlimited accounts. Create, fork and resume each count as one start.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`perMinute` | number
+`perHour` | number
+`perDay` | number
+
+## Example
+
+```typescript
+import type { LimitsFieldsStartLimits } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "perMinute": null,
+  "perHour": null,
+  "perDay": null,
+} satisfies LimitsFieldsStartLimits
+
+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 LimitsFieldsStartLimits
+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/LimitsFieldsStarts.md

@@ -0,0 +1,39 @@
+
+# LimitsFieldsStarts
+
+Remaining machine starts in the rolling minute, hour and day windows. Null windows mean the account is unlimited.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`unlimited` | boolean
+`minute` | [StartWindowUsage](StartWindowUsage.md)
+`hour` | [StartWindowUsage](StartWindowUsage.md)
+`day` | [StartWindowUsage](StartWindowUsage.md)
+
+## Example
+
+```typescript
+import type { LimitsFieldsStarts } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "unlimited": null,
+  "minute": null,
+  "hour": null,
+  "day": null,
+} satisfies LimitsFieldsStarts
+
+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 LimitsFieldsStarts
+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

@@ -0,0 +1,110 @@
+
+# LimitsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`accessTier` | string
+`blockedReason` | string
+`currentLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`standardLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`trialLimits` | [LimitsFieldsCurrentLimits](LimitsFieldsCurrentLimits.md)
+`upgradeEffects` | { [key: string]: any; }
+`canStart` | boolean
+`checkoutRequired` | boolean
+`startBlockedReason` | string
+`contactMessage` | string
+`activeSandboxes` | number
+`activeStates` | Array<string>
+`maxActiveSandboxes` | number
+`maxCreationRequestsPerMinute` | number
+`maxCreationRequestsPerDay` | number
+`startLimits` | [LimitsFieldsStartLimits](LimitsFieldsStartLimits.md)
+`starts` | [LimitsFieldsStarts](LimitsFieldsStarts.md)
+`creditBalanceHours` | number
+`packBalanceHours` | number
+`packBalanceDollars` | number
+`hasPaymentHistory` | boolean
+`_package` | { [key: string]: any; }
+`subscriptionQuotaSeconds` | number
+`subscriptionRemainingSeconds` | number
+`packBalanceSeconds` | number
+`creditPurchasedSeconds` | number
+`creditUsedSeconds` | number
+`liveUsageSeconds` | number
+`creditSecondsPerDollar` | number
+`billingStatus` | string
+`subscriptionStatus` | string
+`subscriptionCancelAtPeriodEnd` | boolean
+`hasSubscription` | boolean
+`subscriptionTrialEndsAt` | Date
+`subscriptionCurrentPeriodEnd` | Date
+`creditBalanceSeconds` | number
+`teamId` | string
+`teamRole` | string
+
+## Example
+
+```typescript
+import type { LimitsResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "accessTier": null,
+  "blockedReason": null,
+  "currentLimits": null,
+  "standardLimits": null,
+  "trialLimits": null,
+  "upgradeEffects": null,
+  "canStart": null,
+  "checkoutRequired": null,
+  "startBlockedReason": null,
+  "contactMessage": null,
+  "activeSandboxes": null,
+  "activeStates": null,
+  "maxActiveSandboxes": null,
+  "maxCreationRequestsPerMinute": null,
+  "maxCreationRequestsPerDay": null,
+  "startLimits": null,
+  "starts": null,
+  "creditBalanceHours": null,
+  "packBalanceHours": null,
+  "packBalanceDollars": null,
+  "hasPaymentHistory": null,
+  "_package": null,
+  "subscriptionQuotaSeconds": null,
+  "subscriptionRemainingSeconds": null,
+  "packBalanceSeconds": null,
+  "creditPurchasedSeconds": null,
+  "creditUsedSeconds": null,
+  "liveUsageSeconds": null,
+  "creditSecondsPerDollar": null,
+  "billingStatus": null,
+  "subscriptionStatus": null,
+  "subscriptionCancelAtPeriodEnd": null,
+  "hasSubscription": null,
+  "subscriptionTrialEndsAt": null,
+  "subscriptionCurrentPeriodEnd": null,
+  "creditBalanceSeconds": null,
+  "teamId": null,
+  "teamRole": null,
+} satisfies LimitsResponse
+
+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 LimitsResponse
+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/MeResponse.md

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

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

@@ -0,0 +1,47 @@
+
+# NamedSnapshot
+
+A named 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 named snapshot still deploys. Named 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 { NamedSnapshot } 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 NamedSnapshot
+
+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 NamedSnapshot
+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/NamedSnapshotDeletedResponse.md

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

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

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

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

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

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