@boatdev/sdk 1.0.0

package/src/models/FileReadResponse.ts

@@ -0,0 +1,139 @@
+/* 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 FileReadResponse
+ */
+export interface FileReadResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof FileReadResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {FileReadResponseTypeEnum}
+     * @memberof FileReadResponse
+     */
+    type: FileReadResponseTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof FileReadResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileReadResponse
+     */
+    path: string;
+    /**
+     * 
+     * @type {FileReadResponseEncodingEnum}
+     * @memberof FileReadResponse
+     */
+    encoding: FileReadResponseEncodingEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof FileReadResponse
+     */
+    size: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileReadResponse
+     */
+    content: string;
+}
+
+
+/**
+ * @export
+ */
+export const FileReadResponseTypeEnum = {
+    FileRead: 'file.read'
+} as const;
+export type FileReadResponseTypeEnum = typeof FileReadResponseTypeEnum[keyof typeof FileReadResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const FileReadResponseEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+} as const;
+export type FileReadResponseEncodingEnum = typeof FileReadResponseEncodingEnum[keyof typeof FileReadResponseEncodingEnum];
+
+
+/**
+ * Check if a given object implements the FileReadResponse interface.
+ */
+export function instanceOfFileReadResponse(value: object): value is FileReadResponse {
+    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;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    return true;
+}
+
+export function FileReadResponseFromJSON(json: any): FileReadResponse {
+    return FileReadResponseFromJSONTyped(json, false);
+}
+
+export function FileReadResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileReadResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'path': json['path'],
+        'encoding': json['encoding'],
+        'size': json['size'],
+        'content': json['content'],
+    };
+}
+
+export function FileReadResponseToJSON(json: any): FileReadResponse {
+    return FileReadResponseToJSONTyped(json, false);
+}
+
+export function FileReadResponseToJSONTyped(value?: FileReadResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'path': value['path'],
+        'encoding': value['encoding'],
+        'size': value['size'],
+        'content': value['content'],
+    };
+}
+

package/src/models/FileWriteRequest.ts

@@ -0,0 +1,94 @@
+/* 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 FileWriteRequest
+ */
+export interface FileWriteRequest {
+    /**
+     * Absolute path, or path relative to the sandbox work directory (/home/user). The canonicalized path must resolve under /home/user or /tmp; anything else is rejected with a 400 invalid_path error.
+     * @type {string}
+     * @memberof FileWriteRequest
+     */
+    path: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileWriteRequest
+     */
+    content: string;
+    /**
+     * 
+     * @type {FileWriteRequestEncodingEnum}
+     * @memberof FileWriteRequest
+     */
+    encoding?: FileWriteRequestEncodingEnum;
+}
+
+
+/**
+ * @export
+ */
+export const FileWriteRequestEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+} as const;
+export type FileWriteRequestEncodingEnum = typeof FileWriteRequestEncodingEnum[keyof typeof FileWriteRequestEncodingEnum];
+
+
+/**
+ * Check if a given object implements the FileWriteRequest interface.
+ */
+export function instanceOfFileWriteRequest(value: object): value is FileWriteRequest {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    return true;
+}
+
+export function FileWriteRequestFromJSON(json: any): FileWriteRequest {
+    return FileWriteRequestFromJSONTyped(json, false);
+}
+
+export function FileWriteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileWriteRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'content': json['content'],
+        'encoding': json['encoding'] == null ? undefined : json['encoding'],
+    };
+}
+
+export function FileWriteRequestToJSON(json: any): FileWriteRequest {
+    return FileWriteRequestToJSONTyped(json, false);
+}
+
+export function FileWriteRequestToJSONTyped(value?: FileWriteRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'content': value['content'],
+        'encoding': value['encoding'],
+    };
+}
+

package/src/models/FileWriteResponse.ts

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

@@ -0,0 +1,110 @@
+/* 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 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 const ForkRequestTypeEnum = {
+    Small: 'small',
+    Default: 'default',
+    Large: 'large',
+    Xlarge: 'xlarge'
+} as const;
+export type ForkRequestTypeEnum = typeof ForkRequestTypeEnum[keyof typeof ForkRequestTypeEnum];
+
+
+/**
+ * Check if a given object implements the ForkRequest interface.
+ */
+export function instanceOfForkRequest(value: object): value is ForkRequest {
+    return true;
+}
+
+export function ForkRequestFromJSON(json: any): ForkRequest {
+    return ForkRequestFromJSONTyped(json, false);
+}
+
+export function ForkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ForkRequest {
+    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'],
+    };
+}
+
+export function ForkRequestToJSON(json: any): ForkRequest {
+    return ForkRequestToJSONTyped(json, false);
+}
+
+export function ForkRequestToJSONTyped(value?: ForkRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'env': value['env'],
+        'environment': value['environment'],
+        'noEnv': value['noEnv'],
+        'type': value['type'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}
+

package/src/models/HostPortRequest.ts

@@ -0,0 +1,82 @@
+/* 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 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 function instanceOfHostPortRequest(value: object): value is HostPortRequest {
+    if (!('port' in value) || value['port'] === undefined) return false;
+    return true;
+}
+
+export function HostPortRequestFromJSON(json: any): HostPortRequest {
+    return HostPortRequestFromJSONTyped(json, false);
+}
+
+export function HostPortRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostPortRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'port': json['port'],
+        '_public': json['public'] == null ? undefined : json['public'],
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+
+export function HostPortRequestToJSON(json: any): HostPortRequest {
+    return HostPortRequestToJSONTyped(json, false);
+}
+
+export function HostPortRequestToJSONTyped(value?: HostPortRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'port': value['port'],
+        'public': value['_public'],
+        'title': value['title'],
+    };
+}
+

package/src/models/HostPortResponse.ts

@@ -0,0 +1,126 @@
+/* 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 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 const HostPortResponseAccessEnum = {
+    Private: 'private',
+    Public: 'public'
+} as const;
+export type HostPortResponseAccessEnum = typeof HostPortResponseAccessEnum[keyof typeof HostPortResponseAccessEnum];
+
+
+/**
+ * Check if a given object implements the HostPortResponse interface.
+ */
+export function instanceOfHostPortResponse(value: object): value is HostPortResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function HostPortResponseFromJSON(json: any): HostPortResponse {
+    return HostPortResponseFromJSONTyped(json, false);
+}
+
+export function HostPortResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostPortResponse {
+    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'],
+    };
+}
+
+export function HostPortResponseToJSON(json: any): HostPortResponse {
+    return HostPortResponseToJSONTyped(json, false);
+}
+
+export function HostPortResponseToJSONTyped(value?: HostPortResponse | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+