@boatdev/sdk 1.9.8 → 1.10.0

package/src/models/Sandbox.ts

@@ -27,6 +27,13 @@ import {
     StopOperationToJSON,
     StopOperationToJSONTyped,
 } from './StopOperation';
+import type { SandboxCost } from './SandboxCost';
+import {
+    SandboxCostFromJSON,
+    SandboxCostFromJSONTyped,
+    SandboxCostToJSON,
+    SandboxCostToJSONTyped,
+} from './SandboxCost';
 import type { SandboxHydration } from './SandboxHydration';
 import {
     SandboxHydrationFromJSON,
@@ -65,6 +72,12 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     error?: string | null;
+    /**
+     * When Boat deleted the snapshot data of this stopped sandbox, 14 days after it stopped. Resume and fork then fail with `409 snapshot_data_expired`. Null while the data is kept.
+     * @type {Date}
+     * @memberof Sandbox
+     */
+    dataExpiredAt?: Date | null;
     /**
      * `degraded` when the machine is alive but Boat cannot fully reach it (for example a firewall rule inside the sandbox blocks the tunnel). The sandbox keeps running.
      * @type {SandboxHealthEnum}
@@ -234,7 +247,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 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`).
+     * What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that is `shared` (see `visibility`), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that is `private`, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).
      * @type {SandboxAccessEnum}
      * @memberof Sandbox
      */
@@ -245,6 +258,18 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     holdsCreatorLogins?: boolean;
+    /**
+     * Organization sandboxes only; null for a personal sandbox. `shared`: every member can use it. It holds none of its creator's personal logins (`noEnv`, shared and restarted, or created on an environment that passes nothing) and its creator did not make it private. `private`: only its creator can use it. It holds their logins, or its creator made it private (`POST /sandboxes/{sandboxId}/unshare`, or the organization's `newSandboxesPrivate` default).
+     * @type {SandboxVisibilityEnum}
+     * @memberof Sandbox
+     */
+    visibility?: SandboxVisibilityEnum | null;
+    /**
+     * 
+     * @type {SandboxCost}
+     * @memberof Sandbox
+     */
+    cost?: SandboxCost;
     /**
      * True once the sandbox is shared but not restarted yet. Its creator's logins are wiped at its next start, and the organization can use it from then on.
      * @type {boolean}
@@ -359,6 +384,15 @@ export const SandboxAccessEnum = {
 } as const;
 export type SandboxAccessEnum = typeof SandboxAccessEnum[keyof typeof SandboxAccessEnum];
 
+/**
+ * @export
+ */
+export const SandboxVisibilityEnum = {
+    Shared: 'shared',
+    Private: 'private'
+} as const;
+export type SandboxVisibilityEnum = typeof SandboxVisibilityEnum[keyof typeof SandboxVisibilityEnum];
+
 /**
  * @export
  */
@@ -409,6 +443,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'name': json['name'],
         'state': json['state'],
         'error': json['error'] == null ? undefined : json['error'],
+        'dataExpiredAt': json['dataExpiredAt'] == null ? undefined : (new Date(json['dataExpiredAt'])),
         'health': json['health'] == null ? undefined : json['health'],
         'healthReason': json['healthReason'] == null ? undefined : json['healthReason'],
         'degradedSince': json['degradedSince'] == null ? undefined : (new Date(json['degradedSince'])),
@@ -439,6 +474,8 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'createdById': json['createdById'] == null ? undefined : json['createdById'],
         'access': json['access'] == null ? undefined : json['access'],
         'holdsCreatorLogins': json['holdsCreatorLogins'] == null ? undefined : json['holdsCreatorLogins'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
+        'cost': json['cost'] == null ? undefined : SandboxCostFromJSON(json['cost']),
         'wipePendingUntilRestart': json['wipePendingUntilRestart'] == null ? undefined : json['wipePendingUntilRestart'],
         'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
         'lastSnapshotAttemptAt': json['lastSnapshotAttemptAt'] == null ? undefined : (new Date(json['lastSnapshotAttemptAt'])),
@@ -466,6 +503,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'name': value['name'],
         'state': value['state'],
         'error': value['error'],
+        'dataExpiredAt': value['dataExpiredAt'] == null ? value['dataExpiredAt'] : value['dataExpiredAt'].toISOString(),
         'health': value['health'],
         'healthReason': value['healthReason'],
         'degradedSince': value['degradedSince'] == null ? value['degradedSince'] : value['degradedSince'].toISOString(),
@@ -496,6 +534,8 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'createdById': value['createdById'],
         'access': value['access'],
         'holdsCreatorLogins': value['holdsCreatorLogins'],
+        'visibility': value['visibility'],
+        'cost': SandboxCostToJSON(value['cost']),
         'wipePendingUntilRestart': value['wipePendingUntilRestart'],
         'subdomain': value['subdomain'],
         'lastSnapshotAttemptAt': value['lastSnapshotAttemptAt'] == null ? value['lastSnapshotAttemptAt'] : value['lastSnapshotAttemptAt'].toISOString(),

package/src/models/SandboxCost.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * Only with `include=cost` on `GET /sandboxes`. Machine time this sandbox used this calendar month (UTC), at list price. Same meter as `GET /sandboxes/{sandboxId}/usage`.
+ * @export
+ * @interface SandboxCost
+ */
+export interface SandboxCost {
+    /**
+     * The 1st of this month, 00:00 UTC.
+     * @type {Date}
+     * @memberof SandboxCost
+     */
+    since: Date;
+    /**
+     * Billable machine-seconds, size multiplier applied.
+     * @type {number}
+     * @memberof SandboxCost
+     */
+    seconds: number;
+    /**
+     * seconds / secondsPerDollar, at list price.
+     * @type {number}
+     * @memberof SandboxCost
+     */
+    dollars: number;
+}
+
+/**
+ * Check if a given object implements the SandboxCost interface.
+ */
+export function instanceOfSandboxCost(value: object): value is SandboxCost {
+    if (!('since' in value) || value['since'] === undefined) return false;
+    if (!('seconds' in value) || value['seconds'] === undefined) return false;
+    if (!('dollars' in value) || value['dollars'] === undefined) return false;
+    return true;
+}
+
+export function SandboxCostFromJSON(json: any): SandboxCost {
+    return SandboxCostFromJSONTyped(json, false);
+}
+
+export function SandboxCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxCost {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'since': (new Date(json['since'])),
+        'seconds': json['seconds'],
+        'dollars': json['dollars'],
+    };
+}
+
+export function SandboxCostToJSON(json: any): SandboxCost {
+    return SandboxCostToJSONTyped(json, false);
+}
+
+export function SandboxCostToJSONTyped(value?: SandboxCost | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'since': value['since'].toISOString(),
+        'seconds': value['seconds'],
+        'dollars': value['dollars'],
+    };
+}
+

