@hatchet-dev/typescript-sdk 1.6.2 → 1.7.1

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

@@ -1,164 +1,3 @@
-export declare enum V1LogLineLevel {
-    DEBUG = "DEBUG",
-    INFO = "INFO",
-    WARN = "WARN",
-    ERROR = "ERROR"
-}
-export declare enum V1TaskRunStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    COMPLETED = "COMPLETED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED"
-}
-export declare enum V1TaskStatus {
-    QUEUED = "QUEUED",
-    RUNNING = "RUNNING",
-    COMPLETED = "COMPLETED",
-    CANCELLED = "CANCELLED",
-    FAILED = "FAILED"
-}
-export declare enum WebhookWorkerRequestMethod {
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT"
-}
-export declare enum LogLineOrderByDirection {
-    Asc = "asc",
-    Desc = "desc"
-}
-export declare enum LogLineOrderByField {
-    CreatedAt = "createdAt"
-}
-export declare enum LogLineLevel {
-    DEBUG = "DEBUG",
-    INFO = "INFO",
-    WARN = "WARN",
-    ERROR = "ERROR"
-}
-export declare enum PullRequestState {
-    Open = "open",
-    Closed = "closed"
-}
-export declare enum WorkerRuntimeSDKs {
-    GOLANG = "GOLANG",
-    PYTHON = "PYTHON",
-    TYPESCRIPT = "TYPESCRIPT"
-}
-export declare enum StepRunEventSeverity {
-    INFO = "INFO",
-    WARNING = "WARNING",
-    CRITICAL = "CRITICAL"
-}
-export declare enum StepRunEventReason {
-    REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
-    REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
-    SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
-    ASSIGNED = "ASSIGNED",
-    STARTED = "STARTED",
-    ACKNOWLEDGED = "ACKNOWLEDGED",
-    FINISHED = "FINISHED",
-    FAILED = "FAILED",
-    RETRYING = "RETRYING",
-    CANCELLED = "CANCELLED",
-    TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
-    REASSIGNED = "REASSIGNED",
-    TIMED_OUT = "TIMED_OUT",
-    SLOT_RELEASED = "SLOT_RELEASED",
-    RETRIED_BY_USER = "RETRIED_BY_USER",
-    WORKFLOW_RUN_GROUP_KEY_SUCCEEDED = "WORKFLOW_RUN_GROUP_KEY_SUCCEEDED",
-    WORKFLOW_RUN_GROUP_KEY_FAILED = "WORKFLOW_RUN_GROUP_KEY_FAILED"
-}
-export declare enum StepRunStatus {
-    PENDING = "PENDING",
-    PENDING_ASSIGNMENT = "PENDING_ASSIGNMENT",
-    ASSIGNED = "ASSIGNED",
-    RUNNING = "RUNNING",
-    SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED",
-    CANCELLING = "CANCELLING",
-    BACKOFF = "BACKOFF"
-}
-export declare enum JobRunStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED",
-    BACKOFF = "BACKOFF"
-}
-export declare enum WorkflowKind {
-    FUNCTION = "FUNCTION",
-    DURABLE = "DURABLE",
-    DAG = "DAG"
-}
-export declare enum WorkflowRunStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED",
-    QUEUED = "QUEUED",
-    BACKOFF = "BACKOFF"
-}
-export declare enum WorkflowRunOrderByDirection {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export declare enum WorkflowRunOrderByField {
-    CreatedAt = "createdAt",
-    StartedAt = "startedAt",
-    FinishedAt = "finishedAt",
-    Duration = "duration"
-}
-export declare enum CronWorkflowsOrderByField {
-    Name = "name",
-    CreatedAt = "createdAt"
-}
-export declare enum ScheduledRunStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED",
-    QUEUED = "QUEUED",
-    SCHEDULED = "SCHEDULED"
-}
-export declare enum ScheduledWorkflowsOrderByField {
-    TriggerAt = "triggerAt",
-    CreatedAt = "createdAt"
-}
-export declare enum RateLimitOrderByDirection {
-    Asc = "asc",
-    Desc = "desc"
-}
-export declare enum RateLimitOrderByField {
-    Key = "key",
-    Value = "value",
-    LimitValue = "limitValue"
-}
-export declare enum EventOrderByDirection {
-    Asc = "asc",
-    Desc = "desc"
-}
-export declare enum EventOrderByField {
-    CreatedAt = "createdAt"
-}
-export declare enum TenantResource {
-    WORKER = "WORKER",
-    WORKER_SLOT = "WORKER_SLOT",
-    EVENT = "EVENT",
-    WORKFLOW_RUN = "WORKFLOW_RUN",
-    TASK_RUN = "TASK_RUN",
-    CRON = "CRON",
-    SCHEDULE = "SCHEDULE"
-}
-export declare enum TenantMemberRole {
-    OWNER = "OWNER",
-    ADMIN = "ADMIN",
-    MEMBER = "MEMBER"
-}
 export interface APIMeta {
     auth?: APIMetaAuth;
     /**
@@ -352,6 +191,8 @@ export interface Tenant {
     alertMemberEmails?: boolean;
     /** The version of the tenant. */
     version: 'V0' | 'V1';
+    /** The UI of the tenant. */
+    uiVersion?: 'V0' | 'V1';
 }
 export interface TenantMember {
     metadata: APIResourceMeta;
@@ -366,6 +207,20 @@ export interface TenantMemberList {
     pagination?: PaginationResponse;
     rows?: TenantMember[];
 }
+export declare enum TenantMemberRole {
+    OWNER = "OWNER",
+    ADMIN = "ADMIN",
+    MEMBER = "MEMBER"
+}
+export declare enum TenantResource {
+    WORKER = "WORKER",
+    WORKER_SLOT = "WORKER_SLOT",
+    EVENT = "EVENT",
+    WORKFLOW_RUN = "WORKFLOW_RUN",
+    TASK_RUN = "TASK_RUN",
+    CRON = "CRON",
+    SCHEDULE = "SCHEDULE"
+}
 export interface TenantResourceLimit {
     metadata: APIResourceMeta;
     /** The resource associated with this limit. */
@@ -495,6 +350,10 @@ export interface CreateTenantRequest {
     name: string;
     /** The slug of the tenant. */
     slug: string;
+    /** The UI version of the tenant. Defaults to V0. */
+    uiVersion?: any;
+    /** The engine version of the tenant. Defaults to V0. */
+    engineVersion?: any;
 }
 export interface UpdateTenantRequest {
     /** The name of the tenant. */
@@ -513,6 +372,8 @@ export interface UpdateTenantRequest {
     maxAlertingFrequency?: string;
     /** The version of the tenant. */
     version?: any;
+    /** The UI of the tenant. */
+    uiVersion?: any;
 }
 export interface Event {
     metadata: APIResourceMeta;
@@ -586,6 +447,13 @@ export interface EventWorkflowRunSummary {
      */
     cancelled?: number;
 }
+export declare enum EventOrderByField {
+    CreatedAt = "createdAt"
+}
+export declare enum EventOrderByDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
 export type EventSearch = string;
 export interface EventKeyList {
     pagination?: PaginationResponse;
@@ -639,6 +507,30 @@ export interface V1EventList {
         };
         /** Additional metadata for the event. */
         additionalMetadata?: object;
+        /** The payload of the event, which can be any JSON-serializable object. */
+        payload?: object;
+        /** The scope of the event, which can be used to filter or categorize events. */
+        scope?: string;
+        /**
+         * The timestamp when the event was seen.
+         * @format date-time
+         */
+        seenAt?: string;
+        /** The external IDs of the runs that were triggered by this event. */
+        triggeredRuns?: {
+            /**
+             * The external ID of the triggered run.
+             * @format uuid
+             * @minLength 36
+             * @maxLength 36
+             */
+            workflowRunId: string;
+            /**
+             * The ID of the filter that triggered the run, if applicable.
+             * @format uuid
+             */
+            filterId?: string;
+        }[];
     }[];
 }
 export interface V1FilterList {
@@ -685,6 +577,15 @@ export interface RateLimitList {
     pagination?: PaginationResponse;
     rows?: RateLimit[];
 }
+export declare enum RateLimitOrderByField {
+    Key = "key",
+    Value = "value",
+    LimitValue = "limitValue"
+}
+export declare enum RateLimitOrderByDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
 export interface ReplayEventRequest {
     eventIds: string[];
 }
@@ -920,6 +821,19 @@ export interface ScheduledWorkflowsList {
     rows?: ScheduledWorkflows[];
     pagination?: PaginationResponse;
 }
+export declare enum ScheduledWorkflowsOrderByField {
+    TriggerAt = "triggerAt",
+    CreatedAt = "createdAt"
+}
+export declare enum ScheduledRunStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    QUEUED = "QUEUED",
+    SCHEDULED = "SCHEDULED"
+}
 export interface CronWorkflows {
     metadata: APIResourceMeta;
     tenantId: string;
@@ -943,6 +857,20 @@ export interface CronWorkflowsList {
     rows?: CronWorkflows[];
     pagination?: PaginationResponse;
 }
+export declare enum CronWorkflowsOrderByField {
+    Name = "name",
+    CreatedAt = "createdAt"
+}
+export declare enum WorkflowRunOrderByField {
+    CreatedAt = "createdAt",
+    StartedAt = "startedAt",
+    FinishedAt = "finishedAt",
+    Duration = "duration"
+}
+export declare enum WorkflowRunOrderByDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
 export interface WorkflowRunsMetrics {
     counts?: WorkflowRunsMetricsCounts;
 }
@@ -954,11 +882,44 @@ export interface WorkflowRunsMetricsCounts {
     QUEUED?: number;
     CANCELLED?: number;
 }
+export declare enum WorkflowRunStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    QUEUED = "QUEUED",
+    BACKOFF = "BACKOFF"
+}
 export type WorkflowRunStatusList = WorkflowRunStatus[];
+export declare enum WorkflowKind {
+    FUNCTION = "FUNCTION",
+    DURABLE = "DURABLE",
+    DAG = "DAG"
+}
 export type WorkflowKindList = WorkflowKind[];
 export interface WorkflowRunsCancelRequest {
     workflowRunIds: string[];
 }
+export declare enum JobRunStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    BACKOFF = "BACKOFF"
+}
+export declare enum StepRunStatus {
+    PENDING = "PENDING",
+    PENDING_ASSIGNMENT = "PENDING_ASSIGNMENT",
+    ASSIGNED = "ASSIGNED",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    CANCELLING = "CANCELLING",
+    BACKOFF = "BACKOFF"
+}
 export interface JobRun {
     metadata: APIResourceMeta;
     tenantId: string;
@@ -1021,6 +982,30 @@ export interface StepRun {
     cancelledReason?: string;
     cancelledError?: string;
 }
+export declare enum StepRunEventReason {
+    REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
+    REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
+    SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
+    ASSIGNED = "ASSIGNED",
+    STARTED = "STARTED",
+    ACKNOWLEDGED = "ACKNOWLEDGED",
+    FINISHED = "FINISHED",
+    FAILED = "FAILED",
+    RETRYING = "RETRYING",
+    CANCELLED = "CANCELLED",
+    TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
+    REASSIGNED = "REASSIGNED",
+    TIMED_OUT = "TIMED_OUT",
+    SLOT_RELEASED = "SLOT_RELEASED",
+    RETRIED_BY_USER = "RETRIED_BY_USER",
+    WORKFLOW_RUN_GROUP_KEY_SUCCEEDED = "WORKFLOW_RUN_GROUP_KEY_SUCCEEDED",
+    WORKFLOW_RUN_GROUP_KEY_FAILED = "WORKFLOW_RUN_GROUP_KEY_FAILED"
+}
+export declare enum StepRunEventSeverity {
+    INFO = "INFO",
+    WARNING = "WARNING",
+    CRITICAL = "CRITICAL"
+}
 export interface StepRunEvent {
     id: number;
     /** @format date-time */
@@ -1074,6 +1059,11 @@ export interface WorkerRuntimeInfo {
     os?: string;
     runtimeExtra?: string;
 }
+export declare enum WorkerRuntimeSDKs {
+    GOLANG = "GOLANG",
+    PYTHON = "PYTHON",
+    TYPESCRIPT = "TYPESCRIPT"
+}
 export interface WorkerList {
     pagination?: PaginationResponse;
     rows?: Worker[];
@@ -1261,6 +1251,10 @@ export interface PullRequest {
     pullRequestBaseBranch: string;
     pullRequestState: PullRequestState;
 }
+export declare enum PullRequestState {
+    Open = "open",
+    Closed = "closed"
+}
 export interface LogLine {
     /**
      * The creation date of the log line.
@@ -1272,10 +1266,23 @@ export interface LogLine {
     /** The log metadata. */
     metadata: object;
 }
+export declare enum LogLineLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
 export interface LogLineList {
     pagination?: PaginationResponse;
     rows?: LogLine[];
 }
+export declare enum LogLineOrderByField {
+    CreatedAt = "createdAt"
+}
+export declare enum LogLineOrderByDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
 export type LogLineSearch = string;
 export type LogLineLevelField = LogLineLevel[];
 export interface SNSIntegration {
@@ -1331,6 +1338,11 @@ export interface WebhookWorker {
     /** The webhook url. */
     url: string;
 }
+export declare enum WebhookWorkerRequestMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT"
+}
 export interface WebhookWorkerRequest {
     /**
      * The date and time the request was created.
@@ -1497,6 +1509,13 @@ export interface V1TaskEventList {
         attempt?: number;
     }[];
 }
+export declare enum V1TaskStatus {
+    QUEUED = "QUEUED",
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    CANCELLED = "CANCELLED",
+    FAILED = "FAILED"
+}
 export type V1TaskRunMetrics = {
     status: V1TaskStatus;
     count: number;
@@ -1603,6 +1622,13 @@ export interface V1WorkflowRunDetails {
     }[];
     tasks: V1TaskSummary[];
 }
+export declare enum V1TaskRunStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED"
+}
 export interface V1TriggerWorkflowRunRequest {
     /** The name of the workflow. */
     workflowName: string;
@@ -1628,6 +1654,12 @@ export interface V1LogLine {
     /** The log level. */
     level?: V1LogLineLevel;
 }
+export declare enum V1LogLineLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
 export interface V1LogLineList {
     pagination?: PaginationResponse;
     rows?: V1LogLine[];
@@ -1713,3 +1745,11 @@ export interface V1CreateFilterRequest {
     /** The payload for the filter */
     payload?: object;
 }
+export interface V1UpdateFilterRequest {
+    /** The expression for the filter */
+    expression?: string;
+    /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
+    scope?: string;
+    /** The payload for the filter */
+    payload?: object;
+}