@boatdev/sdk 1.0.0

package/dist/esm/models/WebhookSecretResponse.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 type { Webhook } 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 declare function instanceOfWebhookSecretResponse(value: object): value is WebhookSecretResponse;
+export declare function WebhookSecretResponseFromJSON(json: any): WebhookSecretResponse;
+export declare function WebhookSecretResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookSecretResponse;
+export declare function WebhookSecretResponseToJSON(json: any): WebhookSecretResponse;
+export declare function WebhookSecretResponseToJSONTyped(value?: WebhookSecretResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WebhookSecretResponse.js

@@ -0,0 +1,56 @@
+/* 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 { WebhookFromJSON, WebhookToJSON, } from './Webhook';
+/**
+ * Check if a given object implements the WebhookSecretResponse interface.
+ */
+export function instanceOfWebhookSecretResponse(value) {
+    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) {
+    return WebhookSecretResponseFromJSONTyped(json, false);
+}
+export function WebhookSecretResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'webhook': WebhookFromJSON(json['webhook']),
+        'secret': json['secret'],
+    };
+}
+export function WebhookSecretResponseToJSON(json) {
+    return WebhookSecretResponseToJSONTyped(json, false);
+}
+export function WebhookSecretResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'webhook': WebhookToJSON(value['webhook']),
+        'secret': value['secret'],
+    };
+}