package/src/models/Unshare200Response.ts

@@ -0,0 +1,81 @@
+/* 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';
+import type { Sandbox } from './Sandbox';
+import {
+    SandboxFromJSON,
+    SandboxFromJSONTyped,
+    SandboxToJSON,
+    SandboxToJSONTyped,
+} from './Sandbox';
+
+/**
+ * 
+ * @export
+ * @interface Unshare200Response
+ */
+export interface Unshare200Response {
+    /**
+     * 
+     * @type {Sandbox}
+     * @memberof Unshare200Response
+     */
+    sandbox?: Sandbox;
+    /**
+     * 
+     * @type {string}
+     * @memberof Unshare200Response
+     */
+    message?: string;
+}
+
+/**
+ * Check if a given object implements the Unshare200Response interface.
+ */
+export function instanceOfUnshare200Response(value: object): value is Unshare200Response {
+    return true;
+}
+
+export function Unshare200ResponseFromJSON(json: any): Unshare200Response {
+    return Unshare200ResponseFromJSONTyped(json, false);
+}
+
+export function Unshare200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Unshare200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandbox': json['sandbox'] == null ? undefined : SandboxFromJSON(json['sandbox']),
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function Unshare200ResponseToJSON(json: any): Unshare200Response {
+    return Unshare200ResponseToJSONTyped(json, false);
+}
+
+export function Unshare200ResponseToJSONTyped(value?: Unshare200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandbox': SandboxToJSON(value['sandbox']),
+        'message': value['message'],
+    };
+}
+

