@boatdev/sdk 1.0.0

package/dist/esm/models/CreateSandboxRequest.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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.
+ */
+/**
+ * Options for provisioning a new cloud computer.
+ * @export
+ * @interface CreateSandboxRequest
+ */
+export interface CreateSandboxRequest {
+    /**
+     * Machine size. `small` consumes machine time at half rate and `large` at twice the default rate (see the Billing guide). `xlarge` costs $0.20 per running hour, requires the effective $100 plan or higher, and requires an explicit bare-metal operator allocation. A fork inherits the source sandbox's type unless the fork request passes its own, and resume and fork can move a sandbox between sizes.
+     * @type {CreateSandboxRequestTypeEnum}
+     * @memberof CreateSandboxRequest
+     */
+    type?: CreateSandboxRequestTypeEnum;
+    /**
+     * Number of seconds before automatic archival. `null` disables auto-stop. The backend also accepts the string `infinite` for legacy compatibility; new clients should send null.
+     * @type {number}
+     * @memberof CreateSandboxRequest
+     */
+    ttlSeconds?: number | null;
+    /**
+     * Per-sandbox environment variables injected into the sandbox's tool environment, on top of the account environment's variables (per-sandbox values win on conflicts). Keys must match `[A-Za-z_][A-Za-z0-9_]{0,127}`; at most 100 variables and 64KB total. Reserved names (`ASCII_TOKEN`, `ASCII_API_URL`, `AGENT_ID`, `PRODUCT_MODE`, `ENVIRONMENT_ID`, `BOAT_ID`, `SERVICE_PREVIEW_TOKEN`, `BOAT_CLI_TOKEN`) are rejected with `invalid_env`. Forked sandboxes inherit the source sandbox's env unless the fork request supplies its own `env`.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateSandboxRequest
+     */
+    env?: {
+        [key: string]: string;
+    };
+    /**
+     * Name of the sandbox environment to attach to this sandbox. Environments are managed in the Boat dashboard and bundle the repositories, secrets, and credential toggles a sandbox gets. Omit to use your default environment (`base` unless you changed it). Unknown names are rejected with `unknown_environment`. An environment marked "safe for third parties" passes nothing to the sandbox, exactly like `noEnv`.
+     * @type {string}
+     * @memberof CreateSandboxRequest
+     */
+    environment?: string;
+    /**
+     * Create a sandbox with none of the secrets attached to your account (no environment variables, secret files, or credentials), confined to itself so it cannot act on your account or other sandboxes. For sandboxes you give to your own users. SSH, SCP, desktop, snapshots, and public URLs still work; pass `env` to give the sandbox a secret of its own. A fork of a no-env sandbox is always no-env. Equivalent to attaching an environment marked "safe for third parties".
+     * @type {boolean}
+     * @memberof CreateSandboxRequest
+     */
+    noEnv?: boolean;
+    /**
+     * Shell script that runs on the sandbox after it is ready. Ready means "ready to accept the user", not "setup done": the script starts in the background once provisioning completes and never blocks the sandbox becoming usable. It runs as the sandbox user via `bash`, with the sandbox's environment applied, and its output goes to a log file on the sandbox. Observe the outcome as `setupStatus` (pending/running/done/failed) and `setupError` on the sandbox. Rejected with a 400 `invalid_setup_script` error when it is not a string or exceeds 64KB.
+     * @type {string}
+     * @memberof CreateSandboxRequest
+     */
+    setupScript?: string;
+    /**
+     * Bill this sandbox to a team you belong to (the team's shared wallet). Your own account id means personal billing. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId` and over the `X-Boat-Org` / `?org=` request scope.
+     * @type {string}
+     * @memberof CreateSandboxRequest
+     */
+    org?: string;
+    /**
+     * Legacy alias for `org`. Ignored when `org` is also set.
+     * @type {string}
+     * @memberof 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.
+     * @type {string}
+     * @memberof CreateSandboxRequest
+     */
+    from?: string;
+}
+/**
+ * @export
+ */
+export declare const CreateSandboxRequestTypeEnum: {
+    readonly Small: 'small';
+    readonly Default: 'default';
+    readonly Large: 'large';
+    readonly Xlarge: 'xlarge';
+};
+export type CreateSandboxRequestTypeEnum = typeof CreateSandboxRequestTypeEnum[keyof typeof CreateSandboxRequestTypeEnum];
+/**
+ * Check if a given object implements the CreateSandboxRequest interface.
+ */
+export declare function instanceOfCreateSandboxRequest(value: object): value is CreateSandboxRequest;
+export declare function CreateSandboxRequestFromJSON(json: any): CreateSandboxRequest;
+export declare function CreateSandboxRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSandboxRequest;
+export declare function CreateSandboxRequestToJSON(json: any): CreateSandboxRequest;
+export declare function CreateSandboxRequestToJSONTyped(value?: CreateSandboxRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateSandboxRequest.js

@@ -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.
+ */
+/**
+ * @export
+ */
+export const CreateSandboxRequestTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+};
+/**
+ * Check if a given object implements the CreateSandboxRequest interface.
+ */
+export function instanceOfCreateSandboxRequest(value) {
+    return true;
+}
+export function CreateSandboxRequestFromJSON(json) {
+    return CreateSandboxRequestFromJSONTyped(json, false);
+}
+export function CreateSandboxRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'] == null ? undefined : json['type'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+        'env': json['env'] == null ? undefined : json['env'],
+        'environment': json['environment'] == null ? undefined : json['environment'],
+        'noEnv': json['noEnv'] == null ? undefined : json['noEnv'],
+        'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
+        'org': json['org'] == null ? undefined : json['org'],
+        'teamId': json['teamId'] == null ? undefined : json['teamId'],
+        'from': json['from'] == null ? undefined : json['from'],
+    };
+}
+export function CreateSandboxRequestToJSON(json) {
+    return CreateSandboxRequestToJSONTyped(json, false);
+}
+export function CreateSandboxRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'ttlSeconds': value['ttlSeconds'],
+        'env': value['env'],
+        'environment': value['environment'],
+        'noEnv': value['noEnv'],
+        'setupScript': value['setupScript'],
+        'org': value['org'],
+        'teamId': value['teamId'],
+        'from': value['from'],
+    };
+}

