@boatdev/sdk 1.0.0

package/dist/models/FileWriteResponse.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 FileWriteResponse
+ */
+export interface FileWriteResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileWriteResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {FileWriteResponseTypeEnum}
+     * @memberof FileWriteResponse
+     */
+    type: FileWriteResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FileWriteResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof FileWriteResponse
+     */
+    path: string;
+    /**
+     *
+     * @type {FileWriteResponseEncodingEnum}
+     * @memberof FileWriteResponse
+     */
+    encoding: FileWriteResponseEncodingEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof FileWriteResponse
+     */
+    size: number;
+}
+/**
+ * @export
+ */
+export declare const FileWriteResponseTypeEnum: {
+    readonly FileWritten: 'file.written';
+};
+export type FileWriteResponseTypeEnum = typeof FileWriteResponseTypeEnum[keyof typeof FileWriteResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const FileWriteResponseEncodingEnum: {
+    readonly Utf8: 'utf8';
+    readonly Base64: 'base64';
+};
+export type FileWriteResponseEncodingEnum = typeof FileWriteResponseEncodingEnum[keyof typeof FileWriteResponseEncodingEnum];
+/**
+ * Check if a given object implements the FileWriteResponse interface.
+ */
+export declare function instanceOfFileWriteResponse(value: object): value is FileWriteResponse;
+export declare function FileWriteResponseFromJSON(json: any): FileWriteResponse;
+export declare function FileWriteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileWriteResponse;
+export declare function FileWriteResponseToJSON(json: any): FileWriteResponse;
+export declare function FileWriteResponseToJSONTyped(value?: FileWriteResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/FileWriteResponse.js

@@ -0,0 +1,84 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileWriteResponseEncodingEnum = exports.FileWriteResponseTypeEnum = void 0;
+exports.instanceOfFileWriteResponse = instanceOfFileWriteResponse;
+exports.FileWriteResponseFromJSON = FileWriteResponseFromJSON;
+exports.FileWriteResponseFromJSONTyped = FileWriteResponseFromJSONTyped;
+exports.FileWriteResponseToJSON = FileWriteResponseToJSON;
+exports.FileWriteResponseToJSONTyped = FileWriteResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.FileWriteResponseTypeEnum = {
+    FileWritten: 'file.written'
+};
+/**
+ * @export
+ */
+exports.FileWriteResponseEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+};
+/**
+ * Check if a given object implements the FileWriteResponse interface.
+ */
+function instanceOfFileWriteResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('encoding' in value) || value['encoding'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+function FileWriteResponseFromJSON(json) {
+    return FileWriteResponseFromJSONTyped(json, false);
+}
+function FileWriteResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'path': json['path'],
+        'encoding': json['encoding'],
+        'size': json['size'],
+    };
+}
+function FileWriteResponseToJSON(json) {
+    return FileWriteResponseToJSONTyped(json, false);
+}
+function FileWriteResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+        'encoding': value['encoding'],
+        'size': value['size'],
+    };
+}

