@boatdev/sdk 1.11.0 → 1.12.1

package/dist/esm/models/FileFindResponse.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.
+ */
+import type { FileFindResponseAllOfMatches } from './FileFindResponseAllOfMatches';
+/**
+ *
+ * @export
+ * @interface FileFindResponse
+ */
+export interface FileFindResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileFindResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileFindResponseTypeEnum}
+     * @memberof FileFindResponse
+     */
+    type: FileFindResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileFindResponse
+     */
+    success?: boolean;
+    /**
+     * At most 1,000 matches. Each line is cut at 500 characters.
+     * @type {Array<FileFindResponseAllOfMatches>}
+     * @memberof FileFindResponse
+     */
+    matches: Array<FileFindResponseAllOfMatches>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileFindResponse
+     */
+    truncated: boolean;
+    /**
+     * Present only when part of the tree could not be searched. The matches are then incomplete. An invalid regular expression is an error response.
+     * @type {Array<string>}
+     * @memberof FileFindResponse
+     */
+    errors?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const FileFindResponseTypeEnum: {
+    readonly FileFind: 'file.find';
+};
+export type FileFindResponseTypeEnum = typeof FileFindResponseTypeEnum[keyof typeof FileFindResponseTypeEnum];
+/**
+ * Check if a given object implements the FileFindResponse interface.
+ */
+export declare function instanceOfFileFindResponse(value: object): value is FileFindResponse;
+export declare function FileFindResponseFromJSON(json: any): FileFindResponse;
+export declare function FileFindResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFindResponse;
+export declare function FileFindResponseToJSON(json: any): FileFindResponse;
+export declare function FileFindResponseToJSONTyped(value?: FileFindResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileFindResponse.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.
+ */
+import { FileFindResponseAllOfMatchesFromJSON, FileFindResponseAllOfMatchesToJSON, } from './FileFindResponseAllOfMatches';
+/**
+ * @export
+ */
+export const FileFindResponseTypeEnum = {
+    FileFind: 'file.find'
+};
+/**
+ * Check if a given object implements the FileFindResponse interface.
+ */
+export function instanceOfFileFindResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('matches' in value) || value['matches'] === undefined)
+        return false;
+    if (!('truncated' in value) || value['truncated'] === undefined)
+        return false;
+    return true;
+}
+export function FileFindResponseFromJSON(json) {
+    return FileFindResponseFromJSONTyped(json, false);
+}
+export function FileFindResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'matches': (json['matches'].map(FileFindResponseAllOfMatchesFromJSON)),
+        'truncated': json['truncated'],
+        'errors': json['errors'] == null ? undefined : json['errors'],
+    };
+}
+export function FileFindResponseToJSON(json) {
+    return FileFindResponseToJSONTyped(json, false);
+}
+export function FileFindResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'matches': (value['matches'].map(FileFindResponseAllOfMatchesToJSON)),
+        'truncated': value['truncated'],
+        'errors': value['errors'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 FileFindResponseAllOfMatches
+ */
+export interface FileFindResponseAllOfMatches {
+    /**
+     *
+     * @type {string}
+     * @memberof FileFindResponseAllOfMatches
+     */
+    file: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FileFindResponseAllOfMatches
+     */
+    line: number;
+    /**
+     *
+     * @type {string}
+     * @memberof FileFindResponseAllOfMatches
+     */
+    content: string;
+}
+/**
+ * Check if a given object implements the FileFindResponseAllOfMatches interface.
+ */
+export declare function instanceOfFileFindResponseAllOfMatches(value: object): value is FileFindResponseAllOfMatches;
+export declare function FileFindResponseAllOfMatchesFromJSON(json: any): FileFindResponseAllOfMatches;
+export declare function FileFindResponseAllOfMatchesFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFindResponseAllOfMatches;
+export declare function FileFindResponseAllOfMatchesToJSON(json: any): FileFindResponseAllOfMatches;
+export declare function FileFindResponseAllOfMatchesToJSONTyped(value?: FileFindResponseAllOfMatches | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileFindResponseAllOfMatches.js

@@ -0,0 +1,51 @@
+/* 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 FileFindResponseAllOfMatches interface.
+ */
+export function instanceOfFileFindResponseAllOfMatches(value) {
+    if (!('file' in value) || value['file'] === undefined)
+        return false;
+    if (!('line' in value) || value['line'] === undefined)
+        return false;
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    return true;
+}
+export function FileFindResponseAllOfMatchesFromJSON(json) {
+    return FileFindResponseAllOfMatchesFromJSONTyped(json, false);
+}
+export function FileFindResponseAllOfMatchesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'file': json['file'],
+        'line': json['line'],
+        'content': json['content'],
+    };
+}
+export function FileFindResponseAllOfMatchesToJSON(json) {
+    return FileFindResponseAllOfMatchesToJSONTyped(json, false);
+}
+export function FileFindResponseAllOfMatchesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file': value['file'],
+        'line': value['line'],
+        'content': value['content'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 FileFolderRequest
+ */
+export interface FileFolderRequest {
+    /**
+     * Missing parent directories are created.
+     * @type {string}
+     * @memberof FileFolderRequest
+     */
+    path: string;
+    /**
+     * Octal permission bits, for example "755".
+     * @type {string}
+     * @memberof FileFolderRequest
+     */
+    mode?: string;
+}
+/**
+ * Check if a given object implements the FileFolderRequest interface.
+ */
+export declare function instanceOfFileFolderRequest(value: object): value is FileFolderRequest;
+export declare function FileFolderRequestFromJSON(json: any): FileFolderRequest;
+export declare function FileFolderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFolderRequest;
+export declare function FileFolderRequestToJSON(json: any): FileFolderRequest;
+export declare function FileFolderRequestToJSONTyped(value?: FileFolderRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileFolderRequest.js

@@ -0,0 +1,45 @@
+/* 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 FileFolderRequest interface.
+ */
+export function instanceOfFileFolderRequest(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    return true;
+}
+export function FileFolderRequestFromJSON(json) {
+    return FileFolderRequestFromJSONTyped(json, false);
+}
+export function FileFolderRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'mode': json['mode'] == null ? undefined : json['mode'],
+    };
+}
+export function FileFolderRequestToJSON(json) {
+    return FileFolderRequestToJSONTyped(json, false);
+}
+export function FileFolderRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'mode': value['mode'],
+    };
+}

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

