@boatdev/sdk 1.9.2 → 1.9.4

package/src/models/HostPortResponse.ts

@@ -61,6 +61,12 @@ export interface HostPortResponse {
      * @memberof HostPortResponse
      */
     access?: HostPortResponseAccessEnum;
+    /**
+     * The sandbox relays the URL to a service that listens on localhost only.
+     * @type {boolean}
+     * @memberof HostPortResponse
+     */
+    localhost?: boolean;
 }
 
 
@@ -100,6 +106,7 @@ export function HostPortResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'url': json['url'] == null ? undefined : json['url'],
         'isProtected': json['isProtected'] == null ? undefined : json['isProtected'],
         'access': json['access'] == null ? undefined : json['access'],
+        'localhost': json['localhost'] == null ? undefined : json['localhost'],
     };
 }
 
@@ -121,6 +128,7 @@ export function HostPortResponseToJSONTyped(value?: HostPortResponse | null, ign
         'url': value['url'],
         'isProtected': value['isProtected'],
         'access': value['access'],
+        'localhost': value['localhost'],
     };
 }
 

package/src/models/ProcessListResponse.ts

@@ -0,0 +1,129 @@
+/* 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 { SandboxProcess } from './SandboxProcess';
+import {
+    SandboxProcessFromJSON,
+    SandboxProcessFromJSONTyped,
+    SandboxProcessToJSON,
+    SandboxProcessToJSONTyped,
+} from './SandboxProcess';
+
+/**
+ * 
+ * @export
+ * @interface ProcessListResponse
+ */
+export interface ProcessListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProcessListResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {ProcessListResponseTypeEnum}
+     * @memberof ProcessListResponse
+     */
+    type: ProcessListResponseTypeEnum;
+    /**
+     * True: read from the running sandbox now. False: the sandbox is stopped (or its agent is not upgraded yet), and this is the last sample kept (top 12 processes, every 30 s, 7 days).
+     * @type {boolean}
+     * @memberof ProcessListResponse
+     */
+    live: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ProcessListResponse
+     */
+    sampledAt: Date | null;
+    /**
+     * Processes on the sandbox. The list holds at most 500
+     * @type {number}
+     * @memberof ProcessListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<SandboxProcess>}
+     * @memberof ProcessListResponse
+     */
+    processes: Array<SandboxProcess>;
+}
+
+
+/**
+ * @export
+ */
+export const ProcessListResponseTypeEnum = {
+    ProcessList: 'process.list'
+} as const;
+export type ProcessListResponseTypeEnum = typeof ProcessListResponseTypeEnum[keyof typeof ProcessListResponseTypeEnum];
+
+
+/**
+ * Check if a given object implements the ProcessListResponse interface.
+ */
+export function instanceOfProcessListResponse(value: object): value is ProcessListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('live' in value) || value['live'] === undefined) return false;
+    if (!('sampledAt' in value) || value['sampledAt'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('processes' in value) || value['processes'] === undefined) return false;
+    return true;
+}
+
+export function ProcessListResponseFromJSON(json: any): ProcessListResponse {
+    return ProcessListResponseFromJSONTyped(json, false);
+}
+
+export function ProcessListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'live': json['live'],
+        'sampledAt': (json['sampledAt'] == null ? null : new Date(json['sampledAt'])),
+        'total': json['total'],
+        'processes': ((json['processes'] as Array<any>).map(SandboxProcessFromJSON)),
+    };
+}
+
+export function ProcessListResponseToJSON(json: any): ProcessListResponse {
+    return ProcessListResponseToJSONTyped(json, false);
+}
+
+export function ProcessListResponseToJSONTyped(value?: ProcessListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'live': value['live'],
+        'sampledAt': value['sampledAt'] == null ? value['sampledAt'] : value['sampledAt'].toISOString(),
+        'total': value['total'],
+        'processes': ((value['processes'] as Array<any>).map(SandboxProcessToJSON)),
+    };
+}
+