package/dist/esm/models/CreateSandboxResponse.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 type { Sandbox } from './Sandbox';
+/**
+ *
+ * @export
+ * @interface CreateSandboxResponse
+ */
+export interface CreateSandboxResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateSandboxResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CreateSandboxResponseTypeEnum}
+     * @memberof CreateSandboxResponse
+     */
+    type: CreateSandboxResponseTypeEnum;
+    /**
+     *
+     * @type {CreateSandboxResponseStatusEnum}
+     * @memberof CreateSandboxResponse
+     */
+    status: CreateSandboxResponseStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateSandboxResponse
+     */
+    ttlSeconds: number | null;
+    /**
+     *
+     * @type {Sandbox}
+     * @memberof CreateSandboxResponse
+     */
+    sandbox: Sandbox;
+}
+/**
+ * @export
+ */
+export declare const CreateSandboxResponseTypeEnum: {
+    readonly SandboxCreated: 'sandbox.created';
+};
+export type CreateSandboxResponseTypeEnum = typeof CreateSandboxResponseTypeEnum[keyof typeof CreateSandboxResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const CreateSandboxResponseStatusEnum: {
+    readonly Provisioning: 'provisioning';
+};
+export type CreateSandboxResponseStatusEnum = typeof CreateSandboxResponseStatusEnum[keyof typeof CreateSandboxResponseStatusEnum];
+/**
+ * Check if a given object implements the CreateSandboxResponse interface.
+ */
+export declare function instanceOfCreateSandboxResponse(value: object): value is CreateSandboxResponse;
+export declare function CreateSandboxResponseFromJSON(json: any): CreateSandboxResponse;
+export declare function CreateSandboxResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSandboxResponse;
+export declare function CreateSandboxResponseToJSON(json: any): CreateSandboxResponse;
+export declare function CreateSandboxResponseToJSONTyped(value?: CreateSandboxResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateSandboxResponse.js

@@ -0,0 +1,72 @@
+/* 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 { SandboxFromJSON, SandboxToJSON, } from './Sandbox';
+/**
+ * @export
+ */
+export const CreateSandboxResponseTypeEnum = {
+    SandboxCreated: 'sandbox.created'
+};
+/**
+ * @export
+ */
+export const CreateSandboxResponseStatusEnum = {
+    Provisioning: 'provisioning'
+};
+/**
+ * Check if a given object implements the CreateSandboxResponse interface.
+ */
+export function instanceOfCreateSandboxResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('ttlSeconds' in value) || value['ttlSeconds'] === undefined)
+        return false;
+    if (!('sandbox' in value) || value['sandbox'] === undefined)
+        return false;
+    return true;
+}
+export function CreateSandboxResponseFromJSON(json) {
+    return CreateSandboxResponseFromJSONTyped(json, false);
+}
+export function CreateSandboxResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'status': json['status'],
+        'ttlSeconds': json['ttlSeconds'],
+        'sandbox': SandboxFromJSON(json['sandbox']),
+    };
+}
+export function CreateSandboxResponseToJSON(json) {
+    return CreateSandboxResponseToJSONTyped(json, false);
+}
+export function CreateSandboxResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'status': value['status'],
+        'ttlSeconds': value['ttlSeconds'],
+        'sandbox': SandboxToJSON(value['sandbox']),
+    };
+}

