@boatdev/sdk 1.0.0

package/src/models/SecretFile.ts

@@ -0,0 +1,75 @@
+/* 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 SecretFile
+ */
+export interface SecretFile {
+    /**
+     * 
+     * @type {string}
+     * @memberof SecretFile
+     */
+    path: string;
+    /**
+     * Secret file contents. Treat as sensitive.
+     * @type {string}
+     * @memberof SecretFile
+     */
+    contents: string;
+}
+
+/**
+ * Check if a given object implements the SecretFile interface.
+ */
+export function instanceOfSecretFile(value: object): value is SecretFile {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('contents' in value) || value['contents'] === undefined) return false;
+    return true;
+}
+
+export function SecretFileFromJSON(json: any): SecretFile {
+    return SecretFileFromJSONTyped(json, false);
+}
+
+export function SecretFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretFile {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'contents': json['contents'],
+    };
+}
+
+export function SecretFileToJSON(json: any): SecretFile {
+    return SecretFileToJSONTyped(json, false);
+}
+
+export function SecretFileToJSONTyped(value?: SecretFile | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'contents': value['contents'],
+    };
+}
+

package/src/models/SecretsResponse.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';
+import type { SecretFile } from './SecretFile';
+import {
+    SecretFileFromJSON,
+    SecretFileFromJSONTyped,
+    SecretFileToJSON,
+    SecretFileToJSONTyped,
+} from './SecretFile';
+
+/**
+ * 
+ * @export
+ * @interface SecretsResponse
+ */
+export interface SecretsResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SecretsResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof SecretsResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SecretsResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecretsResponse
+     */
+    environmentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecretsResponse
+     */
+    envContents: string;
+    /**
+     * 
+     * @type {Array<SecretFile>}
+     * @memberof SecretsResponse
+     */
+    secretFiles: Array<SecretFile>;
+    /**
+     * Present on update; counts how many active sandboxes received the new environment.
+     * @type {{ [key: string]: any; }}
+     * @memberof SecretsResponse
+     */
+    pushed?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the SecretsResponse interface.
+ */
+export function instanceOfSecretsResponse(value: object): value is SecretsResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('environmentId' in value) || value['environmentId'] === undefined) return false;
+    if (!('envContents' in value) || value['envContents'] === undefined) return false;
+    if (!('secretFiles' in value) || value['secretFiles'] === undefined) return false;
+    return true;
+}
+
+export function SecretsResponseFromJSON(json: any): SecretsResponse {
+    return SecretsResponseFromJSONTyped(json, false);
+}
+
+export function SecretsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'] == null ? undefined : json['success'],
+        'environmentId': json['environmentId'],
+        'envContents': json['envContents'],
+        'secretFiles': ((json['secretFiles'] as Array<any>).map(SecretFileFromJSON)),
+        'pushed': json['pushed'] == null ? undefined : json['pushed'],
+    };
+}
+
+export function SecretsResponseToJSON(json: any): SecretsResponse {
+    return SecretsResponseToJSONTyped(json, false);
+}
+
+export function SecretsResponseToJSONTyped(value?: SecretsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'environmentId': value['environmentId'],
+        'envContents': value['envContents'],
+        'secretFiles': ((value['secretFiles'] as Array<any>).map(SecretFileToJSON)),
+        'pushed': value['pushed'],
+    };
+}
+

package/src/models/SecretsUpdateRequest.ts

