@boatdev/sdk 1.8.0 → 1.9.1

package/src/models/CreateSandboxRequest.ts

@@ -80,7 +80,7 @@ export interface CreateSandboxRequest {
      */
     teamId?: string;
     /**
-     * Create the sandbox from a named snapshot (saved with `POST /named-snapshots`, or `boat snapshot <id> <name>` in the CLI). The sandbox starts from that exact frozen state. Omitting `type` inherits the type the snapshot was saved from; env and no-env inherit from the snapshot's source sandbox unless the request passes its own, with the same rules as forking.
+     * Create the sandbox from a named snapshot (saved with `POST /named-snapshots`, or `boat snapshot <id> <name>` in the CLI). The sandbox starts from that exact frozen state. Omitting `type` inherits the type the snapshot was saved from; env and no-env inherit from the snapshot's source sandbox unless the request passes its own, with the same rules as forking. Also accepts a share code (`bsh_...`) that another account made with `POST /named-snapshots/{name}/shares`. The new sandbox lives in and is billed to your account. It does not get the owner's per-sandbox env; your own environment applies normally. A wrong or revoked code returns `404 snapshot_not_found`.
      * @type {string}
      * @memberof CreateSandboxRequest
      */

package/src/models/CreateScopedApiKey503Response.ts

@@ -33,10 +33,10 @@ export interface CreateScopedApiKey503Response {
     message: string;
     /**
      * 
-     * @type {CreateScopedApiKey503ResponseScopedCreationEnabledEnum}
+     * @type {boolean}
      * @memberof CreateScopedApiKey503Response
      */
-    scopedCreationEnabled: CreateScopedApiKey503ResponseScopedCreationEnabledEnum;
+    scopedCreationEnabled: boolean;
 }
 
 
@@ -48,14 +48,6 @@ export const CreateScopedApiKey503ResponseErrorEnum = {
 } as const;
 export type CreateScopedApiKey503ResponseErrorEnum = typeof CreateScopedApiKey503ResponseErrorEnum[keyof typeof CreateScopedApiKey503ResponseErrorEnum];
 
-/**
- * @export
- */
-export const CreateScopedApiKey503ResponseScopedCreationEnabledEnum = {
-    False: false
-} as const;
-export type CreateScopedApiKey503ResponseScopedCreationEnabledEnum = typeof CreateScopedApiKey503ResponseScopedCreationEnabledEnum[keyof typeof CreateScopedApiKey503ResponseScopedCreationEnabledEnum];
-
 
 /**
  * Check if a given object implements the CreateScopedApiKey503Response interface.

package/src/models/NamedSnapshotShare.ts

@@ -0,0 +1,131 @@
+/* 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';
+/**
+ * A share code for a named snapshot. Any Boat account that holds the code can create a sandbox from the snapshot. Boat stores only a hash of the code. The full code is in the create response only.
+ * @export
+ * @interface NamedSnapshotShare
+ */
+export interface NamedSnapshotShare {
+    /**
+     * Share id, for example `shr_...`. Pass it to revoke the code.
+     * @type {string}
+     * @memberof NamedSnapshotShare
+     */
+    id: string;
+    /**
+     * The first characters of the code, for example `bsh_xxxxxxxx`. Use it to tell codes apart.
+     * @type {string}
+     * @memberof NamedSnapshotShare
+     */
+    codePrefix: string;
+    /**
+     * 
+     * @type {NamedSnapshotShareStatusEnum}
+     * @memberof NamedSnapshotShare
+     */
+    status: NamedSnapshotShareStatusEnum;
+    /**
+     * Number of sandboxes created with this code.
+     * @type {number}
+     * @memberof NamedSnapshotShare
+     */
+    useCount: number;
+    /**
+     * When a sandbox was last created with this code. null if never.
+     * @type {Date}
+     * @memberof NamedSnapshotShare
+     */
+    lastUsedAt: Date | null;
+    /**
+     * When the code was revoked. null while active.
+     * @type {Date}
+     * @memberof NamedSnapshotShare
+     */
+    revokedAt: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NamedSnapshotShare
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotShareStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked'
+} as const;
+export type NamedSnapshotShareStatusEnum = typeof NamedSnapshotShareStatusEnum[keyof typeof NamedSnapshotShareStatusEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotShare interface.
+ */
+export function instanceOfNamedSnapshotShare(value: object): value is NamedSnapshotShare {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('codePrefix' in value) || value['codePrefix'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('useCount' in value) || value['useCount'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
+    if (!('revokedAt' in value) || value['revokedAt'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotShareFromJSON(json: any): NamedSnapshotShare {
+    return NamedSnapshotShareFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShare {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'codePrefix': json['codePrefix'],
+        'status': json['status'],
+        'useCount': json['useCount'],
+        'lastUsedAt': (json['lastUsedAt'] == null ? null : new Date(json['lastUsedAt'])),
+        'revokedAt': (json['revokedAt'] == null ? null : new Date(json['revokedAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function NamedSnapshotShareToJSON(json: any): NamedSnapshotShare {
+    return NamedSnapshotShareToJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareToJSONTyped(value?: NamedSnapshotShare | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'codePrefix': value['codePrefix'],
+        'status': value['status'],
+        'useCount': value['useCount'],
+        'lastUsedAt': value['lastUsedAt'] == null ? value['lastUsedAt'] : value['lastUsedAt'].toISOString(),
+        'revokedAt': value['revokedAt'] == null ? value['revokedAt'] : value['revokedAt'].toISOString(),
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/NamedSnapshotShareCreatedResponse.ts

@@ -0,0 +1,120 @@
+/* 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 { NamedSnapshotShare } from './NamedSnapshotShare';
+import {
+    NamedSnapshotShareFromJSON,
+    NamedSnapshotShareFromJSONTyped,
+    NamedSnapshotShareToJSON,
+    NamedSnapshotShareToJSONTyped,
+} from './NamedSnapshotShare';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotShareCreatedResponse
+ */
+export interface NamedSnapshotShareCreatedResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotShareCreatedResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotShareCreatedResponseTypeEnum}
+     * @memberof NamedSnapshotShareCreatedResponse
+     */
+    type: NamedSnapshotShareCreatedResponseTypeEnum;
+    /**
+     * The named snapshot the code deploys.
+     * @type {string}
+     * @memberof NamedSnapshotShareCreatedResponse
+     */
+    name: string;
+    /**
+     * The share code, for example `bsh_...`. Boat shows it only in this response. Store it now; you cannot get it again.
+     * @type {string}
+     * @memberof NamedSnapshotShareCreatedResponse
+     */
+    shareCode: string;
+    /**
+     * 
+     * @type {NamedSnapshotShare}
+     * @memberof NamedSnapshotShareCreatedResponse
+     */
+    share: NamedSnapshotShare;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotShareCreatedResponseTypeEnum = {
+    SnapshotShareCreated: 'snapshot.share.created'
+} as const;
+export type NamedSnapshotShareCreatedResponseTypeEnum = typeof NamedSnapshotShareCreatedResponseTypeEnum[keyof typeof NamedSnapshotShareCreatedResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotShareCreatedResponse interface.
+ */
+export function instanceOfNamedSnapshotShareCreatedResponse(value: object): value is NamedSnapshotShareCreatedResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('shareCode' in value) || value['shareCode'] === undefined) return false;
+    if (!('share' in value) || value['share'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotShareCreatedResponseFromJSON(json: any): NamedSnapshotShareCreatedResponse {
+    return NamedSnapshotShareCreatedResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareCreatedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareCreatedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'shareCode': json['shareCode'],
+        'share': NamedSnapshotShareFromJSON(json['share']),
+    };
+}
+
+export function NamedSnapshotShareCreatedResponseToJSON(json: any): NamedSnapshotShareCreatedResponse {
+    return NamedSnapshotShareCreatedResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareCreatedResponseToJSONTyped(value?: NamedSnapshotShareCreatedResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'shareCode': value['shareCode'],
+        'share': NamedSnapshotShareToJSON(value['share']),
+    };
+}
+

package/src/models/NamedSnapshotShareListResponse.ts

@@ -0,0 +1,111 @@
+/* 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 { NamedSnapshotShare } from './NamedSnapshotShare';
+import {
+    NamedSnapshotShareFromJSON,
+    NamedSnapshotShareFromJSONTyped,
+    NamedSnapshotShareToJSON,
+    NamedSnapshotShareToJSONTyped,
+} from './NamedSnapshotShare';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotShareListResponse
+ */
+export interface NamedSnapshotShareListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotShareListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotShareListResponseTypeEnum}
+     * @memberof NamedSnapshotShareListResponse
+     */
+    type: NamedSnapshotShareListResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof NamedSnapshotShareListResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {Array<NamedSnapshotShare>}
+     * @memberof NamedSnapshotShareListResponse
+     */
+    shares: Array<NamedSnapshotShare>;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotShareListResponseTypeEnum = {
+    SnapshotShareList: 'snapshot.share.list'
+} as const;
+export type NamedSnapshotShareListResponseTypeEnum = typeof NamedSnapshotShareListResponseTypeEnum[keyof typeof NamedSnapshotShareListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotShareListResponse interface.
+ */
+export function instanceOfNamedSnapshotShareListResponse(value: object): value is NamedSnapshotShareListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('shares' in value) || value['shares'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotShareListResponseFromJSON(json: any): NamedSnapshotShareListResponse {
+    return NamedSnapshotShareListResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'shares': ((json['shares'] as Array<any>).map(NamedSnapshotShareFromJSON)),
+    };
+}
+
+export function NamedSnapshotShareListResponseToJSON(json: any): NamedSnapshotShareListResponse {
+    return NamedSnapshotShareListResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareListResponseToJSONTyped(value?: NamedSnapshotShareListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'shares': ((value['shares'] as Array<any>).map(NamedSnapshotShareToJSON)),
+    };
+}
+

package/src/models/NamedSnapshotShareRevokedResponse.ts

@@ -0,0 +1,111 @@
+/* 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 { NamedSnapshotShare } from './NamedSnapshotShare';
+import {
+    NamedSnapshotShareFromJSON,
+    NamedSnapshotShareFromJSONTyped,
+    NamedSnapshotShareToJSON,
+    NamedSnapshotShareToJSONTyped,
+} from './NamedSnapshotShare';
+
+/**
+ * 
+ * @export
+ * @interface NamedSnapshotShareRevokedResponse
+ */
+export interface NamedSnapshotShareRevokedResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NamedSnapshotShareRevokedResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {NamedSnapshotShareRevokedResponseTypeEnum}
+     * @memberof NamedSnapshotShareRevokedResponse
+     */
+    type: NamedSnapshotShareRevokedResponseTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof NamedSnapshotShareRevokedResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {NamedSnapshotShare}
+     * @memberof NamedSnapshotShareRevokedResponse
+     */
+    share: NamedSnapshotShare;
+}
+
+
+/**
+ * @export
+ */
+export const NamedSnapshotShareRevokedResponseTypeEnum = {
+    SnapshotShareRevoked: 'snapshot.share.revoked'
+} as const;
+export type NamedSnapshotShareRevokedResponseTypeEnum = typeof NamedSnapshotShareRevokedResponseTypeEnum[keyof typeof NamedSnapshotShareRevokedResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the NamedSnapshotShareRevokedResponse interface.
+ */
+export function instanceOfNamedSnapshotShareRevokedResponse(value: object): value is NamedSnapshotShareRevokedResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('share' in value) || value['share'] === undefined) return false;
+    return true;
+}
+
+export function NamedSnapshotShareRevokedResponseFromJSON(json: any): NamedSnapshotShareRevokedResponse {
+    return NamedSnapshotShareRevokedResponseFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareRevokedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareRevokedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'share': NamedSnapshotShareFromJSON(json['share']),
+    };
+}
+
+export function NamedSnapshotShareRevokedResponseToJSON(json: any): NamedSnapshotShareRevokedResponse {
+    return NamedSnapshotShareRevokedResponseToJSONTyped(json, false);
+}
+
+export function NamedSnapshotShareRevokedResponseToJSONTyped(value?: NamedSnapshotShareRevokedResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'share': NamedSnapshotShareToJSON(value['share']),
+    };
+}
+

package/src/models/SandboxEnvironmentListResponse.ts

@@ -29,10 +29,10 @@ import {
 export interface SandboxEnvironmentListResponse {
     /**
      * 
-     * @type {SandboxEnvironmentListResponseOkEnum}
+     * @type {boolean}
      * @memberof SandboxEnvironmentListResponse
      */
-    ok?: SandboxEnvironmentListResponseOkEnum;
+    ok?: boolean;
     /**
      * 
      * @type {SandboxEnvironmentListResponseTypeEnum}
@@ -48,14 +48,6 @@ export interface SandboxEnvironmentListResponse {
 }
 
 
-/**
- * @export
- */
-export const SandboxEnvironmentListResponseOkEnum = {
-    True: true
-} as const;
-export type SandboxEnvironmentListResponseOkEnum = typeof SandboxEnvironmentListResponseOkEnum[keyof typeof SandboxEnvironmentListResponseOkEnum];
-
 /**
  * @export
  */

package/src/models/index.ts

@@ -65,6 +65,10 @@ export * from './NamedSnapshotInfoResponse';
 export * from './NamedSnapshotListResponse';
 export * from './NamedSnapshotSaveRequest';
 export * from './NamedSnapshotSavingResponse';
+export * from './NamedSnapshotShare';
+export * from './NamedSnapshotShareCreatedResponse';
+export * from './NamedSnapshotShareListResponse';
+export * from './NamedSnapshotShareRevokedResponse';
 export * from './Org';
 export * from './OrgListResponse';
 export * from './PageInfo';