@boatdev/sdk 1.10.0 → 1.12.0

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
+     * @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
+     * @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;

package/dist/esm/models/FileMoveRequest.js

@@ -0,0 +1,49 @@
+/* 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 FileMoveRequest interface.
+ */
+export function instanceOfFileMoveRequest(value) {
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('destination' in value) || value['destination'] === undefined)
+        return false;
+    return true;
+}
+export function FileMoveRequestFromJSON(json) {
+    return FileMoveRequestFromJSONTyped(json, false);
+}
+export function FileMoveRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'source': json['source'],
+        'destination': json['destination'],
+        'overwrite': json['overwrite'] == null ? undefined : json['overwrite'],
+    };
+}
+export function FileMoveRequestToJSON(json) {
+    return FileMoveRequestToJSONTyped(json, false);
+}
+export function FileMoveRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'source': value['source'],
+        'destination': value['destination'],
+        'overwrite': value['overwrite'],
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 FileMoveResponse
+ */
+export interface FileMoveResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileMoveResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileMoveResponseTypeEnum}
+     * @memberof FileMoveResponse
+     */
+    type: FileMoveResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileMoveResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FileMoveResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileMoveResponse
+     */
+    destination: string;
+}
+/**
+ * @export
+ */
+export declare const FileMoveResponseTypeEnum: {
+    readonly FileMoved: 'file.moved';
+};
+export type FileMoveResponseTypeEnum = typeof FileMoveResponseTypeEnum[keyof typeof FileMoveResponseTypeEnum];
+/**
+ * Check if a given object implements the FileMoveResponse interface.
+ */
+export declare function instanceOfFileMoveResponse(value: object): value is FileMoveResponse;
+export declare function FileMoveResponseFromJSON(json: any): FileMoveResponse;
+export declare function FileMoveResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileMoveResponse;
+export declare function FileMoveResponseToJSON(json: any): FileMoveResponse;
+export declare function FileMoveResponseToJSONTyped(value?: FileMoveResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileMoveResponse.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 FileMoveResponseTypeEnum = {
+    FileMoved: 'file.moved'
+};
+/**
+ * Check if a given object implements the FileMoveResponse interface.
+ */
+export function instanceOfFileMoveResponse(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 (!('destination' in value) || value['destination'] === undefined)
+        return false;
+    return true;
+}
+export function FileMoveResponseFromJSON(json) {
+    return FileMoveResponseFromJSONTyped(json, false);
+}
+export function FileMoveResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'path': json['path'],
+        'destination': json['destination'],
+    };
+}
+export function FileMoveResponseToJSON(json) {
+    return FileMoveResponseToJSONTyped(json, false);
+}
+export function FileMoveResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+        'destination': value['destination'],
+    };
+}

package/dist/esm/models/FilePermissionsRequest.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 FilePermissionsRequest
+ */
+export interface FilePermissionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof FilePermissionsRequest
+     */
+    path: string;
+    /**
+     * Octal permission bits, for example "755".
+     * @type {string}
+     * @memberof FilePermissionsRequest
+     */
+    mode: string;
+}
+/**
+ * Check if a given object implements the FilePermissionsRequest interface.
+ */
+export declare function instanceOfFilePermissionsRequest(value: object): value is FilePermissionsRequest;
+export declare function FilePermissionsRequestFromJSON(json: any): FilePermissionsRequest;
+export declare function FilePermissionsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilePermissionsRequest;
+export declare function FilePermissionsRequestToJSON(json: any): FilePermissionsRequest;
+export declare function FilePermissionsRequestToJSONTyped(value?: FilePermissionsRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FilePermissionsRequest.js

@@ -0,0 +1,47 @@
+/* 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 FilePermissionsRequest interface.
+ */
+export function instanceOfFilePermissionsRequest(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    return true;
+}
+export function FilePermissionsRequestFromJSON(json) {
+    return FilePermissionsRequestFromJSONTyped(json, false);
+}
+export function FilePermissionsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'mode': json['mode'],
+    };
+}
+export function FilePermissionsRequestToJSON(json) {
+    return FilePermissionsRequestToJSONTyped(json, false);
+}
+export function FilePermissionsRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'mode': value['mode'],
+    };
+}