@@ -0,0 +1,81 @@
+/* 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 { SecretFile } from './SecretFile';
+import {
+    SecretFileFromJSON,
+    SecretFileFromJSONTyped,
+    SecretFileToJSON,
+    SecretFileToJSONTyped,
+} from './SecretFile';
+
+/**
+ * Full replacement for the sandbox secret setup. Omitted `envContents` or `secretFiles` are treated as empty values, and successful updates are pushed to active sandboxes.
+ * @export
+ * @interface SecretsUpdateRequest
+ */
+export interface SecretsUpdateRequest {
+    /**
+     * Full .env-style content to sync into sandboxes. Send the complete desired file contents, not a patch.
+     * @type {string}
+     * @memberof SecretsUpdateRequest
+     */
+    envContents?: string;
+    /**
+     * Full list of secret files to keep configured. Send existing files again if they should remain.
+     * @type {Array<SecretFile>}
+     * @memberof SecretsUpdateRequest
+     */
+    secretFiles?: Array<SecretFile>;
+}
+
+/**
+ * Check if a given object implements the SecretsUpdateRequest interface.
+ */
+export function instanceOfSecretsUpdateRequest(value: object): value is SecretsUpdateRequest {
+    return true;
+}
+
+export function SecretsUpdateRequestFromJSON(json: any): SecretsUpdateRequest {
+    return SecretsUpdateRequestFromJSONTyped(json, false);
+}
+
+export function SecretsUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretsUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'envContents': json['envContents'] == null ? undefined : json['envContents'],
+        'secretFiles': json['secretFiles'] == null ? undefined : ((json['secretFiles'] as Array<any>).map(SecretFileFromJSON)),
+    };
+}
+
+export function SecretsUpdateRequestToJSON(json: any): SecretsUpdateRequest {
+    return SecretsUpdateRequestToJSONTyped(json, false);
+}
+
+export function SecretsUpdateRequestToJSONTyped(value?: SecretsUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'envContents': value['envContents'],
+        'secretFiles': value['secretFiles'] == null ? undefined : ((value['secretFiles'] as Array<any>).map(SecretFileToJSON)),
+    };
+}
+

package/src/models/SelectedRepository.ts

@@ -0,0 +1,145 @@
+/* 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 SelectedRepository
+ */
+export interface SelectedRepository {
+    /**
+     * GitHub repository id.
+     * @type {number}
+     * @memberof SelectedRepository
+     */
+    id?: number;
+    /**
+     * Internal repository id used when selecting repositories.
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    databaseId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    fullName?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SelectedRepository
+     */
+    _private?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    permissions?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SelectedRepository
+     */
+    pushedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    baseBranch?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    setupRoutineId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelectedRepository
+     */
+    setupScript?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SelectedRepository
+     */
+    setupBlocking?: boolean;
+}
+
+/**
+ * Check if a given object implements the SelectedRepository interface.
+ */
+export function instanceOfSelectedRepository(value: object): value is SelectedRepository {
+    return true;
+}
+
+export function SelectedRepositoryFromJSON(json: any): SelectedRepository {
+    return SelectedRepositoryFromJSONTyped(json, false);
+}
+
+export function SelectedRepositoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SelectedRepository {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'databaseId': json['databaseId'] == null ? undefined : json['databaseId'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        '_private': json['private'] == null ? undefined : json['private'],
+        'permissions': json['permissions'] == null ? undefined : json['permissions'],
+        'pushedAt': json['pushedAt'] == null ? undefined : (new Date(json['pushedAt'])),
+        'baseBranch': json['baseBranch'] == null ? undefined : json['baseBranch'],
+        'setupRoutineId': json['setupRoutineId'] == null ? undefined : json['setupRoutineId'],
+        'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
+        'setupBlocking': json['setupBlocking'] == null ? undefined : json['setupBlocking'],
+    };
+}
+
+export function SelectedRepositoryToJSON(json: any): SelectedRepository {
+    return SelectedRepositoryToJSONTyped(json, false);
+}
+
+export function SelectedRepositoryToJSONTyped(value?: SelectedRepository | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'databaseId': value['databaseId'],
+        'name': value['name'],
+        'fullName': value['fullName'],
+        'private': value['_private'],
+        'permissions': value['permissions'],
+        'pushedAt': value['pushedAt'] == null ? value['pushedAt'] : value['pushedAt'].toISOString(),
+        'baseBranch': value['baseBranch'],
+        'setupRoutineId': value['setupRoutineId'],
+        'setupScript': value['setupScript'],
+        'setupBlocking': value['setupBlocking'],
+    };
+}
+

package/src/models/SetEnvironmentSecretFileRequest.ts