package/dist/esm/models/CreateScopedApiKey503Response.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CreateScopedApiKey503Response
+ */
+export interface CreateScopedApiKey503Response {
+    /**
+     *
+     * @type {CreateScopedApiKey503ResponseErrorEnum}
+     * @memberof CreateScopedApiKey503Response
+     */
+    error: CreateScopedApiKey503ResponseErrorEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateScopedApiKey503Response
+     */
+    message: string;
+    /**
+     *
+     * @type {CreateScopedApiKey503ResponseScopedCreationEnabledEnum}
+     * @memberof CreateScopedApiKey503Response
+     */
+    scopedCreationEnabled: CreateScopedApiKey503ResponseScopedCreationEnabledEnum;
+}
+/**
+ * @export
+ */
+export declare const CreateScopedApiKey503ResponseErrorEnum: {
+    readonly ScopedApiKeyCreationDisabled: 'scoped_api_key_creation_disabled';
+};
+export type CreateScopedApiKey503ResponseErrorEnum = typeof CreateScopedApiKey503ResponseErrorEnum[keyof typeof CreateScopedApiKey503ResponseErrorEnum];
+/**
+ * @export
+ */
+export declare const CreateScopedApiKey503ResponseScopedCreationEnabledEnum: {
+    readonly False: false;
+};
+export type CreateScopedApiKey503ResponseScopedCreationEnabledEnum = typeof CreateScopedApiKey503ResponseScopedCreationEnabledEnum[keyof typeof CreateScopedApiKey503ResponseScopedCreationEnabledEnum];
+/**
+ * Check if a given object implements the CreateScopedApiKey503Response interface.
+ */
+export declare function instanceOfCreateScopedApiKey503Response(value: object): value is CreateScopedApiKey503Response;
+export declare function CreateScopedApiKey503ResponseFromJSON(json: any): CreateScopedApiKey503Response;
+export declare function CreateScopedApiKey503ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateScopedApiKey503Response;
+export declare function CreateScopedApiKey503ResponseToJSON(json: any): CreateScopedApiKey503Response;
+export declare function CreateScopedApiKey503ResponseToJSONTyped(value?: CreateScopedApiKey503Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateScopedApiKey503Response.js

@@ -0,0 +1,63 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CreateScopedApiKey503ResponseErrorEnum = {
+    ScopedApiKeyCreationDisabled: 'scoped_api_key_creation_disabled'
+};
+/**
+ * @export
+ */
+export const CreateScopedApiKey503ResponseScopedCreationEnabledEnum = {
+    False: false
+};
+/**
+ * Check if a given object implements the CreateScopedApiKey503Response interface.
+ */
+export function instanceOfCreateScopedApiKey503Response(value) {
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    if (!('scopedCreationEnabled' in value) || value['scopedCreationEnabled'] === undefined)
+        return false;
+    return true;
+}
+export function CreateScopedApiKey503ResponseFromJSON(json) {
+    return CreateScopedApiKey503ResponseFromJSONTyped(json, false);
+}
+export function CreateScopedApiKey503ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'error': json['error'],
+        'message': json['message'],
+        'scopedCreationEnabled': json['scopedCreationEnabled'],
+    };
+}
+export function CreateScopedApiKey503ResponseToJSON(json) {
+    return CreateScopedApiKey503ResponseToJSONTyped(json, false);
+}
+export function CreateScopedApiKey503ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'error': value['error'],
+        'message': value['message'],
+        'scopedCreationEnabled': value['scopedCreationEnabled'],
+    };
+}