@@ -0,0 +1,95 @@
+/**
+ * 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 FileInfoResponse
+ */
+export interface FileInfoResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileInfoResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileInfoResponseTypeEnum}
+     * @memberof FileInfoResponse
+     */
+    type: FileInfoResponseTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof FileInfoResponse
+     */
+    name: string;
+    /**
+     * Absolute path on the sandbox.
+     * @type {string}
+     * @memberof FileInfoResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileInfoResponse
+     */
+    isDir: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileInfoResponse
+     */
+    isSymlink: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof FileInfoResponse
+     */
+    size: number;
+    /**
+     * Octal permission bits, for example "0644".
+     * @type {string}
+     * @memberof FileInfoResponse
+     */
+    mode: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof FileInfoResponse
+     */
+    modifiedAt: Date;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileInfoResponse
+     */
+    success?: boolean;
+}
+/**
+ * @export
+ */
+export declare const FileInfoResponseTypeEnum: {
+    readonly FileInfo: 'file.info';
+    readonly FolderCreated: 'folder.created';
+    readonly FilePermissionsSet: 'file.permissions_set';
+};
+export type FileInfoResponseTypeEnum = typeof FileInfoResponseTypeEnum[keyof typeof FileInfoResponseTypeEnum];
+/**
+ * Check if a given object implements the FileInfoResponse interface.
+ */
+export declare function instanceOfFileInfoResponse(value: object): value is FileInfoResponse;
+export declare function FileInfoResponseFromJSON(json: any): FileInfoResponse;
+export declare function FileInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileInfoResponse;
+export declare function FileInfoResponseToJSON(json: any): FileInfoResponse;
+export declare function FileInfoResponseToJSONTyped(value?: FileInfoResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileInfoResponse.js

@@ -0,0 +1,85 @@
+/* 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 FileInfoResponseTypeEnum = {
+    FileInfo: 'file.info',
+    FolderCreated: 'folder.created',
+    FilePermissionsSet: 'file.permissions_set'
+};
+/**
+ * Check if a given object implements the FileInfoResponse interface.
+ */
+export function instanceOfFileInfoResponse(value) {
+    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 (!('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 FileInfoResponseFromJSON(json) {
+    return FileInfoResponseFromJSONTyped(json, false);
+}
+export function FileInfoResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'name': json['name'],
+        'path': json['path'],
+        'isDir': json['isDir'],
+        'isSymlink': json['isSymlink'],
+        'size': json['size'],
+        'mode': json['mode'],
+        'modifiedAt': (new Date(json['modifiedAt'])),
+        'success': json['success'] == null ? undefined : json['success'],
+    };
+}
+export function FileInfoResponseToJSON(json) {
+    return FileInfoResponseToJSONTyped(json, false);
+}
+export function FileInfoResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'name': value['name'],
+        'path': value['path'],
+        'isDir': value['isDir'],
+        'isSymlink': value['isSymlink'],
+        'size': value['size'],
+        'mode': value['mode'],
+        'modifiedAt': value['modifiedAt'].toISOString(),
+        'success': value['success'],
+    };
+}