package/dist/esm/models/WebhookUpdateRequest.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 type { WebhookEventType } from './WebhookEventType';
+/**
+ *
+ * @export
+ * @interface WebhookUpdateRequest
+ */
+export interface WebhookUpdateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof WebhookUpdateRequest
+     */
+    name?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof WebhookUpdateRequest
+     */
+    url?: string;
+    /**
+     *
+     * @type {Set<WebhookEventType>}
+     * @memberof WebhookUpdateRequest
+     */
+    events?: Set<WebhookEventType>;
+}
+/**
+ * Check if a given object implements the WebhookUpdateRequest interface.
+ */
+export declare function instanceOfWebhookUpdateRequest(value: object): value is WebhookUpdateRequest;
+export declare function WebhookUpdateRequestFromJSON(json: any): WebhookUpdateRequest;
+export declare function WebhookUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookUpdateRequest;
+export declare function WebhookUpdateRequestToJSON(json: any): WebhookUpdateRequest;
+export declare function WebhookUpdateRequestToJSONTyped(value?: WebhookUpdateRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WebhookUpdateRequest.js

@@ -0,0 +1,46 @@
+/* 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 { WebhookEventTypeFromJSON, WebhookEventTypeToJSON, } from './WebhookEventType';
+/**
+ * Check if a given object implements the WebhookUpdateRequest interface.
+ */
+export function instanceOfWebhookUpdateRequest(value) {
+    return true;
+}
+export function WebhookUpdateRequestFromJSON(json) {
+    return WebhookUpdateRequestFromJSONTyped(json, false);
+}
+export function WebhookUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'events': json['events'] == null ? undefined : (new Set(json['events'].map(WebhookEventTypeFromJSON))),
+    };
+}
+export function WebhookUpdateRequestToJSON(json) {
+    return WebhookUpdateRequestToJSONTyped(json, false);
+}
+export function WebhookUpdateRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'url': value['url'],
+        'events': value['events'] == null ? undefined : (Array.from(value['events']).map(WebhookEventTypeToJSON)),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,123 @@
+export * from './AddEnvironmentRepoRequest';
+export * from './ApiKey';
+export * from './ApiKeyCatalog';
+export * from './ApiKeyCatalogScopeResources';
+export * from './ApiKeyCreatedResource';
+export * from './ApiKeyRequestUsage';
+export * from './ApiKeyResourceTotals';
+export * from './ApiKeyRevokeResponse';
+export * from './ApiKeyScope';
+export * from './ApiKeyScopeResource';
+export * from './ApiKeyScopeSandboxes';
+export * from './ApiKeySecretResponse';
+export * from './ApiKeyUsageResponse';
+export * from './ApiKeysResponse';
+export * from './Command200Response';
+export * from './CommandRequest';
+export * from './CommandResponse';
+export * from './CommandStartedResponse';
+export * from './CommandStatusResponse';
+export * from './CompletionEvent';
+export * from './Conversation';
+export * from './ConversationsResponse';
+export * from './CreateSandboxEnvironmentRequest';
+export * from './CreateSandboxRequest';
+export * from './CreateSandboxResponse';
+export * from './CreateScopedApiKey503Response';
+export * from './CreateScopedApiKeyRequest';
+export * from './DataRetentionPolicyResponse';
+export * from './DataRetentionUpdateRequest';
+export * from './DeletionOperation';
+export * from './DeletionOperationResponse';
+export * from './DesktopRequest';
+export * from './DesktopResponse';
+export * from './EnvironmentItemChangeResponse';
+export * from './ErrorEnvelope';
+export * from './ErrorEnvelopeError';
+export * from './ErrorEvent';
+export * from './EventsResponse';
+export * from './FileReadResponse';
+export * from './FileWriteRequest';
+export * from './FileWriteResponse';
+export * from './ForkRequest';
+export * from './HostPortRequest';
+export * from './HostPortResponse';
+export * from './LimitsFields';
+export * from './LimitsFieldsCurrentLimits';
+export * from './LimitsFieldsStartLimits';
+export * from './LimitsFieldsStarts';
+export * from './LimitsResponse';
+export * from './MeResponse';
+export * from './MeResponseAllOfUser';
+export * from './NamedSnapshot';
+export * from './NamedSnapshotDeletedResponse';
+export * from './NamedSnapshotInfoResponse';
+export * from './NamedSnapshotListResponse';
+export * from './NamedSnapshotSaveRequest';
+export * from './NamedSnapshotSavingResponse';
+export * from './PageInfo';
+export * from './PromptEvent';
+export * from './PromptEventData';
+export * from './PromptRequest';
+export * from './PromptResponse';
+export * from './PromptRun';
+export * from './PromptRunResponse';
+export * from './RepoSelectionRequest';
+export * from './RepoSelectionResponse';
+export * from './ReposResponse';
+export * from './Repository';
+export * from './RepositoryInstallation';
+export * from './ResponseEvent';
+export * from './ResponseEventData';
+export * from './ResumeRequest';
+export * from './RotateApiKey409Response';
+export * from './Sandbox';
+export * from './SandboxActionResponse';
+export * from './SandboxEnvironment';
+export * from './SandboxEnvironmentListResponse';
+export * from './SandboxEnvironmentResponse';
+export * from './SandboxEnvironmentVersionSummary';
+export * from './SandboxEvent';
+export * from './SandboxInfoResponse';
+export * from './SandboxListResponse';
+export * from './SandboxUsageResponse';
+export * from './SecretFile';
+export * from './SecretsResponse';
+export * from './SecretsUpdateRequest';
+export * from './SelectedRepository';
+export * from './SetEnvironmentSecretFileRequest';
+export * from './SetEnvironmentVarRequest';
+export * from './SnapshotChunk';
+export * from './SnapshotDownloadResponse';
+export * from './SnapshotDownloadResponseAllOfInventory';
+export * from './SnapshotLatestResponse';
+export * from './SnapshotListResponse';
+export * from './SnapshotSummary';
+export * from './SnapshotTreeEntry';
+export * from './SnapshotTreeResponse';
+export * from './SshKeyRequest';
+export * from './SshKeyResponse';
+export * from './StartWindowUsage';
+export * from './SteerEvent';
+export * from './SteerEventData';
+export * from './SteerRequest';
+export * from './SteerResponse';
+export * from './StopRequest';
+export * from './SuccessBase';
+export * from './UnknownEvent';
+export * from './UpdateSandboxEnvironmentRequest';
+export * from './UpdateSandboxEnvironmentRequestRepositoriesInner';
+export * from './UpdateSandboxRequest';
+export * from './UpgradeSandboxEnvironmentRequest';
+export * from './UpgradeSandboxEnvironmentResponse';
+export * from './Webhook';
+export * from './WebhookCreateRequest';
+export * from './WebhookDeleteResponse';
+export * from './WebhookEvent';
+export * from './WebhookEventData';
+export * from './WebhookEventDataSandbox';
+export * from './WebhookEventType';
+export * from './WebhookListResponse';
+export * from './WebhookResponse';
+export * from './WebhookSecretResponse';
+export * from './WebhookUpdateRequest';

