@boatdev/sdk 1.11.0 → 1.12.0

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

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { CreateSandboxRequestFilesInner } from './CreateSandboxRequestFilesInner';
+import type { HostPortRequest } from './HostPortRequest';
 /**
  * Options for provisioning a new cloud computer.
  * @export
@@ -72,11 +74,35 @@ export interface CreateSandboxRequest {
      */
     count?: number;
     /**
-     * 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 (`user`, not root; `sudo` needs no password) 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.
+     * 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 (`user`, not root; `sudo` needs no password) 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. When the request also has `files`, the script starts after every file is written.
      * @type {string}
      * @memberof CreateSandboxRequest
      */
     setupScript?: string;
+    /**
+     * Display name of the sandbox, the same value `PATCH /sandboxes/{id}` sets. A sandbox created `from` a saved snapshot is named after the snapshot when this is omitted.
+     * @type {string}
+     * @memberof CreateSandboxRequest
+     */
+    name?: string;
+    /**
+     * Who can use a sandbox billed to an organization, with the same rules as the sandbox's `visibility` field. `private`: only you can use it. `shared`: every member can, as long as it holds none of your personal logins (`noEnv`, or an environment that passes nothing). Omitted, the organization's default for new sandboxes applies (`PATCH /orgs/{org}` `newSandboxesPrivate`). It is set before the sandbox gets a machine, so a `private` sandbox is never shared, not even for a moment, and needs no `unshare` call. A personal sandbox is always private: `shared` is refused with 400 `not_org_sandbox`. Change it later with `POST /sandboxes/{id}/share` and `POST /sandboxes/{id}/unshare`.
+     * @type {CreateSandboxRequestVisibilityEnum}
+     * @memberof CreateSandboxRequest
+     */
+    visibility?: CreateSandboxRequestVisibilityEnum;
+    /**
+     * Ports to host on public HTTPS URLs, each exactly as `POST /sandboxes/{id}/host` does. The create waits for the sandbox's machine (up to 60 s, usually under a second), hosts every port at once and answers the URLs in `hostedPorts`. The ports are routed before the sandbox is ready, so a service that starts later is reachable as soon as it listens. Refused with 400 `invalid_hosted_ports` for a bad entry or a duplicate port, with 400 `count_with_hosted_ports` together with `count`, and with 400 `fail_fast_with_hosted_ports` together with `failFast`.
+     * @type {Array<HostPortRequest>}
+     * @memberof CreateSandboxRequest
+     */
+    hostedPorts?: Array<HostPortRequest>;
+    /**
+     * Files to write on the sandbox, each like `PUT /sandboxes/{id}/files` (a path under `/home/user` or `/tmp`, relative paths resolve against `/home/user`; missing folders are created). Boat writes them once the sandbox's disk is in place and before it reports `ready`, so a client that sees `ready`, and the `setupScript`, always find them. They are written once, at the first start: a resume does not write them again. At most 256KB in total; upload bigger files with `POST /sandboxes/{id}/files/upload-url`. `setupStatus` covers them: it stays `pending` until they are written, and a write that fails sets it `failed` with the path and the reason in `setupError` (the setup script then does not run). Refused with 400 `invalid_files` for a bad path, a duplicate path or a body over the limits.
+     * @type {Array<CreateSandboxRequestFilesInner>}
+     * @memberof CreateSandboxRequest
+     */
+    files?: Array<CreateSandboxRequestFilesInner>;
     /**
      * Bill this sandbox to an organization you belong to (its shared wallet), by id or by name as `GET /orgs` lists it; `personal` or your own account id means personal billing. Omitted, the `X-Boat-Org` / `?org=` request scope applies, then the account's active wallet (`PATCH /orgs/active`), then personal. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId`.
      * @type {string}
@@ -106,6 +132,14 @@ export declare const CreateSandboxRequestTypeEnum: {
     readonly Xlarge: 'xlarge';
 };
 export type CreateSandboxRequestTypeEnum = typeof CreateSandboxRequestTypeEnum[keyof typeof CreateSandboxRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const CreateSandboxRequestVisibilityEnum: {
+    readonly Private: 'private';
+    readonly Shared: 'shared';
+};
+export type CreateSandboxRequestVisibilityEnum = typeof CreateSandboxRequestVisibilityEnum[keyof typeof CreateSandboxRequestVisibilityEnum];
 /**
  * Check if a given object implements the CreateSandboxRequest interface.
  */