package/src/models/Sandbox.ts

@@ -172,6 +172,12 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     snapshots?: boolean;
+    /**
+     * False when the sandbox was created with monitoring off.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    monitoring?: boolean;
     /**
      * 
      * @type {boolean}
@@ -403,6 +409,7 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'desktopAvailable': json['desktopAvailable'],
         'desktopUrl': json['desktopUrl'] == null ? undefined : json['desktopUrl'],
         'snapshots': json['snapshots'] == null ? undefined : json['snapshots'],
+        'monitoring': json['monitoring'] == null ? undefined : json['monitoring'],
         'snapshotAvailable': json['snapshotAvailable'],
         'snapshotCompletedAt': json['snapshotCompletedAt'] == null ? undefined : (new Date(json['snapshotCompletedAt'])),
         'snapshotVerifiedAt': json['snapshotVerifiedAt'] == null ? undefined : (new Date(json['snapshotVerifiedAt'])),
@@ -457,6 +464,7 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'desktopAvailable': value['desktopAvailable'],
         'desktopUrl': value['desktopUrl'],
         'snapshots': value['snapshots'],
+        'monitoring': value['monitoring'],
         'snapshotAvailable': value['snapshotAvailable'],
         'snapshotCompletedAt': value['snapshotCompletedAt'] == null ? value['snapshotCompletedAt'] : value['snapshotCompletedAt'].toISOString(),
         'snapshotVerifiedAt': value['snapshotVerifiedAt'] == null ? value['snapshotVerifiedAt'] : value['snapshotVerifiedAt'].toISOString(),

package/src/models/SandboxProcess.ts

@@ -0,0 +1,123 @@
+/* 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 SandboxProcess
+ */
+export interface SandboxProcess {
+    /**
+     * 
+     * @type {number}
+     * @memberof SandboxProcess
+     */
+    pid: number;
+    /**
+     * Live list only.
+     * @type {number}
+     * @memberof SandboxProcess
+     */
+    parentPid?: number;
+    /**
+     * Live list only.
+     * @type {string}
+     * @memberof SandboxProcess
+     */
+    user?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SandboxProcess
+     */
+    cpuPercent?: number;
+    /**
+     * Resident memory.
+     * @type {number}
+     * @memberof SandboxProcess
+     */
+    memoryMB?: number;
+    /**
+     * Live list only.
+     * @type {Date}
+     * @memberof SandboxProcess
+     */
+    startedAt?: Date;
+    /**
+     * The full command line (first 1000 characters; 120 in a stored sample).
+     * @type {string}
+     * @memberof SandboxProcess
+     */
+    command: string;
+    /**
+     * Live list: the history record holding this process's output, when it has one.
+     * @type {string}
+     * @memberof SandboxProcess
+     */
+    commandId?: string | null;
+}
+
+/**
+ * Check if a given object implements the SandboxProcess interface.
+ */
+export function instanceOfSandboxProcess(value: object): value is SandboxProcess {
+    if (!('pid' in value) || value['pid'] === undefined) return false;
+    if (!('command' in value) || value['command'] === undefined) return false;
+    return true;
+}
+
+export function SandboxProcessFromJSON(json: any): SandboxProcess {
+    return SandboxProcessFromJSONTyped(json, false);
+}
+
+export function SandboxProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): SandboxProcess {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pid': json['pid'],
+        'parentPid': json['parentPid'] == null ? undefined : json['parentPid'],
+        'user': json['user'] == null ? undefined : json['user'],
+        'cpuPercent': json['cpuPercent'] == null ? undefined : json['cpuPercent'],
+        'memoryMB': json['memoryMB'] == null ? undefined : json['memoryMB'],
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'command': json['command'],
+        'commandId': json['commandId'] == null ? undefined : json['commandId'],
+    };
+}
+
+export function SandboxProcessToJSON(json: any): SandboxProcess {
+    return SandboxProcessToJSONTyped(json, false);
+}
+
+export function SandboxProcessToJSONTyped(value?: SandboxProcess | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'pid': value['pid'],
+        'parentPid': value['parentPid'],
+        'user': value['user'],
+        'cpuPercent': value['cpuPercent'],
+        'memoryMB': value['memoryMB'],
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'command': value['command'],
+        'commandId': value['commandId'],
+    };
+}
+

