@boatdev/sdk 1.0.0

package/src/models/CreateScopedApiKeyRequest.ts

@@ -0,0 +1,118 @@
+/* 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 CreateScopedApiKeyRequest
+ */
+export interface CreateScopedApiKeyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    name?: string;
+    /**
+     * Duration such as 90d, 24h, or seconds. Max 365d.
+     * @type {string}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    ttl?: string;
+    /**
+     * 
+     * @type {CreateScopedApiKeyRequestPresetEnum}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    preset?: CreateScopedApiKeyRequestPresetEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    actions?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    sandboxIds?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateScopedApiKeyRequest
+     */
+    environmentIds?: Array<string>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateScopedApiKeyRequestPresetEnum = {
+    ReadOnly: 'read-only',
+    FullSandbox: 'full-sandbox',
+    Ci: 'ci',
+    Admin: 'admin'
+} as const;
+export type CreateScopedApiKeyRequestPresetEnum = typeof CreateScopedApiKeyRequestPresetEnum[keyof typeof CreateScopedApiKeyRequestPresetEnum];
+
+
+/**
+ * Check if a given object implements the CreateScopedApiKeyRequest interface.
+ */
+export function instanceOfCreateScopedApiKeyRequest(value: object): value is CreateScopedApiKeyRequest {
+    return true;
+}
+
+export function CreateScopedApiKeyRequestFromJSON(json: any): CreateScopedApiKeyRequest {
+    return CreateScopedApiKeyRequestFromJSONTyped(json, false);
+}
+
+export function CreateScopedApiKeyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateScopedApiKeyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'ttl': json['ttl'] == null ? undefined : json['ttl'],
+        'preset': json['preset'] == null ? undefined : json['preset'],
+        'actions': json['actions'] == null ? undefined : json['actions'],
+        'sandboxIds': json['sandboxIds'] == null ? undefined : json['sandboxIds'],
+        'environmentIds': json['environmentIds'] == null ? undefined : json['environmentIds'],
+    };
+}
+
+export function CreateScopedApiKeyRequestToJSON(json: any): CreateScopedApiKeyRequest {
+    return CreateScopedApiKeyRequestToJSONTyped(json, false);
+}
+
+export function CreateScopedApiKeyRequestToJSONTyped(value?: CreateScopedApiKeyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'ttl': value['ttl'],
+        'preset': value['preset'],
+        'actions': value['actions'],
+        'sandboxIds': value['sandboxIds'],
+        'environmentIds': value['environmentIds'],
+    };
+}
+

package/src/models/DataRetentionPolicyResponse.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';
+/**
+ * 
+ * @export
+ * @interface DataRetentionPolicyResponse
+ */
+export interface DataRetentionPolicyResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataRetentionPolicyResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {DataRetentionPolicyResponseTypeEnum}
+     * @memberof DataRetentionPolicyResponse
+     */
+    type: DataRetentionPolicyResponseTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataRetentionPolicyResponse
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataRetentionPolicyResponse
+     */
+    enabledAt: Date | null;
+    /**
+     * Archived Sandboxes newly queued for deletion by this policy update.
+     * @type {number}
+     * @memberof DataRetentionPolicyResponse
+     */
+    queuedSandboxes?: number;
+    /**
+     * Always true on updates. Disabling the policy does not cancel accepted deletion operations.
+     * @type {boolean}
+     * @memberof DataRetentionPolicyResponse
+     */
+    acceptedDeletionOperationsIrreversible?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const DataRetentionPolicyResponseTypeEnum = {
+    DataRetentionInfo: 'data_retention.info',
+    DataRetentionUpdated: 'data_retention.updated'
+} as const;
+export type DataRetentionPolicyResponseTypeEnum = typeof DataRetentionPolicyResponseTypeEnum[keyof typeof DataRetentionPolicyResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the DataRetentionPolicyResponse interface.
+ */
+export function instanceOfDataRetentionPolicyResponse(value: object): value is DataRetentionPolicyResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('enabledAt' in value) || value['enabledAt'] === undefined) return false;
+    return true;
+}
+
+export function DataRetentionPolicyResponseFromJSON(json: any): DataRetentionPolicyResponse {
+    return DataRetentionPolicyResponseFromJSONTyped(json, false);
+}
+
+export function DataRetentionPolicyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataRetentionPolicyResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'enabled': json['enabled'],
+        'enabledAt': (json['enabledAt'] == null ? null : new Date(json['enabledAt'])),
+        'queuedSandboxes': json['queuedSandboxes'] == null ? undefined : json['queuedSandboxes'],
+        'acceptedDeletionOperationsIrreversible': json['acceptedDeletionOperationsIrreversible'] == null ? undefined : json['acceptedDeletionOperationsIrreversible'],
+    };
+}
+
+export function DataRetentionPolicyResponseToJSON(json: any): DataRetentionPolicyResponse {
+    return DataRetentionPolicyResponseToJSONTyped(json, false);
+}
+
+export function DataRetentionPolicyResponseToJSONTyped(value?: DataRetentionPolicyResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'enabled': value['enabled'],
+        'enabledAt': value['enabledAt'] == null ? value['enabledAt'] : value['enabledAt'].toISOString(),
+        'queuedSandboxes': value['queuedSandboxes'],
+        'acceptedDeletionOperationsIrreversible': value['acceptedDeletionOperationsIrreversible'],
+    };
+}
+