package/dist/esm/models/CreateSandboxRequest.js

@@ -11,6 +11,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CreateSandboxRequestFilesInnerFromJSON, CreateSandboxRequestFilesInnerToJSON, } from './CreateSandboxRequestFilesInner';
+import { HostPortRequestFromJSON, HostPortRequestToJSON, } from './HostPortRequest';
 /**
  * @export
  */
@@ -20,6 +22,13 @@ export const CreateSandboxRequestTypeEnum = {
     Large: 'large',
     Xlarge: 'xlarge'
 };
+/**
+ * @export
+ */
+export const CreateSandboxRequestVisibilityEnum = {
+    Private: 'private',
+    Shared: 'shared'
+};
 /**
  * Check if a given object implements the CreateSandboxRequest interface.
  */
@@ -44,6 +53,10 @@ export function CreateSandboxRequestFromJSONTyped(json, ignoreDiscriminator) {
         'failFast': json['failFast'] == null ? undefined : json['failFast'],
         'count': json['count'] == null ? undefined : json['count'],
         'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
+        'hostedPorts': json['hostedPorts'] == null ? undefined : (json['hostedPorts'].map(HostPortRequestFromJSON)),
+        'files': json['files'] == null ? undefined : (json['files'].map(CreateSandboxRequestFilesInnerFromJSON)),
         'org': json['org'] == null ? undefined : json['org'],
         'teamId': json['teamId'] == null ? undefined : json['teamId'],
         'from': json['from'] == null ? undefined : json['from'],
@@ -67,6 +80,10 @@ export function CreateSandboxRequestToJSONTyped(value, ignoreDiscriminator = fal
         'failFast': value['failFast'],
         'count': value['count'],
         'setupScript': value['setupScript'],
+        'name': value['name'],
+        'visibility': value['visibility'],
+        'hostedPorts': value['hostedPorts'] == null ? undefined : (value['hostedPorts'].map(HostPortRequestToJSON)),
+        'files': value['files'] == null ? undefined : (value['files'].map(CreateSandboxRequestFilesInnerToJSON)),
         'org': value['org'],
         'teamId': value['teamId'],
         'from': value['from'],

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

@@ -0,0 +1,52 @@
+/**
+ * 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 CreateSandboxRequestFilesInner
+ */
+export interface CreateSandboxRequestFilesInner {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSandboxRequestFilesInner
+     */
+    path: string;
+    /**
+     * File contents, as text or base64 (see `encoding`).
+     * @type {string}
+     * @memberof CreateSandboxRequestFilesInner
+     */
+    content: string;
+    /**
+     *
+     * @type {CreateSandboxRequestFilesInnerEncodingEnum}
+     * @memberof CreateSandboxRequestFilesInner
+     */
+    encoding?: CreateSandboxRequestFilesInnerEncodingEnum;
+}
+/**
+ * @export
+ */
+export declare const CreateSandboxRequestFilesInnerEncodingEnum: {
+    readonly Utf8: 'utf8';
+    readonly Base64: 'base64';
+};
+export type CreateSandboxRequestFilesInnerEncodingEnum = typeof CreateSandboxRequestFilesInnerEncodingEnum[keyof typeof CreateSandboxRequestFilesInnerEncodingEnum];
+/**
+ * Check if a given object implements the CreateSandboxRequestFilesInner interface.
+ */
+export declare function instanceOfCreateSandboxRequestFilesInner(value: object): value is CreateSandboxRequestFilesInner;
+export declare function CreateSandboxRequestFilesInnerFromJSON(json: any): CreateSandboxRequestFilesInner;
+export declare function CreateSandboxRequestFilesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSandboxRequestFilesInner;
+export declare function CreateSandboxRequestFilesInnerToJSON(json: any): CreateSandboxRequestFilesInner;
+export declare function CreateSandboxRequestFilesInnerToJSONTyped(value?: CreateSandboxRequestFilesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateSandboxRequestFilesInner.js

@@ -0,0 +1,56 @@
+/* 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 CreateSandboxRequestFilesInnerEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+};
+/**
+ * Check if a given object implements the CreateSandboxRequestFilesInner interface.
+ */
+export function instanceOfCreateSandboxRequestFilesInner(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    return true;
+}
+export function CreateSandboxRequestFilesInnerFromJSON(json) {
+    return CreateSandboxRequestFilesInnerFromJSONTyped(json, false);
+}
+export function CreateSandboxRequestFilesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'content': json['content'],
+        'encoding': json['encoding'] == null ? undefined : json['encoding'],
+    };
+}
+export function CreateSandboxRequestFilesInnerToJSON(json) {
+    return CreateSandboxRequestFilesInnerToJSONTyped(json, false);
+}
+export function CreateSandboxRequestFilesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'content': value['content'],
+        'encoding': value['encoding'],
+    };
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { CreateSandboxResponseAllOfHostedPortsInner } from './CreateSandboxResponseAllOfHostedPortsInner';
 import type { Sandbox } from './Sandbox';
 /**
  *
@@ -52,6 +53,12 @@ export interface CreateSandboxResponse {
      * @memberof CreateSandboxResponse
      */
     sandboxes?: Array<Sandbox>;
