@boatdev/sdk 1.0.0

package/src/models/WebhookEvent.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 { WebhookEventType } from './WebhookEventType';
+import {
+    WebhookEventTypeFromJSON,
+    WebhookEventTypeFromJSONTyped,
+    WebhookEventTypeToJSON,
+    WebhookEventTypeToJSONTyped,
+} from './WebhookEventType';
+import type { WebhookEventData } from './WebhookEventData';
+import {
+    WebhookEventDataFromJSON,
+    WebhookEventDataFromJSONTyped,
+    WebhookEventDataToJSON,
+    WebhookEventDataToJSONTyped,
+} from './WebhookEventData';
+
+/**
+ * JSON body sent to the registered endpoint. This is not a v1 success envelope.
+ * @export
+ * @interface WebhookEvent
+ */
+export interface WebhookEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {WebhookEventType}
+     * @memberof WebhookEvent
+     */
+    type: WebhookEventType;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WebhookEvent
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {WebhookEventData}
+     * @memberof WebhookEvent
+     */
+    data: WebhookEventData;
+}
+
+
+
+/**
+ * Check if a given object implements the WebhookEvent interface.
+ */
+export function instanceOfWebhookEvent(value: object): value is WebhookEvent {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function WebhookEventFromJSON(json: any): WebhookEvent {
+    return WebhookEventFromJSONTyped(json, false);
+}
+
+export function WebhookEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': WebhookEventTypeFromJSON(json['type']),
+        'createdAt': (new Date(json['createdAt'])),
+        'data': WebhookEventDataFromJSON(json['data']),
+    };
+}
+
+export function WebhookEventToJSON(json: any): WebhookEvent {
+    return WebhookEventToJSONTyped(json, false);
+}
+
+export function WebhookEventToJSONTyped(value?: WebhookEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': WebhookEventTypeToJSON(value['type']),
+        'createdAt': value['createdAt'].toISOString(),
+        'data': WebhookEventDataToJSON(value['data']),
+    };
+}
+

package/src/models/WebhookEventData.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 { WebhookEventDataSandbox } from './WebhookEventDataSandbox';
+import {
+    WebhookEventDataSandboxFromJSON,
+    WebhookEventDataSandboxFromJSONTyped,
+    WebhookEventDataSandboxToJSON,
+    WebhookEventDataSandboxToJSONTyped,
+} from './WebhookEventDataSandbox';
+
+/**
+ * 
+ * @export
+ * @interface WebhookEventData
+ */
+export interface WebhookEventData {
+    /**
+     * 
+     * @type {WebhookEventDataSandbox}
+     * @memberof WebhookEventData
+     */
+    sandbox: WebhookEventDataSandbox;
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookEventData
+     */
+    previousState: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookEventData
+     */
+    state: string;
+}
+
+/**
+ * Check if a given object implements the WebhookEventData interface.
+ */
+export function instanceOfWebhookEventData(value: object): value is WebhookEventData {
+    if (!('sandbox' in value) || value['sandbox'] === undefined) return false;
+    if (!('previousState' in value) || value['previousState'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    return true;
+}
+
+export function WebhookEventDataFromJSON(json: any): WebhookEventData {
+    return WebhookEventDataFromJSONTyped(json, false);
+}
+
+export function WebhookEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandbox': WebhookEventDataSandboxFromJSON(json['sandbox']),
+        'previousState': json['previousState'],
+        'state': json['state'],
+    };
+}
+
+export function WebhookEventDataToJSON(json: any): WebhookEventData {
+    return WebhookEventDataToJSONTyped(json, false);
+}
+
+export function WebhookEventDataToJSONTyped(value?: WebhookEventData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandbox': WebhookEventDataSandboxToJSON(value['sandbox']),
+        'previousState': value['previousState'],
+        'state': value['state'],
+    };
+}
+