package/dist/models/ForkRequest.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 ForkRequest
+ */
+export interface ForkRequest {
+    /**
+     * Replaces the env the fork would otherwise inherit from the source sandbox. Same validation rules as `CreateSandboxRequest.env`.
+     * @type {{ [key: string]: string; }}
+     * @memberof ForkRequest
+     */
+    env?: {
+        [key: string]: string;
+    };
+    /**
+     * Optionally pin the fork to a different named sandbox environment. Omit to inherit the source sandbox's environment. Unknown names are rejected with `unknown_environment`.
+     * @type {string}
+     * @memberof ForkRequest
+     */
+    environment?: string;
+    /**
+     * Make the fork no-env (see `CreateSandboxRequest.noEnv`). A fork of a no-env sandbox is always no-env regardless of this field.
+     * @type {boolean}
+     * @memberof ForkRequest
+     */
+    noEnv?: boolean;
+    /**
+     * Machine size for the fork. Omit to inherit the source sandbox's type. The source sandbox is never modified. Shrinking is rejected with `type_too_small` when the source's data would not fit the smaller disk. `xlarge` requires the effective $100 plan or higher and an explicit bare-metal operator allocation.
+     * @type {ForkRequestTypeEnum}
+     * @memberof ForkRequest
+     */
+    type?: ForkRequestTypeEnum;
+    /**
+     * Auto-stop for the fork, in seconds. Omit for the 1 hour default; the fork does NOT inherit the source sandbox's TTL, so forking a sandbox that has auto-stop disabled still gives you a fork that stops itself. `null` disables auto-stop, which means nothing will ever stop this sandbox for you.
+     * @type {number}
+     * @memberof ForkRequest
+     */
+    ttlSeconds?: number | null;
+}
+/**
+ * @export
+ */
+export declare const ForkRequestTypeEnum: {
+    readonly Small: 'small';
+    readonly Default: 'default';
+    readonly Large: 'large';
+    readonly Xlarge: 'xlarge';
+};
+export type ForkRequestTypeEnum = typeof ForkRequestTypeEnum[keyof typeof ForkRequestTypeEnum];
+/**
+ * Check if a given object implements the ForkRequest interface.
+ */
+export declare function instanceOfForkRequest(value: object): value is ForkRequest;
+export declare function ForkRequestFromJSON(json: any): ForkRequest;
+export declare function ForkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ForkRequest;
+export declare function ForkRequestToJSON(json: any): ForkRequest;
+export declare function ForkRequestToJSONTyped(value?: ForkRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ForkRequest.js

@@ -0,0 +1,66 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForkRequestTypeEnum = void 0;
+exports.instanceOfForkRequest = instanceOfForkRequest;
+exports.ForkRequestFromJSON = ForkRequestFromJSON;
+exports.ForkRequestFromJSONTyped = ForkRequestFromJSONTyped;
+exports.ForkRequestToJSON = ForkRequestToJSON;
+exports.ForkRequestToJSONTyped = ForkRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.ForkRequestTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+};
+/**
+ * Check if a given object implements the ForkRequest interface.
+ */
+function instanceOfForkRequest(value) {
+    return true;
+}
+function ForkRequestFromJSON(json) {
+    return ForkRequestFromJSONTyped(json, false);
+}
+function ForkRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'env': json['env'] == null ? undefined : json['env'],
+        'environment': json['environment'] == null ? undefined : json['environment'],
+        'noEnv': json['noEnv'] == null ? undefined : json['noEnv'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+function ForkRequestToJSON(json) {
+    return ForkRequestToJSONTyped(json, false);
+}
+function ForkRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'env': value['env'],
+        'environment': value['environment'],
+        'noEnv': value['noEnv'],
+        'type': value['type'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}

package/dist/models/HostPortRequest.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 HostPortRequest
+ */
+export interface HostPortRequest {
+    /**
+     * Port the service listens on inside the sandbox.
+     * @type {number}
+     * @memberof HostPortRequest
+     */
+    port: number;
+    /**
+     * Return an ungated URL instead of one that requires the `_token` query parameter.
+     * @type {boolean}
+     * @memberof HostPortRequest
+     */
+    _public?: boolean;
+    /**
+     * Display title for the hosted port.
+     * @type {string}
+     * @memberof HostPortRequest
+     */
+    title?: string;
+}
+/**
+ * Check if a given object implements the HostPortRequest interface.
+ */
+export declare function instanceOfHostPortRequest(value: object): value is HostPortRequest;
+export declare function HostPortRequestFromJSON(json: any): HostPortRequest;
+export declare function HostPortRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostPortRequest;
+export declare function HostPortRequestToJSON(json: any): HostPortRequest;
+export declare function HostPortRequestToJSONTyped(value?: HostPortRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/HostPortRequest.js

@@ -0,0 +1,54 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfHostPortRequest = instanceOfHostPortRequest;
+exports.HostPortRequestFromJSON = HostPortRequestFromJSON;
+exports.HostPortRequestFromJSONTyped = HostPortRequestFromJSONTyped;
+exports.HostPortRequestToJSON = HostPortRequestToJSON;
+exports.HostPortRequestToJSONTyped = HostPortRequestToJSONTyped;
+/**
+ * Check if a given object implements the HostPortRequest interface.
+ */
+function instanceOfHostPortRequest(value) {
+    if (!('port' in value) || value['port'] === undefined)
+        return false;
+    return true;
+}
+function HostPortRequestFromJSON(json) {
+    return HostPortRequestFromJSONTyped(json, false);
+}
+function HostPortRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'port': json['port'],
+        '_public': json['public'] == null ? undefined : json['public'],
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+function HostPortRequestToJSON(json) {
+    return HostPortRequestToJSONTyped(json, false);
+}
+function HostPortRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'port': value['port'],
+        'public': value['_public'],
+        'title': value['title'],
+    };
+}

package/dist/models/HostPortResponse.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 HostPortResponse
+ */
+export interface HostPortResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof HostPortResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HostPortResponse
+     */
+    type: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HostPortResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof HostPortResponse
+     */
+    port?: number;
+    /**
+     * Public HTTPS URL. Carries the `_token` query parameter unless the port is public; redact from logs.
+     * @type {string}
+     * @memberof HostPortResponse
+     */
+    url?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HostPortResponse
+     */
+    isProtected?: boolean;
+    /**
+     *
+     * @type {HostPortResponseAccessEnum}
+     * @memberof HostPortResponse
+     */
+    access?: HostPortResponseAccessEnum;
+}
+/**
+ * @export
+ */
+export declare const HostPortResponseAccessEnum: {
+    readonly Private: 'private';
+    readonly Public: 'public';
+};
+export type HostPortResponseAccessEnum = typeof HostPortResponseAccessEnum[keyof typeof HostPortResponseAccessEnum];
+/**
+ * Check if a given object implements the HostPortResponse interface.
+ */
+export declare function instanceOfHostPortResponse(value: object): value is HostPortResponse;
+export declare function HostPortResponseFromJSON(json: any): HostPortResponse;
+export declare function HostPortResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostPortResponse;
+export declare function HostPortResponseToJSON(json: any): HostPortResponse;
+export declare function HostPortResponseToJSONTyped(value?: HostPortResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/HostPortResponse.js

@@ -0,0 +1,72 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HostPortResponseAccessEnum = void 0;
+exports.instanceOfHostPortResponse = instanceOfHostPortResponse;
+exports.HostPortResponseFromJSON = HostPortResponseFromJSON;
+exports.HostPortResponseFromJSONTyped = HostPortResponseFromJSONTyped;
+exports.HostPortResponseToJSON = HostPortResponseToJSON;
+exports.HostPortResponseToJSONTyped = HostPortResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.HostPortResponseAccessEnum = {
+    Private: 'private',
+    Public: 'public'
+};
+/**
+ * Check if a given object implements the HostPortResponse interface.
+ */
+function instanceOfHostPortResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+function HostPortResponseFromJSON(json) {
+    return HostPortResponseFromJSONTyped(json, false);
+}
+function HostPortResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'port': json['port'] == null ? undefined : json['port'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'isProtected': json['isProtected'] == null ? undefined : json['isProtected'],
+        'access': json['access'] == null ? undefined : json['access'],
+    };
+}
+function HostPortResponseToJSON(json) {
+    return HostPortResponseToJSONTyped(json, false);
+}
+function HostPortResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'port': value['port'],
+        'url': value['url'],
+        'isProtected': value['isProtected'],
+        'access': value['access'],
+    };
+}