package/dist/esm/models/CreateScopedApiKeyRequest.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const CreateScopedApiKeyRequestPresetEnum: {
+    readonly ReadOnly: 'read-only';
+    readonly FullSandbox: 'full-sandbox';
+    readonly Ci: 'ci';
+    readonly Admin: 'admin';
+};
+export type CreateScopedApiKeyRequestPresetEnum = typeof CreateScopedApiKeyRequestPresetEnum[keyof typeof CreateScopedApiKeyRequestPresetEnum];
+/**
+ * Check if a given object implements the CreateScopedApiKeyRequest interface.
+ */
+export declare function instanceOfCreateScopedApiKeyRequest(value: object): value is CreateScopedApiKeyRequest;
+export declare function CreateScopedApiKeyRequestFromJSON(json: any): CreateScopedApiKeyRequest;
+export declare function CreateScopedApiKeyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateScopedApiKeyRequest;
+export declare function CreateScopedApiKeyRequestToJSON(json: any): CreateScopedApiKeyRequest;
+export declare function CreateScopedApiKeyRequestToJSONTyped(value?: CreateScopedApiKeyRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateScopedApiKeyRequest.js

@@ -0,0 +1,60 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CreateScopedApiKeyRequestPresetEnum = {
+    ReadOnly: 'read-only',
+    FullSandbox: 'full-sandbox',
+    Ci: 'ci',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the CreateScopedApiKeyRequest interface.
+ */
+export function instanceOfCreateScopedApiKeyRequest(value) {
+    return true;
+}
+export function CreateScopedApiKeyRequestFromJSON(json) {
+    return CreateScopedApiKeyRequestFromJSONTyped(json, false);
+}
+export function CreateScopedApiKeyRequestFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return CreateScopedApiKeyRequestToJSONTyped(json, false);
+}
+export function CreateScopedApiKeyRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/DataRetentionPolicyResponse.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const DataRetentionPolicyResponseTypeEnum: {
+    readonly DataRetentionInfo: 'data_retention.info';
+    readonly DataRetentionUpdated: 'data_retention.updated';
+};
+export type DataRetentionPolicyResponseTypeEnum = typeof DataRetentionPolicyResponseTypeEnum[keyof typeof DataRetentionPolicyResponseTypeEnum];
+/**
+ * Check if a given object implements the DataRetentionPolicyResponse interface.
+ */
+export declare function instanceOfDataRetentionPolicyResponse(value: object): value is DataRetentionPolicyResponse;
+export declare function DataRetentionPolicyResponseFromJSON(json: any): DataRetentionPolicyResponse;
+export declare function DataRetentionPolicyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataRetentionPolicyResponse;
+export declare function DataRetentionPolicyResponseToJSON(json: any): DataRetentionPolicyResponse;
+export declare function DataRetentionPolicyResponseToJSONTyped(value?: DataRetentionPolicyResponse | null, ignoreDiscriminator?: boolean): any;