@hatchet-dev/typescript-sdk 0.16.0-alpha.4 → 0.17.0

package/clients/rest/generated/cloud/data-contracts.d.ts

@@ -1,468 +0,0 @@
-export interface APICloudMetadata {
-    /**
-     * whether the tenant can be billed
-     * @example true
-     */
-    canBill?: boolean;
-    /**
-     * whether the tenant can link to GitHub
-     * @example true
-     */
-    canLinkGithub?: boolean;
-    /**
-     * whether metrics are enabled for the tenant
-     * @example true
-     */
-    metricsEnabled?: boolean;
-}
-export interface APIErrors {
-    errors: APIError[];
-}
-export interface APIError {
-    /**
-     * a custom Hatchet error code
-     * @format uint64
-     * @example 1400
-     */
-    code?: number;
-    /**
-     * the field that this error is associated with, if applicable
-     * @example "name"
-     */
-    field?: string;
-    /**
-     * a description for this error
-     * @example "A descriptive error message"
-     */
-    description: string;
-    /**
-     * a link to the documentation for this error, if it exists
-     * @example "github.com/hatchet-dev/hatchet"
-     */
-    docs_link?: string;
-}
-/** @example {"next_page":3,"num_pages":10,"current_page":2} */
-export interface PaginationResponse {
-    /**
-     * the current page
-     * @format int64
-     * @example 2
-     */
-    current_page?: number;
-    /**
-     * the next page
-     * @format int64
-     * @example 3
-     */
-    next_page?: number;
-    /**
-     * the total number of pages for listing
-     * @format int64
-     * @example 10
-     */
-    num_pages?: number;
-}
-export interface APIResourceMeta {
-    /**
-     * the id of this resource, in UUID format
-     * @format uuid
-     * @minLength 36
-     * @maxLength 36
-     * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
-     */
-    id: string;
-    /**
-     * the time that this resource was created
-     * @format date-time
-     * @example "2022-12-13T20:06:48.888Z"
-     */
-    createdAt: string;
-    /**
-     * the time that this resource was last updated
-     * @format date-time
-     * @example "2022-12-13T20:06:48.888Z"
-     */
-    updatedAt: string;
-}
-export interface GithubBranch {
-    branch_name: string;
-    is_default: boolean;
-}
-export interface GithubRepo {
-    repo_owner: string;
-    repo_name: string;
-}
-export interface GithubAppInstallation {
-    metadata: APIResourceMeta;
-    installation_settings_url: string;
-    account_name: string;
-    account_avatar_url: string;
-}
-export interface ListGithubAppInstallationsResponse {
-    pagination: PaginationResponse;
-    rows: GithubAppInstallation[];
-}
-export type ListGithubReposResponse = GithubRepo[];
-export type ListGithubBranchesResponse = GithubBranch[];
-export interface ManagedWorker {
-    metadata: APIResourceMeta;
-    name: string;
-    buildConfig: ManagedWorkerBuildConfig;
-    isIac: boolean;
-    /** A map of environment variables to set for the worker */
-    envVars: Record<string, string>;
-    runtimeConfigs?: ManagedWorkerRuntimeConfig[];
-}
-export interface ManagedWorkerList {
-    rows?: ManagedWorker[];
-    pagination?: PaginationResponse;
-}
-export interface ManagedWorkerBuildConfig {
-    metadata: APIResourceMeta;
-    /**
-     * @format uuid
-     * @minLength 36
-     * @maxLength 36
-     */
-    githubInstallationId: string;
-    githubRepository: GithubRepo;
-    githubRepositoryBranch: string;
-    steps?: BuildStep[];
-}
-export interface BuildStep {
-    metadata: APIResourceMeta;
-    /** The relative path to the build directory */
-    buildDir: string;
-    /** The relative path from the build dir to the Dockerfile */
-    dockerfilePath: string;
-}
-export interface ManagedWorkerRuntimeConfig {
-    metadata: APIResourceMeta;
-    numReplicas: number;
-    /** The kind of CPU to use for the worker */
-    cpuKind: string;
-    /** The number of CPUs to use for the worker */
-    cpus: number;
-    /** The amount of memory in MB to use for the worker */
-    memoryMb: number;
-    /** The region that the worker is deployed to */
-    region: ManagedWorkerRegion;
-    /** A list of actions this runtime config corresponds to */
-    actions?: string[];
-}
-export declare enum ManagedWorkerEventStatus {
-    IN_PROGRESS = "IN_PROGRESS",
-    SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED"
-}
-export interface ManagedWorkerEvent {
-    id: number;
-    /** @format date-time */
-    timeFirstSeen: string;
-    /** @format date-time */
-    timeLastSeen: string;
-    managedWorkerId: string;
-    status: ManagedWorkerEventStatus;
-    message: string;
-    data: object;
-}
-export interface ManagedWorkerEventList {
-    pagination?: PaginationResponse;
-    rows?: ManagedWorkerEvent[];
-}
-export interface CreateManagedWorkerRequest {
-    name: string;
-    buildConfig: CreateManagedWorkerBuildConfigRequest;
-    /** A map of environment variables to set for the worker */
-    envVars: Record<string, string>;
-    isIac: boolean;
-    runtimeConfig?: CreateManagedWorkerRuntimeConfigRequest;
-}
-export interface UpdateManagedWorkerRequest {
-    name?: string;
-    buildConfig?: CreateManagedWorkerBuildConfigRequest;
-    /** A map of environment variables to set for the worker */
-    envVars?: Record<string, string>;
-    isIac?: boolean;
-    runtimeConfig?: CreateManagedWorkerRuntimeConfigRequest;
-}
-export interface InfraAsCodeRequest {
-    runtimeConfigs: CreateManagedWorkerRuntimeConfigRequest[];
-}
-export interface RuntimeConfigActionsResponse {
-    actions: string[];
-}
-export interface CreateManagedWorkerBuildConfigRequest {
-    /**
-     * @format uuid
-     * @minLength 36
-     * @maxLength 36
-     */
-    githubInstallationId: string;
-    githubRepositoryOwner: string;
-    githubRepositoryName: string;
-    githubRepositoryBranch: string;
-    steps: CreateBuildStepRequest[];
-}
-export interface CreateBuildStepRequest {
-    /** The relative path to the build directory */
-    buildDir: string;
-    /** The relative path from the build dir to the Dockerfile */
-    dockerfilePath: string;
-}
-export declare enum ManagedWorkerRegion {
-    Ams = "ams",
-    Arn = "arn",
-    Atl = "atl",
-    Bog = "bog",
-    Bos = "bos",
-    Cdg = "cdg",
-    Den = "den",
-    Dfw = "dfw",
-    Ewr = "ewr",
-    Eze = "eze",
-    Gdl = "gdl",
-    Gig = "gig",
-    Gru = "gru",
-    Hkg = "hkg",
-    Iad = "iad",
-    Jnb = "jnb",
-    Lax = "lax",
-    Lhr = "lhr",
-    Mad = "mad",
-    Mia = "mia",
-    Nrt = "nrt",
-    Ord = "ord",
-    Otp = "otp",
-    Phx = "phx",
-    Qro = "qro",
-    Scl = "scl",
-    Sea = "sea",
-    Sin = "sin",
-    Sjc = "sjc",
-    Syd = "syd",
-    Waw = "waw",
-    Yul = "yul",
-    Yyz = "yyz"
-}
-export interface CreateManagedWorkerRuntimeConfigRequest {
-    /**
-     * @min 0
-     * @max 1000
-     */
-    numReplicas: number;
-    /** The region to deploy the worker to */
-    regions?: ManagedWorkerRegion[];
-    /** The kind of CPU to use for the worker */
-    cpuKind: string;
-    /**
-     * The number of CPUs to use for the worker
-     * @min 1
-     * @max 64
-     */
-    cpus: number;
-    /**
-     * The amount of memory in MB to use for the worker
-     * @min 1024
-     * @max 65536
-     */
-    memoryMb: number;
-    /** The kind of GPU to use for the worker */
-    gpuKind?: 'a10' | 'l40s' | 'a100-40gb' | 'a100-80gb';
-    /**
-     * The number of GPUs to use for the worker
-     * @min 1
-     * @max 8
-     */
-    gpus?: number;
-    actions?: string[];
-    /**
-     * @min 1
-     * @max 1000
-     */
-    slots?: number;
-}
-export interface TenantBillingState {
-    paymentMethods?: TenantPaymentMethod[];
-    /** The subscription associated with this policy. */
-    subscription: TenantSubscription;
-    /** A list of plans available for the tenant. */
-    plans?: SubscriptionPlan[];
-    /** A list of coupons applied to the tenant. */
-    coupons?: Coupon[];
-}
-export interface SubscriptionPlan {
-    /** The code of the plan. */
-    plan_code: string;
-    /** The name of the plan. */
-    name: string;
-    /** The description of the plan. */
-    description: string;
-    /** The price of the plan. */
-    amount_cents: number;
-    /** The period of the plan. */
-    period?: string;
-}
-export interface UpdateTenantSubscription {
-    /** The code of the plan. */
-    plan?: string;
-    /** The period of the plan. */
-    period?: string;
-}
-export interface TenantSubscription {
-    /** The plan code associated with the tenant subscription. */
-    plan?: string;
-    /** The period associated with the tenant subscription. */
-    period?: string;
-    /** The status of the tenant subscription. */
-    status?: TenantSubscriptionStatus;
-    /** A note associated with the tenant subscription. */
-    note?: string;
-}
-export interface TenantPaymentMethod {
-    /** The brand of the payment method. */
-    brand: string;
-    /** The last 4 digits of the card. */
-    last4?: string;
-    /** The expiration date of the card. */
-    expiration?: string;
-    /** The description of the payment method. */
-    description?: string;
-}
-export declare enum TenantSubscriptionStatus {
-    Active = "active",
-    Pending = "pending",
-    Terminated = "terminated",
-    Canceled = "canceled"
-}
-export interface Coupon {
-    /** The name of the coupon. */
-    name: string;
-    /** The amount off of the coupon. */
-    amount_cents?: number;
-    /** The amount remaining on the coupon. */
-    amount_cents_remaining?: number;
-    /** The currency of the coupon. */
-    amount_currency?: string;
-    /** The frequency of the coupon. */
-    frequency: CouponFrequency;
-    /** The frequency duration of the coupon. */
-    frequency_duration?: number;
-    /** The frequency duration remaining of the coupon. */
-    frequency_duration_remaining?: number;
-    /** The percentage off of the coupon. */
-    percent?: number;
-}
-export declare enum CouponFrequency {
-    Once = "once",
-    Recurring = "recurring"
-}
-export type VectorPushRequest = EventObject[];
-export interface EventObject {
-    event?: {
-        provider?: string;
-    };
-    fly?: {
-        app?: {
-            instance?: string;
-            name?: string;
-        };
-        region?: string;
-    };
-    host?: string;
-    log?: {
-        level?: string;
-    };
-    message?: string;
-    /** @format date-time */
-    timestamp?: string;
-}
-export interface LogLine {
-    /** @format date-time */
-    timestamp: string;
-    instance: string;
-    line: string;
-}
-export interface LogLineList {
-    rows?: LogLine[];
-    pagination?: PaginationResponse;
-}
-export type Matrix = SampleStream[];
-export interface SampleStream {
-    metric?: Metric;
-    values?: SamplePair[];
-    histograms?: SampleHistogramPair[];
-}
-export type SamplePair = any[];
-/** @format float */
-export type SampleValue = number;
-export interface SampleHistogramPair {
-    timestamp?: Time;
-    histogram?: SampleHistogram;
-}
-export interface SampleHistogram {
-    count?: FloatString;
-    sum?: FloatString;
-    buckets?: HistogramBuckets;
-}
-/** @format float */
-export type FloatString = number;
-export type HistogramBuckets = HistogramBucket[];
-export interface HistogramBucket {
-    /** @format int32 */
-    boundaries?: number;
-    lower?: FloatString;
-    upper?: FloatString;
-    count?: FloatString;
-}
-export type Metric = Record<string, LabelValue>;
-export type LabelSet = Record<string, LabelValue>;
-export type LabelName = string;
-export type LabelValue = string;
-export type Time = number;
-export interface Build {
-    metadata?: APIResourceMeta;
-    status: string;
-    statusDetail?: string;
-    /** @format date-time */
-    createTime: string;
-    /** @format date-time */
-    startTime?: string;
-    /** @format date-time */
-    finishTime?: string;
-    /** @format uuid */
-    buildConfigId: string;
-}
-export interface Instance {
-    instanceId: string;
-    name: string;
-    region: string;
-    state: string;
-    cpuKind: string;
-    cpus: number;
-    memoryMb: number;
-    diskGb: number;
-    commitSha: string;
-}
-export interface InstanceList {
-    pagination?: PaginationResponse;
-    rows?: Instance[];
-}
-/**
- * a map of feature flags for the tenant
- * @example {"flag1":"value1","flag2":"value2"}
- */
-export type FeatureFlags = Record<string, string>;
-export interface WorkflowRunEventsMetric {
-    /** @format date-time */
-    time: string;
-    PENDING: number;
-    RUNNING: number;
-    SUCCEEDED: number;
-    FAILED: number;
-    QUEUED: number;
-}
-export interface WorkflowRunEventsMetricsCounts {
-    results?: WorkflowRunEventsMetric[];
-}

