@boatdev/sdk 1.0.0

package/src/models/ApiKeyCreatedResource.ts

@@ -0,0 +1,113 @@
+/* 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 ApiKeyCreatedResource
+ */
+export interface ApiKeyCreatedResource {
+    /**
+     * 
+     * @type {ApiKeyCreatedResourceKindEnum}
+     * @memberof ApiKeyCreatedResource
+     */
+    kind: ApiKeyCreatedResourceKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyCreatedResource
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyCreatedResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyCreatedResource
+     */
+    state: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyCreatedResource
+     */
+    createdAt: Date | null;
+}
+
+
+/**
+ * @export
+ */
+export const ApiKeyCreatedResourceKindEnum = {
+    Sandbox: 'sandbox',
+    Agent: 'agent'
+} as const;
+export type ApiKeyCreatedResourceKindEnum = typeof ApiKeyCreatedResourceKindEnum[keyof typeof ApiKeyCreatedResourceKindEnum];
+
+
+/**
+ * Check if a given object implements the ApiKeyCreatedResource interface.
+ */
+export function instanceOfApiKeyCreatedResource(value: object): value is ApiKeyCreatedResource {
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyCreatedResourceFromJSON(json: any): ApiKeyCreatedResource {
+    return ApiKeyCreatedResourceFromJSONTyped(json, false);
+}
+
+export function ApiKeyCreatedResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyCreatedResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'kind': json['kind'],
+        'id': json['id'],
+        'name': json['name'],
+        'state': json['state'],
+        'createdAt': (json['createdAt'] == null ? null : new Date(json['createdAt'])),
+    };
+}
+
+export function ApiKeyCreatedResourceToJSON(json: any): ApiKeyCreatedResource {
+    return ApiKeyCreatedResourceToJSONTyped(json, false);
+}
+
+export function ApiKeyCreatedResourceToJSONTyped(value?: ApiKeyCreatedResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'kind': value['kind'],
+        'id': value['id'],
+        'name': value['name'],
+        'state': value['state'],
+        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/ApiKeyRequestUsage.ts

@@ -0,0 +1,85 @@
+/* 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 ApiKeyRequestUsage
+ */
+export interface ApiKeyRequestUsage {
+    /**
+     * Requests authenticated with this key during the current UTC day and the previous 29 UTC days.
+     * @type {number}
+     * @memberof ApiKeyRequestUsage
+     */
+    requests: number;
+    /**
+     * 
+     * @type {ApiKeyRequestUsageWindowDaysEnum}
+     * @memberof ApiKeyRequestUsage
+     */
+    windowDays: ApiKeyRequestUsageWindowDaysEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ApiKeyRequestUsageWindowDaysEnum = {
+    NUMBER_30: 30
+} as const;
+export type ApiKeyRequestUsageWindowDaysEnum = typeof ApiKeyRequestUsageWindowDaysEnum[keyof typeof ApiKeyRequestUsageWindowDaysEnum];
+
+
+/**
+ * Check if a given object implements the ApiKeyRequestUsage interface.
+ */
+export function instanceOfApiKeyRequestUsage(value: object): value is ApiKeyRequestUsage {
+    if (!('requests' in value) || value['requests'] === undefined) return false;
+    if (!('windowDays' in value) || value['windowDays'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyRequestUsageFromJSON(json: any): ApiKeyRequestUsage {
+    return ApiKeyRequestUsageFromJSONTyped(json, false);
+}
+
+export function ApiKeyRequestUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyRequestUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'requests': json['requests'],
+        'windowDays': json['windowDays'],
+    };
+}
+
+export function ApiKeyRequestUsageToJSON(json: any): ApiKeyRequestUsage {
+    return ApiKeyRequestUsageToJSONTyped(json, false);
+}
+
+export function ApiKeyRequestUsageToJSONTyped(value?: ApiKeyRequestUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'requests': value['requests'],
+        'windowDays': value['windowDays'],
+    };
+}
+

package/src/models/ApiKeyResourceTotals.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 ApiKeyResourceTotals
+ */
+export interface ApiKeyResourceTotals {
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiKeyResourceTotals
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiKeyResourceTotals
+     */
+    sandboxes: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiKeyResourceTotals
+     */
+    agents: number;
+}
+
+/**
+ * Check if a given object implements the ApiKeyResourceTotals interface.
+ */
+export function instanceOfApiKeyResourceTotals(value: object): value is ApiKeyResourceTotals {
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('sandboxes' in value) || value['sandboxes'] === undefined) return false;
+    if (!('agents' in value) || value['agents'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyResourceTotalsFromJSON(json: any): ApiKeyResourceTotals {
+    return ApiKeyResourceTotalsFromJSONTyped(json, false);
+}
+
+export function ApiKeyResourceTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyResourceTotals {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'total': json['total'],
+        'sandboxes': json['sandboxes'],
+        'agents': json['agents'],
+    };
+}
+
+export function ApiKeyResourceTotalsToJSON(json: any): ApiKeyResourceTotals {
+    return ApiKeyResourceTotalsToJSONTyped(json, false);
+}
+
+export function ApiKeyResourceTotalsToJSONTyped(value?: ApiKeyResourceTotals | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'total': value['total'],
+        'sandboxes': value['sandboxes'],
+        'agents': value['agents'],
+    };
+}
+

package/src/models/ApiKeyRevokeResponse.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 { ApiKey } from './ApiKey';
+import {
+    ApiKeyFromJSON,
+    ApiKeyFromJSONTyped,
+    ApiKeyToJSON,
+    ApiKeyToJSONTyped,
+} from './ApiKey';
+
+/**
+ * 
+ * @export
+ * @interface ApiKeyRevokeResponse
+ */
+export interface ApiKeyRevokeResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeyRevokeResponse
+     */
+    ok: boolean;
+    /**
+     * Stable success envelope discriminator added by v1.
+     * @type {string}
+     * @memberof ApiKeyRevokeResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {Array<ApiKey>}
+     * @memberof ApiKeyRevokeResponse
+     */
+    apiKeys: Array<ApiKey>;
+}
+
+/**
+ * Check if a given object implements the ApiKeyRevokeResponse interface.
+ */
+export function instanceOfApiKeyRevokeResponse(value: object): value is ApiKeyRevokeResponse {
+    if (!('ok' in value) || value['ok'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('apiKeys' in value) || value['apiKeys'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyRevokeResponseFromJSON(json: any): ApiKeyRevokeResponse {
+    return ApiKeyRevokeResponseFromJSONTyped(json, false);
+}
+
+export function ApiKeyRevokeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyRevokeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ok': json['ok'],
+        'type': json['type'],
+        'apiKeys': ((json['apiKeys'] as Array<any>).map(ApiKeyFromJSON)),
+    };
+}
+
+export function ApiKeyRevokeResponseToJSON(json: any): ApiKeyRevokeResponse {
+    return ApiKeyRevokeResponseToJSONTyped(json, false);
+}
+
+export function ApiKeyRevokeResponseToJSONTyped(value?: ApiKeyRevokeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ok': value['ok'],
+        'type': value['type'],
+        'apiKeys': ((value['apiKeys'] as Array<any>).map(ApiKeyToJSON)),
+    };
+}
+

package/src/models/ApiKeyScope.ts

@@ -0,0 +1,105 @@
+/* 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 { ApiKeyScopeSandboxes } from './ApiKeyScopeSandboxes';
+import {
+    ApiKeyScopeSandboxesFromJSON,
+    ApiKeyScopeSandboxesFromJSONTyped,
+    ApiKeyScopeSandboxesToJSON,
+    ApiKeyScopeSandboxesToJSONTyped,
+} from './ApiKeyScopeSandboxes';
+
+/**
+ * 
+ * @export
+ * @interface ApiKeyScope
+ */
+export interface ApiKeyScope {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyScope
+     */
+    expiresAt?: Date | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ApiKeyScope
+     */
+    actions?: Array<string>;
+    /**
+     * 
+     * @type {ApiKeyScopeSandboxes}
+     * @memberof ApiKeyScope
+     */
+    sandboxes?: ApiKeyScopeSandboxes;
+    /**
+     * 
+     * @type {ApiKeyScopeSandboxes}
+     * @memberof ApiKeyScope
+     */
+    environments?: ApiKeyScopeSandboxes;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiKeyScope
+     */
+    grandfathered?: boolean;
+}
+
+/**
+ * Check if a given object implements the ApiKeyScope interface.
+ */
+export function instanceOfApiKeyScope(value: object): value is ApiKeyScope {
+    return true;
+}
+
+export function ApiKeyScopeFromJSON(json: any): ApiKeyScope {
+    return ApiKeyScopeFromJSONTyped(json, false);
+}
+
+export function ApiKeyScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyScope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+        'actions': json['actions'] == null ? undefined : json['actions'],
+        'sandboxes': json['sandboxes'] == null ? undefined : ApiKeyScopeSandboxesFromJSON(json['sandboxes']),
+        'environments': json['environments'] == null ? undefined : ApiKeyScopeSandboxesFromJSON(json['environments']),
+        'grandfathered': json['grandfathered'] == null ? undefined : json['grandfathered'],
+    };
+}
+
+export function ApiKeyScopeToJSON(json: any): ApiKeyScope {
+    return ApiKeyScopeToJSONTyped(json, false);
+}
+
+export function ApiKeyScopeToJSONTyped(value?: ApiKeyScope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'expiresAt': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'actions': value['actions'],
+        'sandboxes': ApiKeyScopeSandboxesToJSON(value['sandboxes']),
+        'environments': ApiKeyScopeSandboxesToJSON(value['environments']),
+        'grandfathered': value['grandfathered'],
+    };
+}
+

