@boatdev/sdk 1.0.0

package/src/models/UpdateSandboxEnvironmentRequestRepositoriesInner.ts

@@ -0,0 +1,90 @@
+/* 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 UpdateSandboxEnvironmentRequestRepositoriesInner
+ */
+export interface UpdateSandboxEnvironmentRequestRepositoriesInner {
+    /**
+     * Internal repository databaseId.
+     * @type {string}
+     * @memberof UpdateSandboxEnvironmentRequestRepositoriesInner
+     */
+    repositoryId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSandboxEnvironmentRequestRepositoriesInner
+     */
+    baseBranch?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSandboxEnvironmentRequestRepositoriesInner
+     */
+    setupScript?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSandboxEnvironmentRequestRepositoriesInner
+     */
+    setupBlocking?: boolean;
+}
+
+/**
+ * Check if a given object implements the UpdateSandboxEnvironmentRequestRepositoriesInner interface.
+ */
+export function instanceOfUpdateSandboxEnvironmentRequestRepositoriesInner(value: object): value is UpdateSandboxEnvironmentRequestRepositoriesInner {
+    if (!('repositoryId' in value) || value['repositoryId'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSON(json: any): UpdateSandboxEnvironmentRequestRepositoriesInner {
+    return UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSONTyped(json, false);
+}
+
+export function UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSandboxEnvironmentRequestRepositoriesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'repositoryId': json['repositoryId'],
+        'baseBranch': json['baseBranch'] == null ? undefined : json['baseBranch'],
+        'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
+        'setupBlocking': json['setupBlocking'] == null ? undefined : json['setupBlocking'],
+    };
+}
+
+export function UpdateSandboxEnvironmentRequestRepositoriesInnerToJSON(json: any): UpdateSandboxEnvironmentRequestRepositoriesInner {
+    return UpdateSandboxEnvironmentRequestRepositoriesInnerToJSONTyped(json, false);
+}
+
+export function UpdateSandboxEnvironmentRequestRepositoriesInnerToJSONTyped(value?: UpdateSandboxEnvironmentRequestRepositoriesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'repositoryId': value['repositoryId'],
+        'baseBranch': value['baseBranch'],
+        'setupScript': value['setupScript'],
+        'setupBlocking': value['setupBlocking'],
+    };
+}
+

package/src/models/UpdateSandboxRequest.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';
+/**
+ * 
+ * @export
+ * @interface UpdateSandboxRequest
+ */
+export interface UpdateSandboxRequest {
+    /**
+     * New display name. Empty strings are rejected; longer names are truncated to 120 chars by the backend.
+     * @type {string}
+     * @memberof UpdateSandboxRequest
+     */
+    name?: string;
+    /**
+     * New archival TTL. `null` disables auto-stop.
+     * @type {number}
+     * @memberof UpdateSandboxRequest
+     */
+    ttlSeconds?: number | null;
+    /**
+     * Rename the sandbox's stable subdomain (the `<subdomain>.on.boat.dev` label). Lowercase letters, digits and hyphens; no leading/trailing/double hyphens; cannot end in `-desktop` or `-<number>` (reserved for the desktop and hosted-port URLs). Must be globally unique. The base URL, desktop URL and every live `host <port>` URL are re-pointed to the new name with no downtime and their access tokens preserved; the old URLs stop resolving. On a transient routing error the rename is saved but returns 502 `gateway_error` - retry with the same value to finish activating routes.
+     * @type {string}
+     * @memberof UpdateSandboxRequest
+     */
+    subdomain?: string;
+}
+
+/**
+ * Check if a given object implements the UpdateSandboxRequest interface.
+ */
+export function instanceOfUpdateSandboxRequest(value: object): value is UpdateSandboxRequest {
+    return true;
+}
+
+export function UpdateSandboxRequestFromJSON(json: any): UpdateSandboxRequest {
+    return UpdateSandboxRequestFromJSONTyped(json, false);
+}
+
+export function UpdateSandboxRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSandboxRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+        'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
+    };
+}
+
+export function UpdateSandboxRequestToJSON(json: any): UpdateSandboxRequest {
+    return UpdateSandboxRequestToJSONTyped(json, false);
+}
+
+export function UpdateSandboxRequestToJSONTyped(value?: UpdateSandboxRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'ttlSeconds': value['ttlSeconds'],
+        'subdomain': value['subdomain'],
+    };
+}
+