package/clients/rest/generated/cloud/data-contracts.js

@@ -1,68 +0,0 @@
-"use strict";
-/* eslint-disable */
-/* tslint:disable */
-/*
- * ---------------------------------------------------------------
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
- * ##                                                           ##
- * ## AUTHOR: acacode                                           ##
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
- * ---------------------------------------------------------------
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CouponFrequency = exports.TenantSubscriptionStatus = exports.ManagedWorkerRegion = exports.ManagedWorkerEventStatus = void 0;
-var ManagedWorkerEventStatus;
-(function (ManagedWorkerEventStatus) {
-    ManagedWorkerEventStatus["IN_PROGRESS"] = "IN_PROGRESS";
-    ManagedWorkerEventStatus["SUCCEEDED"] = "SUCCEEDED";
-    ManagedWorkerEventStatus["FAILED"] = "FAILED";
-    ManagedWorkerEventStatus["CANCELLED"] = "CANCELLED";
-})(ManagedWorkerEventStatus || (exports.ManagedWorkerEventStatus = ManagedWorkerEventStatus = {}));
-var ManagedWorkerRegion;
-(function (ManagedWorkerRegion) {
-    ManagedWorkerRegion["Ams"] = "ams";
-    ManagedWorkerRegion["Arn"] = "arn";
-    ManagedWorkerRegion["Atl"] = "atl";
-    ManagedWorkerRegion["Bog"] = "bog";
-    ManagedWorkerRegion["Bos"] = "bos";
-    ManagedWorkerRegion["Cdg"] = "cdg";
-    ManagedWorkerRegion["Den"] = "den";
-    ManagedWorkerRegion["Dfw"] = "dfw";
-    ManagedWorkerRegion["Ewr"] = "ewr";
-    ManagedWorkerRegion["Eze"] = "eze";
-    ManagedWorkerRegion["Gdl"] = "gdl";
-    ManagedWorkerRegion["Gig"] = "gig";
-    ManagedWorkerRegion["Gru"] = "gru";
-    ManagedWorkerRegion["Hkg"] = "hkg";
-    ManagedWorkerRegion["Iad"] = "iad";
-    ManagedWorkerRegion["Jnb"] = "jnb";
-    ManagedWorkerRegion["Lax"] = "lax";
-    ManagedWorkerRegion["Lhr"] = "lhr";
-    ManagedWorkerRegion["Mad"] = "mad";
-    ManagedWorkerRegion["Mia"] = "mia";
-    ManagedWorkerRegion["Nrt"] = "nrt";
-    ManagedWorkerRegion["Ord"] = "ord";
-    ManagedWorkerRegion["Otp"] = "otp";
-    ManagedWorkerRegion["Phx"] = "phx";
-    ManagedWorkerRegion["Qro"] = "qro";
-    ManagedWorkerRegion["Scl"] = "scl";
-    ManagedWorkerRegion["Sea"] = "sea";
-    ManagedWorkerRegion["Sin"] = "sin";
-    ManagedWorkerRegion["Sjc"] = "sjc";
-    ManagedWorkerRegion["Syd"] = "syd";
-    ManagedWorkerRegion["Waw"] = "waw";
-    ManagedWorkerRegion["Yul"] = "yul";
-    ManagedWorkerRegion["Yyz"] = "yyz";
-})(ManagedWorkerRegion || (exports.ManagedWorkerRegion = ManagedWorkerRegion = {}));
-var TenantSubscriptionStatus;
-(function (TenantSubscriptionStatus) {
-    TenantSubscriptionStatus["Active"] = "active";
-    TenantSubscriptionStatus["Pending"] = "pending";
-    TenantSubscriptionStatus["Terminated"] = "terminated";
-    TenantSubscriptionStatus["Canceled"] = "canceled";
-})(TenantSubscriptionStatus || (exports.TenantSubscriptionStatus = TenantSubscriptionStatus = {}));
-var CouponFrequency;
-(function (CouponFrequency) {
-    CouponFrequency["Once"] = "once";
-    CouponFrequency["Recurring"] = "recurring";
-})(CouponFrequency || (exports.CouponFrequency = CouponFrequency = {}));

package/clients/rest/generated/cloud/http-client.d.ts

@@ -1,41 +0,0 @@
-import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
-export type QueryParamsType = Record<string | number, any>;
-export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
-    /** set parameter to `true` for call `securityWorker` for this request */
-    secure?: boolean;
-    /** request path */
-    path: string;
-    /** content type of request body */
-    type?: ContentType;
-    /** query params */
-    query?: QueryParamsType;
-    /** format of response (i.e. response.json() -> format: "json") */
-    format?: ResponseType;
-    /** request body */
-    body?: unknown;
-}
-export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
-    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
-    secure?: boolean;
-    format?: ResponseType;
-}
-export declare enum ContentType {
-    Json = "application/json",
-    FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded",
-    Text = "text/plain"
-}
-export declare class HttpClient<SecurityDataType = unknown> {
-    instance: AxiosInstance;
-    private securityData;
-    private securityWorker?;
-    private secure?;
-    private format?;
-    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
-    setSecurityData: (data: SecurityDataType | null) => void;
-    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
-    protected stringifyFormItem(formItem: unknown): string;
-    protected createFormData(input: Record<string, unknown>): FormData;
-    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
-}