package/src/models/ApiKeyScopeResource.ts

@@ -0,0 +1,93 @@
+/* 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 ApiKeyScopeResource
+ */
+export interface ApiKeyScopeResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyScopeResource
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyScopeResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyScopeResource
+     */
+    organizationId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiKeyScopeResource
+     */
+    organizationName: string;
+}
+
+/**
+ * Check if a given object implements the ApiKeyScopeResource interface.
+ */
+export function instanceOfApiKeyScopeResource(value: object): value is ApiKeyScopeResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('organizationId' in value) || value['organizationId'] === undefined) return false;
+    if (!('organizationName' in value) || value['organizationName'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyScopeResourceFromJSON(json: any): ApiKeyScopeResource {
+    return ApiKeyScopeResourceFromJSONTyped(json, false);
+}
+
+export function ApiKeyScopeResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyScopeResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'organizationId': json['organizationId'],
+        'organizationName': json['organizationName'],
+    };
+}
+
+export function ApiKeyScopeResourceToJSON(json: any): ApiKeyScopeResource {
+    return ApiKeyScopeResourceToJSONTyped(json, false);
+}
+
+export function ApiKeyScopeResourceToJSONTyped(value?: ApiKeyScopeResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'organizationId': value['organizationId'],
+        'organizationName': value['organizationName'],
+    };
+}
+