package/src/models/UpgradeSandboxEnvironmentRequest.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Repoint active sandboxes to the environment's latest version, scrubbing any owner secrets the new version drops and hot-pushing the new config.
+ * @export
+ * @interface UpgradeSandboxEnvironmentRequest
+ */
+export interface UpgradeSandboxEnvironmentRequest {
+    /**
+     * Restrict the upgrade to these sandbox (agent) ids. Omit to upgrade all of the caller's active sandboxes that are on an older version of this environment.
+     * @type {Array<string>}
+     * @memberof UpgradeSandboxEnvironmentRequest
+     */
+    agentIds?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the UpgradeSandboxEnvironmentRequest interface.
+ */
+export function instanceOfUpgradeSandboxEnvironmentRequest(value: object): value is UpgradeSandboxEnvironmentRequest {
+    return true;
+}
+
+export function UpgradeSandboxEnvironmentRequestFromJSON(json: any): UpgradeSandboxEnvironmentRequest {
+    return UpgradeSandboxEnvironmentRequestFromJSONTyped(json, false);
+}
+
+export function UpgradeSandboxEnvironmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpgradeSandboxEnvironmentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'agentIds': json['agentIds'] == null ? undefined : json['agentIds'],
+    };
+}
+
+export function UpgradeSandboxEnvironmentRequestToJSON(json: any): UpgradeSandboxEnvironmentRequest {
+    return UpgradeSandboxEnvironmentRequestToJSONTyped(json, false);
+}
+
+export function UpgradeSandboxEnvironmentRequestToJSONTyped(value?: UpgradeSandboxEnvironmentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'agentIds': value['agentIds'],
+    };
+}
+

package/src/models/UpgradeSandboxEnvironmentResponse.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';
+/**
+ * 
+ * @export
+ * @interface UpgradeSandboxEnvironmentResponse
+ */
+export interface UpgradeSandboxEnvironmentResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpgradeSandboxEnvironmentResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof UpgradeSandboxEnvironmentResponse
+     */
+    upgraded: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof UpgradeSandboxEnvironmentResponse
+     */
+    failed: number;
+}
+
+/**
+ * Check if a given object implements the UpgradeSandboxEnvironmentResponse interface.
+ */
+export function instanceOfUpgradeSandboxEnvironmentResponse(value: object): value is UpgradeSandboxEnvironmentResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('upgraded' in value) || value['upgraded'] === undefined) return false;
+    if (!('failed' in value) || value['failed'] === undefined) return false;
+    return true;
+}
+
+export function UpgradeSandboxEnvironmentResponseFromJSON(json: any): UpgradeSandboxEnvironmentResponse {
+    return UpgradeSandboxEnvironmentResponseFromJSONTyped(json, false);
+}
+
+export function UpgradeSandboxEnvironmentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpgradeSandboxEnvironmentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'upgraded': json['upgraded'],
+        'failed': json['failed'],
+    };
+}
+
+export function UpgradeSandboxEnvironmentResponseToJSON(json: any): UpgradeSandboxEnvironmentResponse {
+    return UpgradeSandboxEnvironmentResponseToJSONTyped(json, false);
+}
+
+export function UpgradeSandboxEnvironmentResponseToJSONTyped(value?: UpgradeSandboxEnvironmentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'upgraded': value['upgraded'],
+        'failed': value['failed'],
+    };
+}
+

package/src/models/Webhook.ts