package/dist/esm/models/index.js

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AddEnvironmentRepoRequest';
+export * from './ApiKey';
+export * from './ApiKeyCatalog';
+export * from './ApiKeyCatalogScopeResources';
+export * from './ApiKeyCreatedResource';
+export * from './ApiKeyRequestUsage';
+export * from './ApiKeyResourceTotals';
+export * from './ApiKeyRevokeResponse';
+export * from './ApiKeyScope';
+export * from './ApiKeyScopeResource';
+export * from './ApiKeyScopeSandboxes';
+export * from './ApiKeySecretResponse';
+export * from './ApiKeyUsageResponse';
+export * from './ApiKeysResponse';
+export * from './Command200Response';
+export * from './CommandRequest';
+export * from './CommandResponse';
+export * from './CommandStartedResponse';
+export * from './CommandStatusResponse';
+export * from './CompletionEvent';
+export * from './Conversation';
+export * from './ConversationsResponse';
+export * from './CreateSandboxEnvironmentRequest';
+export * from './CreateSandboxRequest';
+export * from './CreateSandboxResponse';
+export * from './CreateScopedApiKey503Response';
+export * from './CreateScopedApiKeyRequest';
+export * from './DataRetentionPolicyResponse';
+export * from './DataRetentionUpdateRequest';
+export * from './DeletionOperation';
+export * from './DeletionOperationResponse';
+export * from './DesktopRequest';
+export * from './DesktopResponse';
+export * from './EnvironmentItemChangeResponse';
+export * from './ErrorEnvelope';
+export * from './ErrorEnvelopeError';
+export * from './ErrorEvent';
+export * from './EventsResponse';
+export * from './FileReadResponse';
+export * from './FileWriteRequest';
+export * from './FileWriteResponse';
+export * from './ForkRequest';
+export * from './HostPortRequest';
+export * from './HostPortResponse';
+export * from './LimitsFields';
+export * from './LimitsFieldsCurrentLimits';
+export * from './LimitsFieldsStartLimits';
+export * from './LimitsFieldsStarts';
+export * from './LimitsResponse';
+export * from './MeResponse';
+export * from './MeResponseAllOfUser';
+export * from './NamedSnapshot';
+export * from './NamedSnapshotDeletedResponse';
+export * from './NamedSnapshotInfoResponse';
+export * from './NamedSnapshotListResponse';
+export * from './NamedSnapshotSaveRequest';
+export * from './NamedSnapshotSavingResponse';
+export * from './PageInfo';
+export * from './PromptEvent';
+export * from './PromptEventData';
+export * from './PromptRequest';
+export * from './PromptResponse';
+export * from './PromptRun';
+export * from './PromptRunResponse';
+export * from './RepoSelectionRequest';
+export * from './RepoSelectionResponse';
+export * from './ReposResponse';
+export * from './Repository';
+export * from './RepositoryInstallation';
+export * from './ResponseEvent';
+export * from './ResponseEventData';
+export * from './ResumeRequest';
+export * from './RotateApiKey409Response';
+export * from './Sandbox';
+export * from './SandboxActionResponse';
+export * from './SandboxEnvironment';
+export * from './SandboxEnvironmentListResponse';
+export * from './SandboxEnvironmentResponse';
+export * from './SandboxEnvironmentVersionSummary';
+export * from './SandboxEvent';
+export * from './SandboxInfoResponse';
+export * from './SandboxListResponse';
+export * from './SandboxUsageResponse';
+export * from './SecretFile';
+export * from './SecretsResponse';
+export * from './SecretsUpdateRequest';
+export * from './SelectedRepository';
+export * from './SetEnvironmentSecretFileRequest';
+export * from './SetEnvironmentVarRequest';
+export * from './SnapshotChunk';
+export * from './SnapshotDownloadResponse';
+export * from './SnapshotDownloadResponseAllOfInventory';
+export * from './SnapshotLatestResponse';
+export * from './SnapshotListResponse';
+export * from './SnapshotSummary';
+export * from './SnapshotTreeEntry';
+export * from './SnapshotTreeResponse';
+export * from './SshKeyRequest';
+export * from './SshKeyResponse';
+export * from './StartWindowUsage';
+export * from './SteerEvent';
+export * from './SteerEventData';
+export * from './SteerRequest';
+export * from './SteerResponse';
+export * from './StopRequest';
+export * from './SuccessBase';
+export * from './UnknownEvent';
+export * from './UpdateSandboxEnvironmentRequest';
+export * from './UpdateSandboxEnvironmentRequestRepositoriesInner';
+export * from './UpdateSandboxRequest';
+export * from './UpgradeSandboxEnvironmentRequest';
+export * from './UpgradeSandboxEnvironmentResponse';
+export * from './Webhook';
+export * from './WebhookCreateRequest';
+export * from './WebhookDeleteResponse';
+export * from './WebhookEvent';
+export * from './WebhookEventData';
+export * from './WebhookEventDataSandbox';
+export * from './WebhookEventType';
+export * from './WebhookListResponse';
+export * from './WebhookResponse';
+export * from './WebhookSecretResponse';
+export * from './WebhookUpdateRequest';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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 declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}