package/src/models/DataRetentionUpdateRequest.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';
+/**
+ * 
+ * @export
+ * @interface DataRetentionUpdateRequest
+ */
+export interface DataRetentionUpdateRequest {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataRetentionUpdateRequest
+     */
+    enabled: boolean;
+    /**
+     * Required when enabling and must exactly equal `delete archived sandbox data`.
+     * @type {DataRetentionUpdateRequestConfirmationEnum}
+     * @memberof DataRetentionUpdateRequest
+     */
+    confirmation?: DataRetentionUpdateRequestConfirmationEnum;
+}
+
+
+/**
+ * @export
+ */
+export const DataRetentionUpdateRequestConfirmationEnum = {
+    DeleteArchivedSandboxData: 'delete archived sandbox data'
+} as const;
+export type DataRetentionUpdateRequestConfirmationEnum = typeof DataRetentionUpdateRequestConfirmationEnum[keyof typeof DataRetentionUpdateRequestConfirmationEnum];
+
+
+/**
+ * Check if a given object implements the DataRetentionUpdateRequest interface.
+ */
+export function instanceOfDataRetentionUpdateRequest(value: object): value is DataRetentionUpdateRequest {
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function DataRetentionUpdateRequestFromJSON(json: any): DataRetentionUpdateRequest {
+    return DataRetentionUpdateRequestFromJSONTyped(json, false);
+}
+
+export function DataRetentionUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataRetentionUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'],
+        'confirmation': json['confirmation'] == null ? undefined : json['confirmation'],
+    };
+}
+
+export function DataRetentionUpdateRequestToJSON(json: any): DataRetentionUpdateRequest {
+    return DataRetentionUpdateRequestToJSONTyped(json, false);
+}
+
+export function DataRetentionUpdateRequestToJSONTyped(value?: DataRetentionUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'confirmation': value['confirmation'],
+    };
+}
+

package/src/models/DeletionOperation.ts