package/src/models/TelemetryConfig.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';
+import type { TelemetryConfigLastError } from './TelemetryConfigLastError';
+import {
+    TelemetryConfigLastErrorFromJSON,
+    TelemetryConfigLastErrorFromJSONTyped,
+    TelemetryConfigLastErrorToJSON,
+    TelemetryConfigLastErrorToJSONTyped,
+} from './TelemetryConfigLastError';
+
+/**
+ * 
+ * @export
+ * @interface TelemetryConfig
+ */
+export interface TelemetryConfig {
+    /**
+     * The OTLP/HTTP base URL. Boat posts to `<endpoint>/v1/metrics` and `<endpoint>/v1/logs`.
+     * @type {string}
+     * @memberof TelemetryConfig
+     */
+    endpoint: string;
+    /**
+     * The names of the saved headers. The values are never returned.
+     * @type {Array<string>}
+     * @memberof TelemetryConfig
+     */
+    headers: Array<string>;
+    /**
+     * The time of the last metrics export that the collector accepted.
+     * @type {Date}
+     * @memberof TelemetryConfig
+     */
+    lastExportAt: Date | null;
+    /**
+     * 
+     * @type {TelemetryConfigLastError}
+     * @memberof TelemetryConfig
+     */
+    lastError: TelemetryConfigLastError | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof TelemetryConfig
+     */
+    createdAt: Date;
+}
+
+/**
+ * Check if a given object implements the TelemetryConfig interface.
+ */
+export function instanceOfTelemetryConfig(value: object): value is TelemetryConfig {
+    if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
+    if (!('headers' in value) || value['headers'] === undefined) return false;
+    if (!('lastExportAt' in value) || value['lastExportAt'] === undefined) return false;
+    if (!('lastError' in value) || value['lastError'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function TelemetryConfigFromJSON(json: any): TelemetryConfig {
+    return TelemetryConfigFromJSONTyped(json, false);
+}
+
+export function TelemetryConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): TelemetryConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'endpoint': json['endpoint'],
+        'headers': json['headers'],
+        'lastExportAt': (json['lastExportAt'] == null ? null : new Date(json['lastExportAt'])),
+        'lastError': TelemetryConfigLastErrorFromJSON(json['lastError']),
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function TelemetryConfigToJSON(json: any): TelemetryConfig {
+    return TelemetryConfigToJSONTyped(json, false);
+}
+
+export function TelemetryConfigToJSONTyped(value?: TelemetryConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'endpoint': value['endpoint'],
+        'headers': value['headers'],
+        'lastExportAt': value['lastExportAt'] == null ? value['lastExportAt'] : value['lastExportAt'].toISOString(),
+        'lastError': TelemetryConfigLastErrorToJSON(value['lastError']),
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/TelemetryConfigLastError.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';
+/**
+ * The most recent error from the collector, for metrics or events.
+ * @export
+ * @interface TelemetryConfigLastError
+ */
+export interface TelemetryConfigLastError {
+    /**
+     * 
+     * @type {string}
+     * @memberof TelemetryConfigLastError
+     */
+    message: string;
+    /**
+     * HTTP status, or null for a network error.
+     * @type {number}
+     * @memberof TelemetryConfigLastError
+     */
+    status: number | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof TelemetryConfigLastError
+     */
+    at: Date;
+}
+
+/**
+ * Check if a given object implements the TelemetryConfigLastError interface.
+ */
+export function instanceOfTelemetryConfigLastError(value: object): value is TelemetryConfigLastError {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('at' in value) || value['at'] === undefined) return false;
+    return true;
+}
+
+export function TelemetryConfigLastErrorFromJSON(json: any): TelemetryConfigLastError {
+    return TelemetryConfigLastErrorFromJSONTyped(json, false);
+}
+
+export function TelemetryConfigLastErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): TelemetryConfigLastError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'status': json['status'],
+        'at': (new Date(json['at'])),
+    };
+}
+
+export function TelemetryConfigLastErrorToJSON(json: any): TelemetryConfigLastError {
+    return TelemetryConfigLastErrorToJSONTyped(json, false);
+}
+
+export function TelemetryConfigLastErrorToJSONTyped(value?: TelemetryConfigLastError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'status': value['status'],
+        'at': value['at'].toISOString(),
+    };
+}
+