+    /**
+     * Present when the request set `hostedPorts`, in request order. Each entry is what `POST /sandboxes/{id}/host` answers for that port: `url`, `access`, `isProtected` and `localhost`, or `error` and `message` when that one port could not be hosted (the sandbox is created anyway; host the port again with `POST /sandboxes/{id}/host`).
+     * @type {Array<CreateSandboxResponseAllOfHostedPortsInner>}
+     * @memberof CreateSandboxResponse
+     */
+    hostedPorts?: Array<CreateSandboxResponseAllOfHostedPortsInner>;
     /**
      * Present when a fair-use cap on a gifted account shortened the requested auto-stop time.
      * @type {string}

package/dist/esm/models/CreateSandboxResponse.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CreateSandboxResponseAllOfHostedPortsInnerFromJSON, CreateSandboxResponseAllOfHostedPortsInnerToJSON, } from './CreateSandboxResponseAllOfHostedPortsInner';
 import { SandboxFromJSON, SandboxToJSON, } from './Sandbox';
 /**
  * @export
@@ -55,6 +56,7 @@ export function CreateSandboxResponseFromJSONTyped(json, ignoreDiscriminator) {
         'ttlSeconds': json['ttlSeconds'],
         'sandbox': SandboxFromJSON(json['sandbox']),
         'sandboxes': json['sandboxes'] == null ? undefined : (json['sandboxes'].map(SandboxFromJSON)),
+        'hostedPorts': json['hostedPorts'] == null ? undefined : (json['hostedPorts'].map(CreateSandboxResponseAllOfHostedPortsInnerFromJSON)),
         'giftLimitNotice': json['giftLimitNotice'] == null ? undefined : json['giftLimitNotice'],
     };
 }
@@ -72,6 +74,7 @@ export function CreateSandboxResponseToJSONTyped(value, ignoreDiscriminator = fa
         'ttlSeconds': value['ttlSeconds'],
         'sandbox': SandboxToJSON(value['sandbox']),
         'sandboxes': value['sandboxes'] == null ? undefined : (value['sandboxes'].map(SandboxToJSON)),
+        'hostedPorts': value['hostedPorts'] == null ? undefined : (value['hostedPorts'].map(CreateSandboxResponseAllOfHostedPortsInnerToJSON)),
         'giftLimitNotice': value['giftLimitNotice'],
     };
 }

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

@@ -0,0 +1,77 @@
+/**
+ * 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 CreateSandboxResponseAllOfHostedPortsInner
+ */
+export interface CreateSandboxResponseAllOfHostedPortsInner {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    port: number;
+    /**
+     * Public HTTPS URL. Carries the `_token` query parameter unless the port is public; redact from logs.
+     * @type {string}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    url?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    isProtected?: boolean;
+    /**
+     *
+     * @type {CreateSandboxResponseAllOfHostedPortsInnerAccessEnum}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    access?: CreateSandboxResponseAllOfHostedPortsInnerAccessEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    localhost?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    error?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSandboxResponseAllOfHostedPortsInner
+     */
+    message?: string;
+}
+/**
+ * @export
+ */
+export declare const CreateSandboxResponseAllOfHostedPortsInnerAccessEnum: {
+    readonly Private: 'private';
+    readonly Public: 'public';
+};
+export type CreateSandboxResponseAllOfHostedPortsInnerAccessEnum = typeof CreateSandboxResponseAllOfHostedPortsInnerAccessEnum[keyof typeof CreateSandboxResponseAllOfHostedPortsInnerAccessEnum];
+/**
+ * Check if a given object implements the CreateSandboxResponseAllOfHostedPortsInner interface.
+ */
+export declare function instanceOfCreateSandboxResponseAllOfHostedPortsInner(value: object): value is CreateSandboxResponseAllOfHostedPortsInner;
+export declare function CreateSandboxResponseAllOfHostedPortsInnerFromJSON(json: any): CreateSandboxResponseAllOfHostedPortsInner;
+export declare function CreateSandboxResponseAllOfHostedPortsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSandboxResponseAllOfHostedPortsInner;
+export declare function CreateSandboxResponseAllOfHostedPortsInnerToJSON(json: any): CreateSandboxResponseAllOfHostedPortsInner;
+export declare function CreateSandboxResponseAllOfHostedPortsInnerToJSONTyped(value?: CreateSandboxResponseAllOfHostedPortsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateSandboxResponseAllOfHostedPortsInner.js

@@ -0,0 +1,64 @@
+/* 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 CreateSandboxResponseAllOfHostedPortsInnerAccessEnum = {
+    Private: 'private',
+    Public: 'public'
+};
+/**
+ * Check if a given object implements the CreateSandboxResponseAllOfHostedPortsInner interface.
+ */
+export function instanceOfCreateSandboxResponseAllOfHostedPortsInner(value) {
+    if (!('port' in value) || value['port'] === undefined)
+        return false;
+    return true;
+}
+export function CreateSandboxResponseAllOfHostedPortsInnerFromJSON(json) {
+    return CreateSandboxResponseAllOfHostedPortsInnerFromJSONTyped(json, false);
+}
+export function CreateSandboxResponseAllOfHostedPortsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        ...json,
+        'port': json['port'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'isProtected': json['isProtected'] == null ? undefined : json['isProtected'],
+        'access': json['access'] == null ? undefined : json['access'],
+        'localhost': json['localhost'] == null ? undefined : json['localhost'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+export function CreateSandboxResponseAllOfHostedPortsInnerToJSON(json) {
+    return CreateSandboxResponseAllOfHostedPortsInnerToJSONTyped(json, false);
+}
+export function CreateSandboxResponseAllOfHostedPortsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        ...value,
+        'port': value['port'],
+        'url': value['url'],
+        'isProtected': value['isProtected'],
+        'access': value['access'],
+        'localhost': value['localhost'],
+        'error': value['error'],
+        'message': value['message'],
+    };
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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 FileDeleteResponse
+ */
+export interface FileDeleteResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileDeleteResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileDeleteResponseTypeEnum}
+     * @memberof FileDeleteResponse
+     */
+    type: FileDeleteResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileDeleteResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FileDeleteResponse
+     */
+    path: string;
+}
+/**
+ * @export
+ */
+export declare const FileDeleteResponseTypeEnum: {
+    readonly FileDeleted: 'file.deleted';
+};
+export type FileDeleteResponseTypeEnum = typeof FileDeleteResponseTypeEnum[keyof typeof FileDeleteResponseTypeEnum];
+/**
+ * Check if a given object implements the FileDeleteResponse interface.
+ */
+export declare function instanceOfFileDeleteResponse(value: object): value is FileDeleteResponse;
+export declare function FileDeleteResponseFromJSON(json: any): FileDeleteResponse;
+export declare function FileDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileDeleteResponse;
+export declare function FileDeleteResponseToJSON(json: any): FileDeleteResponse;
+export declare function FileDeleteResponseToJSONTyped(value?: FileDeleteResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileDeleteResponse.js

@@ -0,0 +1,59 @@
+/* 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 FileDeleteResponseTypeEnum = {
+    FileDeleted: 'file.deleted'
+};
+/**
+ * Check if a given object implements the FileDeleteResponse interface.
+ */
+export function instanceOfFileDeleteResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    return true;
+}
+export function FileDeleteResponseFromJSON(json) {
+    return FileDeleteResponseFromJSONTyped(json, false);
+}
+export function FileDeleteResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'path': json['path'],
+    };
+}
+export function FileDeleteResponseToJSON(json) {
+    return FileDeleteResponseToJSONTyped(json, false);
+}
+export function FileDeleteResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+    };
+}

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

