@boatdev/sdk 1.9.3 → 1.9.5

package/src/models/FileUrlRequest.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 FileUrlRequest
+ */
+export interface FileUrlRequest {
+    /**
+     * Absolute path, or path relative to the sandbox work directory (/home/user). It must resolve under /home/user or /tmp.
+     * @type {string}
+     * @memberof FileUrlRequest
+     */
+    path: string;
+    /**
+     * How long the URL stays valid.
+     * @type {number}
+     * @memberof FileUrlRequest
+     */
+    ttlSeconds?: number;
+}
+
+/**
+ * Check if a given object implements the FileUrlRequest interface.
+ */
+export function instanceOfFileUrlRequest(value: object): value is FileUrlRequest {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    return true;
+}
+
+export function FileUrlRequestFromJSON(json: any): FileUrlRequest {
+    return FileUrlRequestFromJSONTyped(json, false);
+}
+
+export function FileUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+
+export function FileUrlRequestToJSON(json: any): FileUrlRequest {
+    return FileUrlRequestToJSONTyped(json, false);
+}
+
+export function FileUrlRequestToJSONTyped(value?: FileUrlRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}
+

package/src/models/FileUrlResponse.ts

@@ -0,0 +1,131 @@
+/* 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 FileUrlResponse
+ */
+export interface FileUrlResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof FileUrlResponse
+     */
+    ok: boolean;
+    /**
+     * 
+     * @type {FileUrlResponseTypeEnum}
+     * @memberof FileUrlResponse
+     */
+    type: FileUrlResponseTypeEnum;
+    /**
+     * The signed URL. Send the request straight to it; it needs no Authorization header.
+     * @type {string}
+     * @memberof FileUrlResponse
+     */
+    url: string;
+    /**
+     * GET downloads the file. PUT uploads the request body as the file.
+     * @type {FileUrlResponseMethodEnum}
+     * @memberof FileUrlResponse
+     */
+    method: FileUrlResponseMethodEnum;
+    /**
+     * The canonical path the URL is bound to.
+     * @type {string}
+     * @memberof FileUrlResponse
+     */
+    path: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof FileUrlResponse
+     */
+    expiresAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const FileUrlResponseTypeEnum = {
+    FileDownloadUrl: 'file.download_url',
+    FileUploadUrl: 'file.upload_url'
+} as const;
+export type FileUrlResponseTypeEnum = typeof FileUrlResponseTypeEnum[keyof typeof FileUrlResponseTypeEnum];
+
+/**
+ * @export
+ */
+export const FileUrlResponseMethodEnum = {
+    Get: 'GET',
+    Put: 'PUT'
+} as const;
+export type FileUrlResponseMethodEnum = typeof FileUrlResponseMethodEnum[keyof typeof FileUrlResponseMethodEnum];
+
+
+/**
+ * Check if a given object implements the FileUrlResponse interface.
+ */
+export function instanceOfFileUrlResponse(value: object): value is FileUrlResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('method' in value) || value['method'] === undefined) return false;
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    return true;
+}
+
+export function FileUrlResponseFromJSON(json: any): FileUrlResponse {
+    return FileUrlResponseFromJSONTyped(json, false);
+}
+
+export function FileUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'url': json['url'],
+        'method': json['method'],
+        'path': json['path'],
+        'expiresAt': (new Date(json['expiresAt'])),
+    };
+}
+
+export function FileUrlResponseToJSON(json: any): FileUrlResponse {
+    return FileUrlResponseToJSONTyped(json, false);
+}
+
+export function FileUrlResponseToJSONTyped(value?: FileUrlResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'url': value['url'],
+        'method': value['method'],
+        'path': value['path'],
+        'expiresAt': value['expiresAt'].toISOString(),
+    };
+}
+

package/src/models/HostPortRequest.ts

@@ -31,6 +31,12 @@ export interface HostPortRequest {
      * @memberof HostPortRequest
      */
     _public?: boolean;
+    /**
+     * Set when the service listens on localhost (`127.0.0.1` or `::1`) only. The sandbox relays the URL to it. Leave unset for a service bound to `0.0.0.0`. Each call sets the value again.
+     * @type {boolean}
+     * @memberof HostPortRequest
+     */
+    localhost?: boolean;
     /**
      * Display title for the hosted port.
      * @type {string}
@@ -59,6 +65,7 @@ export function HostPortRequestFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'port': json['port'],
         '_public': json['public'] == null ? undefined : json['public'],
+        'localhost': json['localhost'] == null ? undefined : json['localhost'],
         'title': json['title'] == null ? undefined : json['title'],
     };
 }
@@ -76,6 +83,7 @@ export function HostPortRequestToJSONTyped(value?: HostPortRequest | null, ignor
         
         'port': value['port'],
         'public': value['_public'],
+        'localhost': value['localhost'],
         'title': value['title'],
     };
 }

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/SnapshotSummary.ts

@@ -91,6 +91,12 @@ export interface SnapshotSummary {
      * @memberof SnapshotSummary
      */
     contentFileCount?: number | null;
+    /**
+     * `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, named snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
+     * @type {SnapshotSummaryOriginEnum}
+     * @memberof SnapshotSummary
+     */
+    origin?: SnapshotSummaryOriginEnum;
 }
 
 
@@ -111,6 +117,15 @@ export const SnapshotSummaryKindEnum = {
 } as const;
 export type SnapshotSummaryKindEnum = typeof SnapshotSummaryKindEnum[keyof typeof SnapshotSummaryKindEnum];
 
+/**
+ * @export
+ */
+export const SnapshotSummaryOriginEnum = {
+    Captured: 'captured',
+    Template: 'template'
+} as const;
+export type SnapshotSummaryOriginEnum = typeof SnapshotSummaryOriginEnum[keyof typeof SnapshotSummaryOriginEnum];
+
 
 /**
  * Check if a given object implements the SnapshotSummary interface.
@@ -148,6 +163,7 @@ export function SnapshotSummaryFromJSONTyped(json: any, ignoreDiscriminator: boo
         'fileCount': json['fileCount'],
         'contentSizeBytes': json['contentSizeBytes'] == null ? undefined : json['contentSizeBytes'],
         'contentFileCount': json['contentFileCount'] == null ? undefined : json['contentFileCount'],
+        'origin': json['origin'] == null ? undefined : json['origin'],
     };
 }
 
@@ -174,6 +190,7 @@ export function SnapshotSummaryToJSONTyped(value?: SnapshotSummary | null, ignor
         'fileCount': value['fileCount'],
         'contentSizeBytes': value['contentSizeBytes'],
         'contentFileCount': value['contentFileCount'],
+        'origin': value['origin'],
     };
 }
 

package/src/models/index.ts

@@ -50,6 +50,8 @@ export * from './ErrorEnvelopeError';
 export * from './ErrorEvent';
 export * from './EventsResponse';
 export * from './FileReadResponse';
+export * from './FileUrlRequest';
+export * from './FileUrlResponse';
 export * from './FileWriteRequest';
 export * from './FileWriteResponse';
 export * from './ForkRequest';