package/src/models/TelemetryResponse.ts

@@ -0,0 +1,92 @@
+/* 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 { TelemetryConfig } from './TelemetryConfig';
+import {
+    TelemetryConfigFromJSON,
+    TelemetryConfigFromJSONTyped,
+    TelemetryConfigToJSON,
+    TelemetryConfigToJSONTyped,
+} from './TelemetryConfig';
+
+/**
+ * 
+ * @export
+ * @interface TelemetryResponse
+ */
+export interface TelemetryResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TelemetryResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof TelemetryResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {TelemetryConfig}
+     * @memberof TelemetryResponse
+     */
+    telemetry: TelemetryConfig | null;
+}
+
+/**
+ * Check if a given object implements the TelemetryResponse interface.
+ */
+export function instanceOfTelemetryResponse(value: object): value is TelemetryResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('telemetry' in value) || value['telemetry'] === undefined) return false;
+    return true;
+}
+
+export function TelemetryResponseFromJSON(json: any): TelemetryResponse {
+    return TelemetryResponseFromJSONTyped(json, false);
+}
+
+export function TelemetryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TelemetryResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'telemetry': TelemetryConfigFromJSON(json['telemetry']),
+    };
+}
+
+export function TelemetryResponseToJSON(json: any): TelemetryResponse {
+    return TelemetryResponseToJSONTyped(json, false);
+}
+
+export function TelemetryResponseToJSONTyped(value?: TelemetryResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'telemetry': TelemetryConfigToJSON(value['telemetry']),
+    };
+}
+

package/src/models/TelemetrySetRequest.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 TelemetrySetRequest
+ */
+export interface TelemetrySetRequest {
+    /**
+     * HTTPS URL on port 443 or 4318. Boat removes a trailing `/v1/metrics` or `/v1/logs`.
+     * @type {string}
+     * @memberof TelemetrySetRequest
+     */
+    endpoint: string;
+    /**
+     * Headers sent with every export, for example the vendor API key. Boat encrypts them at rest.
+     * @type {{ [key: string]: string; }}
+     * @memberof TelemetrySetRequest
+     */
+    headers?: { [key: string]: string; };
+}
+
+/**
+ * Check if a given object implements the TelemetrySetRequest interface.
+ */
+export function instanceOfTelemetrySetRequest(value: object): value is TelemetrySetRequest {
+    if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
+    return true;
+}
+
+export function TelemetrySetRequestFromJSON(json: any): TelemetrySetRequest {
+    return TelemetrySetRequestFromJSONTyped(json, false);
+}
+
+export function TelemetrySetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TelemetrySetRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'endpoint': json['endpoint'],
+        'headers': json['headers'] == null ? undefined : json['headers'],
+    };
+}
+
+export function TelemetrySetRequestToJSON(json: any): TelemetrySetRequest {
+    return TelemetrySetRequestToJSONTyped(json, false);
+}
+
+export function TelemetrySetRequestToJSONTyped(value?: TelemetrySetRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'endpoint': value['endpoint'],
+        'headers': value['headers'],
+    };
+}
+