@boatdev/sdk 1.9.7 → 1.9.8

package/src/models/Sandbox.ts

@@ -27,6 +27,13 @@ import {
     StopOperationToJSON,
     StopOperationToJSONTyped,
 } from './StopOperation';
+import type { SandboxHydration } from './SandboxHydration';
+import {
+    SandboxHydrationFromJSON,
+    SandboxHydrationFromJSONTyped,
+    SandboxHydrationToJSON,
+    SandboxHydrationToJSONTyped,
+} from './SandboxHydration';
 
 /**
  * 
@@ -88,6 +95,12 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     hydratedAt?: Date | null;
+    /**
+     * 
+     * @type {SandboxHydration}
+     * @memberof Sandbox
+     */
+    hydration?: SandboxHydration | null;
     /**
      * Current machine size: what the sandbox was created with, or the size it was last resumed or forked onto.
      * @type {SandboxTypeEnum}
@@ -149,11 +162,17 @@ export interface Sandbox {
      */
     updatedAt?: Date | null;
     /**
-     * Automatic archival time, or null when auto-stop is disabled.
+     * When the sandbox stops by itself (the stop starts within about 5 seconds), or null when auto-stop is disabled. A sandbox whose agent is working gets a fresh full TTL, and this time moves forward.
      * @type {Date}
      * @memberof Sandbox
      */
     archiveAfter?: Date | null;
+    /**
+     * The auto-stop length as last set on create, resume, fork or PATCH, or null when auto-stop is disabled.
+     * @type {number}
+     * @memberof Sandbox
+     */
+    ttlSeconds?: number | null;
     /**
      * 
      * @type {boolean}
@@ -215,7 +234,7 @@ export interface Sandbox {
      */
     createdById?: string | null;
     /**
-     * What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that is `noEnv` (created with it, or shared and restarted), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that still holds their personal logins, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).
+     * What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that never received their personal logins (`noEnv`, shared and restarted, or created on an environment that passes nothing), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that still holds their personal logins, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).
      * @type {SandboxAccessEnum}
      * @memberof Sandbox
      */
@@ -395,6 +414,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'degradedSince': json['degradedSince'] == null ? undefined : (new Date(json['degradedSince'])),
         'hydrated': json['hydrated'] == null ? undefined : json['hydrated'],
         'hydratedAt': json['hydratedAt'] == null ? undefined : (new Date(json['hydratedAt'])),
+        'hydration': json['hydration'] == null ? undefined : SandboxHydrationFromJSON(json['hydration']),
         'type': json['type'] == null ? undefined : json['type'],
         'vcpu': json['vcpu'] == null ? undefined : json['vcpu'],
         'memoryGB': json['memoryGB'] == null ? undefined : json['memoryGB'],
@@ -406,6 +426,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
         'archiveAfter': json['archiveAfter'] == null ? undefined : (new Date(json['archiveAfter'])),
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
         'desktopAvailable': json['desktopAvailable'],
         'desktopUrl': json['desktopUrl'] == null ? undefined : json['desktopUrl'],
         'snapshots': json['snapshots'] == null ? undefined : json['snapshots'],
@@ -450,6 +471,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'degradedSince': value['degradedSince'] == null ? value['degradedSince'] : value['degradedSince'].toISOString(),
         'hydrated': value['hydrated'],
         'hydratedAt': value['hydratedAt'] == null ? value['hydratedAt'] : value['hydratedAt'].toISOString(),
+        'hydration': SandboxHydrationToJSON(value['hydration']),
         'type': value['type'],
         'vcpu': value['vcpu'],
         'memoryGB': value['memoryGB'],
@@ -461,6 +483,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
         'archiveAfter': value['archiveAfter'] == null ? value['archiveAfter'] : value['archiveAfter'].toISOString(),
+        'ttlSeconds': value['ttlSeconds'],
         'desktopAvailable': value['desktopAvailable'],
         'desktopUrl': value['desktopUrl'],
         'snapshots': value['snapshots'],

package/src/models/SandboxHydration.ts

@@ -0,0 +1,93 @@
+/* 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';
+/**
+ * Restore progress while `hydrated` is false, on GET /sandboxes/{id} only. Null in lists, after hydration, or when the sandbox does not answer within 1.5 s.
+ * @export
+ * @interface SandboxHydration
+ */
+export interface SandboxHydration {
+    /**
+     * Restore step: `dvol` (docker volumes), `sysdelta` (system files), `images` (saved docker images), `hydrating` (the home directory), `reconciling` (the last check). `degraded` and `stuck` mean a step failed and is retried.
+     * @type {string}
+     * @memberof SandboxHydration
+     */
+    phase: string;
+    /**
+     * Files, directories and links copied in so far.
+     * @type {number}
+     * @memberof SandboxHydration
+     */
+    entriesDone: number;
+    /**
+     * Files, directories and links this restore copies in. Null for the first seconds, until the system files are counted.
+     * @type {number}
+     * @memberof SandboxHydration
+     */
+    entriesTotal: number | null;
+    /**
+     * entriesDone of entriesTotal, 0-99. Files you change during the restore are yours, not copied, so it can stop short of 99; `hydrated` is the end signal.
+     * @type {number}
+     * @memberof SandboxHydration
+     */
+    percent: number | null;
+}
+
+/**
+ * Check if a given object implements the SandboxHydration interface.
+ */
+export function instanceOfSandboxHydration(value: object): value is SandboxHydration {
+    if (!('phase' in value) || value['phase'] === undefined) return false;
+    if (!('entriesDone' in value) || value['entriesDone'] === undefined) return false;
+    if (!('entriesTotal' in value) || value['entriesTotal'] === undefined) return false;
+    if (!('percent' in value) || value['percent'] === undefined) return false;
+    return true;
+}
+
+export function SandboxHydrationFromJSON(json: any): SandboxHydration {
+    return SandboxHydrationFromJSONTyped(json, false);
+}
+
+export function SandboxHydrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxHydration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'phase': json['phase'],
+        'entriesDone': json['entriesDone'],
+        'entriesTotal': json['entriesTotal'],
+        'percent': json['percent'],
+    };
+}
+
+export function SandboxHydrationToJSON(json: any): SandboxHydration {
+    return SandboxHydrationToJSONTyped(json, false);
+}
+
+export function SandboxHydrationToJSONTyped(value?: SandboxHydration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'phase': value['phase'],
+        'entriesDone': value['entriesDone'],
+        'entriesTotal': value['entriesTotal'],
+        'percent': value['percent'],
+    };
+}
+

package/src/models/index.ts

@@ -74,6 +74,7 @@ export * from './HostPortResponse';
 export * from './LimitsFields';
 export * from './LimitsFieldsCurrentLimits';
 export * from './LimitsFieldsGiftLimit';
+export * from './LimitsFieldsMachineTypesInner';
 export * from './LimitsFieldsSandboxPlanTiersInner';
 export * from './LimitsFieldsStartLimits';
 export * from './LimitsFieldsStarts';
@@ -123,6 +124,7 @@ export * from './SandboxEnvironmentListResponse';
 export * from './SandboxEnvironmentResponse';
 export * from './SandboxEnvironmentVersionSummary';
 export * from './SandboxEvent';
+export * from './SandboxHydration';
 export * from './SandboxInfoResponse';
 export * from './SandboxListResponse';
 export * from './SandboxProcess';