package/src/models/WebhookEventDataSandbox.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 WebhookEventDataSandbox
+ */
+export interface WebhookEventDataSandbox {
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookEventDataSandbox
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WebhookEventDataSandbox
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the WebhookEventDataSandbox interface.
+ */
+export function instanceOfWebhookEventDataSandbox(value: object): value is WebhookEventDataSandbox {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function WebhookEventDataSandboxFromJSON(json: any): WebhookEventDataSandbox {
+    return WebhookEventDataSandboxFromJSONTyped(json, false);
+}
+
+export function WebhookEventDataSandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventDataSandbox {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+
+export function WebhookEventDataSandboxToJSON(json: any): WebhookEventDataSandbox {
+    return WebhookEventDataSandboxToJSONTyped(json, false);
+}
+
+export function WebhookEventDataSandboxToJSONTyped(value?: WebhookEventDataSandbox | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+    };
+}
+

package/src/models/WebhookEventType.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const WebhookEventType = {
+    SandboxReady: 'sandbox.ready',
+    SandboxError: 'sandbox.error',
+    SandboxArchived: 'sandbox.archived',
+    SandboxHydrated: 'sandbox.hydrated'
+} as const;
+export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
+
+
+export function instanceOfWebhookEventType(value: any): boolean {
+    for (const key in WebhookEventType) {
+        if (Object.prototype.hasOwnProperty.call(WebhookEventType, key)) {
+            if (WebhookEventType[key as keyof typeof WebhookEventType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function WebhookEventTypeFromJSON(json: any): WebhookEventType {
+    return WebhookEventTypeFromJSONTyped(json, false);
+}
+
+export function WebhookEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventType {
+    return json as WebhookEventType;
+}
+
+export function WebhookEventTypeToJSON(value?: WebhookEventType | null): any {
+    return value as any;
+}
+
+export function WebhookEventTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WebhookEventType {
+    return value as WebhookEventType;
+}
+

package/src/models/WebhookListResponse.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 { Webhook } from './Webhook';
+import {
+    WebhookFromJSON,
+    WebhookFromJSONTyped,
+    WebhookToJSON,
+    WebhookToJSONTyped,
+} from './Webhook';
+
+/**
+ * 
+ * @export
+ * @interface WebhookListResponse
+ */
+export interface WebhookListResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WebhookListResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof WebhookListResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Array<Webhook>}
+     * @memberof WebhookListResponse
+     */
+    webhooks: Array<Webhook>;
+}
+
+/**
+ * Check if a given object implements the WebhookListResponse interface.
+ */
+export function instanceOfWebhookListResponse(value: object): value is WebhookListResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('webhooks' in value) || value['webhooks'] === undefined) return false;
+    return true;
+}
+
+export function WebhookListResponseFromJSON(json: any): WebhookListResponse {
+    return WebhookListResponseFromJSONTyped(json, false);
+}
+
+export function WebhookListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'webhooks': ((json['webhooks'] as Array<any>).map(WebhookFromJSON)),
+    };
+}
+
+export function WebhookListResponseToJSON(json: any): WebhookListResponse {
+    return WebhookListResponseToJSONTyped(json, false);
+}
+
+export function WebhookListResponseToJSONTyped(value?: WebhookListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'webhooks': ((value['webhooks'] as Array<any>).map(WebhookToJSON)),
+    };
+}
+

package/src/models/WebhookResponse.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 { Webhook } from './Webhook';
+import {
+    WebhookFromJSON,
+    WebhookFromJSONTyped,
+    WebhookToJSON,
+    WebhookToJSONTyped,
+} from './Webhook';
+
+/**
+ * 
+ * @export
+ * @interface WebhookResponse
+ */
+export interface WebhookResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WebhookResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof WebhookResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Webhook}
+     * @memberof WebhookResponse
+     */
+    webhook: Webhook;
+}
+
+/**
+ * Check if a given object implements the WebhookResponse interface.
+ */
+export function instanceOfWebhookResponse(value: object): value is WebhookResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('webhook' in value) || value['webhook'] === undefined) return false;
+    return true;
+}
+
+export function WebhookResponseFromJSON(json: any): WebhookResponse {
+    return WebhookResponseFromJSONTyped(json, false);
+}
+
+export function WebhookResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'webhook': WebhookFromJSON(json['webhook']),
+    };
+}
+
+export function WebhookResponseToJSON(json: any): WebhookResponse {
+    return WebhookResponseToJSONTyped(json, false);
+}
+
+export function WebhookResponseToJSONTyped(value?: WebhookResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'webhook': WebhookToJSON(value['webhook']),
+    };
+}
+

package/src/models/WebhookSecretResponse.ts

@@ -0,0 +1,101 @@
+/* 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 { Webhook } from './Webhook';
+import {
+    WebhookFromJSON,
+    WebhookFromJSONTyped,
+    WebhookToJSON,
+    WebhookToJSONTyped,
+} from './Webhook';
+
+/**
+ * 
+ * @export
+ * @interface WebhookSecretResponse
+ */
+export interface WebhookSecretResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WebhookSecretResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof WebhookSecretResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Webhook}
+     * @memberof WebhookSecretResponse
+     */
+    webhook: Webhook;
+    /**
+     * Signing secret returned only when created or rotated.
+     * @type {string}
+     * @memberof WebhookSecretResponse
+     */
+    secret: string;
+}
+
+/**
+ * Check if a given object implements the WebhookSecretResponse interface.
+ */
+export function instanceOfWebhookSecretResponse(value: object): value is WebhookSecretResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('webhook' in value) || value['webhook'] === undefined) return false;
+    if (!('secret' in value) || value['secret'] === undefined) return false;
+    return true;
+}
+
+export function WebhookSecretResponseFromJSON(json: any): WebhookSecretResponse {
+    return WebhookSecretResponseFromJSONTyped(json, false);
+}
+
+export function WebhookSecretResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookSecretResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'webhook': WebhookFromJSON(json['webhook']),
+        'secret': json['secret'],
+    };
+}
+
+export function WebhookSecretResponseToJSON(json: any): WebhookSecretResponse {
+    return WebhookSecretResponseToJSONTyped(json, false);
+}
+
+export function WebhookSecretResponseToJSONTyped(value?: WebhookSecretResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'webhook': WebhookToJSON(value['webhook']),
+        'secret': value['secret'],
+    };
+}
+