package/src/models/UpdateOrganization200Response.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';
+/**
+ * 
+ * @export
+ * @interface UpdateOrganization200Response
+ */
+export interface UpdateOrganization200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateOrganization200Response
+     */
+    ok?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateOrganization200Response
+     */
+    type?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateOrganization200Response
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateOrganization200Response
+     */
+    newSandboxesPrivate?: boolean;
+}
+
+/**
+ * Check if a given object implements the UpdateOrganization200Response interface.
+ */
+export function instanceOfUpdateOrganization200Response(value: object): value is UpdateOrganization200Response {
+    return true;
+}
+
+export function UpdateOrganization200ResponseFromJSON(json: any): UpdateOrganization200Response {
+    return UpdateOrganization200ResponseFromJSONTyped(json, false);
+}
+
+export function UpdateOrganization200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrganization200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'] == null ? undefined : json['ok'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'newSandboxesPrivate': json['newSandboxesPrivate'] == null ? undefined : json['newSandboxesPrivate'],
+    };
+}
+
+export function UpdateOrganization200ResponseToJSON(json: any): UpdateOrganization200Response {
+    return UpdateOrganization200ResponseToJSONTyped(json, false);
+}
+
+export function UpdateOrganization200ResponseToJSONTyped(value?: UpdateOrganization200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'newSandboxesPrivate': value['newSandboxesPrivate'],
+    };
+}
+

package/src/models/UpdateOrganizationRequest.ts

@@ -0,0 +1,66 @@
+/* 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 UpdateOrganizationRequest
+ */
+export interface UpdateOrganizationRequest {
+    /**
+     * True = new sandboxes start private. False = they start shared.
+     * @type {boolean}
+     * @memberof UpdateOrganizationRequest
+     */
+    newSandboxesPrivate: boolean;
+}
+
+/**
+ * Check if a given object implements the UpdateOrganizationRequest interface.
+ */
+export function instanceOfUpdateOrganizationRequest(value: object): value is UpdateOrganizationRequest {
+    if (!('newSandboxesPrivate' in value) || value['newSandboxesPrivate'] === undefined) return false;
+    return true;
+}
+
+export function UpdateOrganizationRequestFromJSON(json: any): UpdateOrganizationRequest {
+    return UpdateOrganizationRequestFromJSONTyped(json, false);
+}
+
+export function UpdateOrganizationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrganizationRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'newSandboxesPrivate': json['newSandboxesPrivate'],
+    };
+}
+
+export function UpdateOrganizationRequestToJSON(json: any): UpdateOrganizationRequest {
+    return UpdateOrganizationRequestToJSONTyped(json, false);
+}
+
+export function UpdateOrganizationRequestToJSONTyped(value?: UpdateOrganizationRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'newSandboxesPrivate': value['newSandboxesPrivate'],
+    };
+}
+

package/src/models/index.ts

@@ -119,6 +119,7 @@ export * from './SandboxActionResponse';
 export * from './SandboxAiAccessResponse';
 export * from './SandboxAiUsage';
 export * from './SandboxAiUsageResponse';
+export * from './SandboxCost';
 export * from './SandboxEnvironment';
 export * from './SandboxEnvironmentListResponse';
 export * from './SandboxEnvironmentResponse';
@@ -166,8 +167,11 @@ export * from './TelemetrySetRequest';
 export * from './TelemetrySetResponse';
 export * from './TelemetryTestResult';
 export * from './UnknownEvent';
+export * from './Unshare200Response';
 export * from './UpdateAiProxyRequest';
 export * from './UpdateCredentialProfileRequest';
+export * from './UpdateOrganization200Response';
+export * from './UpdateOrganizationRequest';
 export * from './UpdateSandboxEnvironmentRequest';
 export * from './UpdateSandboxEnvironmentRequestRepositoriesInner';
 export * from './UpdateSandboxRequest';