@@ -0,0 +1,119 @@
+/* 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 { WebhookEventType } from './WebhookEventType';
+import {
+    WebhookEventTypeFromJSON,
+    WebhookEventTypeFromJSONTyped,
+    WebhookEventTypeToJSON,
+    WebhookEventTypeToJSONTyped,
+} from './WebhookEventType';
+
+/**
+ * 
+ * @export
+ * @interface Webhook
+ */
+export interface Webhook {
+    /**
+     * 
+     * @type {string}
+     * @memberof Webhook
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Webhook
+     */
+    name: string | null;
+    /**
+     * Public HTTPS endpoint on port 443.
+     * @type {string}
+     * @memberof Webhook
+     */
+    url: string;
+    /**
+     * 
+     * @type {Set<WebhookEventType>}
+     * @memberof Webhook
+     */
+    events: Set<WebhookEventType>;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Webhook
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Webhook
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the Webhook interface.
+ */
+export function instanceOfWebhook(value: object): value is Webhook {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('events' in value) || value['events'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function WebhookFromJSON(json: any): Webhook {
+    return WebhookFromJSONTyped(json, false);
+}
+
+export function WebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): Webhook {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'url': json['url'],
+        'events': (new Set((json['events'] as Array<any>).map(WebhookEventTypeFromJSON))),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function WebhookToJSON(json: any): Webhook {
+    return WebhookToJSONTyped(json, false);
+}
+
+export function WebhookToJSONTyped(value?: Webhook | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'url': value['url'],
+        'events': (Array.from(value['events'] as Set<any>).map(WebhookEventTypeToJSON)),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/WebhookCreateRequest.ts

@@ -0,0 +1,91 @@
+/* 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 { WebhookEventType } from './WebhookEventType';
+import {
+    WebhookEventTypeFromJSON,
+    WebhookEventTypeFromJSONTyped,
+    WebhookEventTypeToJSON,
+    WebhookEventTypeToJSONTyped,
+} from './WebhookEventType';
+
+/**
+ * 
+ * @export
+ * @interface WebhookCreateRequest
+ */
+export interface WebhookCreateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookCreateRequest
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookCreateRequest
+     */
+    url: string;
+    /**
+     * 
+     * @type {Set<WebhookEventType>}
+     * @memberof WebhookCreateRequest
+     */
+    events: Set<WebhookEventType>;
+}
+
+/**
+ * Check if a given object implements the WebhookCreateRequest interface.
+ */
+export function instanceOfWebhookCreateRequest(value: object): value is WebhookCreateRequest {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('events' in value) || value['events'] === undefined) return false;
+    return true;
+}
+
+export function WebhookCreateRequestFromJSON(json: any): WebhookCreateRequest {
+    return WebhookCreateRequestFromJSONTyped(json, false);
+}
+
+export function WebhookCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookCreateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'url': json['url'],
+        'events': (new Set((json['events'] as Array<any>).map(WebhookEventTypeFromJSON))),
+    };
+}
+
+export function WebhookCreateRequestToJSON(json: any): WebhookCreateRequest {
+    return WebhookCreateRequestToJSONTyped(json, false);
+}
+
+export function WebhookCreateRequestToJSONTyped(value?: WebhookCreateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'url': value['url'],
+        'events': (Array.from(value['events'] as Set<any>).map(WebhookEventTypeToJSON)),
+    };
+}
+

package/src/models/WebhookDeleteResponse.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';
+/**
+ * 
+ * @export
+ * @interface WebhookDeleteResponse
+ */
+export interface WebhookDeleteResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WebhookDeleteResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof WebhookDeleteResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookDeleteResponse
+     */
+    id: string;
+}
+
+/**
+ * Check if a given object implements the WebhookDeleteResponse interface.
+ */
+export function instanceOfWebhookDeleteResponse(value: object): value is WebhookDeleteResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function WebhookDeleteResponseFromJSON(json: any): WebhookDeleteResponse {
+    return WebhookDeleteResponseFromJSONTyped(json, false);
+}
+
+export function WebhookDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookDeleteResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'id': json['id'],
+    };
+}
+
+export function WebhookDeleteResponseToJSON(json: any): WebhookDeleteResponse {
+    return WebhookDeleteResponseToJSONTyped(json, false);
+}
+
+export function WebhookDeleteResponseToJSONTyped(value?: WebhookDeleteResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'id': value['id'],
+    };
+}
+