package/dist/esm/models/FileListResponse.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.
+ */
+import type { FileEntry } from './FileEntry';
+/**
+ *
+ * @export
+ * @interface FileListResponse
+ */
+export interface FileListResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileListResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileListResponseTypeEnum}
+     * @memberof FileListResponse
+     */
+    type: FileListResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileListResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FileListResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {Array<FileEntry>}
+     * @memberof FileListResponse
+     */
+    files: Array<FileEntry>;
+    /**
+     * True when the directory holds more than 10,000 entries.
+     * @type {boolean}
+     * @memberof FileListResponse
+     */
+    truncated: boolean;
+}
+/**
+ * @export
+ */
+export declare const FileListResponseTypeEnum: {
+    readonly FileList: 'file.list';
+};
+export type FileListResponseTypeEnum = typeof FileListResponseTypeEnum[keyof typeof FileListResponseTypeEnum];
+/**
+ * Check if a given object implements the FileListResponse interface.
+ */
+export declare function instanceOfFileListResponse(value: object): value is FileListResponse;
+export declare function FileListResponseFromJSON(json: any): FileListResponse;
+export declare function FileListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileListResponse;
+export declare function FileListResponseToJSON(json: any): FileListResponse;
+export declare function FileListResponseToJSONTyped(value?: FileListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileListResponse.js

@@ -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 { FileEntryFromJSON, FileEntryToJSON, } from './FileEntry';
+/**
+ * @export
+ */
+export const FileListResponseTypeEnum = {
+    FileList: 'file.list'
+};
+/**
+ * Check if a given object implements the FileListResponse interface.
+ */
+export function instanceOfFileListResponse(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;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    if (!('truncated' in value) || value['truncated'] === undefined)
+        return false;
+    return true;
+}
+export function FileListResponseFromJSON(json) {
+    return FileListResponseFromJSONTyped(json, false);
+}
+export function FileListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'path': json['path'],
+        'files': (json['files'].map(FileEntryFromJSON)),
+        'truncated': json['truncated'],
+    };
+}
+export function FileListResponseToJSON(json) {
+    return FileListResponseToJSONTyped(json, false);
+}
+export function FileListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+        'files': (value['files'].map(FileEntryToJSON)),
+        'truncated': value['truncated'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 FileMoveRequest
+ */
+export interface FileMoveRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof FileMoveRequest
+     */
+    source: string;
+    /**
+     * The new full path. Missing parent directories are created.
+     * @type {string}
+     * @memberof FileMoveRequest
+     */
+    destination: string;
+    /**
+     * Replace an existing destination. Without it, an existing destination is an error.
+     * @type {boolean}
+     * @memberof FileMoveRequest
+     */
+    overwrite?: boolean;
+}
+/**
+ * Check if a given object implements the FileMoveRequest interface.
+ */
+export declare function instanceOfFileMoveRequest(value: object): value is FileMoveRequest;
+export declare function FileMoveRequestFromJSON(json: any): FileMoveRequest;
+export declare function FileMoveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileMoveRequest;
+export declare function FileMoveRequestToJSON(json: any): FileMoveRequest;
+export declare function FileMoveRequestToJSONTyped(value?: FileMoveRequest | null, ignoreDiscriminator?: boolean): any;