@boatdev/sdk 1.0.0 → 1.1.0

package/src/models/LimitsFields.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { LimitsFieldsGiftLimit } from './LimitsFieldsGiftLimit';
+import {
+    LimitsFieldsGiftLimitFromJSON,
+    LimitsFieldsGiftLimitFromJSONTyped,
+    LimitsFieldsGiftLimitToJSON,
+    LimitsFieldsGiftLimitToJSONTyped,
+} from './LimitsFieldsGiftLimit';
 import type { LimitsFieldsCurrentLimits } from './LimitsFieldsCurrentLimits';
 import {
     LimitsFieldsCurrentLimitsFromJSON,
@@ -34,6 +41,13 @@ import {
     LimitsFieldsStartsToJSON,
     LimitsFieldsStartsToJSONTyped,
 } from './LimitsFieldsStarts';
+import type { LimitsFieldsSandboxPlanTiersInner } from './LimitsFieldsSandboxPlanTiersInner';
+import {
+    LimitsFieldsSandboxPlanTiersInnerFromJSON,
+    LimitsFieldsSandboxPlanTiersInnerFromJSONTyped,
+    LimitsFieldsSandboxPlanTiersInnerToJSON,
+    LimitsFieldsSandboxPlanTiersInnerToJSONTyped,
+} from './LimitsFieldsSandboxPlanTiersInner';
 
 /**
  * 
@@ -216,6 +230,84 @@ export interface LimitsFields {
      * @memberof LimitsFields
      */
     creditSecondsPerDollar?: number;
+    /**
+     * Current plan key, or `trial` before any payment.
+     * @type {string}
+     * @memberof LimitsFields
+     */
+    sandboxPlanKey?: string;
+    /**
+     * Monthly price of the current plan in dollars.
+     * @type {number}
+     * @memberof LimitsFields
+     */
+    sandboxPlanDollars?: number;
+    /**
+     * Every plan tier and its limits.
+     * @type {Array<LimitsFieldsSandboxPlanTiersInner>}
+     * @memberof LimitsFields
+     */
+    sandboxPlanTiers?: Array<LimitsFieldsSandboxPlanTiersInner>;
+    /**
+     * 
+     * @type {string}
+     * @memberof LimitsFields
+     */
+    accountPlan?: string;
+    /**
+     * `service` for service accounts, otherwise null.
+     * @type {string}
+     * @memberof LimitsFields
+     */
+    plan?: string | null;
+    /**
+     * `Service` for service accounts, otherwise null.
+     * @type {string}
+     * @memberof LimitsFields
+     */
+    planName?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LimitsFields
+     */
+    serviceAccount?: boolean;
+    /**
+     * True when the account has no machine-time or start limits.
+     * @type {boolean}
+     * @memberof LimitsFields
+     */
+    unlimited?: boolean;
+    /**
+     * True when an organization has an active per-seat plan.
+     * @type {boolean}
+     * @memberof LimitsFields
+     */
+    hasSeatPlan?: boolean;
+    /**
+     * Machine time used in the last 24 hours, in seconds. Useful to estimate how long the balance lasts.
+     * @type {number}
+     * @memberof LimitsFields
+     */
+    last24hUsageSeconds?: number;
+    /**
+     * Lifetime machine-time allowance for a trial that never paid. Null once the account has paid or has a plan.
+     * @type {number}
+     * @memberof LimitsFields
+     */
+    trialComputeCapSeconds?: number | null;
+    /**
+     * The trial limits in one readable line. Null on paid accounts.
+     * @type {string}
+     * @memberof LimitsFields
+     */
+    trialLine?: string | null;
+    /**
+     * 
+     * @type {LimitsFieldsGiftLimit}
+     * @memberof LimitsFields
+     */
+    giftLimit?: LimitsFieldsGiftLimit;
     /**
      * Account access state returned by the current backend. Billing endpoints are not part of v1.
      * @type {string}
@@ -323,6 +415,19 @@ export function LimitsFieldsFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'creditUsedSeconds': json['creditUsedSeconds'] == null ? undefined : json['creditUsedSeconds'],
         'liveUsageSeconds': json['liveUsageSeconds'] == null ? undefined : json['liveUsageSeconds'],
         'creditSecondsPerDollar': json['creditSecondsPerDollar'] == null ? undefined : json['creditSecondsPerDollar'],
+        'sandboxPlanKey': json['sandboxPlanKey'] == null ? undefined : json['sandboxPlanKey'],
+        'sandboxPlanDollars': json['sandboxPlanDollars'] == null ? undefined : json['sandboxPlanDollars'],
+        'sandboxPlanTiers': json['sandboxPlanTiers'] == null ? undefined : ((json['sandboxPlanTiers'] as Array<any>).map(LimitsFieldsSandboxPlanTiersInnerFromJSON)),
+        'accountPlan': json['accountPlan'] == null ? undefined : json['accountPlan'],
+        'plan': json['plan'] == null ? undefined : json['plan'],
+        'planName': json['planName'] == null ? undefined : json['planName'],
+        'serviceAccount': json['serviceAccount'] == null ? undefined : json['serviceAccount'],
+        'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
+        'hasSeatPlan': json['hasSeatPlan'] == null ? undefined : json['hasSeatPlan'],
+        'last24hUsageSeconds': json['last24hUsageSeconds'] == null ? undefined : json['last24hUsageSeconds'],
+        'trialComputeCapSeconds': json['trialComputeCapSeconds'] == null ? undefined : json['trialComputeCapSeconds'],
+        'trialLine': json['trialLine'] == null ? undefined : json['trialLine'],
+        'giftLimit': json['giftLimit'] == null ? undefined : LimitsFieldsGiftLimitFromJSON(json['giftLimit']),
         'billingStatus': json['billingStatus'],
         'subscriptionStatus': json['subscriptionStatus'] == null ? undefined : json['subscriptionStatus'],
         'subscriptionCancelAtPeriodEnd': json['subscriptionCancelAtPeriodEnd'] == null ? undefined : json['subscriptionCancelAtPeriodEnd'],
@@ -376,6 +481,19 @@ export function LimitsFieldsToJSONTyped(value?: LimitsFields | null, ignoreDiscr
         'creditUsedSeconds': value['creditUsedSeconds'],
         'liveUsageSeconds': value['liveUsageSeconds'],
         'creditSecondsPerDollar': value['creditSecondsPerDollar'],
+        'sandboxPlanKey': value['sandboxPlanKey'],
+        'sandboxPlanDollars': value['sandboxPlanDollars'],
+        'sandboxPlanTiers': value['sandboxPlanTiers'] == null ? undefined : ((value['sandboxPlanTiers'] as Array<any>).map(LimitsFieldsSandboxPlanTiersInnerToJSON)),
+        'accountPlan': value['accountPlan'],
+        'plan': value['plan'],
+        'planName': value['planName'],
+        'serviceAccount': value['serviceAccount'],
+        'unlimited': value['unlimited'],
+        'hasSeatPlan': value['hasSeatPlan'],
+        'last24hUsageSeconds': value['last24hUsageSeconds'],
+        'trialComputeCapSeconds': value['trialComputeCapSeconds'],
+        'trialLine': value['trialLine'],
+        'giftLimit': LimitsFieldsGiftLimitToJSON(value['giftLimit']),
         'billingStatus': value['billingStatus'],
         'subscriptionStatus': value['subscriptionStatus'],
         'subscriptionCancelAtPeriodEnd': value['subscriptionCancelAtPeriodEnd'],

package/src/models/LimitsFieldsCurrentLimits.ts

@@ -32,6 +32,12 @@ export interface LimitsFieldsCurrentLimits {
      * @memberof LimitsFieldsCurrentLimits
      */
     creationRatePerMinute?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsCurrentLimits
+     */
+    creationRequestsPerHour?: number | null;
     /**
      * 
      * @type {number}
@@ -60,6 +66,7 @@ export function LimitsFieldsCurrentLimitsFromJSONTyped(json: any, ignoreDiscrimi
             ...json,
         'activeSandboxes': json['activeSandboxes'] == null ? undefined : json['activeSandboxes'],
         'creationRatePerMinute': json['creationRatePerMinute'] == null ? undefined : json['creationRatePerMinute'],
+        'creationRequestsPerHour': json['creationRequestsPerHour'] == null ? undefined : json['creationRequestsPerHour'],
         'creationRequestsPerDay': json['creationRequestsPerDay'] == null ? undefined : json['creationRequestsPerDay'],
     };
 }
@@ -78,6 +85,7 @@ export function LimitsFieldsCurrentLimitsToJSONTyped(value?: LimitsFieldsCurrent
             ...value,
         'activeSandboxes': value['activeSandboxes'],
         'creationRatePerMinute': value['creationRatePerMinute'],
+        'creationRequestsPerHour': value['creationRequestsPerHour'],
         'creationRequestsPerDay': value['creationRequestsPerDay'],
     };
 }

package/src/models/LimitsFieldsGiftLimit.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Fair-use caps on a gifted account, or null when there are none.
+ * @export
+ * @interface LimitsFieldsGiftLimit
+ */
+export interface LimitsFieldsGiftLimit {
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsGiftLimit
+     */
+    maxActiveSandboxes?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsGiftLimit
+     */
+    maxTtlSeconds?: number | null;
+    /**
+     * The caps in one readable line.
+     * @type {string}
+     * @memberof LimitsFieldsGiftLimit
+     */
+    line?: string | null;
+    /**
+     * The same text shown when a cap is hit.
+     * @type {string}
+     * @memberof LimitsFieldsGiftLimit
+     */
+    message?: string;
+}
+
+/**
+ * Check if a given object implements the LimitsFieldsGiftLimit interface.
+ */
+export function instanceOfLimitsFieldsGiftLimit(value: object): value is LimitsFieldsGiftLimit {
+    return true;
+}
+
+export function LimitsFieldsGiftLimitFromJSON(json: any): LimitsFieldsGiftLimit {
+    return LimitsFieldsGiftLimitFromJSONTyped(json, false);
+}
+
+export function LimitsFieldsGiftLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): LimitsFieldsGiftLimit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxActiveSandboxes': json['maxActiveSandboxes'] == null ? undefined : json['maxActiveSandboxes'],
+        'maxTtlSeconds': json['maxTtlSeconds'] == null ? undefined : json['maxTtlSeconds'],
+        'line': json['line'] == null ? undefined : json['line'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function LimitsFieldsGiftLimitToJSON(json: any): LimitsFieldsGiftLimit {
+    return LimitsFieldsGiftLimitToJSONTyped(json, false);
+}
+
+export function LimitsFieldsGiftLimitToJSONTyped(value?: LimitsFieldsGiftLimit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'maxActiveSandboxes': value['maxActiveSandboxes'],
+        'maxTtlSeconds': value['maxTtlSeconds'],
+        'line': value['line'],
+        'message': value['message'],
+    };
+}
+