package/clients/rest/generated/cloud/http-client.js

@@ -1,102 +0,0 @@
-"use strict";
-/* eslint-disable */
-/* tslint:disable */
-/*
- * ---------------------------------------------------------------
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
- * ##                                                           ##
- * ## AUTHOR: acacode                                           ##
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
- * ---------------------------------------------------------------
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpClient = exports.ContentType = void 0;
-const axios_1 = __importDefault(require("axios"));
-var ContentType;
-(function (ContentType) {
-    ContentType["Json"] = "application/json";
-    ContentType["FormData"] = "multipart/form-data";
-    ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
-    ContentType["Text"] = "text/plain";
-})(ContentType || (exports.ContentType = ContentType = {}));
-class HttpClient {
-    constructor(_a = {}) {
-        var { securityWorker, secure, format } = _a, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
-        this.securityData = null;
-        this.setSecurityData = (data) => {
-            this.securityData = data;
-        };
-        this.request = (_a) => __awaiter(this, void 0, void 0, function* () {
-            var { secure, path, type, query, format, body } = _a, params = __rest(_a, ["secure", "path", "type", "query", "format", "body"]);
-            const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
-                this.securityWorker &&
-                (yield this.securityWorker(this.securityData))) ||
-                {};
-            const requestParams = this.mergeRequestParams(params, secureParams);
-            const responseFormat = format || this.format || undefined;
-            if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
-                body = this.createFormData(body);
-            }
-            if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
-                body = JSON.stringify(body);
-            }
-            return this.instance.request(Object.assign(Object.assign({}, requestParams), { headers: Object.assign(Object.assign({}, (requestParams.headers || {})), (type ? { 'Content-Type': type } : {})), params: query, responseType: responseFormat, data: body, url: path }));
-        });
-        this.instance = axios_1.default.create(Object.assign(Object.assign({}, axiosConfig), { baseURL: axiosConfig.baseURL || '' }));
-        this.secure = secure;
-        this.format = format;
-        this.securityWorker = securityWorker;
-    }
-    mergeRequestParams(params1, params2) {
-        const method = params1.method || (params2 && params2.method);
-        return Object.assign(Object.assign(Object.assign(Object.assign({}, this.instance.defaults), params1), (params2 || {})), { headers: Object.assign(Object.assign(Object.assign({}, ((method &&
-                this.instance.defaults.headers[method.toLowerCase()]) ||
-                {})), (params1.headers || {})), ((params2 && params2.headers) || {})) });
-    }
-    stringifyFormItem(formItem) {
-        if (typeof formItem === 'object' && formItem !== null) {
-            return JSON.stringify(formItem);
-        }
-        else {
-            return `${formItem}`;
-        }
-    }
-    createFormData(input) {
-        if (input instanceof FormData) {
-            return input;
-        }
-        return Object.keys(input || {}).reduce((formData, key) => {
-            const property = input[key];
-            const propertyContent = property instanceof Array ? property : [property];
-            for (const formItem of propertyContent) {
-                const isFileType = formItem instanceof Blob || formItem instanceof File;
-                formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
-            }
-            return formData;
-        }, new FormData());
-    }
-}
-exports.HttpClient = HttpClient;