@boatdev/sdk 1.11.0 → 1.12.0

package/src/models/FileFindResponse.ts

@@ -0,0 +1,127 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { FileFindResponseAllOfMatches } from './FileFindResponseAllOfMatches';
+import {
+    FileFindResponseAllOfMatchesFromJSON,
+    FileFindResponseAllOfMatchesFromJSONTyped,
+    FileFindResponseAllOfMatchesToJSON,
+    FileFindResponseAllOfMatchesToJSONTyped,
+} 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 const FileFindResponseTypeEnum = {
+    FileFind: 'file.find'
+} as const;
+export type FileFindResponseTypeEnum = typeof FileFindResponseTypeEnum[keyof typeof FileFindResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the FileFindResponse interface.
+ */
+export function instanceOfFileFindResponse(value: object): value is FileFindResponse {
+    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: any): FileFindResponse {
+    return FileFindResponseFromJSONTyped(json, false);
+}
+
+export function FileFindResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFindResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'matches': ((json['matches'] as Array<any>).map(FileFindResponseAllOfMatchesFromJSON)),
+        'truncated': json['truncated'],
+        'errors': json['errors'] == null ? undefined : json['errors'],
+    };
+}
+
+export function FileFindResponseToJSON(json: any): FileFindResponse {
+    return FileFindResponseToJSONTyped(json, false);
+}
+
+export function FileFindResponseToJSONTyped(value?: FileFindResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'matches': ((value['matches'] as Array<any>).map(FileFindResponseAllOfMatchesToJSON)),
+        'truncated': value['truncated'],
+        'errors': value['errors'],
+    };
+}
+

package/src/models/FileFindResponseAllOfMatches.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface 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 function instanceOfFileFindResponseAllOfMatches(value: object): value is FileFindResponseAllOfMatches {
+    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: any): FileFindResponseAllOfMatches {
+    return FileFindResponseAllOfMatchesFromJSONTyped(json, false);
+}
+
+export function FileFindResponseAllOfMatchesFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFindResponseAllOfMatches {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'file': json['file'],
+        'line': json['line'],
+        'content': json['content'],
+    };
+}
+
+export function FileFindResponseAllOfMatchesToJSON(json: any): FileFindResponseAllOfMatches {
+    return FileFindResponseAllOfMatchesToJSONTyped(json, false);
+}
+
+export function FileFindResponseAllOfMatchesToJSONTyped(value?: FileFindResponseAllOfMatches | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'file': value['file'],
+        'line': value['line'],
+        'content': value['content'],
+    };
+}
+

package/src/models/FileFolderRequest.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface 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 function instanceOfFileFolderRequest(value: object): value is FileFolderRequest {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    return true;
+}
+
+export function FileFolderRequestFromJSON(json: any): FileFolderRequest {
+    return FileFolderRequestFromJSONTyped(json, false);
+}
+
+export function FileFolderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileFolderRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'mode': json['mode'] == null ? undefined : json['mode'],
+    };
+}
+
+export function FileFolderRequestToJSON(json: any): FileFolderRequest {
+    return FileFolderRequestToJSONTyped(json, false);
+}
+
+export function FileFolderRequestToJSONTyped(value?: FileFolderRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'mode': value['mode'],
+    };
+}
+

package/src/models/FileInfoResponse.ts

@@ -0,0 +1,158 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface 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 const FileInfoResponseTypeEnum = {
+    FileInfo: 'file.info',
+    FolderCreated: 'folder.created',
+    FilePermissionsSet: 'file.permissions_set'
+} as const;
+export type FileInfoResponseTypeEnum = typeof FileInfoResponseTypeEnum[keyof typeof FileInfoResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the FileInfoResponse interface.
+ */
+export function instanceOfFileInfoResponse(value: object): value is FileInfoResponse {
+    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: any): FileInfoResponse {
+    return FileInfoResponseFromJSONTyped(json, false);
+}
+
+export function FileInfoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileInfoResponse {
+    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: any): FileInfoResponse {
+    return FileInfoResponseToJSONTyped(json, false);
+}
+
+export function FileInfoResponseToJSONTyped(value?: FileInfoResponse | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/FileListResponse.ts

@@ -0,0 +1,128 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { FileEntry } from './FileEntry';
+import {
+    FileEntryFromJSON,
+    FileEntryFromJSONTyped,
+    FileEntryToJSON,
+    FileEntryToJSONTyped,
+} 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 const FileListResponseTypeEnum = {
+    FileList: 'file.list'
+} as const;
+export type FileListResponseTypeEnum = typeof FileListResponseTypeEnum[keyof typeof FileListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the FileListResponse interface.
+ */
+export function instanceOfFileListResponse(value: object): value is FileListResponse {
+    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: any): FileListResponse {
+    return FileListResponseFromJSONTyped(json, false);
+}
+
+export function FileListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileListResponse {
+    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'] as Array<any>).map(FileEntryFromJSON)),
+        'truncated': json['truncated'],
+    };
+}
+
+export function FileListResponseToJSON(json: any): FileListResponse {
+    return FileListResponseToJSONTyped(json, false);
+}
+
+export function FileListResponseToJSONTyped(value?: FileListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+        'files': ((value['files'] as Array<any>).map(FileEntryToJSON)),
+        'truncated': value['truncated'],
+    };
+}
+

package/src/models/FileMoveRequest.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface 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 function instanceOfFileMoveRequest(value: object): value is FileMoveRequest {
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('destination' in value) || value['destination'] === undefined) return false;
+    return true;
+}
+
+export function FileMoveRequestFromJSON(json: any): FileMoveRequest {
+    return FileMoveRequestFromJSONTyped(json, false);
+}
+
+export function FileMoveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileMoveRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'source': json['source'],
+        'destination': json['destination'],
+        'overwrite': json['overwrite'] == null ? undefined : json['overwrite'],
+    };
+}
+
+export function FileMoveRequestToJSON(json: any): FileMoveRequest {
+    return FileMoveRequestToJSONTyped(json, false);
+}
+
+export function FileMoveRequestToJSONTyped(value?: FileMoveRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'source': value['source'],
+        'destination': value['destination'],
+        'overwrite': value['overwrite'],
+    };
+}
+