package/src/models/LimitsFieldsSandboxPlanTiersInner.ts

@@ -0,0 +1,129 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface LimitsFieldsSandboxPlanTiersInner
+ */
+export interface LimitsFieldsSandboxPlanTiersInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    key?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    dollars?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    displayPrice?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    maxActiveSandboxes?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    startsPerMinute?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    startsPerHour?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    startsPerDay?: number;
+    /**
+     * Machine time included each month.
+     * @type {number}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    includedSeconds?: number;
+    /**
+     * Whether this tier can be bought right now.
+     * @type {boolean}
+     * @memberof LimitsFieldsSandboxPlanTiersInner
+     */
+    purchasable?: boolean;
+}
+
+/**
+ * Check if a given object implements the LimitsFieldsSandboxPlanTiersInner interface.
+ */
+export function instanceOfLimitsFieldsSandboxPlanTiersInner(value: object): value is LimitsFieldsSandboxPlanTiersInner {
+    return true;
+}
+
+export function LimitsFieldsSandboxPlanTiersInnerFromJSON(json: any): LimitsFieldsSandboxPlanTiersInner {
+    return LimitsFieldsSandboxPlanTiersInnerFromJSONTyped(json, false);
+}
+
+export function LimitsFieldsSandboxPlanTiersInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): LimitsFieldsSandboxPlanTiersInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'] == null ? undefined : json['key'],
+        'dollars': json['dollars'] == null ? undefined : json['dollars'],
+        'displayPrice': json['displayPrice'] == null ? undefined : json['displayPrice'],
+        'maxActiveSandboxes': json['maxActiveSandboxes'] == null ? undefined : json['maxActiveSandboxes'],
+        'startsPerMinute': json['startsPerMinute'] == null ? undefined : json['startsPerMinute'],
+        'startsPerHour': json['startsPerHour'] == null ? undefined : json['startsPerHour'],
+        'startsPerDay': json['startsPerDay'] == null ? undefined : json['startsPerDay'],
+        'includedSeconds': json['includedSeconds'] == null ? undefined : json['includedSeconds'],
+        'purchasable': json['purchasable'] == null ? undefined : json['purchasable'],
+    };
+}
+
+export function LimitsFieldsSandboxPlanTiersInnerToJSON(json: any): LimitsFieldsSandboxPlanTiersInner {
+    return LimitsFieldsSandboxPlanTiersInnerToJSONTyped(json, false);
+}
+
+export function LimitsFieldsSandboxPlanTiersInnerToJSONTyped(value?: LimitsFieldsSandboxPlanTiersInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'dollars': value['dollars'],
+        'displayPrice': value['displayPrice'],
+        'maxActiveSandboxes': value['maxActiveSandboxes'],
+        'startsPerMinute': value['startsPerMinute'],
+        'startsPerHour': value['startsPerHour'],
+        'startsPerDay': value['startsPerDay'],
+        'includedSeconds': value['includedSeconds'],
+        'purchasable': value['purchasable'],
+    };
+}
+