@@ -0,0 +1,68 @@
+/**
+ * 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 FileEntry
+ */
+export interface FileEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof FileEntry
+     */
+    name: string;
+    /**
+     * Absolute path on the sandbox.
+     * @type {string}
+     * @memberof FileEntry
+     */
+    path: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileEntry
+     */
+    isDir: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileEntry
+     */
+    isSymlink: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof FileEntry
+     */
+    size: number;
+    /**
+     * Octal permission bits, for example "0644".
+     * @type {string}
+     * @memberof FileEntry
+     */
+    mode: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof FileEntry
+     */
+    modifiedAt: Date;
+}
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+export declare function instanceOfFileEntry(value: object): value is FileEntry;
+export declare function FileEntryFromJSON(json: any): FileEntry;
+export declare function FileEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileEntry;
+export declare function FileEntryToJSON(json: any): FileEntry;
+export declare function FileEntryToJSONTyped(value?: FileEntry | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileEntry.js

@@ -0,0 +1,67 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+export function instanceOfFileEntry(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('isDir' in value) || value['isDir'] === undefined)
+        return false;
+    if (!('isSymlink' in value) || value['isSymlink'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('modifiedAt' in value) || value['modifiedAt'] === undefined)
+        return false;
+    return true;
+}
+export function FileEntryFromJSON(json) {
+    return FileEntryFromJSONTyped(json, false);
+}
+export function FileEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'path': json['path'],
+        'isDir': json['isDir'],
+        'isSymlink': json['isSymlink'],
+        'size': json['size'],
+        'mode': json['mode'],
+        'modifiedAt': (new Date(json['modifiedAt'])),
+    };
+}
+export function FileEntryToJSON(json) {
+    return FileEntryToJSONTyped(json, false);
+}
+export function FileEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'path': value['path'],
+        'isDir': value['isDir'],
+        'isSymlink': value['isSymlink'],
+        'size': value['size'],
+        'mode': value['mode'],
+        'modifiedAt': value['modifiedAt'].toISOString(),
+    };
+}