package/dist/esm/models/FileReplaceRequest.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 FileReplaceRequest
+ */
+export interface FileReplaceRequest {
+    /**
+     * Files up to 5 MiB each.
+     * @type {Array<string>}
+     * @memberof FileReplaceRequest
+     */
+    paths: Array<string>;
+    /**
+     * Plain text. Every occurrence is replaced
+     * @type {string}
+     * @memberof FileReplaceRequest
+     */
+    pattern: string;
+    /**
+     * Required. Use "" to delete the matches.
+     * @type {string}
+     * @memberof FileReplaceRequest
+     */
+    newValue: string;
+}
+/**
+ * Check if a given object implements the FileReplaceRequest interface.
+ */
+export declare function instanceOfFileReplaceRequest(value: object): value is FileReplaceRequest;
+export declare function FileReplaceRequestFromJSON(json: any): FileReplaceRequest;
+export declare function FileReplaceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileReplaceRequest;
+export declare function FileReplaceRequestToJSON(json: any): FileReplaceRequest;
+export declare function FileReplaceRequestToJSONTyped(value?: FileReplaceRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileReplaceRequest.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 FileReplaceRequest interface.
+ */
+export function instanceOfFileReplaceRequest(value) {
+    if (!('paths' in value) || value['paths'] === undefined)
+        return false;
+    if (!('pattern' in value) || value['pattern'] === undefined)
+        return false;
+    if (!('newValue' in value) || value['newValue'] === undefined)
+        return false;
+    return true;
+}
+export function FileReplaceRequestFromJSON(json) {
+    return FileReplaceRequestFromJSONTyped(json, false);
+}
+export function FileReplaceRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'paths': json['paths'],
+        'pattern': json['pattern'],
+        'newValue': json['newValue'],
+    };
+}
+export function FileReplaceRequestToJSON(json) {
+    return FileReplaceRequestToJSONTyped(json, false);
+}
+export function FileReplaceRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'paths': value['paths'],
+        'pattern': value['pattern'],
+        'newValue': value['newValue'],
+    };
+}

package/dist/esm/models/FileReplaceResponse.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.
+ */
+import type { FileReplaceResponseAllOfResults } from './FileReplaceResponseAllOfResults';
+/**
+ *
+ * @export
+ * @interface FileReplaceResponse
+ */
+export interface FileReplaceResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileReplaceResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileReplaceResponseTypeEnum}
+     * @memberof FileReplaceResponse
+     */
+    type: FileReplaceResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileReplaceResponse
+     */
+    success?: boolean;
+    /**
+     * One result per file. A file that fails does not stop the others.
+     * @type {Array<FileReplaceResponseAllOfResults>}
+     * @memberof FileReplaceResponse
+     */
+    results: Array<FileReplaceResponseAllOfResults>;
+}
+/**
+ * @export
+ */
+export declare const FileReplaceResponseTypeEnum: {
+    readonly FileReplaced: 'file.replaced';
+};
+export type FileReplaceResponseTypeEnum = typeof FileReplaceResponseTypeEnum[keyof typeof FileReplaceResponseTypeEnum];
+/**
+ * Check if a given object implements the FileReplaceResponse interface.
+ */
+export declare function instanceOfFileReplaceResponse(value: object): value is FileReplaceResponse;
+export declare function FileReplaceResponseFromJSON(json: any): FileReplaceResponse;
+export declare function FileReplaceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileReplaceResponse;
+export declare function FileReplaceResponseToJSON(json: any): FileReplaceResponse;
+export declare function FileReplaceResponseToJSONTyped(value?: FileReplaceResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileReplaceResponse.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.
+ */
+import { FileReplaceResponseAllOfResultsFromJSON, FileReplaceResponseAllOfResultsToJSON, } from './FileReplaceResponseAllOfResults';
+/**
+ * @export
+ */
+export const FileReplaceResponseTypeEnum = {
+    FileReplaced: 'file.replaced'
+};
+/**
+ * Check if a given object implements the FileReplaceResponse interface.
+ */
+export function instanceOfFileReplaceResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('results' in value) || value['results'] === undefined)
+        return false;
+    return true;
+}
+export function FileReplaceResponseFromJSON(json) {
+    return FileReplaceResponseFromJSONTyped(json, false);
+}
+export function FileReplaceResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'results': (json['results'].map(FileReplaceResponseAllOfResultsFromJSON)),
+    };
+}
+export function FileReplaceResponseToJSON(json) {
+    return FileReplaceResponseToJSONTyped(json, false);
+}
+export function FileReplaceResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'results': (value['results'].map(FileReplaceResponseAllOfResultsToJSON)),
+    };
+}