package/src/models/LimitsResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { LimitsFieldsGiftLimit } from './LimitsFieldsGiftLimit';
+import {
+    LimitsFieldsGiftLimitFromJSON,
+    LimitsFieldsGiftLimitFromJSONTyped,
+    LimitsFieldsGiftLimitToJSON,
+    LimitsFieldsGiftLimitToJSONTyped,
+} from './LimitsFieldsGiftLimit';
 import type { LimitsFieldsCurrentLimits } from './LimitsFieldsCurrentLimits';
 import {
     LimitsFieldsCurrentLimitsFromJSON,
@@ -34,6 +41,13 @@ import {
     LimitsFieldsStartsToJSON,
     LimitsFieldsStartsToJSONTyped,
 } from './LimitsFieldsStarts';
+import type { LimitsFieldsSandboxPlanTiersInner } from './LimitsFieldsSandboxPlanTiersInner';
+import {
+    LimitsFieldsSandboxPlanTiersInnerFromJSON,
+    LimitsFieldsSandboxPlanTiersInnerFromJSONTyped,
+    LimitsFieldsSandboxPlanTiersInnerToJSON,
+    LimitsFieldsSandboxPlanTiersInnerToJSONTyped,
+} from './LimitsFieldsSandboxPlanTiersInner';
 
 /**
  * 
@@ -227,6 +241,84 @@ export interface LimitsResponse {
      * @memberof LimitsResponse
      */
     creditSecondsPerDollar?: number;
+    /**
+     * Current plan key, or `trial` before any payment.
+     * @type {string}
+     * @memberof LimitsResponse
+     */
+    sandboxPlanKey?: string;
+    /**
+     * Monthly price of the current plan in dollars.
+     * @type {number}
+     * @memberof LimitsResponse
+     */
+    sandboxPlanDollars?: number;
+    /**
+     * Every plan tier and its limits.
+     * @type {Array<LimitsFieldsSandboxPlanTiersInner>}
+     * @memberof LimitsResponse
+     */
+    sandboxPlanTiers?: Array<LimitsFieldsSandboxPlanTiersInner>;
+    /**
+     * 
+     * @type {string}
+     * @memberof LimitsResponse
+     */
+    accountPlan?: string;
+    /**
+     * `service` for service accounts, otherwise null.
+     * @type {string}
+     * @memberof LimitsResponse
+     */
+    plan?: string;
+    /**
+     * `Service` for service accounts, otherwise null.
+     * @type {string}
+     * @memberof LimitsResponse
+     */
+    planName?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LimitsResponse
+     */
+    serviceAccount?: boolean;
+    /**
+     * True when the account has no machine-time or start limits.
+     * @type {boolean}
+     * @memberof LimitsResponse
+     */
+    unlimited?: boolean;
+    /**
+     * True when an organization has an active per-seat plan.
+     * @type {boolean}
+     * @memberof LimitsResponse
+     */
+    hasSeatPlan?: boolean;
+    /**
+     * Machine time used in the last 24 hours, in seconds. Useful to estimate how long the balance lasts.
+     * @type {number}
+     * @memberof LimitsResponse
+     */
+    last24hUsageSeconds?: number;
+    /**
+     * Lifetime machine-time allowance for a trial that never paid. Null once the account has paid or has a plan.
+     * @type {number}
+     * @memberof LimitsResponse
+     */
+    trialComputeCapSeconds?: number;
+    /**
+     * The trial limits in one readable line. Null on paid accounts.
+     * @type {string}
+     * @memberof LimitsResponse
+     */
+    trialLine?: string;
+    /**
+     * 
+     * @type {LimitsFieldsGiftLimit}
+     * @memberof LimitsResponse
+     */
+    giftLimit?: LimitsFieldsGiftLimit;
     /**
      * Account access state returned by the current backend. Billing endpoints are not part of v1.
      * @type {string}
@@ -337,6 +429,19 @@ export function LimitsResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'creditUsedSeconds': json['creditUsedSeconds'] == null ? undefined : json['creditUsedSeconds'],
         'liveUsageSeconds': json['liveUsageSeconds'] == null ? undefined : json['liveUsageSeconds'],
         'creditSecondsPerDollar': json['creditSecondsPerDollar'] == null ? undefined : json['creditSecondsPerDollar'],
+        'sandboxPlanKey': json['sandboxPlanKey'] == null ? undefined : json['sandboxPlanKey'],
+        'sandboxPlanDollars': json['sandboxPlanDollars'] == null ? undefined : json['sandboxPlanDollars'],
+        'sandboxPlanTiers': json['sandboxPlanTiers'] == null ? undefined : ((json['sandboxPlanTiers'] as Array<any>).map(LimitsFieldsSandboxPlanTiersInnerFromJSON)),
+        'accountPlan': json['accountPlan'] == null ? undefined : json['accountPlan'],
+        'plan': json['plan'] == null ? undefined : json['plan'],
+        'planName': json['planName'] == null ? undefined : json['planName'],
+        'serviceAccount': json['serviceAccount'] == null ? undefined : json['serviceAccount'],
+        'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
+        'hasSeatPlan': json['hasSeatPlan'] == null ? undefined : json['hasSeatPlan'],
+        'last24hUsageSeconds': json['last24hUsageSeconds'] == null ? undefined : json['last24hUsageSeconds'],
+        'trialComputeCapSeconds': json['trialComputeCapSeconds'] == null ? undefined : json['trialComputeCapSeconds'],
+        'trialLine': json['trialLine'] == null ? undefined : json['trialLine'],
+        'giftLimit': json['giftLimit'] == null ? undefined : LimitsFieldsGiftLimitFromJSON(json['giftLimit']),
         'billingStatus': json['billingStatus'],
         'subscriptionStatus': json['subscriptionStatus'] == null ? undefined : json['subscriptionStatus'],
         'subscriptionCancelAtPeriodEnd': json['subscriptionCancelAtPeriodEnd'] == null ? undefined : json['subscriptionCancelAtPeriodEnd'],
@@ -391,6 +496,19 @@ export function LimitsResponseToJSONTyped(value?: LimitsResponse | null, ignoreD
         'creditUsedSeconds': value['creditUsedSeconds'],
         'liveUsageSeconds': value['liveUsageSeconds'],
         'creditSecondsPerDollar': value['creditSecondsPerDollar'],
+        'sandboxPlanKey': value['sandboxPlanKey'],
+        'sandboxPlanDollars': value['sandboxPlanDollars'],
+        'sandboxPlanTiers': value['sandboxPlanTiers'] == null ? undefined : ((value['sandboxPlanTiers'] as Array<any>).map(LimitsFieldsSandboxPlanTiersInnerToJSON)),
+        'accountPlan': value['accountPlan'],
+        'plan': value['plan'],
+        'planName': value['planName'],
+        'serviceAccount': value['serviceAccount'],
+        'unlimited': value['unlimited'],
+        'hasSeatPlan': value['hasSeatPlan'],
+        'last24hUsageSeconds': value['last24hUsageSeconds'],
+        'trialComputeCapSeconds': value['trialComputeCapSeconds'],
+        'trialLine': value['trialLine'],
+        'giftLimit': LimitsFieldsGiftLimitToJSON(value['giftLimit']),
         'billingStatus': value['billingStatus'],
         'subscriptionStatus': value['subscriptionStatus'],
         'subscriptionCancelAtPeriodEnd': value['subscriptionCancelAtPeriodEnd'],