@@ -0,0 +1,161 @@
+/* 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 DeletionOperation
+ */
+export interface DeletionOperation {
+    /**
+     * 
+     * @type {string}
+     * @memberof DeletionOperation
+     */
+    id: string;
+    /**
+     * 
+     * @type {DeletionOperationKindEnum}
+     * @memberof DeletionOperation
+     */
+    kind: DeletionOperationKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeletionOperation
+     */
+    targetId: string;
+    /**
+     * 
+     * @type {DeletionOperationReasonEnum}
+     * @memberof DeletionOperation
+     */
+    reason: DeletionOperationReasonEnum;
+    /**
+     * 
+     * @type {DeletionOperationStatusEnum}
+     * @memberof DeletionOperation
+     */
+    status: DeletionOperationStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof DeletionOperation
+     */
+    attemptCount: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    requestedAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DeletionOperation
+     */
+    completedAt: Date | null;
+}
+
+
+/**
+ * @export
+ */
+export const DeletionOperationKindEnum = {
+    Sandbox: 'sandbox',
+    Snapshot: 'snapshot'
+} as const;
+export type DeletionOperationKindEnum = typeof DeletionOperationKindEnum[keyof typeof DeletionOperationKindEnum];
+
+/**
+ * @export
+ */
+export const DeletionOperationReasonEnum = {
+    Explicit: 'explicit',
+    Zdr: 'zdr',
+    Account: 'account'
+} as const;
+export type DeletionOperationReasonEnum = typeof DeletionOperationReasonEnum[keyof typeof DeletionOperationReasonEnum];
+
+/**
+ * @export
+ */
+export const DeletionOperationStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Blocked: 'blocked',
+    Completed: 'completed'
+} as const;
+export type DeletionOperationStatusEnum = typeof DeletionOperationStatusEnum[keyof typeof DeletionOperationStatusEnum];
+
+
+/**
+ * Check if a given object implements the DeletionOperation interface.
+ */
+export function instanceOfDeletionOperation(value: object): value is DeletionOperation {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('targetId' in value) || value['targetId'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('attemptCount' in value) || value['attemptCount'] === undefined) return false;
+    if (!('requestedAt' in value) || value['requestedAt'] === undefined) return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined) return false;
+    return true;
+}
+
+export function DeletionOperationFromJSON(json: any): DeletionOperation {
+    return DeletionOperationFromJSONTyped(json, false);
+}
+
+export function DeletionOperationFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'kind': json['kind'],
+        'targetId': json['targetId'],
+        'reason': json['reason'],
+        'status': json['status'],
+        'attemptCount': json['attemptCount'],
+        'requestedAt': (new Date(json['requestedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+    };
+}
+
+export function DeletionOperationToJSON(json: any): DeletionOperation {
+    return DeletionOperationToJSONTyped(json, false);
+}
+
+export function DeletionOperationToJSONTyped(value?: DeletionOperation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'kind': value['kind'],
+        'targetId': value['targetId'],
+        'reason': value['reason'],
+        'status': value['status'],
+        'attemptCount': value['attemptCount'],
+        'requestedAt': value['requestedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+    };
+}
+

package/src/models/DeletionOperationResponse.ts

@@ -0,0 +1,104 @@
+/* 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 { DeletionOperation } from './DeletionOperation';
+import {
+    DeletionOperationFromJSON,
+    DeletionOperationFromJSONTyped,
+    DeletionOperationToJSON,
+    DeletionOperationToJSONTyped,
+} from './DeletionOperation';
+
+/**
+ * 
+ * @export
+ * @interface DeletionOperationResponse
+ */
+export interface DeletionOperationResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeletionOperationResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {DeletionOperationResponseTypeEnum}
+     * @memberof DeletionOperationResponse
+     */
+    type: DeletionOperationResponseTypeEnum;
+    /**
+     * 
+     * @type {DeletionOperation}
+     * @memberof DeletionOperationResponse
+     */
+    operation: DeletionOperation;
+}
+
+
+/**
+ * @export
+ */
+export const DeletionOperationResponseTypeEnum = {
+    DeletionOperation: 'deletion.operation',
+    SandboxDeleting: 'sandbox.deleting',
+    SnapshotDeleting: 'snapshot.deleting'
+} as const;
+export type DeletionOperationResponseTypeEnum = typeof DeletionOperationResponseTypeEnum[keyof typeof DeletionOperationResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the DeletionOperationResponse interface.
+ */
+export function instanceOfDeletionOperationResponse(value: object): value is DeletionOperationResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('operation' in value) || value['operation'] === undefined) return false;
+    return true;
+}
+
+export function DeletionOperationResponseFromJSON(json: any): DeletionOperationResponse {
+    return DeletionOperationResponseFromJSONTyped(json, false);
+}
+
+export function DeletionOperationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'operation': DeletionOperationFromJSON(json['operation']),
+    };
+}
+
+export function DeletionOperationResponseToJSON(json: any): DeletionOperationResponse {
+    return DeletionOperationResponseToJSONTyped(json, false);
+}
+
+export function DeletionOperationResponseToJSONTyped(value?: DeletionOperationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'operation': DeletionOperationToJSON(value['operation']),
+    };
+}
+

package/src/models/DesktopRequest.ts

@@ -0,0 +1,68 @@
+/* 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';
+/**
+ * Optional desktop/VNC setup options used by the Boat dashboard and CLI. Most callers send an empty body.
+ * @export
+ * @interface DesktopRequest
+ */
+export interface DesktopRequest {
+    [key: string]: any | any;
+    /**
+     * For `?vnc=1`, return a noVNC URL that does not require an access token.
+     * @type {boolean}
+     * @memberof DesktopRequest
+     */
+    publicAccess?: boolean;
+}
+
+/**
+ * Check if a given object implements the DesktopRequest interface.
+ */
+export function instanceOfDesktopRequest(value: object): value is DesktopRequest {
+    return true;
+}
+
+export function DesktopRequestFromJSON(json: any): DesktopRequest {
+    return DesktopRequestFromJSONTyped(json, false);
+}
+
+export function DesktopRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DesktopRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'publicAccess': json['publicAccess'] == null ? undefined : json['publicAccess'],
+    };
+}
+
+export function DesktopRequestToJSON(json: any): DesktopRequest {
+    return DesktopRequestToJSONTyped(json, false);
+}
+
+export function DesktopRequestToJSONTyped(value?: DesktopRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'publicAccess': value['publicAccess'],
+    };
+}
+