package/src/models/ApiKeyScopeSandboxes.ts

@@ -0,0 +1,59 @@
+/* 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.
+ */
+
+/**
+ * @type ApiKeyScopeSandboxes
+ * 
+ * @export
+ */
+export type ApiKeyScopeSandboxes = Array<string> | string;
+
+export function ApiKeyScopeSandboxesFromJSON(json: any): ApiKeyScopeSandboxes {
+    return ApiKeyScopeSandboxesFromJSONTyped(json, false);
+}
+
+export function ApiKeyScopeSandboxesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyScopeSandboxes {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json === 'string' && (json === '*')) {
+        return json;
+    }
+    if (Array.isArray(json)) {
+        if (json.every(item => typeof item === 'string')) {
+            return json;
+        }
+    }
+    return {} as any;
+}
+
+export function ApiKeyScopeSandboxesToJSON(json: any): any {
+    return ApiKeyScopeSandboxesToJSONTyped(json, false);
+}
+
+export function ApiKeyScopeSandboxesToJSONTyped(value?: ApiKeyScopeSandboxes | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value === 'string' && (value === '*')) {
+        return value;
+    }
+    if (Array.isArray(value)) {
+        if (value.every(item => typeof item === 'string')) {
+            return value;
+        }
+    }
+    return {};
+}
+