@@ -0,0 +1,75 @@
+/* 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 SetEnvironmentSecretFileRequest
+ */
+export interface SetEnvironmentSecretFileRequest {
+    /**
+     * In-sandbox path relative to the workspace, e.g. `.env` or `repo/.env`.
+     * @type {string}
+     * @memberof SetEnvironmentSecretFileRequest
+     */
+    path: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SetEnvironmentSecretFileRequest
+     */
+    contents: string;
+}
+
+/**
+ * Check if a given object implements the SetEnvironmentSecretFileRequest interface.
+ */
+export function instanceOfSetEnvironmentSecretFileRequest(value: object): value is SetEnvironmentSecretFileRequest {
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('contents' in value) || value['contents'] === undefined) return false;
+    return true;
+}
+
+export function SetEnvironmentSecretFileRequestFromJSON(json: any): SetEnvironmentSecretFileRequest {
+    return SetEnvironmentSecretFileRequestFromJSONTyped(json, false);
+}
+
+export function SetEnvironmentSecretFileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetEnvironmentSecretFileRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'contents': json['contents'],
+    };
+}
+
+export function SetEnvironmentSecretFileRequestToJSON(json: any): SetEnvironmentSecretFileRequest {
+    return SetEnvironmentSecretFileRequestToJSONTyped(json, false);
+}
+
+export function SetEnvironmentSecretFileRequestToJSONTyped(value?: SetEnvironmentSecretFileRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'contents': value['contents'],
+    };
+}
+

package/src/models/SetEnvironmentVarRequest.ts

@@ -0,0 +1,66 @@
+/* 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 SetEnvironmentVarRequest
+ */
+export interface SetEnvironmentVarRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SetEnvironmentVarRequest
+     */
+    value: string;
+}
+
+/**
+ * Check if a given object implements the SetEnvironmentVarRequest interface.
+ */
+export function instanceOfSetEnvironmentVarRequest(value: object): value is SetEnvironmentVarRequest {
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function SetEnvironmentVarRequestFromJSON(json: any): SetEnvironmentVarRequest {
+    return SetEnvironmentVarRequestFromJSONTyped(json, false);
+}
+
+export function SetEnvironmentVarRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetEnvironmentVarRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'value': json['value'],
+    };
+}
+
+export function SetEnvironmentVarRequestToJSON(json: any): SetEnvironmentVarRequest {
+    return SetEnvironmentVarRequestToJSONTyped(json, false);
+}
+
+export function SetEnvironmentVarRequestToJSONTyped(value?: SetEnvironmentVarRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'value': value['value'],
+    };
+}
+

package/src/models/SnapshotChunk.ts

@@ -0,0 +1,120 @@
+/* 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 SnapshotChunk
+ */
+export interface SnapshotChunk {
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotChunk
+     */
+    snapshotId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapshotChunk
+     */
+    generation: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapshotChunk
+     */
+    chunkIndex: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotChunk
+     */
+    r2Key: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapshotChunk
+     */
+    sizeBytes: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapshotChunk
+     */
+    sha256: string;
+    /**
+     * Time-limited download URL (see `expiresInSeconds`).
+     * @type {string}
+     * @memberof SnapshotChunk
+     */
+    signedUrl: string;
+}
+
+/**
+ * Check if a given object implements the SnapshotChunk interface.
+ */
+export function instanceOfSnapshotChunk(value: object): value is SnapshotChunk {
+    if (!('snapshotId' in value) || value['snapshotId'] === undefined) return false;
+    if (!('generation' in value) || value['generation'] === undefined) return false;
+    if (!('chunkIndex' in value) || value['chunkIndex'] === undefined) return false;
+    if (!('r2Key' in value) || value['r2Key'] === undefined) return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined) return false;
+    if (!('sha256' in value) || value['sha256'] === undefined) return false;
+    if (!('signedUrl' in value) || value['signedUrl'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotChunkFromJSON(json: any): SnapshotChunk {
+    return SnapshotChunkFromJSONTyped(json, false);
+}
+
+export function SnapshotChunkFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotChunk {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'snapshotId': json['snapshotId'],
+        'generation': json['generation'],
+        'chunkIndex': json['chunkIndex'],
+        'r2Key': json['r2Key'],
+        'sizeBytes': json['sizeBytes'],
+        'sha256': json['sha256'],
+        'signedUrl': json['signedUrl'],
+    };
+}
+
+export function SnapshotChunkToJSON(json: any): SnapshotChunk {
+    return SnapshotChunkToJSONTyped(json, false);
+}
+
+export function SnapshotChunkToJSONTyped(value?: SnapshotChunk | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'snapshotId': value['snapshotId'],
+        'generation': value['generation'],
+        'chunkIndex': value['chunkIndex'],
+        'r2Key': value['r2Key'],
+        'sizeBytes': value['sizeBytes'],
+        'sha256': value['sha256'],
+        'signedUrl': value['signedUrl'],
+    };
+}
+