@hatchet-dev/typescript-sdk 1.10.4 → 1.10.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,63 +1,359 @@
1
- export interface APIMeta {
2
- auth?: APIMetaAuth;
1
+ export declare enum V1TaskRunStatus {
2
+ PENDING = "PENDING",
3
+ RUNNING = "RUNNING",
4
+ COMPLETED = "COMPLETED",
5
+ FAILED = "FAILED",
6
+ CANCELLED = "CANCELLED"
7
+ }
8
+ export declare enum PullRequestState {
9
+ Open = "open",
10
+ Closed = "closed"
11
+ }
12
+ export declare enum WebhookWorkerRequestMethod {
13
+ GET = "GET",
14
+ POST = "POST",
15
+ PUT = "PUT"
16
+ }
17
+ export declare enum WorkerRuntimeSDKs {
18
+ GOLANG = "GOLANG",
19
+ PYTHON = "PYTHON",
20
+ TYPESCRIPT = "TYPESCRIPT"
21
+ }
22
+ export declare enum WorkerType {
23
+ SELFHOSTED = "SELFHOSTED",
24
+ MANAGED = "MANAGED",
25
+ WEBHOOK = "WEBHOOK"
26
+ }
27
+ export declare enum WorkflowRunOrderByField {
28
+ CreatedAt = "createdAt",
29
+ StartedAt = "startedAt",
30
+ FinishedAt = "finishedAt",
31
+ Duration = "duration"
32
+ }
33
+ export declare enum WorkflowKind {
34
+ FUNCTION = "FUNCTION",
35
+ DURABLE = "DURABLE",
36
+ DAG = "DAG"
37
+ }
38
+ export declare enum StepRunEventSeverity {
39
+ INFO = "INFO",
40
+ WARNING = "WARNING",
41
+ CRITICAL = "CRITICAL"
42
+ }
43
+ export declare enum StepRunEventReason {
44
+ REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
45
+ REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
46
+ SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
47
+ ASSIGNED = "ASSIGNED",
48
+ STARTED = "STARTED",
49
+ ACKNOWLEDGED = "ACKNOWLEDGED",
50
+ FINISHED = "FINISHED",
51
+ FAILED = "FAILED",
52
+ RETRYING = "RETRYING",
53
+ CANCELLED = "CANCELLED",
54
+ TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
55
+ REASSIGNED = "REASSIGNED",
56
+ TIMED_OUT = "TIMED_OUT",
57
+ SLOT_RELEASED = "SLOT_RELEASED",
58
+ RETRIED_BY_USER = "RETRIED_BY_USER",
59
+ WORKFLOW_RUN_GROUP_KEY_SUCCEEDED = "WORKFLOW_RUN_GROUP_KEY_SUCCEEDED",
60
+ WORKFLOW_RUN_GROUP_KEY_FAILED = "WORKFLOW_RUN_GROUP_KEY_FAILED"
61
+ }
62
+ export declare enum LogLineOrderByDirection {
63
+ Asc = "asc",
64
+ Desc = "desc"
65
+ }
66
+ export declare enum LogLineOrderByField {
67
+ CreatedAt = "createdAt"
68
+ }
69
+ export declare enum LogLineLevel {
70
+ DEBUG = "DEBUG",
71
+ INFO = "INFO",
72
+ WARN = "WARN",
73
+ ERROR = "ERROR"
74
+ }
75
+ export declare enum JobRunStatus {
76
+ PENDING = "PENDING",
77
+ RUNNING = "RUNNING",
78
+ SUCCEEDED = "SUCCEEDED",
79
+ FAILED = "FAILED",
80
+ CANCELLED = "CANCELLED",
81
+ BACKOFF = "BACKOFF"
82
+ }
83
+ export declare enum StepRunStatus {
84
+ PENDING = "PENDING",
85
+ PENDING_ASSIGNMENT = "PENDING_ASSIGNMENT",
86
+ ASSIGNED = "ASSIGNED",
87
+ RUNNING = "RUNNING",
88
+ SUCCEEDED = "SUCCEEDED",
89
+ FAILED = "FAILED",
90
+ CANCELLED = "CANCELLED",
91
+ CANCELLING = "CANCELLING",
92
+ BACKOFF = "BACKOFF"
93
+ }
94
+ export declare enum ConcurrencyLimitStrategy {
95
+ CANCEL_IN_PROGRESS = "CANCEL_IN_PROGRESS",
96
+ DROP_NEWEST = "DROP_NEWEST",
97
+ QUEUE_NEWEST = "QUEUE_NEWEST",
98
+ GROUP_ROUND_ROBIN = "GROUP_ROUND_ROBIN"
99
+ }
100
+ export declare enum CronWorkflowsOrderByField {
101
+ Name = "name",
102
+ CreatedAt = "createdAt"
103
+ }
104
+ export declare enum CronWorkflowsMethod {
105
+ DEFAULT = "DEFAULT",
106
+ API = "API"
107
+ }
108
+ export declare enum ScheduledRunStatus {
109
+ PENDING = "PENDING",
110
+ RUNNING = "RUNNING",
111
+ SUCCEEDED = "SUCCEEDED",
112
+ FAILED = "FAILED",
113
+ CANCELLED = "CANCELLED",
114
+ QUEUED = "QUEUED",
115
+ SCHEDULED = "SCHEDULED"
116
+ }
117
+ export declare enum WorkflowRunOrderByDirection {
118
+ ASC = "ASC",
119
+ DESC = "DESC"
120
+ }
121
+ export declare enum ScheduledWorkflowsOrderByField {
122
+ TriggerAt = "triggerAt",
123
+ CreatedAt = "createdAt"
124
+ }
125
+ export declare enum ScheduledWorkflowsMethod {
126
+ DEFAULT = "DEFAULT",
127
+ API = "API"
128
+ }
129
+ export declare enum RateLimitOrderByDirection {
130
+ Asc = "asc",
131
+ Desc = "desc"
132
+ }
133
+ export declare enum RateLimitOrderByField {
134
+ Key = "key",
135
+ Value = "value",
136
+ LimitValue = "limitValue"
137
+ }
138
+ export declare enum EventOrderByDirection {
139
+ Asc = "asc",
140
+ Desc = "desc"
141
+ }
142
+ export declare enum EventOrderByField {
143
+ CreatedAt = "createdAt"
144
+ }
145
+ export declare enum WorkflowRunStatus {
146
+ PENDING = "PENDING",
147
+ RUNNING = "RUNNING",
148
+ SUCCEEDED = "SUCCEEDED",
149
+ FAILED = "FAILED",
150
+ CANCELLED = "CANCELLED",
151
+ QUEUED = "QUEUED",
152
+ BACKOFF = "BACKOFF"
153
+ }
154
+ export declare enum TenantMemberRole {
155
+ OWNER = "OWNER",
156
+ ADMIN = "ADMIN",
157
+ MEMBER = "MEMBER"
158
+ }
159
+ export declare enum TenantResource {
160
+ WORKER = "WORKER",
161
+ WORKER_SLOT = "WORKER_SLOT",
162
+ EVENT = "EVENT",
163
+ WORKFLOW_RUN = "WORKFLOW_RUN",
164
+ TASK_RUN = "TASK_RUN",
165
+ CRON = "CRON",
166
+ SCHEDULE = "SCHEDULE",
167
+ INCOMING_WEBHOOK = "INCOMING_WEBHOOK"
168
+ }
169
+ /** The status of the CEL evaluation */
170
+ export declare enum V1CELDebugResponseStatus {
171
+ SUCCESS = "SUCCESS",
172
+ ERROR = "ERROR"
173
+ }
174
+ export declare enum V1WebhookHMACEncoding {
175
+ HEX = "HEX",
176
+ BASE64 = "BASE64",
177
+ BASE64URL = "BASE64URL"
178
+ }
179
+ export declare enum V1WebhookHMACAlgorithm {
180
+ SHA1 = "SHA1",
181
+ SHA256 = "SHA256",
182
+ SHA512 = "SHA512",
183
+ MD5 = "MD5"
184
+ }
185
+ export declare enum V1WebhookAuthType {
186
+ BASIC = "BASIC",
187
+ API_KEY = "API_KEY",
188
+ HMAC = "HMAC"
189
+ }
190
+ export declare enum V1WebhookSourceName {
191
+ GENERIC = "GENERIC",
192
+ GITHUB = "GITHUB",
193
+ STRIPE = "STRIPE",
194
+ SLACK = "SLACK",
195
+ LINEAR = "LINEAR"
196
+ }
197
+ export declare enum TenantEnvironment {
198
+ Local = "local",
199
+ Development = "development",
200
+ Production = "production"
201
+ }
202
+ export declare enum TenantVersion {
203
+ V0 = "V0",
204
+ V1 = "V1"
205
+ }
206
+ export declare enum V1LogLineLevel {
207
+ DEBUG = "DEBUG",
208
+ INFO = "INFO",
209
+ WARN = "WARN",
210
+ ERROR = "ERROR"
211
+ }
212
+ export declare enum V1TaskEventType {
213
+ REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
214
+ REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
215
+ SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
216
+ ASSIGNED = "ASSIGNED",
217
+ STARTED = "STARTED",
218
+ FINISHED = "FINISHED",
219
+ FAILED = "FAILED",
220
+ RETRYING = "RETRYING",
221
+ CANCELLED = "CANCELLED",
222
+ TIMED_OUT = "TIMED_OUT",
223
+ REASSIGNED = "REASSIGNED",
224
+ SLOT_RELEASED = "SLOT_RELEASED",
225
+ TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
226
+ RETRIED_BY_USER = "RETRIED_BY_USER",
227
+ SENT_TO_WORKER = "SENT_TO_WORKER",
228
+ RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR",
229
+ ACKNOWLEDGED = "ACKNOWLEDGED",
230
+ CREATED = "CREATED",
231
+ QUEUED = "QUEUED",
232
+ SKIPPED = "SKIPPED",
233
+ COULD_NOT_SEND_TO_WORKER = "COULD_NOT_SEND_TO_WORKER"
234
+ }
235
+ export declare enum V1WorkflowType {
236
+ DAG = "DAG",
237
+ TASK = "TASK"
238
+ }
239
+ export declare enum V1TaskStatus {
240
+ QUEUED = "QUEUED",
241
+ RUNNING = "RUNNING",
242
+ COMPLETED = "COMPLETED",
243
+ CANCELLED = "CANCELLED",
244
+ FAILED = "FAILED"
245
+ }
246
+ export interface APIResourceMeta {
3
247
  /**
4
- * the Pylon app ID for usepylon.com chat support
5
- * @example "12345678-1234-1234-1234-123456789012"
248
+ * the id of this resource, in UUID format
249
+ * @minLength 0
250
+ * @maxLength 36
251
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
6
252
  */
7
- pylonAppId?: string;
8
- posthog?: APIMetaPosthog;
253
+ id: string;
9
254
  /**
10
- * whether or not users can sign up for this instance
11
- * @example true
255
+ * the time that this resource was created
256
+ * @format date-time
257
+ * @example "2022-12-13T15:06:48.888358-05:00"
12
258
  */
13
- allowSignup?: boolean;
259
+ createdAt: string;
14
260
  /**
15
- * whether or not users can invite other users to this instance
16
- * @example true
261
+ * the time that this resource was last updated
262
+ * @format date-time
263
+ * @example "2022-12-13T15:06:48.888358-05:00"
17
264
  */
18
- allowInvites?: boolean;
265
+ updatedAt: string;
266
+ }
267
+ export interface V1TaskSummary {
268
+ metadata: APIResourceMeta;
269
+ /** The action ID of the task. */
270
+ actionId?: string;
271
+ /** The number of retries of the task. */
272
+ retryCount?: number;
273
+ /** The attempt number of the task. */
274
+ attempt?: number;
275
+ /** Additional metadata for the task run. */
276
+ additionalMetadata?: object;
277
+ /** The list of children tasks */
278
+ children?: V1TaskSummary[];
19
279
  /**
20
- * whether or not users can create new tenants
21
- * @example true
280
+ * The timestamp the task was created.
281
+ * @format date-time
22
282
  */
23
- allowCreateTenant?: boolean;
283
+ createdAt: string;
284
+ /** The display name of the task run. */
285
+ displayName: string;
286
+ /** The duration of the task run, in milliseconds. */
287
+ duration?: number;
288
+ /** The error message of the task run (for the latest run) */
289
+ errorMessage?: string;
24
290
  /**
25
- * whether or not users can change their password
26
- * @example true
291
+ * The timestamp the task run finished.
292
+ * @format date-time
27
293
  */
28
- allowChangePassword?: boolean;
29
- }
30
- export interface APIMetaAuth {
294
+ finishedAt?: string;
295
+ /** The input of the task run. */
296
+ input: object;
297
+ /** The number of spawned children tasks */
298
+ numSpawnedChildren: number;
299
+ /** The output of the task run (for the latest run) */
300
+ output: object;
301
+ status: V1TaskStatus;
31
302
  /**
32
- * the supported types of authentication
33
- * @example ["basic","google"]
303
+ * The timestamp the task run started.
304
+ * @format date-time
34
305
  */
35
- schemes?: string[];
36
- }
37
- export interface APIMetaPosthog {
306
+ startedAt?: string;
38
307
  /**
39
- * the PostHog API key
40
- * @example "phk_1234567890abcdef"
308
+ * The step ID of the task.
309
+ * @format uuid
310
+ * @minLength 36
311
+ * @maxLength 36
41
312
  */
42
- apiKey?: string;
313
+ stepId?: string;
43
314
  /**
44
- * the PostHog API host
45
- * @example "https://posthog.example.com"
315
+ * The external ID of the task.
316
+ * @format uuid
317
+ * @minLength 36
318
+ * @maxLength 36
46
319
  */
47
- apiHost?: string;
48
- }
49
- export type ListAPIMetaIntegration = APIMetaIntegration[];
50
- export interface APIMetaIntegration {
320
+ taskExternalId: string;
321
+ /** The ID of the task. */
322
+ taskId: number;
51
323
  /**
52
- * the name of the integration
53
- * @example "github"
324
+ * The timestamp the task was inserted.
325
+ * @format date-time
54
326
  */
55
- name: string;
56
- /** whether this integration is enabled on the instance */
57
- enabled: boolean;
58
- }
59
- export interface APIErrors {
60
- errors: APIError[];
327
+ taskInsertedAt: string;
328
+ /**
329
+ * The ID of the tenant.
330
+ * @format uuid
331
+ * @minLength 36
332
+ * @maxLength 36
333
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
334
+ */
335
+ tenantId: string;
336
+ /** The type of the workflow (whether it's a DAG or a task) */
337
+ type: V1WorkflowType;
338
+ /** @format uuid */
339
+ workflowId: string;
340
+ workflowName?: string;
341
+ /**
342
+ * The external ID of the workflow run
343
+ * @format uuid
344
+ */
345
+ workflowRunExternalId: string;
346
+ /**
347
+ * The version ID of the workflow
348
+ * @format uuid
349
+ */
350
+ workflowVersionId?: string;
351
+ workflowConfig?: object;
352
+ /**
353
+ * The external ID of the parent task.
354
+ * @format uuid
355
+ */
356
+ parentTaskExternalId?: string;
61
357
  }
62
358
  export interface APIError {
63
359
  /**
@@ -82,6 +378,9 @@ export interface APIError {
82
378
  */
83
379
  docs_link?: string;
84
380
  }
381
+ export interface APIErrors {
382
+ errors: APIError[];
383
+ }
85
384
  /** @example {"next_page":3,"num_pages":10,"current_page":2} */
86
385
  export interface PaginationResponse {
87
386
  /**
@@ -101,475 +400,355 @@ export interface PaginationResponse {
101
400
  * @format int64
102
401
  * @example 10
103
402
  */
104
- num_pages?: number;
105
- }
106
- export interface APIResourceMeta {
107
- /**
108
- * the id of this resource, in UUID format
109
- * @minLength 0
110
- * @maxLength 36
111
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
112
- */
113
- id: string;
114
- /**
115
- * the time that this resource was created
116
- * @format date-time
117
- * @example "2022-12-13T15:06:48.888358-05:00"
118
- */
119
- createdAt: string;
120
- /**
121
- * the time that this resource was last updated
122
- * @format date-time
123
- * @example "2022-12-13T15:06:48.888358-05:00"
124
- */
125
- updatedAt: string;
126
- }
127
- export interface User {
128
- metadata: APIResourceMeta;
129
- /** The display name of the user. */
130
- name?: string;
131
- /**
132
- * The email address of the user.
133
- * @format email
134
- */
135
- email: string;
136
- /** Whether the user has verified their email address. */
137
- emailVerified: boolean;
138
- /** Whether the user has a password set. */
139
- hasPassword?: boolean;
140
- /** A hash of the user's email address for use with Pylon Support Chat */
141
- emailHash?: string;
142
- }
143
- export interface UserTenantPublic {
144
- /**
145
- * The email address of the user.
146
- * @format email
147
- */
148
- email: string;
149
- /** The display name of the user. */
150
- name?: string;
151
- }
152
- export interface UserLoginRequest {
153
- /**
154
- * The email address of the user.
155
- * @format email
156
- */
157
- email: string;
158
- /** The password of the user. */
159
- password: string;
403
+ num_pages?: number;
160
404
  }
161
- export interface UserChangePasswordRequest {
162
- /** The password of the user. */
163
- password: string;
164
- /** The new password for the user. */
165
- newPassword: string;
405
+ export interface V1TaskEvent {
406
+ id: number;
407
+ /** @format uuid */
408
+ taskId: string;
409
+ /** @format date-time */
410
+ timestamp: string;
411
+ eventType: V1TaskEventType;
412
+ message: string;
413
+ errorMessage?: string;
414
+ output?: string;
415
+ /** @format uuid */
416
+ workerId?: string;
417
+ taskDisplayName?: string;
418
+ /** The number of retries of the task. */
419
+ retryCount?: number;
420
+ /** The attempt number of the task. */
421
+ attempt?: number;
166
422
  }
167
- export interface UserRegisterRequest {
168
- /** The name of the user. */
169
- name: string;
423
+ export interface V1TaskEventList {
424
+ pagination?: PaginationResponse;
425
+ rows?: V1TaskEvent[];
426
+ }
427
+ export interface V1LogLine {
170
428
  /**
171
- * The email address of the user.
172
- * @format email
429
+ * The creation date of the log line.
430
+ * @format date-time
173
431
  */
174
- email: string;
175
- /** The password of the user. */
176
- password: string;
432
+ createdAt: string;
433
+ /** The log message. */
434
+ message: string;
435
+ /** The log metadata. */
436
+ metadata: object;
437
+ /** The retry count of the log line. */
438
+ retryCount?: number;
439
+ /** The attempt number of the log line. */
440
+ attempt?: number;
441
+ /** The log level. */
442
+ level?: V1LogLineLevel;
177
443
  }
178
- export interface UserTenantMembershipsList {
444
+ export interface V1LogLineList {
179
445
  pagination?: PaginationResponse;
180
- rows?: TenantMember[];
181
- }
182
- export interface Tenant {
183
- metadata: APIResourceMeta;
184
- /** The name of the tenant. */
185
- name: string;
186
- /** The slug of the tenant. */
187
- slug: string;
188
- /** Whether the tenant has opted out of analytics. */
189
- analyticsOptOut?: boolean;
190
- /** Whether to alert tenant members. */
191
- alertMemberEmails?: boolean;
192
- /** The version of the tenant. */
193
- version: 'V0' | 'V1';
194
- /** The UI of the tenant. */
195
- uiVersion?: 'V0' | 'V1';
196
- /** The environment type of the tenant. */
197
- environment?: TenantEnvironment;
446
+ rows?: V1LogLine[];
198
447
  }
199
- export interface TenantMember {
200
- metadata: APIResourceMeta;
201
- /** The user associated with this tenant member. */
202
- user: UserTenantPublic;
203
- /** The role of the user in the tenant. */
204
- role: TenantMemberRole;
205
- /** The tenant associated with this tenant member. */
206
- tenant?: Tenant;
448
+ export interface V1TaskFilter {
449
+ /** @format date-time */
450
+ since: string;
451
+ /** @format date-time */
452
+ until?: string;
453
+ statuses?: V1TaskStatus[];
454
+ workflowIds?: string[];
455
+ additionalMetadata?: string[];
207
456
  }
208
- export interface TenantMemberList {
209
- pagination?: PaginationResponse;
210
- rows?: TenantMember[];
457
+ export interface V1CancelTaskRequest {
458
+ /** A list of external IDs, which can refer to either task or workflow run external IDs */
459
+ externalIds?: string[];
460
+ filter?: V1TaskFilter;
211
461
  }
212
- export declare enum TenantEnvironment {
213
- Local = "local",
214
- Development = "development",
215
- Production = "production"
462
+ export interface V1CancelledTasks {
463
+ /** The list of task external ids that were cancelled */
464
+ ids?: string[];
216
465
  }
217
- export declare enum TenantMemberRole {
218
- OWNER = "OWNER",
219
- ADMIN = "ADMIN",
220
- MEMBER = "MEMBER"
466
+ export interface V1ReplayTaskRequest {
467
+ /** A list of external IDs, which can refer to either task or workflow run external IDs */
468
+ externalIds?: string[];
469
+ filter?: V1TaskFilter;
221
470
  }
222
- export declare enum TenantResource {
223
- WORKER = "WORKER",
224
- WORKER_SLOT = "WORKER_SLOT",
225
- EVENT = "EVENT",
226
- WORKFLOW_RUN = "WORKFLOW_RUN",
227
- TASK_RUN = "TASK_RUN",
228
- CRON = "CRON",
229
- SCHEDULE = "SCHEDULE",
230
- INCOMING_WEBHOOK = "INCOMING_WEBHOOK"
471
+ export interface V1ReplayedTasks {
472
+ /** The list of task external ids that were replayed */
473
+ ids?: string[];
231
474
  }
232
- export interface TenantResourceLimit {
233
- metadata: APIResourceMeta;
234
- /** The resource associated with this limit. */
235
- resource: TenantResource;
236
- /** The limit associated with this limit. */
237
- limitValue: number;
238
- /** The alarm value associated with this limit to warn of approaching limit value. */
239
- alarmValue?: number;
240
- /** The current value associated with this limit. */
241
- value: number;
242
- /** The meter window for the limit. (i.e. 1 day, 1 week, 1 month) */
243
- window?: string;
244
- /**
245
- * The last time the limit was refilled.
246
- * @format date-time
247
- */
248
- lastRefill?: string;
475
+ export interface V1DagChildren {
476
+ /** @format uuid */
477
+ dagId?: string;
478
+ children?: V1TaskSummary[];
249
479
  }
250
- export interface TenantResourcePolicy {
251
- /** A list of resource limits for the tenant. */
252
- limits: TenantResourceLimit[];
480
+ export interface V1TaskSummaryList {
481
+ pagination: PaginationResponse;
482
+ /** The list of tasks */
483
+ rows: V1TaskSummary[];
253
484
  }
254
- export interface CreateTenantInviteRequest {
255
- /** The email of the user to invite. */
256
- email: string;
257
- /** The role of the user in the tenant. */
258
- role: TenantMemberRole;
485
+ export interface V1WorkflowRunDisplayName {
486
+ metadata: APIResourceMeta;
487
+ displayName: string;
259
488
  }
260
- export interface UpdateTenantInviteRequest {
261
- /** The role of the user in the tenant. */
262
- role: TenantMemberRole;
489
+ export interface V1WorkflowRunDisplayNameList {
490
+ pagination: PaginationResponse;
491
+ /** The list of display names */
492
+ rows: V1WorkflowRunDisplayName[];
263
493
  }
264
- export interface UpdateTenantMemberRequest {
265
- /** The role of the user in the tenant. */
266
- role: TenantMemberRole;
494
+ /** The list of external IDs */
495
+ export type V1WorkflowRunExternalIdList = string[];
496
+ export interface V1TriggerWorkflowRunRequest {
497
+ /** The name of the workflow. */
498
+ workflowName: string;
499
+ input: object;
500
+ additionalMetadata?: object;
501
+ /** The priority of the workflow run. */
502
+ priority?: number;
267
503
  }
268
- export interface TenantAlertingSettings {
504
+ export interface V1WorkflowRun {
269
505
  metadata: APIResourceMeta;
270
- /** Whether to alert tenant members. */
271
- alertMemberEmails?: boolean;
272
- /** Whether to send alerts when workflow runs fail. */
273
- enableWorkflowRunFailureAlerts?: boolean;
274
- /** Whether to enable alerts when tokens are approaching expiration. */
275
- enableExpiringTokenAlerts?: boolean;
276
- /** Whether to enable alerts when tenant resources are approaching limits. */
277
- enableTenantResourceLimitAlerts?: boolean;
278
- /** The max frequency at which to alert. */
279
- maxAlertingFrequency: string;
506
+ status: V1TaskStatus;
280
507
  /**
281
- * The last time an alert was sent.
508
+ * The timestamp the task run started.
282
509
  * @format date-time
283
510
  */
284
- lastAlertedAt?: string;
285
- }
286
- export interface TenantAlertEmailGroup {
287
- metadata: APIResourceMeta;
288
- /** A list of emails for users */
289
- emails: string[];
290
- }
291
- export interface TenantAlertEmailGroupList {
292
- pagination?: PaginationResponse;
293
- rows?: TenantAlertEmailGroup[];
511
+ startedAt?: string;
512
+ /**
513
+ * The timestamp the task run finished.
514
+ * @format date-time
515
+ */
516
+ finishedAt?: string;
517
+ /** The duration of the task run, in milliseconds. */
518
+ duration?: number;
519
+ /**
520
+ * The ID of the tenant.
521
+ * @format uuid
522
+ * @minLength 36
523
+ * @maxLength 36
524
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
525
+ */
526
+ tenantId: string;
527
+ /** Additional metadata for the task run. */
528
+ additionalMetadata?: object;
529
+ /** The display name of the task run. */
530
+ displayName: string;
531
+ /** @format uuid */
532
+ workflowId: string;
533
+ /** The output of the task run (for the latest run) */
534
+ output: object;
535
+ /** The error message of the task run (for the latest run) */
536
+ errorMessage?: string;
537
+ /**
538
+ * The ID of the workflow version.
539
+ * @format uuid
540
+ */
541
+ workflowVersionId?: string;
542
+ /** The input of the task run. */
543
+ input: object;
544
+ /**
545
+ * The timestamp the task run was created.
546
+ * @format date-time
547
+ */
548
+ createdAt?: string;
549
+ /**
550
+ * @format uuid
551
+ * @minLength 36
552
+ * @maxLength 36
553
+ */
554
+ parentTaskExternalId?: string;
294
555
  }
295
- export interface CreateTenantAlertEmailGroupRequest {
296
- /** A list of emails for users */
297
- emails: string[];
556
+ export interface WorkflowRunShapeItemForWorkflowRunDetails {
557
+ /**
558
+ * @format uuid
559
+ * @minLength 36
560
+ * @maxLength 36
561
+ */
562
+ taskExternalId: string;
563
+ /**
564
+ * @format uuid
565
+ * @minLength 36
566
+ * @maxLength 36
567
+ */
568
+ stepId: string;
569
+ childrenStepIds: string[];
570
+ taskName: string;
298
571
  }
299
- export interface UpdateTenantAlertEmailGroupRequest {
300
- /** A list of emails for users */
301
- emails: string[];
572
+ export type WorkflowRunShapeForWorkflowRunDetails = WorkflowRunShapeItemForWorkflowRunDetails[];
573
+ export interface V1WorkflowRunDetails {
574
+ run: V1WorkflowRun;
575
+ /** The list of task events for the workflow run */
576
+ taskEvents: V1TaskEvent[];
577
+ shape: WorkflowRunShapeForWorkflowRunDetails;
578
+ tasks: V1TaskSummary[];
579
+ workflowConfig?: object;
302
580
  }
303
- export interface TenantInvite {
581
+ export interface V1TaskTiming {
304
582
  metadata: APIResourceMeta;
305
- /** The email of the user to invite. */
306
- email: string;
307
- /** The role of the user in the tenant. */
308
- role: TenantMemberRole;
309
- /** The tenant id associated with this tenant invite. */
310
- tenantId: string;
311
- /** The tenant name for the tenant. */
312
- tenantName?: string;
583
+ /** The depth of the task in the waterfall. */
584
+ depth: number;
585
+ status: V1TaskStatus;
586
+ /** The display name of the task run. */
587
+ taskDisplayName: string;
313
588
  /**
314
- * The time that this invite expires.
589
+ * The external ID of the task.
590
+ * @format uuid
591
+ * @minLength 36
592
+ * @maxLength 36
593
+ */
594
+ taskExternalId: string;
595
+ /** The ID of the task. */
596
+ taskId: number;
597
+ /**
598
+ * The timestamp the task was inserted.
315
599
  * @format date-time
316
600
  */
317
- expires: string;
318
- }
319
- export type TaskStats = Record<string, TaskStat>;
320
- export interface TaskStat {
321
- queued?: TaskStatusStat;
322
- running?: TaskStatusStat;
323
- }
324
- export interface TaskStatusStat {
325
- /** @format int64 */
326
- total?: number;
327
- queues?: Record<string, number>;
328
- concurrency?: ConcurrencyStat[];
329
- }
330
- export interface ConcurrencyStat {
331
- expression?: string;
332
- type?: string;
333
- keys?: Record<string, number>;
334
- }
335
- export interface TenantInviteList {
336
- pagination?: PaginationResponse;
337
- rows?: TenantInvite[];
338
- }
339
- export interface QueueMetrics {
340
- /** The number of items in the queue. */
341
- numQueued: number;
342
- /** The number of items running. */
343
- numRunning: number;
344
- /** The number of items pending. */
345
- numPending: number;
346
- }
347
- export interface TenantQueueMetrics {
348
- /** The total queue metrics. */
349
- total?: QueueMetrics;
350
- workflow?: Record<string, QueueMetrics>;
351
- queues?: Record<string, number>;
352
- }
353
- export interface TenantStepRunQueueMetrics {
354
- queues?: object;
355
- }
356
- export interface AcceptInviteRequest {
601
+ taskInsertedAt: string;
357
602
  /**
603
+ * The ID of the tenant.
604
+ * @format uuid
358
605
  * @minLength 36
359
606
  * @maxLength 36
360
607
  * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
361
608
  */
362
- invite: string;
363
- }
364
- export interface RejectInviteRequest {
609
+ tenantId: string;
365
610
  /**
611
+ * The external ID of the parent task.
612
+ * @format uuid
366
613
  * @minLength 36
367
614
  * @maxLength 36
368
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
369
615
  */
370
- invite: string;
616
+ parentTaskExternalId?: string;
617
+ /**
618
+ * The timestamp the task run was queued.
619
+ * @format date-time
620
+ */
621
+ queuedAt?: string;
622
+ /**
623
+ * The timestamp the task run started.
624
+ * @format date-time
625
+ */
626
+ startedAt?: string;
627
+ /**
628
+ * The timestamp the task run finished.
629
+ * @format date-time
630
+ */
631
+ finishedAt?: string;
632
+ /**
633
+ * The external ID of the workflow run.
634
+ * @format uuid
635
+ */
636
+ workflowRunId?: string;
637
+ /** The number of retries of the task. */
638
+ retryCount?: number;
639
+ /** The attempt number of the task. */
640
+ attempt?: number;
371
641
  }
372
- export interface TenantList {
373
- pagination?: PaginationResponse;
374
- rows?: Tenant[];
642
+ export interface V1TaskTimingList {
643
+ pagination: PaginationResponse;
644
+ /** The list of task timings */
645
+ rows: V1TaskTiming[];
375
646
  }
376
- export interface CreateTenantRequest {
647
+ export interface V1TaskRunMetric {
648
+ status: V1TaskStatus;
649
+ count: number;
650
+ }
651
+ export type V1TaskRunMetrics = V1TaskRunMetric[];
652
+ export interface V1TaskPointMetric {
653
+ /** @format date-time */
654
+ time: string;
655
+ SUCCEEDED: number;
656
+ FAILED: number;
657
+ }
658
+ export interface V1TaskPointMetrics {
659
+ results?: V1TaskPointMetric[];
660
+ }
661
+ /** The key for the event. */
662
+ export type EventKey = string;
663
+ export interface Tenant {
664
+ metadata: APIResourceMeta;
377
665
  /** The name of the tenant. */
378
666
  name: string;
379
667
  /** The slug of the tenant. */
380
668
  slug: string;
381
- /** The UI version of the tenant. Defaults to V0. */
382
- uiVersion?: any;
383
- /** The engine version of the tenant. Defaults to V0. */
384
- engineVersion?: any;
385
- /** The environment type of the tenant. */
386
- environment?: TenantEnvironment;
387
- /** Additional onboarding data to store with the tenant. */
388
- onboardingData?: Record<string, any>;
389
- }
390
- export interface UpdateTenantRequest {
391
- /** The name of the tenant. */
392
- name?: string;
393
669
  /** Whether the tenant has opted out of analytics. */
394
670
  analyticsOptOut?: boolean;
395
671
  /** Whether to alert tenant members. */
396
672
  alertMemberEmails?: boolean;
397
- /** Whether to send alerts when workflow runs fail. */
398
- enableWorkflowRunFailureAlerts?: boolean;
399
- /** Whether to enable alerts when tokens are approaching expiration. */
400
- enableExpiringTokenAlerts?: boolean;
401
- /** Whether to enable alerts when tenant resources are approaching limits. */
402
- enableTenantResourceLimitAlerts?: boolean;
403
- /** The max frequency at which to alert. */
404
- maxAlertingFrequency?: string;
405
673
  /** The version of the tenant. */
406
- version?: any;
407
- /** The UI of the tenant. */
408
- uiVersion?: any;
409
- }
410
- export interface Event {
411
- metadata: APIResourceMeta;
412
- /** The key for the event. */
413
- key: string;
414
- /** The tenant associated with this event. */
415
- tenant?: Tenant;
416
- /** The ID of the tenant associated with this event. */
417
- tenantId: string;
418
- /** The workflow run summary for this event. */
419
- workflowRunSummary?: EventWorkflowRunSummary;
420
- /** Additional metadata for the event. */
421
- additionalMetadata?: object;
422
- }
423
- export interface EventData {
424
- /** The data for the event (JSON bytes). */
425
- data: string;
426
- }
427
- export interface CreateEventRequest {
428
- /** The key for the event. */
429
- key: string;
430
- /** The data for the event. */
431
- data: object;
432
- /** Additional metadata for the event. */
433
- additionalMetadata?: object;
434
- /**
435
- * The priority of the event.
436
- * @format int32
437
- */
438
- priority?: number;
439
- /** The scope for event filtering. */
440
- scope?: string;
441
- }
442
- export interface BulkCreateEventRequest {
443
- events: CreateEventRequest[];
444
- }
445
- export interface BulkCreateEventResponse {
446
- metadata: APIResourceMeta;
447
- /** The events. */
448
- events: Event[];
674
+ version: TenantVersion;
675
+ /** The environment type of the tenant. */
676
+ environment?: TenantEnvironment;
449
677
  }
450
- export interface EventWorkflowRunSummary {
451
- /**
452
- * The number of pending runs.
453
- * @format int64
454
- */
455
- pending?: number;
678
+ export interface V1EventWorkflowRunSummary {
456
679
  /**
457
680
  * The number of running runs.
458
681
  * @format int64
459
682
  */
460
- running?: number;
683
+ running: number;
461
684
  /**
462
685
  * The number of queued runs.
463
686
  * @format int64
464
687
  */
465
- queued?: number;
688
+ queued: number;
466
689
  /**
467
690
  * The number of succeeded runs.
468
691
  * @format int64
469
692
  */
470
- succeeded?: number;
693
+ succeeded: number;
471
694
  /**
472
695
  * The number of failed runs.
473
696
  * @format int64
474
697
  */
475
- failed?: number;
698
+ failed: number;
476
699
  /**
477
700
  * The number of cancelled runs.
478
701
  * @format int64
479
702
  */
480
- cancelled?: number;
481
- }
482
- export declare enum EventOrderByField {
483
- CreatedAt = "createdAt"
484
- }
485
- export declare enum EventOrderByDirection {
486
- Asc = "asc",
487
- Desc = "desc"
703
+ cancelled: number;
488
704
  }
489
- export type EventSearch = string;
490
- export interface EventKeyList {
491
- pagination?: PaginationResponse;
492
- rows?: EventKey[];
705
+ export interface V1EventTriggeredRun {
706
+ /**
707
+ * The external ID of the triggered run.
708
+ * @format uuid
709
+ * @minLength 36
710
+ * @maxLength 36
711
+ */
712
+ workflowRunId: string;
713
+ /**
714
+ * The ID of the filter that triggered the run, if applicable.
715
+ * @format uuid
716
+ */
717
+ filterId?: string;
493
718
  }
494
- /** The key for the event. */
495
- export type EventKey = string;
496
- /** A workflow ID. */
497
- export type WorkflowID = string;
498
- export interface EventList {
499
- pagination?: PaginationResponse;
500
- rows?: Event[];
719
+ export interface V1Event {
720
+ metadata: APIResourceMeta;
721
+ /** The key for the event. */
722
+ key: string;
723
+ /** The tenant associated with this event. */
724
+ tenant?: Tenant;
725
+ /** The ID of the tenant associated with this event. */
726
+ tenantId: string;
727
+ /** The workflow run summary for this event. */
728
+ workflowRunSummary: V1EventWorkflowRunSummary;
729
+ /** Additional metadata for the event. */
730
+ additionalMetadata?: object;
731
+ /** The payload of the event, which can be any JSON-serializable object. */
732
+ payload?: object;
733
+ /** The scope of the event, which can be used to filter or categorize events. */
734
+ scope?: string;
735
+ /**
736
+ * The timestamp when the event was seen.
737
+ * @format date-time
738
+ */
739
+ seenAt?: string;
740
+ /** The external IDs of the runs that were triggered by this event. */
741
+ triggeredRuns?: V1EventTriggeredRun[];
742
+ /** The name of the webhook that triggered this event, if applicable. */
743
+ triggeringWebhookName?: string;
501
744
  }
502
745
  export interface V1EventList {
503
746
  pagination?: PaginationResponse;
504
- rows?: {
505
- metadata: APIResourceMeta;
506
- /** The key for the event. */
507
- key: string;
508
- /** The tenant associated with this event. */
509
- tenant?: Tenant;
510
- /** The ID of the tenant associated with this event. */
511
- tenantId: string;
512
- /** The workflow run summary for this event. */
513
- workflowRunSummary: {
514
- /**
515
- * The number of running runs.
516
- * @format int64
517
- */
518
- running: number;
519
- /**
520
- * The number of queued runs.
521
- * @format int64
522
- */
523
- queued: number;
524
- /**
525
- * The number of succeeded runs.
526
- * @format int64
527
- */
528
- succeeded: number;
529
- /**
530
- * The number of failed runs.
531
- * @format int64
532
- */
533
- failed: number;
534
- /**
535
- * The number of cancelled runs.
536
- * @format int64
537
- */
538
- cancelled: number;
539
- };
540
- /** Additional metadata for the event. */
541
- additionalMetadata?: object;
542
- /** The payload of the event, which can be any JSON-serializable object. */
543
- payload?: object;
544
- /** The scope of the event, which can be used to filter or categorize events. */
545
- scope?: string;
546
- /**
547
- * The timestamp when the event was seen.
548
- * @format date-time
549
- */
550
- seenAt?: string;
551
- /** The external IDs of the runs that were triggered by this event. */
552
- triggeredRuns?: {
553
- /**
554
- * The external ID of the triggered run.
555
- * @format uuid
556
- * @minLength 36
557
- * @maxLength 36
558
- */
559
- workflowRunId: string;
560
- /**
561
- * The ID of the filter that triggered the run, if applicable.
562
- * @format uuid
563
- */
564
- filterId?: string;
565
- }[];
566
- /** The name of the webhook that triggered this event, if applicable. */
567
- triggeringWebhookName?: string;
568
- }[];
747
+ rows?: V1Event[];
569
748
  }
570
- export interface V1FilterList {
749
+ export interface EventKeyList {
571
750
  pagination?: PaginationResponse;
572
- rows?: V1Filter[];
751
+ rows?: EventKey[];
573
752
  }
574
753
  export interface V1Filter {
575
754
  metadata: APIResourceMeta;
@@ -591,9 +770,32 @@ export interface V1Filter {
591
770
  /** Whether the filter is declarative (true) or programmatic (false) */
592
771
  isDeclarative?: boolean;
593
772
  }
594
- export interface V1WebhookList {
595
- pagination?: PaginationResponse;
596
- rows?: V1Webhook[];
773
+ export interface V1FilterList {
774
+ pagination?: PaginationResponse;
775
+ rows?: V1Filter[];
776
+ }
777
+ export interface V1CreateFilterRequest {
778
+ /**
779
+ * The workflow id
780
+ * @format uuid
781
+ * @minLength 36
782
+ * @maxLength 36
783
+ */
784
+ workflowId: string;
785
+ /** The expression for the filter */
786
+ expression: string;
787
+ /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
788
+ scope: string;
789
+ /** The payload for the filter */
790
+ payload?: object;
791
+ }
792
+ export interface V1UpdateFilterRequest {
793
+ /** The expression for the filter */
794
+ expression?: string;
795
+ /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
796
+ scope?: string;
797
+ /** The payload for the filter */
798
+ payload?: object;
597
799
  }
598
800
  export interface V1Webhook {
599
801
  metadata: APIResourceMeta;
@@ -608,743 +810,594 @@ export interface V1Webhook {
608
810
  /** The type of authentication to use for the webhook */
609
811
  authType: V1WebhookAuthType;
610
812
  }
611
- export declare enum V1WebhookSourceName {
612
- GENERIC = "GENERIC",
613
- GITHUB = "GITHUB",
614
- STRIPE = "STRIPE",
615
- SLACK = "SLACK",
616
- LINEAR = "LINEAR"
617
- }
618
- export declare enum V1WebhookAuthType {
619
- BASIC = "BASIC",
620
- API_KEY = "API_KEY",
621
- HMAC = "HMAC"
622
- }
623
- export interface RateLimit {
624
- /** The key for the rate limit. */
625
- key: string;
626
- /** The ID of the tenant associated with this rate limit. */
627
- tenantId: string;
628
- /** The maximum number of requests allowed within the window. */
629
- limitValue: number;
630
- /** The current number of requests made within the window. */
631
- value: number;
632
- /** The window of time in which the limitValue is enforced. */
633
- window: string;
634
- /**
635
- * The last time the rate limit was refilled.
636
- * @format date-time
637
- * @example "2022-12-13T15:06:48.888358-05:00"
638
- */
639
- lastRefill: string;
640
- }
641
- export interface RateLimitList {
813
+ export interface V1WebhookList {
642
814
  pagination?: PaginationResponse;
643
- rows?: RateLimit[];
815
+ rows?: V1Webhook[];
644
816
  }
645
- export declare enum RateLimitOrderByField {
646
- Key = "key",
647
- Value = "value",
648
- LimitValue = "limitValue"
817
+ export interface V1CreateWebhookRequestBase {
818
+ /** The name of the source for this webhook */
819
+ sourceName: V1WebhookSourceName;
820
+ /** The name of the webhook */
821
+ name: string;
822
+ /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
823
+ eventKeyExpression: string;
649
824
  }
650
- export declare enum RateLimitOrderByDirection {
651
- Asc = "asc",
652
- Desc = "desc"
825
+ export interface V1WebhookBasicAuth {
826
+ /** The username for basic auth */
827
+ username: string;
828
+ /** The password for basic auth */
829
+ password: string;
653
830
  }
654
- export interface ReplayEventRequest {
655
- eventIds: string[];
831
+ export type V1CreateWebhookRequestBasicAuth = V1CreateWebhookRequestBase & {
832
+ /** The type of authentication to use for the webhook */
833
+ authType: 'BASIC';
834
+ auth: V1WebhookBasicAuth;
835
+ };
836
+ export interface V1WebhookAPIKeyAuth {
837
+ /** The name of the header to use for the API key */
838
+ headerName: string;
839
+ /** The API key to use for authentication */
840
+ apiKey: string;
656
841
  }
657
- export interface CancelEventRequest {
658
- eventIds: string[];
842
+ export type V1CreateWebhookRequestAPIKey = V1CreateWebhookRequestBase & {
843
+ /** The type of authentication to use for the webhook */
844
+ authType: 'API_KEY';
845
+ auth: V1WebhookAPIKeyAuth;
846
+ };
847
+ export interface V1WebhookHMACAuth {
848
+ /** The HMAC algorithm to use for the webhook */
849
+ algorithm: V1WebhookHMACAlgorithm;
850
+ /** The encoding to use for the HMAC signature */
851
+ encoding: V1WebhookHMACEncoding;
852
+ /** The name of the header to use for the HMAC signature */
853
+ signatureHeaderName: string;
854
+ /** The secret key used to sign the HMAC signature */
855
+ signingSecret: string;
856
+ }
857
+ export type V1CreateWebhookRequestHMAC = V1CreateWebhookRequestBase & {
858
+ /** The type of authentication to use for the webhook */
859
+ authType: 'HMAC';
860
+ auth: V1WebhookHMACAuth;
861
+ };
862
+ export type V1CreateWebhookRequest = V1CreateWebhookRequestBasicAuth | V1CreateWebhookRequestAPIKey | V1CreateWebhookRequestHMAC;
863
+ export interface V1UpdateWebhookRequest {
864
+ /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
865
+ eventKeyExpression: string;
659
866
  }
660
- export interface Workflow {
661
- metadata: APIResourceMeta;
662
- /** The name of the workflow. */
663
- name: string;
664
- /** The description of the workflow. */
665
- description?: string;
666
- /** Whether the workflow is paused. */
667
- isPaused?: boolean;
668
- versions?: WorkflowVersionMeta[];
669
- /** The tags of the workflow. */
670
- tags?: WorkflowTag[];
671
- /** The jobs of the workflow. */
672
- jobs?: Job[];
673
- /** The tenant id of the workflow. */
674
- tenantId: string;
867
+ export interface V1CELDebugRequest {
868
+ /** The CEL expression to evaluate */
869
+ expression: string;
870
+ /** The input, which simulates the workflow run input */
871
+ input: object;
872
+ /** The filter payload, which simulates a payload set on a previous-created filter */
873
+ filterPayload?: object;
874
+ /** Additional metadata, which simulates metadata that could be sent with an event or a workflow run */
875
+ additionalMetadata?: object;
675
876
  }
676
- export interface WorkflowUpdateRequest {
677
- /** Whether the workflow is paused. */
678
- isPaused?: boolean;
877
+ export interface V1CELDebugResponse {
878
+ /** The status of the CEL evaluation */
879
+ status: V1CELDebugResponseStatus;
880
+ /** The result of the CEL expression evaluation, if successful */
881
+ output?: boolean;
882
+ /** The error message if the evaluation failed */
883
+ error?: string;
679
884
  }
680
- export interface WorkflowConcurrency {
885
+ export interface APIMetaAuth {
681
886
  /**
682
- * The maximum number of concurrent workflow runs.
683
- * @format int32
887
+ * the supported types of authentication
888
+ * @example ["basic","google"]
684
889
  */
685
- maxRuns: number;
686
- /** The strategy to use when the concurrency limit is reached. */
687
- limitStrategy: 'CANCEL_IN_PROGRESS' | 'DROP_NEWEST' | 'QUEUE_NEWEST' | 'GROUP_ROUND_ROBIN';
688
- /** An action which gets the concurrency group for the WorkflowRun. */
689
- getConcurrencyGroup: string;
690
- }
691
- export interface WorkflowVersionMeta {
692
- metadata: APIResourceMeta;
693
- /** The version of the workflow. */
694
- version: string;
695
- /** @format int32 */
696
- order: number;
697
- workflowId: string;
698
- workflow?: Workflow;
890
+ schemes?: string[];
699
891
  }
700
- export interface WorkflowVersion {
701
- metadata: APIResourceMeta;
702
- /** The version of the workflow. */
703
- version: string;
704
- /** @format int32 */
705
- order: number;
706
- workflowId: string;
707
- /** The sticky strategy of the workflow. */
708
- sticky?: string;
892
+ export interface APIMetaPosthog {
709
893
  /**
710
- * The default priority of the workflow.
711
- * @format int32
894
+ * the PostHog API key
895
+ * @example "phk_1234567890abcdef"
712
896
  */
713
- defaultPriority?: number;
714
- workflow?: Workflow;
715
- concurrency?: WorkflowConcurrency;
716
- triggers?: WorkflowTriggers;
717
- scheduleTimeout?: string;
718
- jobs?: Job[];
719
- workflowConfig?: object;
720
- }
721
- export interface WorkflowVersionDefinition {
722
- /** The raw YAML definition of the workflow. */
723
- rawDefinition: string;
724
- }
725
- export interface WorkflowTag {
726
- /** The name of the workflow. */
727
- name: string;
728
- /** The description of the workflow. */
729
- color: string;
730
- }
731
- export interface WorkflowList {
732
- metadata?: APIResourceMeta;
733
- rows?: Workflow[];
734
- pagination?: PaginationResponse;
735
- }
736
- export interface WorkflowTriggers {
737
- metadata?: APIResourceMeta;
738
- workflow_version_id?: string;
739
- tenant_id?: string;
740
- events?: WorkflowTriggerEventRef[];
741
- crons?: WorkflowTriggerCronRef[];
742
- }
743
- export interface WorkflowTriggerEventRef {
744
- parent_id?: string;
745
- event_key?: string;
746
- }
747
- export interface WorkflowTriggerCronRef {
748
- parent_id?: string;
749
- cron?: string;
750
- }
751
- export interface Job {
752
- metadata: APIResourceMeta;
753
- tenantId: string;
754
- versionId: string;
755
- name: string;
756
- /** The description of the job. */
757
- description?: string;
758
- steps: Step[];
759
- /** The timeout of the job. */
760
- timeout?: string;
761
- }
762
- export interface Step {
763
- metadata: APIResourceMeta;
764
- /** The readable id of the step. */
765
- readableId: string;
766
- tenantId: string;
767
- jobId: string;
768
- action: string;
769
- /** The timeout of the step. */
770
- timeout?: string;
771
- children?: string[];
772
- parents?: string[];
773
- }
774
- export interface WorkflowWorkersCount {
775
- freeSlotCount?: number;
776
- maxSlotCount?: number;
777
- workflowRunId?: string;
897
+ apiKey?: string;
898
+ /**
899
+ * the PostHog API host
900
+ * @example "https://posthog.example.com"
901
+ */
902
+ apiHost?: string;
778
903
  }
779
- export interface WorkflowRun {
780
- metadata: APIResourceMeta;
781
- tenantId: string;
782
- workflowVersionId: string;
783
- workflowVersion?: WorkflowVersion;
784
- status: WorkflowRunStatus;
785
- displayName?: string;
786
- jobRuns?: JobRun[];
787
- triggeredBy: WorkflowRunTriggeredBy;
788
- input?: Record<string, any>;
789
- error?: string;
790
- /** @format date-time */
791
- startedAt?: string;
792
- /** @format date-time */
793
- finishedAt?: string;
794
- /** @example 1000 */
795
- duration?: number;
904
+ export interface APIMeta {
905
+ auth?: APIMetaAuth;
906
+ /**
907
+ * the Pylon app ID for usepylon.com chat support
908
+ * @example "12345678-1234-1234-1234-123456789012"
909
+ */
910
+ pylonAppId?: string;
911
+ posthog?: APIMetaPosthog;
912
+ /**
913
+ * whether or not users can sign up for this instance
914
+ * @example true
915
+ */
916
+ allowSignup?: boolean;
917
+ /**
918
+ * whether or not users can invite other users to this instance
919
+ * @example true
920
+ */
921
+ allowInvites?: boolean;
922
+ /**
923
+ * whether or not users can create new tenants
924
+ * @example true
925
+ */
926
+ allowCreateTenant?: boolean;
796
927
  /**
797
- * @format uuid
798
- * @minLength 36
799
- * @maxLength 36
800
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
928
+ * whether or not users can change their password
929
+ * @example true
801
930
  */
802
- parentId?: string;
931
+ allowChangePassword?: boolean;
932
+ }
933
+ export interface APIMetaIntegration {
803
934
  /**
804
- * @format uuid
805
- * @minLength 36
806
- * @maxLength 36
807
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
935
+ * the name of the integration
936
+ * @example "github"
808
937
  */
809
- parentStepRunId?: string;
810
- additionalMetadata?: Record<string, any>;
938
+ name: string;
939
+ /** whether this integration is enabled on the instance */
940
+ enabled: boolean;
811
941
  }
812
- export interface WorkflowRunShape {
942
+ export type ListAPIMetaIntegration = APIMetaIntegration[];
943
+ export interface UserLoginRequest {
944
+ /**
945
+ * The email address of the user.
946
+ * @format email
947
+ */
948
+ email: string;
949
+ /** The password of the user. */
950
+ password: string;
951
+ }
952
+ export interface User {
813
953
  metadata: APIResourceMeta;
814
- tenantId: string;
815
- workflowId?: string;
816
- workflowVersionId: string;
817
- workflowVersion?: WorkflowVersion;
818
- status: WorkflowRunStatus;
819
- displayName?: string;
820
- jobRuns?: JobRun[];
821
- triggeredBy: WorkflowRunTriggeredBy;
822
- input?: Record<string, any>;
823
- error?: string;
824
- /** @format date-time */
825
- startedAt?: string;
826
- /** @format date-time */
827
- finishedAt?: string;
828
- /** @example 1000 */
829
- duration?: number;
954
+ /** The display name of the user. */
955
+ name?: string;
830
956
  /**
831
- * @format uuid
832
- * @minLength 36
833
- * @maxLength 36
834
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
957
+ * The email address of the user.
958
+ * @format email
835
959
  */
836
- parentId?: string;
960
+ email: string;
961
+ /** Whether the user has verified their email address. */
962
+ emailVerified: boolean;
963
+ /** Whether the user has a password set. */
964
+ hasPassword?: boolean;
965
+ /** A hash of the user's email address for use with Pylon Support Chat */
966
+ emailHash?: string;
967
+ }
968
+ export interface SNSIntegration {
969
+ metadata: APIResourceMeta;
837
970
  /**
971
+ * The unique identifier for the tenant that the SNS integration belongs to.
838
972
  * @format uuid
839
- * @minLength 36
840
- * @maxLength 36
841
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
842
973
  */
843
- parentStepRunId?: string;
844
- additionalMetadata?: Record<string, any>;
974
+ tenantId: string;
975
+ /** The Amazon Resource Name (ARN) of the SNS topic. */
976
+ topicArn: string;
977
+ /** The URL to send SNS messages to. */
978
+ ingestUrl?: string;
845
979
  }
846
- export interface ReplayWorkflowRunsRequest {
847
- /** @maxLength 500 */
848
- workflowRunIds: string[];
980
+ export interface ListSNSIntegrations {
981
+ pagination: PaginationResponse;
982
+ rows: SNSIntegration[];
849
983
  }
850
- export interface ReplayWorkflowRunsResponse {
851
- workflowRuns: WorkflowRun[];
984
+ export interface CreateSNSIntegrationRequest {
985
+ /** The Amazon Resource Name (ARN) of the SNS topic. */
986
+ topicArn: string;
852
987
  }
853
- export interface WorkflowRunList {
854
- rows?: WorkflowRun[];
988
+ export interface TenantAlertEmailGroup {
989
+ metadata: APIResourceMeta;
990
+ /** A list of emails for users */
991
+ emails: string[];
992
+ }
993
+ export interface TenantAlertEmailGroupList {
855
994
  pagination?: PaginationResponse;
995
+ rows?: TenantAlertEmailGroup[];
856
996
  }
857
- export interface ScheduledWorkflows {
997
+ export interface CreateTenantAlertEmailGroupRequest {
998
+ /** A list of emails for users */
999
+ emails: string[];
1000
+ }
1001
+ export interface TenantResourceLimit {
858
1002
  metadata: APIResourceMeta;
859
- tenantId: string;
860
- workflowVersionId: string;
861
- workflowId: string;
862
- workflowName: string;
863
- /** @format date-time */
864
- triggerAt: string;
865
- input?: Record<string, any>;
866
- additionalMetadata?: Record<string, any>;
867
- /** @format date-time */
868
- workflowRunCreatedAt?: string;
869
- workflowRunName?: string;
870
- workflowRunStatus?: WorkflowRunStatus;
871
- /**
872
- * @format uuid
873
- * @minLength 36
874
- * @maxLength 36
875
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
876
- */
877
- workflowRunId?: string;
878
- method: 'DEFAULT' | 'API';
1003
+ /** The resource associated with this limit. */
1004
+ resource: TenantResource;
1005
+ /** The limit associated with this limit. */
1006
+ limitValue: number;
1007
+ /** The alarm value associated with this limit to warn of approaching limit value. */
1008
+ alarmValue?: number;
1009
+ /** The current value associated with this limit. */
1010
+ value: number;
1011
+ /** The meter window for the limit. (i.e. 1 day, 1 week, 1 month) */
1012
+ window?: string;
879
1013
  /**
880
- * @format int32
881
- * @min 1
882
- * @max 3
1014
+ * The last time the limit was refilled.
1015
+ * @format date-time
883
1016
  */
884
- priority?: number;
1017
+ lastRefill?: string;
885
1018
  }
886
- export interface ScheduledWorkflowsList {
887
- rows?: ScheduledWorkflows[];
888
- pagination?: PaginationResponse;
1019
+ export interface TenantResourcePolicy {
1020
+ /** A list of resource limits for the tenant. */
1021
+ limits: TenantResourceLimit[];
889
1022
  }
890
- export interface UpdateScheduledWorkflowRunRequest {
891
- /** @format date-time */
892
- triggerAt: string;
1023
+ export interface UpdateTenantAlertEmailGroupRequest {
1024
+ /** A list of emails for users */
1025
+ emails: string[];
893
1026
  }
894
- export interface ScheduledWorkflowsBulkDeleteFilter {
895
- /**
896
- * @format uuid
897
- * @minLength 36
898
- * @maxLength 36
899
- */
900
- workflowId?: string;
901
- /**
902
- * @format uuid
903
- * @minLength 36
904
- * @maxLength 36
905
- */
906
- parentWorkflowRunId?: string;
1027
+ export interface SlackWebhook {
1028
+ metadata: APIResourceMeta;
907
1029
  /**
1030
+ * The unique identifier for the tenant that the SNS integration belongs to.
908
1031
  * @format uuid
909
- * @minLength 36
910
- * @maxLength 36
911
- */
912
- parentStepRunId?: string;
913
- /**
914
- * A list of metadata key value pairs to filter by
915
- * @example ["key1:value1","key2:value2"]
916
1032
  */
917
- additionalMetadata?: string[];
918
- /** A list of scheduled run statuses to filter by */
919
- statuses?: ScheduledRunStatus[];
1033
+ tenantId: string;
1034
+ /** The team name associated with this slack webhook. */
1035
+ teamName: string;
1036
+ /** The team id associated with this slack webhook. */
1037
+ teamId: string;
1038
+ /** The channel name associated with this slack webhook. */
1039
+ channelName: string;
1040
+ /** The channel id associated with this slack webhook. */
1041
+ channelId: string;
920
1042
  }
921
- export interface ScheduledWorkflowsBulkDeleteRequest {
922
- /** @maxItems 500 */
923
- scheduledWorkflowRunIds?: string[];
924
- filter?: ScheduledWorkflowsBulkDeleteFilter;
1043
+ export interface ListSlackWebhooks {
1044
+ pagination: PaginationResponse;
1045
+ rows: SlackWebhook[];
925
1046
  }
926
- export interface ScheduledWorkflowsBulkError {
1047
+ export interface UserChangePasswordRequest {
1048
+ /** The password of the user. */
1049
+ password: string;
1050
+ /** The new password for the user. */
1051
+ newPassword: string;
1052
+ }
1053
+ export interface UserRegisterRequest {
1054
+ /** The name of the user. */
1055
+ name: string;
927
1056
  /**
928
- * @format uuid
929
- * @minLength 36
930
- * @maxLength 36
1057
+ * The email address of the user.
1058
+ * @format email
931
1059
  */
932
- id?: string;
933
- error: string;
934
- }
935
- export interface ScheduledWorkflowsBulkDeleteResponse {
936
- deletedIds: string[];
937
- errors: ScheduledWorkflowsBulkError[];
1060
+ email: string;
1061
+ /** The password of the user. */
1062
+ password: string;
938
1063
  }
939
- export interface ScheduledWorkflowsBulkUpdateItem {
1064
+ export interface UserTenantPublic {
940
1065
  /**
941
- * @format uuid
942
- * @minLength 36
943
- * @maxLength 36
1066
+ * The email address of the user.
1067
+ * @format email
944
1068
  */
945
- id: string;
946
- /** @format date-time */
947
- triggerAt: string;
948
- }
949
- export interface ScheduledWorkflowsBulkUpdateRequest {
950
- /** @maxItems 500 */
951
- updates: ScheduledWorkflowsBulkUpdateItem[];
952
- }
953
- export interface ScheduledWorkflowsBulkUpdateResponse {
954
- updatedIds: string[];
955
- errors: ScheduledWorkflowsBulkError[];
956
- }
957
- export declare enum ScheduledWorkflowsOrderByField {
958
- TriggerAt = "triggerAt",
959
- CreatedAt = "createdAt"
1069
+ email: string;
1070
+ /** The display name of the user. */
1071
+ name?: string;
960
1072
  }
961
- export declare enum ScheduledRunStatus {
962
- PENDING = "PENDING",
963
- RUNNING = "RUNNING",
964
- SUCCEEDED = "SUCCEEDED",
965
- FAILED = "FAILED",
966
- CANCELLED = "CANCELLED",
967
- QUEUED = "QUEUED",
968
- SCHEDULED = "SCHEDULED"
1073
+ export interface TenantMember {
1074
+ metadata: APIResourceMeta;
1075
+ /** The user associated with this tenant member. */
1076
+ user: UserTenantPublic;
1077
+ /** The role of the user in the tenant. */
1078
+ role: TenantMemberRole;
1079
+ /** The tenant associated with this tenant member. */
1080
+ tenant?: Tenant;
969
1081
  }
970
- export interface CronWorkflows {
1082
+ export interface UserTenantMembershipsList {
1083
+ pagination?: PaginationResponse;
1084
+ rows?: TenantMember[];
1085
+ }
1086
+ export interface TenantInvite {
971
1087
  metadata: APIResourceMeta;
1088
+ /** The email of the user to invite. */
1089
+ email: string;
1090
+ /** The role of the user in the tenant. */
1091
+ role: TenantMemberRole;
1092
+ /** The tenant id associated with this tenant invite. */
972
1093
  tenantId: string;
973
- workflowVersionId: string;
974
- workflowId: string;
975
- workflowName: string;
976
- cron: string;
977
- name?: string;
978
- input?: Record<string, any>;
979
- additionalMetadata?: Record<string, any>;
980
- enabled: boolean;
981
- method: 'DEFAULT' | 'API';
1094
+ /** The tenant name for the tenant. */
1095
+ tenantName?: string;
982
1096
  /**
983
- * @format int32
984
- * @min 1
985
- * @max 3
1097
+ * The time that this invite expires.
1098
+ * @format date-time
986
1099
  */
987
- priority?: number;
1100
+ expires: string;
988
1101
  }
989
- export interface CronWorkflowsList {
990
- rows?: CronWorkflows[];
1102
+ export interface TenantInviteList {
991
1103
  pagination?: PaginationResponse;
1104
+ rows?: TenantInvite[];
992
1105
  }
993
- export declare enum CronWorkflowsOrderByField {
994
- Name = "name",
995
- CreatedAt = "createdAt"
996
- }
997
- export declare enum WorkflowRunOrderByField {
998
- CreatedAt = "createdAt",
999
- StartedAt = "startedAt",
1000
- FinishedAt = "finishedAt",
1001
- Duration = "duration"
1002
- }
1003
- export declare enum WorkflowRunOrderByDirection {
1004
- ASC = "ASC",
1005
- DESC = "DESC"
1006
- }
1007
- export interface WorkflowRunsMetrics {
1008
- counts?: WorkflowRunsMetricsCounts;
1009
- }
1010
- export interface WorkflowRunsMetricsCounts {
1011
- PENDING?: number;
1012
- RUNNING?: number;
1013
- SUCCEEDED?: number;
1014
- FAILED?: number;
1015
- QUEUED?: number;
1016
- CANCELLED?: number;
1017
- }
1018
- export declare enum WorkflowRunStatus {
1019
- PENDING = "PENDING",
1020
- RUNNING = "RUNNING",
1021
- SUCCEEDED = "SUCCEEDED",
1022
- FAILED = "FAILED",
1023
- CANCELLED = "CANCELLED",
1024
- QUEUED = "QUEUED",
1025
- BACKOFF = "BACKOFF"
1026
- }
1027
- export type WorkflowRunStatusList = WorkflowRunStatus[];
1028
- export declare enum WorkflowKind {
1029
- FUNCTION = "FUNCTION",
1030
- DURABLE = "DURABLE",
1031
- DAG = "DAG"
1032
- }
1033
- export type WorkflowKindList = WorkflowKind[];
1034
- export interface WorkflowRunsCancelRequest {
1035
- workflowRunIds: string[];
1036
- }
1037
- export declare enum JobRunStatus {
1038
- PENDING = "PENDING",
1039
- RUNNING = "RUNNING",
1040
- SUCCEEDED = "SUCCEEDED",
1041
- FAILED = "FAILED",
1042
- CANCELLED = "CANCELLED",
1043
- BACKOFF = "BACKOFF"
1106
+ export interface AcceptInviteRequest {
1107
+ /**
1108
+ * @minLength 36
1109
+ * @maxLength 36
1110
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1111
+ */
1112
+ invite: string;
1044
1113
  }
1045
- export declare enum StepRunStatus {
1046
- PENDING = "PENDING",
1047
- PENDING_ASSIGNMENT = "PENDING_ASSIGNMENT",
1048
- ASSIGNED = "ASSIGNED",
1049
- RUNNING = "RUNNING",
1050
- SUCCEEDED = "SUCCEEDED",
1051
- FAILED = "FAILED",
1052
- CANCELLED = "CANCELLED",
1053
- CANCELLING = "CANCELLING",
1054
- BACKOFF = "BACKOFF"
1114
+ export interface RejectInviteRequest {
1115
+ /**
1116
+ * @minLength 36
1117
+ * @maxLength 36
1118
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1119
+ */
1120
+ invite: string;
1055
1121
  }
1056
- export interface JobRun {
1057
- metadata: APIResourceMeta;
1058
- tenantId: string;
1059
- workflowRunId: string;
1060
- workflowRun?: WorkflowRun;
1061
- jobId: string;
1062
- job?: Job;
1063
- tickerId?: string;
1064
- stepRuns?: StepRun[];
1065
- status: JobRunStatus;
1066
- result?: object;
1067
- /** @format date-time */
1068
- startedAt?: string;
1069
- /** @format date-time */
1070
- finishedAt?: string;
1071
- /** @format date-time */
1072
- timeoutAt?: string;
1073
- /** @format date-time */
1074
- cancelledAt?: string;
1075
- cancelledReason?: string;
1076
- cancelledError?: string;
1122
+ export interface CreateTenantRequest {
1123
+ /** The name of the tenant. */
1124
+ name: string;
1125
+ /** The slug of the tenant. */
1126
+ slug: string;
1127
+ /** The engine version of the tenant. Defaults to V0. */
1128
+ engineVersion?: TenantVersion;
1129
+ /** The environment type of the tenant. */
1130
+ environment?: TenantEnvironment;
1131
+ /** Additional onboarding data to store with the tenant. */
1132
+ onboardingData?: Record<string, any>;
1077
1133
  }
1078
- export interface WorkflowRunTriggeredBy {
1079
- metadata: APIResourceMeta;
1080
- parentWorkflowRunId?: string;
1081
- eventId?: string;
1082
- cronParentId?: string;
1083
- cronSchedule?: string;
1134
+ export interface UpdateTenantRequest {
1135
+ /** The name of the tenant. */
1136
+ name?: string;
1137
+ /** Whether the tenant has opted out of analytics. */
1138
+ analyticsOptOut?: boolean;
1139
+ /** Whether to alert tenant members. */
1140
+ alertMemberEmails?: boolean;
1141
+ /** Whether to send alerts when workflow runs fail. */
1142
+ enableWorkflowRunFailureAlerts?: boolean;
1143
+ /** Whether to enable alerts when tokens are approaching expiration. */
1144
+ enableExpiringTokenAlerts?: boolean;
1145
+ /** Whether to enable alerts when tenant resources are approaching limits. */
1146
+ enableTenantResourceLimitAlerts?: boolean;
1147
+ /** The max frequency at which to alert. */
1148
+ maxAlertingFrequency?: string;
1149
+ /** The version of the tenant. */
1150
+ version?: TenantVersion;
1084
1151
  }
1085
- export interface StepRun {
1152
+ export interface TenantAlertingSettings {
1086
1153
  metadata: APIResourceMeta;
1087
- tenantId: string;
1088
- jobRunId: string;
1089
- jobRun?: JobRun;
1090
- stepId: string;
1091
- step?: Step;
1092
- childWorkflowsCount?: number;
1093
- parents?: string[];
1094
- childWorkflowRuns?: string[];
1095
- workerId?: string;
1096
- input?: string;
1097
- output?: string;
1098
- status: StepRunStatus;
1099
- /** @format date-time */
1100
- requeueAfter?: string;
1101
- result?: object;
1102
- error?: string;
1103
- /** @format date-time */
1104
- startedAt?: string;
1105
- startedAtEpoch?: number;
1106
- /** @format date-time */
1107
- finishedAt?: string;
1108
- finishedAtEpoch?: number;
1109
- /** @format date-time */
1110
- timeoutAt?: string;
1111
- timeoutAtEpoch?: number;
1112
- /** @format date-time */
1113
- cancelledAt?: string;
1114
- cancelledAtEpoch?: number;
1115
- cancelledReason?: string;
1116
- cancelledError?: string;
1154
+ /** Whether to alert tenant members. */
1155
+ alertMemberEmails?: boolean;
1156
+ /** Whether to send alerts when workflow runs fail. */
1157
+ enableWorkflowRunFailureAlerts?: boolean;
1158
+ /** Whether to enable alerts when tokens are approaching expiration. */
1159
+ enableExpiringTokenAlerts?: boolean;
1160
+ /** Whether to enable alerts when tenant resources are approaching limits. */
1161
+ enableTenantResourceLimitAlerts?: boolean;
1162
+ /** The max frequency at which to alert. */
1163
+ maxAlertingFrequency: string;
1164
+ /**
1165
+ * The last time an alert was sent.
1166
+ * @format date-time
1167
+ */
1168
+ lastAlertedAt?: string;
1117
1169
  }
1118
- export declare enum StepRunEventReason {
1119
- REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
1120
- REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
1121
- SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
1122
- ASSIGNED = "ASSIGNED",
1123
- STARTED = "STARTED",
1124
- ACKNOWLEDGED = "ACKNOWLEDGED",
1125
- FINISHED = "FINISHED",
1126
- FAILED = "FAILED",
1127
- RETRYING = "RETRYING",
1128
- CANCELLED = "CANCELLED",
1129
- TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
1130
- REASSIGNED = "REASSIGNED",
1131
- TIMED_OUT = "TIMED_OUT",
1132
- SLOT_RELEASED = "SLOT_RELEASED",
1133
- RETRIED_BY_USER = "RETRIED_BY_USER",
1134
- WORKFLOW_RUN_GROUP_KEY_SUCCEEDED = "WORKFLOW_RUN_GROUP_KEY_SUCCEEDED",
1135
- WORKFLOW_RUN_GROUP_KEY_FAILED = "WORKFLOW_RUN_GROUP_KEY_FAILED"
1170
+ export interface CreateTenantInviteRequest {
1171
+ /** The email of the user to invite. */
1172
+ email: string;
1173
+ /** The role of the user in the tenant. */
1174
+ role: TenantMemberRole;
1136
1175
  }
1137
- export declare enum StepRunEventSeverity {
1138
- INFO = "INFO",
1139
- WARNING = "WARNING",
1140
- CRITICAL = "CRITICAL"
1176
+ export interface UpdateTenantInviteRequest {
1177
+ /** The role of the user in the tenant. */
1178
+ role: TenantMemberRole;
1141
1179
  }
1142
- export interface StepRunEvent {
1143
- id: number;
1144
- /** @format date-time */
1145
- timeFirstSeen: string;
1146
- /** @format date-time */
1147
- timeLastSeen: string;
1148
- stepRunId?: string;
1149
- workflowRunId?: string;
1150
- reason: StepRunEventReason;
1151
- severity: StepRunEventSeverity;
1152
- message: string;
1153
- count: number;
1154
- data?: object;
1180
+ export interface APIToken {
1181
+ metadata: APIResourceMeta;
1182
+ /**
1183
+ * The name of the API token.
1184
+ * @maxLength 255
1185
+ */
1186
+ name: string;
1187
+ /**
1188
+ * When the API token expires.
1189
+ * @format date-time
1190
+ */
1191
+ expiresAt: string;
1155
1192
  }
1156
- export interface StepRunEventList {
1193
+ export interface ListAPITokensResponse {
1157
1194
  pagination?: PaginationResponse;
1158
- rows?: StepRunEvent[];
1195
+ rows?: APIToken[];
1159
1196
  }
1160
- export interface StepRunArchive {
1161
- stepRunId: string;
1162
- order: number;
1163
- input?: string;
1164
- output?: string;
1165
- /** @format date-time */
1166
- startedAt?: string;
1167
- error?: string;
1168
- retryCount: number;
1169
- /** @format date-time */
1170
- createdAt: string;
1171
- startedAtEpoch?: number;
1172
- /** @format date-time */
1173
- finishedAt?: string;
1174
- finishedAtEpoch?: number;
1175
- /** @format date-time */
1176
- timeoutAt?: string;
1177
- timeoutAtEpoch?: number;
1178
- /** @format date-time */
1179
- cancelledAt?: string;
1180
- cancelledAtEpoch?: number;
1181
- cancelledReason?: string;
1182
- cancelledError?: string;
1197
+ export interface CreateAPITokenRequest {
1198
+ /**
1199
+ * A name for the API token.
1200
+ * @maxLength 255
1201
+ */
1202
+ name: string;
1203
+ /** The duration for which the token is valid. */
1204
+ expiresIn?: string;
1183
1205
  }
1184
- export interface StepRunArchiveList {
1185
- pagination?: PaginationResponse;
1186
- rows?: StepRunArchive[];
1206
+ export interface CreateAPITokenResponse {
1207
+ /** The API token. */
1208
+ token: string;
1187
1209
  }
1188
- export interface WorkerRuntimeInfo {
1189
- sdkVersion?: string;
1190
- language?: WorkerRuntimeSDKs;
1191
- languageVersion?: string;
1192
- os?: string;
1193
- runtimeExtra?: string;
1210
+ /** A workflow ID. */
1211
+ export type WorkflowID = string;
1212
+ export interface QueueMetrics {
1213
+ /** The number of items in the queue. */
1214
+ numQueued: number;
1215
+ /** The number of items running. */
1216
+ numRunning: number;
1217
+ /** The number of items pending. */
1218
+ numPending: number;
1194
1219
  }
1195
- export declare enum WorkerRuntimeSDKs {
1196
- GOLANG = "GOLANG",
1197
- PYTHON = "PYTHON",
1198
- TYPESCRIPT = "TYPESCRIPT"
1220
+ export interface TenantQueueMetrics {
1221
+ /** The total queue metrics. */
1222
+ total?: QueueMetrics;
1223
+ workflow?: Record<string, QueueMetrics>;
1224
+ queues?: Record<string, number>;
1199
1225
  }
1200
- export interface WorkerList {
1201
- pagination?: PaginationResponse;
1202
- rows?: Worker[];
1226
+ export interface TenantStepRunQueueMetrics {
1227
+ queues?: object;
1203
1228
  }
1204
- export interface SemaphoreSlots {
1229
+ export type WorkflowRunStatusList = WorkflowRunStatus[];
1230
+ export type EventSearch = string;
1231
+ export interface EventWorkflowRunSummary {
1205
1232
  /**
1206
- * The step run id.
1207
- * @format uuid
1233
+ * The number of pending runs.
1234
+ * @format int64
1208
1235
  */
1209
- stepRunId: string;
1210
- /** The action id. */
1211
- actionId: string;
1236
+ pending?: number;
1212
1237
  /**
1213
- * The time this slot was started.
1214
- * @format date-time
1238
+ * The number of running runs.
1239
+ * @format int64
1215
1240
  */
1216
- startedAt?: string;
1241
+ running?: number;
1217
1242
  /**
1218
- * The time this slot will timeout.
1219
- * @format date-time
1243
+ * The number of queued runs.
1244
+ * @format int64
1220
1245
  */
1221
- timeoutAt?: string;
1246
+ queued?: number;
1222
1247
  /**
1223
- * The workflow run id.
1224
- * @format uuid
1248
+ * The number of succeeded runs.
1249
+ * @format int64
1225
1250
  */
1226
- workflowRunId: string;
1227
- status?: StepRunStatus;
1251
+ succeeded?: number;
1252
+ /**
1253
+ * The number of failed runs.
1254
+ * @format int64
1255
+ */
1256
+ failed?: number;
1257
+ /**
1258
+ * The number of cancelled runs.
1259
+ * @format int64
1260
+ */
1261
+ cancelled?: number;
1228
1262
  }
1229
- export interface RecentStepRuns {
1263
+ export interface Event {
1230
1264
  metadata: APIResourceMeta;
1231
- /** The action id. */
1232
- actionId: string;
1233
- status: StepRunStatus;
1234
- /** @format date-time */
1235
- startedAt?: string;
1236
- /** @format date-time */
1237
- finishedAt?: string;
1238
- /** @format date-time */
1239
- cancelledAt?: string;
1240
- /** @format uuid */
1241
- workflowRunId: string;
1265
+ /** The key for the event. */
1266
+ key: string;
1267
+ /** The tenant associated with this event. */
1268
+ tenant?: Tenant;
1269
+ /** The ID of the tenant associated with this event. */
1270
+ tenantId: string;
1271
+ /** The workflow run summary for this event. */
1272
+ workflowRunSummary?: EventWorkflowRunSummary;
1273
+ /** Additional metadata for the event. */
1274
+ additionalMetadata?: object;
1242
1275
  }
1243
- export interface Worker {
1244
- metadata: APIResourceMeta;
1245
- /** The name of the worker. */
1246
- name: string;
1247
- type: 'SELFHOSTED' | 'MANAGED' | 'WEBHOOK';
1276
+ export interface EventList {
1277
+ pagination?: PaginationResponse;
1278
+ rows?: Event[];
1279
+ }
1280
+ export interface CreateEventRequest {
1281
+ /** The key for the event. */
1282
+ key: string;
1283
+ /** The data for the event. */
1284
+ data: object;
1285
+ /** Additional metadata for the event. */
1286
+ additionalMetadata?: object;
1248
1287
  /**
1249
- * The time this worker last sent a heartbeat.
1250
- * @format date-time
1251
- * @example "2022-12-13T15:06:48.888358-05:00"
1288
+ * The priority of the event.
1289
+ * @format int32
1252
1290
  */
1253
- lastHeartbeatAt?: string;
1291
+ priority?: number;
1292
+ /** The scope for event filtering. */
1293
+ scope?: string;
1294
+ }
1295
+ export interface BulkCreateEventRequest {
1296
+ events: CreateEventRequest[];
1297
+ }
1298
+ export interface Events {
1299
+ metadata: APIResourceMeta;
1300
+ /** The events. */
1301
+ events: Event[];
1302
+ }
1303
+ export interface ReplayEventRequest {
1304
+ eventIds: string[];
1305
+ }
1306
+ export interface CancelEventRequest {
1307
+ eventIds: string[];
1308
+ }
1309
+ export interface RateLimit {
1310
+ /** The key for the rate limit. */
1311
+ key: string;
1312
+ /** The ID of the tenant associated with this rate limit. */
1313
+ tenantId: string;
1314
+ /** The maximum number of requests allowed within the window. */
1315
+ limitValue: number;
1316
+ /** The current number of requests made within the window. */
1317
+ value: number;
1318
+ /** The window of time in which the limitValue is enforced. */
1319
+ window: string;
1254
1320
  /**
1255
- * The time this worker last sent a heartbeat.
1321
+ * The last time the rate limit was refilled.
1256
1322
  * @format date-time
1257
1323
  * @example "2022-12-13T15:06:48.888358-05:00"
1258
1324
  */
1259
- lastListenerEstablished?: string;
1260
- /** The actions this worker can perform. */
1261
- actions?: string[];
1262
- /** The workflow ids registered on this worker. */
1263
- registeredWorkflows?: {
1264
- /**
1265
- * The workflow id registered on this worker.
1266
- * @format uuid
1267
- */
1268
- id: string;
1269
- /** The name of the workflow registered on this worker. */
1270
- name: string;
1271
- }[];
1272
- /** The semaphore slot state for the worker. */
1273
- slots?: SemaphoreSlots[];
1274
- /** The recent step runs for the worker. */
1275
- recentStepRuns?: RecentStepRuns[];
1276
- /** The status of the worker. */
1277
- status?: 'ACTIVE' | 'INACTIVE' | 'PAUSED';
1278
- /** The maximum number of runs this worker can execute concurrently. */
1279
- maxRuns?: number;
1280
- /** The number of runs this worker can execute concurrently. */
1281
- availableRuns?: number;
1282
- /**
1283
- * the id of the assigned dispatcher, in UUID format
1284
- * @format uuid
1285
- * @minLength 36
1286
- * @maxLength 36
1287
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1288
- */
1289
- dispatcherId?: string;
1290
- /** The current label state of the worker. */
1291
- labels?: WorkerLabel[];
1292
- /** The webhook URL for the worker. */
1293
- webhookUrl?: string;
1294
- /**
1295
- * The webhook ID for the worker.
1296
- * @format uuid
1297
- */
1298
- webhookId?: string;
1299
- runtimeInfo?: WorkerRuntimeInfo;
1325
+ lastRefill: string;
1326
+ }
1327
+ export interface RateLimitList {
1328
+ pagination?: PaginationResponse;
1329
+ rows?: RateLimit[];
1330
+ }
1331
+ export interface TenantMemberList {
1332
+ pagination?: PaginationResponse;
1333
+ rows?: TenantMember[];
1334
+ }
1335
+ export interface UpdateTenantMemberRequest {
1336
+ /** The role of the user in the tenant. */
1337
+ role: TenantMemberRole;
1338
+ }
1339
+ export interface EventData {
1340
+ /** The data for the event (JSON bytes). */
1341
+ data: string;
1342
+ }
1343
+ export interface Workflow {
1344
+ metadata: APIResourceMeta;
1345
+ /** The name of the workflow. */
1346
+ name: string;
1347
+ /** The description of the workflow. */
1348
+ description?: string;
1349
+ /** Whether the workflow is paused. */
1350
+ isPaused?: boolean;
1351
+ versions?: WorkflowVersionMeta[];
1352
+ /** The tags of the workflow. */
1353
+ tags?: WorkflowTag[];
1354
+ /** The jobs of the workflow. */
1355
+ jobs?: Job[];
1356
+ /** The tenant id of the workflow. */
1357
+ tenantId: string;
1300
1358
  }
1301
- export interface WorkerLabel {
1359
+ export interface WorkflowVersionMeta {
1302
1360
  metadata: APIResourceMeta;
1303
- /** The key of the label. */
1304
- key: string;
1305
- /** The value of the label. */
1306
- value?: string;
1361
+ /** The version of the workflow. */
1362
+ version: string;
1363
+ /** @format int32 */
1364
+ order: number;
1365
+ workflowId: string;
1366
+ workflow?: Workflow;
1307
1367
  }
1308
- export interface UpdateWorkerRequest {
1309
- /** Whether the worker is paused and cannot accept new runs. */
1310
- isPaused?: boolean;
1368
+ export interface WorkflowTag {
1369
+ /** The name of the workflow. */
1370
+ name: string;
1371
+ /** The description of the workflow. */
1372
+ color: string;
1311
1373
  }
1312
- export interface APIToken {
1374
+ export interface Step {
1313
1375
  metadata: APIResourceMeta;
1314
- /**
1315
- * The name of the API token.
1316
- * @maxLength 255
1317
- */
1318
- name: string;
1319
- /**
1320
- * When the API token expires.
1321
- * @format date-time
1322
- */
1323
- expiresAt: string;
1376
+ /** The readable id of the step. */
1377
+ readableId: string;
1378
+ tenantId: string;
1379
+ jobId: string;
1380
+ action: string;
1381
+ /** The timeout of the step. */
1382
+ timeout?: string;
1383
+ children?: string[];
1384
+ parents?: string[];
1324
1385
  }
1325
- export interface CreateAPITokenRequest {
1326
- /**
1327
- * A name for the API token.
1328
- * @maxLength 255
1329
- */
1386
+ export interface Job {
1387
+ metadata: APIResourceMeta;
1388
+ tenantId: string;
1389
+ versionId: string;
1330
1390
  name: string;
1331
- /** The duration for which the token is valid. */
1332
- expiresIn?: string;
1333
- }
1334
- export interface CreateAPITokenResponse {
1335
- /** The API token. */
1336
- token: string;
1391
+ /** The description of the job. */
1392
+ description?: string;
1393
+ steps: Step[];
1394
+ /** The timeout of the job. */
1395
+ timeout?: string;
1337
1396
  }
1338
- export interface ListAPITokensResponse {
1397
+ export interface WorkflowList {
1398
+ metadata?: APIResourceMeta;
1399
+ rows?: Workflow[];
1339
1400
  pagination?: PaginationResponse;
1340
- rows?: APIToken[];
1341
- }
1342
- export interface RerunStepRunRequest {
1343
- input: object;
1344
- }
1345
- export interface TriggerWorkflowRunRequest {
1346
- input: object;
1347
- additionalMetadata?: object;
1348
1401
  }
1349
1402
  export interface ScheduleWorkflowRunRequest {
1350
1403
  input: object;
@@ -1358,11 +1411,28 @@ export interface ScheduleWorkflowRunRequest {
1358
1411
  */
1359
1412
  priority?: number;
1360
1413
  }
1361
- export interface CreateCronWorkflowTriggerRequest {
1362
- input: object;
1363
- additionalMetadata: object;
1364
- cronName: string;
1365
- cronExpression: string;
1414
+ export interface ScheduledWorkflows {
1415
+ metadata: APIResourceMeta;
1416
+ tenantId: string;
1417
+ workflowVersionId: string;
1418
+ workflowId: string;
1419
+ workflowName: string;
1420
+ /** @format date-time */
1421
+ triggerAt: string;
1422
+ input?: Record<string, any>;
1423
+ additionalMetadata?: Record<string, any>;
1424
+ /** @format date-time */
1425
+ workflowRunCreatedAt?: string;
1426
+ workflowRunName?: string;
1427
+ workflowRunStatus?: WorkflowRunStatus;
1428
+ /**
1429
+ * @format uuid
1430
+ * @minLength 36
1431
+ * @maxLength 36
1432
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1433
+ */
1434
+ workflowRunId?: string;
1435
+ method: ScheduledWorkflowsMethod;
1366
1436
  /**
1367
1437
  * @format int32
1368
1438
  * @min 1
@@ -1370,615 +1440,623 @@ export interface CreateCronWorkflowTriggerRequest {
1370
1440
  */
1371
1441
  priority?: number;
1372
1442
  }
1373
- export interface UpdateCronWorkflowTriggerRequest {
1374
- enabled?: boolean;
1375
- }
1376
- export interface CreatePullRequestFromStepRun {
1377
- branchName: string;
1378
- }
1379
- export interface GetStepRunDiffResponse {
1380
- diffs: StepRunDiff[];
1381
- }
1382
- export interface StepRunDiff {
1383
- key: string;
1384
- original: string;
1385
- modified: string;
1386
- }
1387
- export interface ListPullRequestsResponse {
1388
- pullRequests: PullRequest[];
1389
- }
1390
- export interface PullRequest {
1391
- repositoryOwner: string;
1392
- repositoryName: string;
1393
- pullRequestID: number;
1394
- pullRequestTitle: string;
1395
- pullRequestNumber: number;
1396
- pullRequestHeadBranch: string;
1397
- pullRequestBaseBranch: string;
1398
- pullRequestState: PullRequestState;
1443
+ export interface ScheduledWorkflowsList {
1444
+ rows?: ScheduledWorkflows[];
1445
+ pagination?: PaginationResponse;
1399
1446
  }
1400
- export declare enum PullRequestState {
1401
- Open = "open",
1402
- Closed = "closed"
1447
+ export interface UpdateScheduledWorkflowRunRequest {
1448
+ /** @format date-time */
1449
+ triggerAt: string;
1403
1450
  }
1404
- export interface LogLine {
1451
+ export interface ScheduledWorkflowsBulkDeleteFilter {
1405
1452
  /**
1406
- * The creation date of the log line.
1407
- * @format date-time
1453
+ * @format uuid
1454
+ * @minLength 36
1455
+ * @maxLength 36
1408
1456
  */
1409
- createdAt: string;
1410
- /** The log message. */
1411
- message: string;
1412
- /** The log metadata. */
1413
- metadata: object;
1414
- }
1415
- export declare enum LogLineLevel {
1416
- DEBUG = "DEBUG",
1417
- INFO = "INFO",
1418
- WARN = "WARN",
1419
- ERROR = "ERROR"
1420
- }
1421
- export interface LogLineList {
1422
- pagination?: PaginationResponse;
1423
- rows?: LogLine[];
1424
- }
1425
- export declare enum LogLineOrderByField {
1426
- CreatedAt = "createdAt"
1427
- }
1428
- export declare enum LogLineOrderByDirection {
1429
- Asc = "asc",
1430
- Desc = "desc"
1431
- }
1432
- export type LogLineSearch = string;
1433
- export type LogLineLevelField = LogLineLevel[];
1434
- export interface SNSIntegration {
1435
- metadata: APIResourceMeta;
1457
+ workflowId?: string;
1458
+ /**
1459
+ * @format uuid
1460
+ * @minLength 36
1461
+ * @maxLength 36
1462
+ */
1463
+ parentWorkflowRunId?: string;
1436
1464
  /**
1437
- * The unique identifier for the tenant that the SNS integration belongs to.
1438
1465
  * @format uuid
1466
+ * @minLength 36
1467
+ * @maxLength 36
1439
1468
  */
1440
- tenantId: string;
1441
- /** The Amazon Resource Name (ARN) of the SNS topic. */
1442
- topicArn: string;
1443
- /** The URL to send SNS messages to. */
1444
- ingestUrl?: string;
1469
+ parentStepRunId?: string;
1470
+ /**
1471
+ * A list of metadata key value pairs to filter by
1472
+ * @example ["key1:value1","key2:value2"]
1473
+ */
1474
+ additionalMetadata?: string[];
1445
1475
  }
1446
- export interface ListSNSIntegrations {
1447
- pagination: PaginationResponse;
1448
- rows: SNSIntegration[];
1476
+ export interface ScheduledWorkflowsBulkDeleteRequest {
1477
+ /**
1478
+ * @maxItems 500
1479
+ * @minItems 1
1480
+ */
1481
+ scheduledWorkflowRunIds?: string[];
1482
+ filter?: ScheduledWorkflowsBulkDeleteFilter;
1449
1483
  }
1450
- export interface SlackWebhook {
1451
- metadata: APIResourceMeta;
1484
+ export interface ScheduledWorkflowsBulkError {
1452
1485
  /**
1453
- * The unique identifier for the tenant that the SNS integration belongs to.
1454
1486
  * @format uuid
1487
+ * @minLength 36
1488
+ * @maxLength 36
1455
1489
  */
1456
- tenantId: string;
1457
- /** The team name associated with this slack webhook. */
1458
- teamName: string;
1459
- /** The team id associated with this slack webhook. */
1460
- teamId: string;
1461
- /** The channel name associated with this slack webhook. */
1462
- channelName: string;
1463
- /** The channel id associated with this slack webhook. */
1464
- channelId: string;
1465
- }
1466
- export interface ListSlackWebhooks {
1467
- pagination: PaginationResponse;
1468
- rows: SlackWebhook[];
1490
+ id?: string;
1491
+ error: string;
1469
1492
  }
1470
- export interface CreateSNSIntegrationRequest {
1471
- /** The Amazon Resource Name (ARN) of the SNS topic. */
1472
- topicArn: string;
1493
+ export interface ScheduledWorkflowsBulkDeleteResponse {
1494
+ deletedIds: string[];
1495
+ errors: ScheduledWorkflowsBulkError[];
1473
1496
  }
1474
- export interface WorkflowMetrics {
1475
- /** The number of runs for a specific group key (passed via filter) */
1476
- groupKeyRunsCount?: number;
1477
- /** The total number of concurrency group keys. */
1478
- groupKeyCount?: number;
1497
+ export interface ScheduledWorkflowsBulkUpdateItem {
1498
+ /**
1499
+ * @format uuid
1500
+ * @minLength 36
1501
+ * @maxLength 36
1502
+ */
1503
+ id: string;
1504
+ /** @format date-time */
1505
+ triggerAt: string;
1479
1506
  }
1480
- export interface WebhookWorker {
1481
- metadata: APIResourceMeta;
1482
- /** The name of the webhook worker. */
1483
- name: string;
1484
- /** The webhook url. */
1485
- url: string;
1507
+ export interface ScheduledWorkflowsBulkUpdateRequest {
1508
+ /**
1509
+ * @maxItems 500
1510
+ * @minItems 1
1511
+ */
1512
+ updates: ScheduledWorkflowsBulkUpdateItem[];
1486
1513
  }
1487
- export declare enum WebhookWorkerRequestMethod {
1488
- GET = "GET",
1489
- POST = "POST",
1490
- PUT = "PUT"
1514
+ export interface ScheduledWorkflowsBulkUpdateResponse {
1515
+ updatedIds: string[];
1516
+ errors: ScheduledWorkflowsBulkError[];
1491
1517
  }
1492
- export interface WebhookWorkerRequest {
1518
+ export interface CreateCronWorkflowTriggerRequest {
1519
+ input: object;
1520
+ additionalMetadata: object;
1521
+ cronName: string;
1522
+ cronExpression: string;
1493
1523
  /**
1494
- * The date and time the request was created.
1495
- * @format date-time
1524
+ * @format int32
1525
+ * @min 1
1526
+ * @max 3
1496
1527
  */
1497
- created_at: string;
1498
- /** The HTTP method used for the request. */
1499
- method: WebhookWorkerRequestMethod;
1500
- /** The HTTP status code of the response. */
1501
- statusCode: number;
1502
- }
1503
- export interface WebhookWorkerRequestListResponse {
1504
- /** The list of webhook requests. */
1505
- requests?: WebhookWorkerRequest[];
1528
+ priority?: number;
1506
1529
  }
1507
- export interface WebhookWorkerCreated {
1530
+ export interface CronWorkflows {
1508
1531
  metadata: APIResourceMeta;
1509
- /** The name of the webhook worker. */
1510
- name: string;
1511
- /** The webhook url. */
1512
- url: string;
1513
- /** The secret key for validation. */
1514
- secret: string;
1515
- }
1516
- export interface WebhookWorkerCreateRequest {
1517
- /** The name of the webhook worker. */
1518
- name: string;
1519
- /** The webhook url. */
1520
- url: string;
1532
+ tenantId: string;
1533
+ workflowVersionId: string;
1534
+ workflowId: string;
1535
+ workflowName: string;
1536
+ cron: string;
1537
+ name?: string;
1538
+ input?: Record<string, any>;
1539
+ additionalMetadata?: Record<string, any>;
1540
+ enabled: boolean;
1541
+ method: CronWorkflowsMethod;
1521
1542
  /**
1522
- * The secret key for validation. If not provided, a random secret will be generated.
1523
- * @minLength 32
1543
+ * @format int32
1544
+ * @min 1
1545
+ * @max 3
1524
1546
  */
1525
- secret?: string;
1526
- }
1527
- export interface WebhookWorkerCreateResponse {
1528
- worker?: WebhookWorkerCreated;
1547
+ priority?: number;
1529
1548
  }
1530
- export interface WebhookWorkerListResponse {
1549
+ export interface CronWorkflowsList {
1550
+ rows?: CronWorkflows[];
1531
1551
  pagination?: PaginationResponse;
1532
- rows?: WebhookWorker[];
1533
1552
  }
1534
- export interface V1TaskSummaryList {
1535
- pagination: PaginationResponse;
1536
- /** The list of tasks */
1537
- rows: V1TaskSummary[];
1553
+ export interface UpdateCronWorkflowTriggerRequest {
1554
+ enabled?: boolean;
1538
1555
  }
1539
- export interface V1WorkflowRunDisplayNameList {
1540
- pagination: PaginationResponse;
1541
- /** The list of display names */
1542
- rows: {
1543
- metadata: APIResourceMeta;
1544
- displayName: string;
1545
- }[];
1556
+ export interface WorkflowRunsCancelRequest {
1557
+ workflowRunIds: string[];
1546
1558
  }
1547
- /** The list of external IDs */
1548
- export type V1WorkflowRunExternalIdList = string[];
1549
- export interface V1TaskSummary {
1550
- metadata: APIResourceMeta;
1551
- /** The action ID of the task. */
1552
- actionId?: string;
1553
- /** The number of retries of the task. */
1554
- retryCount?: number;
1555
- /** The attempt number of the task. */
1556
- attempt?: number;
1557
- /** Additional metadata for the task run. */
1558
- additionalMetadata?: object;
1559
- /** The list of children tasks */
1560
- children?: V1TaskSummary[];
1559
+ export interface WorkflowUpdateRequest {
1560
+ /** Whether the workflow is paused. */
1561
+ isPaused?: boolean;
1562
+ }
1563
+ export interface WorkflowConcurrency {
1561
1564
  /**
1562
- * The timestamp the task was created.
1563
- * @format date-time
1565
+ * The maximum number of concurrent workflow runs.
1566
+ * @format int32
1564
1567
  */
1565
- createdAt: string;
1566
- /** The display name of the task run. */
1567
- displayName: string;
1568
- /** The duration of the task run, in milliseconds. */
1569
- duration?: number;
1570
- /** The error message of the task run (for the latest run) */
1571
- errorMessage?: string;
1568
+ maxRuns: number;
1569
+ /** The strategy to use when the concurrency limit is reached. */
1570
+ limitStrategy: ConcurrencyLimitStrategy;
1571
+ /** An action which gets the concurrency group for the WorkflowRun. */
1572
+ getConcurrencyGroup: string;
1573
+ }
1574
+ export interface WorkflowTriggerEventRef {
1575
+ parent_id?: string;
1576
+ event_key?: string;
1577
+ }
1578
+ export interface WorkflowTriggerCronRef {
1579
+ parent_id?: string;
1580
+ cron?: string;
1581
+ }
1582
+ export interface WorkflowTriggers {
1583
+ metadata?: APIResourceMeta;
1584
+ workflow_version_id?: string;
1585
+ tenant_id?: string;
1586
+ events?: WorkflowTriggerEventRef[];
1587
+ crons?: WorkflowTriggerCronRef[];
1588
+ }
1589
+ export interface WorkflowVersion {
1590
+ metadata: APIResourceMeta;
1591
+ /** The version of the workflow. */
1592
+ version: string;
1593
+ /** @format int32 */
1594
+ order: number;
1595
+ workflowId: string;
1596
+ /** The sticky strategy of the workflow. */
1597
+ sticky?: string;
1572
1598
  /**
1573
- * The timestamp the task run finished.
1574
- * @format date-time
1599
+ * The default priority of the workflow.
1600
+ * @format int32
1575
1601
  */
1576
- finishedAt?: string;
1577
- /** The input of the task run. */
1602
+ defaultPriority?: number;
1603
+ workflow?: Workflow;
1604
+ concurrency?: WorkflowConcurrency;
1605
+ triggers?: WorkflowTriggers;
1606
+ scheduleTimeout?: string;
1607
+ jobs?: Job[];
1608
+ workflowConfig?: object;
1609
+ }
1610
+ export interface TriggerWorkflowRunRequest {
1578
1611
  input: object;
1579
- /** The number of spawned children tasks */
1580
- numSpawnedChildren: number;
1581
- /** The output of the task run (for the latest run) */
1582
- output: object;
1583
- status: V1TaskStatus;
1584
- /**
1585
- * The timestamp the task run started.
1586
- * @format date-time
1587
- */
1612
+ additionalMetadata?: object;
1613
+ }
1614
+ export interface WorkflowRun {
1615
+ metadata: APIResourceMeta;
1616
+ tenantId: string;
1617
+ workflowVersionId: string;
1618
+ workflowVersion?: WorkflowVersion;
1619
+ status: WorkflowRunStatus;
1620
+ displayName?: string;
1621
+ jobRuns?: JobRun[];
1622
+ triggeredBy: WorkflowRunTriggeredBy;
1623
+ input?: Record<string, any>;
1624
+ error?: string;
1625
+ /** @format date-time */
1588
1626
  startedAt?: string;
1627
+ /** @format date-time */
1628
+ finishedAt?: string;
1629
+ /** @example 1000 */
1630
+ duration?: number;
1589
1631
  /**
1590
- * The step ID of the task.
1591
- * @format uuid
1592
- * @minLength 36
1593
- * @maxLength 36
1594
- */
1595
- stepId?: string;
1596
- /**
1597
- * The external ID of the task.
1598
1632
  * @format uuid
1599
1633
  * @minLength 36
1600
1634
  * @maxLength 36
1635
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1601
1636
  */
1602
- taskExternalId: string;
1603
- /** The ID of the task. */
1604
- taskId: number;
1605
- /**
1606
- * The timestamp the task was inserted.
1607
- * @format date-time
1608
- */
1609
- taskInsertedAt: string;
1637
+ parentId?: string;
1610
1638
  /**
1611
- * The ID of the tenant.
1612
1639
  * @format uuid
1613
1640
  * @minLength 36
1614
1641
  * @maxLength 36
1615
1642
  * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1616
1643
  */
1644
+ parentStepRunId?: string;
1645
+ additionalMetadata?: Record<string, any>;
1646
+ }
1647
+ export interface JobRun {
1648
+ metadata: APIResourceMeta;
1617
1649
  tenantId: string;
1618
- /** The type of the workflow (whether it's a DAG or a task) */
1619
- type: 'DAG' | 'TASK';
1620
- /** @format uuid */
1621
- workflowId: string;
1622
- workflowName?: string;
1623
- /**
1624
- * The external ID of the workflow run
1625
- * @format uuid
1626
- */
1627
- workflowRunExternalId: string;
1628
- /**
1629
- * The version ID of the workflow
1630
- * @format uuid
1631
- */
1632
- workflowVersionId?: string;
1633
- workflowConfig?: object;
1650
+ workflowRunId: string;
1651
+ workflowRun?: WorkflowRun;
1652
+ jobId: string;
1653
+ job?: Job;
1654
+ tickerId?: string;
1655
+ stepRuns?: StepRun[];
1656
+ status: JobRunStatus;
1657
+ result?: object;
1658
+ /** @format date-time */
1659
+ startedAt?: string;
1660
+ /** @format date-time */
1661
+ finishedAt?: string;
1662
+ /** @format date-time */
1663
+ timeoutAt?: string;
1664
+ /** @format date-time */
1665
+ cancelledAt?: string;
1666
+ cancelledReason?: string;
1667
+ cancelledError?: string;
1668
+ }
1669
+ export interface StepRun {
1670
+ metadata: APIResourceMeta;
1671
+ tenantId: string;
1672
+ jobRunId: string;
1673
+ jobRun?: JobRun;
1674
+ stepId: string;
1675
+ step?: Step;
1676
+ childWorkflowsCount?: number;
1677
+ parents?: string[];
1678
+ childWorkflowRuns?: string[];
1679
+ workerId?: string;
1680
+ input?: string;
1681
+ output?: string;
1682
+ status: StepRunStatus;
1683
+ /** @format date-time */
1684
+ requeueAfter?: string;
1685
+ result?: object;
1686
+ error?: string;
1687
+ /** @format date-time */
1688
+ startedAt?: string;
1689
+ startedAtEpoch?: number;
1690
+ /** @format date-time */
1691
+ finishedAt?: string;
1692
+ finishedAtEpoch?: number;
1693
+ /** @format date-time */
1694
+ timeoutAt?: string;
1695
+ timeoutAtEpoch?: number;
1696
+ /** @format date-time */
1697
+ cancelledAt?: string;
1698
+ cancelledAtEpoch?: number;
1699
+ cancelledReason?: string;
1700
+ cancelledError?: string;
1701
+ }
1702
+ export interface WorkflowRunTriggeredBy {
1703
+ metadata: APIResourceMeta;
1704
+ parentWorkflowRunId?: string;
1705
+ eventId?: string;
1706
+ cronParentId?: string;
1707
+ cronSchedule?: string;
1708
+ }
1709
+ export interface WorkflowMetrics {
1710
+ /** The number of runs for a specific group key (passed via filter) */
1711
+ groupKeyRunsCount?: number;
1712
+ /** The total number of concurrency group keys. */
1713
+ groupKeyCount?: number;
1714
+ }
1715
+ export type LogLineLevelField = LogLineLevel[];
1716
+ export type LogLineSearch = string;
1717
+ export interface LogLine {
1634
1718
  /**
1635
- * The external ID of the parent task.
1636
- * @format uuid
1719
+ * The creation date of the log line.
1720
+ * @format date-time
1637
1721
  */
1638
- parentTaskExternalId?: string;
1722
+ createdAt: string;
1723
+ /** The log message. */
1724
+ message: string;
1725
+ /** The log metadata. */
1726
+ metadata: object;
1639
1727
  }
1640
- export interface V1DagChildren {
1641
- /** @format uuid */
1642
- dagId?: string;
1643
- children?: V1TaskSummary[];
1728
+ export interface LogLineList {
1729
+ pagination?: PaginationResponse;
1730
+ rows?: LogLine[];
1644
1731
  }
1645
- export interface V1TaskEventList {
1732
+ export interface StepRunEvent {
1733
+ id: number;
1734
+ /** @format date-time */
1735
+ timeFirstSeen: string;
1736
+ /** @format date-time */
1737
+ timeLastSeen: string;
1738
+ stepRunId?: string;
1739
+ workflowRunId?: string;
1740
+ reason: StepRunEventReason;
1741
+ severity: StepRunEventSeverity;
1742
+ message: string;
1743
+ count: number;
1744
+ data?: object;
1745
+ }
1746
+ export interface StepRunEventList {
1646
1747
  pagination?: PaginationResponse;
1647
- rows?: {
1648
- id: number;
1649
- /** @format uuid */
1650
- taskId: string;
1651
- /** @format date-time */
1652
- timestamp: string;
1653
- eventType: 'REQUEUED_NO_WORKER' | 'REQUEUED_RATE_LIMIT' | 'SCHEDULING_TIMED_OUT' | 'ASSIGNED' | 'STARTED' | 'FINISHED' | 'FAILED' | 'RETRYING' | 'CANCELLED' | 'TIMED_OUT' | 'REASSIGNED' | 'SLOT_RELEASED' | 'TIMEOUT_REFRESHED' | 'RETRIED_BY_USER' | 'SENT_TO_WORKER' | 'RATE_LIMIT_ERROR' | 'ACKNOWLEDGED' | 'CREATED' | 'QUEUED' | 'SKIPPED';
1654
- message: string;
1655
- errorMessage?: string;
1656
- output?: string;
1657
- /** @format uuid */
1658
- workerId?: string;
1659
- taskDisplayName?: string;
1660
- /** The number of retries of the task. */
1661
- retryCount?: number;
1662
- /** The attempt number of the task. */
1663
- attempt?: number;
1664
- }[];
1748
+ rows?: StepRunEvent[];
1665
1749
  }
1666
- export interface V1ReplayedTasks {
1667
- /** The list of task external ids that were replayed */
1668
- ids?: string[];
1750
+ export interface StepRunArchive {
1751
+ stepRunId: string;
1752
+ order: number;
1753
+ input?: string;
1754
+ output?: string;
1755
+ /** @format date-time */
1756
+ startedAt?: string;
1757
+ error?: string;
1758
+ retryCount: number;
1759
+ /** @format date-time */
1760
+ createdAt: string;
1761
+ startedAtEpoch?: number;
1762
+ /** @format date-time */
1763
+ finishedAt?: string;
1764
+ finishedAtEpoch?: number;
1765
+ /** @format date-time */
1766
+ timeoutAt?: string;
1767
+ timeoutAtEpoch?: number;
1768
+ /** @format date-time */
1769
+ cancelledAt?: string;
1770
+ cancelledAtEpoch?: number;
1771
+ cancelledReason?: string;
1772
+ cancelledError?: string;
1669
1773
  }
1670
- export interface V1CancelledTasks {
1671
- /** The list of task external ids that were cancelled */
1672
- ids?: string[];
1774
+ export interface StepRunArchiveList {
1775
+ pagination?: PaginationResponse;
1776
+ rows?: StepRunArchive[];
1673
1777
  }
1674
- export declare enum V1TaskStatus {
1675
- QUEUED = "QUEUED",
1676
- RUNNING = "RUNNING",
1677
- COMPLETED = "COMPLETED",
1678
- CANCELLED = "CANCELLED",
1679
- FAILED = "FAILED"
1778
+ export interface WorkflowWorkersCount {
1779
+ freeSlotCount?: number;
1780
+ maxSlotCount?: number;
1781
+ workflowRunId?: string;
1680
1782
  }
1681
- export type V1TaskRunMetrics = {
1682
- status: V1TaskStatus;
1683
- count: number;
1684
- }[];
1685
- export interface V1TaskPointMetric {
1686
- /** @format date-time */
1687
- time: string;
1688
- SUCCEEDED: number;
1689
- FAILED: number;
1783
+ export type WorkflowKindList = WorkflowKind[];
1784
+ export interface WorkflowRunList {
1785
+ rows?: WorkflowRun[];
1786
+ pagination?: PaginationResponse;
1690
1787
  }
1691
- export interface V1TaskPointMetrics {
1692
- results?: V1TaskPointMetric[];
1788
+ export interface ReplayWorkflowRunsRequest {
1789
+ /** @maxLength 500 */
1790
+ workflowRunIds: string[];
1693
1791
  }
1694
- export interface V1TaskFilter {
1695
- /** @format date-time */
1696
- since: string;
1697
- /** @format date-time */
1698
- until?: string;
1699
- statuses?: V1TaskStatus[];
1700
- workflowIds?: string[];
1701
- additionalMetadata?: string[];
1792
+ export interface ReplayWorkflowRunsResponse {
1793
+ workflowRuns: WorkflowRun[];
1702
1794
  }
1703
- export interface V1CancelTaskRequest {
1704
- /** A list of external IDs, which can refer to either task or workflow run external IDs */
1705
- externalIds?: string[];
1706
- filter?: V1TaskFilter;
1795
+ export interface WorkflowRunsMetricsCounts {
1796
+ PENDING?: number;
1797
+ RUNNING?: number;
1798
+ SUCCEEDED?: number;
1799
+ FAILED?: number;
1800
+ QUEUED?: number;
1801
+ CANCELLED?: number;
1707
1802
  }
1708
- export interface V1ReplayTaskRequest {
1709
- /** A list of external IDs, which can refer to either task or workflow run external IDs */
1710
- externalIds?: string[];
1711
- filter?: V1TaskFilter;
1803
+ export interface WorkflowRunsMetrics {
1804
+ counts?: WorkflowRunsMetricsCounts;
1712
1805
  }
1713
- export interface V1WorkflowRun {
1806
+ export interface WorkflowRunShape {
1714
1807
  metadata: APIResourceMeta;
1715
- status: V1TaskStatus;
1716
- /**
1717
- * The timestamp the task run started.
1718
- * @format date-time
1719
- */
1808
+ tenantId: string;
1809
+ workflowId?: string;
1810
+ workflowVersionId: string;
1811
+ workflowVersion?: WorkflowVersion;
1812
+ status: WorkflowRunStatus;
1813
+ displayName?: string;
1814
+ jobRuns?: JobRun[];
1815
+ triggeredBy: WorkflowRunTriggeredBy;
1816
+ input?: Record<string, any>;
1817
+ error?: string;
1818
+ /** @format date-time */
1720
1819
  startedAt?: string;
1721
- /**
1722
- * The timestamp the task run finished.
1723
- * @format date-time
1724
- */
1820
+ /** @format date-time */
1725
1821
  finishedAt?: string;
1726
- /** The duration of the task run, in milliseconds. */
1822
+ /** @example 1000 */
1727
1823
  duration?: number;
1728
1824
  /**
1729
- * The ID of the tenant.
1730
1825
  * @format uuid
1731
1826
  * @minLength 36
1732
1827
  * @maxLength 36
1733
1828
  * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1734
1829
  */
1735
- tenantId: string;
1736
- /** Additional metadata for the task run. */
1737
- additionalMetadata?: object;
1738
- /** The display name of the task run. */
1739
- displayName: string;
1740
- /** @format uuid */
1741
- workflowId: string;
1742
- /** The output of the task run (for the latest run) */
1743
- output: object;
1744
- /** The error message of the task run (for the latest run) */
1745
- errorMessage?: string;
1746
- /**
1747
- * The ID of the workflow version.
1748
- * @format uuid
1749
- */
1750
- workflowVersionId?: string;
1751
- /** The input of the task run. */
1752
- input: object;
1753
- /**
1754
- * The timestamp the task run was created.
1755
- * @format date-time
1756
- */
1757
- createdAt?: string;
1830
+ parentId?: string;
1758
1831
  /**
1759
1832
  * @format uuid
1760
1833
  * @minLength 36
1761
1834
  * @maxLength 36
1835
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1762
1836
  */
1763
- parentTaskExternalId?: string;
1764
- }
1765
- export interface V1WorkflowRunDetails {
1766
- run: V1WorkflowRun;
1767
- /** The list of task events for the workflow run */
1768
- taskEvents: any[];
1769
- shape: {
1770
- /**
1771
- * @format uuid
1772
- * @minLength 36
1773
- * @maxLength 36
1774
- */
1775
- taskExternalId: string;
1776
- /**
1777
- * @format uuid
1778
- * @minLength 36
1779
- * @maxLength 36
1780
- */
1781
- stepId: string;
1782
- childrenStepIds: string[];
1783
- taskName: string;
1784
- }[];
1785
- tasks: V1TaskSummary[];
1786
- workflowConfig?: object;
1787
- }
1788
- export declare enum V1TaskRunStatus {
1789
- PENDING = "PENDING",
1790
- RUNNING = "RUNNING",
1791
- COMPLETED = "COMPLETED",
1792
- FAILED = "FAILED",
1793
- CANCELLED = "CANCELLED"
1837
+ parentStepRunId?: string;
1838
+ additionalMetadata?: Record<string, any>;
1794
1839
  }
1795
- export interface V1TriggerWorkflowRunRequest {
1796
- /** The name of the workflow. */
1797
- workflowName: string;
1840
+ export interface RerunStepRunRequest {
1798
1841
  input: object;
1799
- additionalMetadata?: object;
1800
- /** The priority of the workflow run. */
1801
- priority?: number;
1802
1842
  }
1803
- export interface V1LogLine {
1843
+ export interface RegisteredWorkflow {
1804
1844
  /**
1805
- * The creation date of the log line.
1806
- * @format date-time
1845
+ * The workflow id registered on this worker.
1846
+ * @format uuid
1807
1847
  */
1808
- createdAt: string;
1809
- /** The log message. */
1810
- message: string;
1811
- /** The log metadata. */
1812
- metadata: object;
1813
- /** The retry count of the log line. */
1814
- retryCount?: number;
1815
- /** The attempt number of the log line. */
1816
- attempt?: number;
1817
- /** The log level. */
1818
- level?: V1LogLineLevel;
1819
- }
1820
- export declare enum V1LogLineLevel {
1821
- DEBUG = "DEBUG",
1822
- INFO = "INFO",
1823
- WARN = "WARN",
1824
- ERROR = "ERROR"
1825
- }
1826
- export interface V1LogLineList {
1827
- pagination?: PaginationResponse;
1828
- rows?: V1LogLine[];
1848
+ id: string;
1849
+ /** The name of the workflow registered on this worker. */
1850
+ name: string;
1829
1851
  }
1830
- export interface V1TaskTiming {
1831
- metadata: APIResourceMeta;
1832
- /** The depth of the task in the waterfall. */
1833
- depth: number;
1834
- status: V1TaskStatus;
1835
- /** The display name of the task run. */
1836
- taskDisplayName: string;
1852
+ export interface SemaphoreSlots {
1837
1853
  /**
1838
- * The external ID of the task.
1854
+ * The step run id.
1839
1855
  * @format uuid
1840
- * @minLength 36
1841
- * @maxLength 36
1842
1856
  */
1843
- taskExternalId: string;
1844
- /** The ID of the task. */
1845
- taskId: number;
1857
+ stepRunId: string;
1858
+ /** The action id. */
1859
+ actionId: string;
1846
1860
  /**
1847
- * The timestamp the task was inserted.
1861
+ * The time this slot was started.
1848
1862
  * @format date-time
1849
1863
  */
1850
- taskInsertedAt: string;
1864
+ startedAt?: string;
1851
1865
  /**
1852
- * The ID of the tenant.
1853
- * @format uuid
1854
- * @minLength 36
1855
- * @maxLength 36
1856
- * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1866
+ * The time this slot will timeout.
1867
+ * @format date-time
1857
1868
  */
1858
- tenantId: string;
1869
+ timeoutAt?: string;
1859
1870
  /**
1860
- * The external ID of the parent task.
1871
+ * The workflow run id.
1861
1872
  * @format uuid
1862
- * @minLength 36
1863
- * @maxLength 36
1864
1873
  */
1865
- parentTaskExternalId?: string;
1874
+ workflowRunId: string;
1875
+ status?: StepRunStatus;
1876
+ }
1877
+ export interface RecentStepRuns {
1878
+ metadata: APIResourceMeta;
1879
+ /** The action id. */
1880
+ actionId: string;
1881
+ status: StepRunStatus;
1882
+ /** @format date-time */
1883
+ startedAt?: string;
1884
+ /** @format date-time */
1885
+ finishedAt?: string;
1886
+ /** @format date-time */
1887
+ cancelledAt?: string;
1888
+ /** @format uuid */
1889
+ workflowRunId: string;
1890
+ }
1891
+ export interface WorkerLabel {
1892
+ metadata: APIResourceMeta;
1893
+ /** The key of the label. */
1894
+ key: string;
1895
+ /** The value of the label. */
1896
+ value?: string;
1897
+ }
1898
+ export interface WorkerRuntimeInfo {
1899
+ sdkVersion?: string;
1900
+ language?: WorkerRuntimeSDKs;
1901
+ languageVersion?: string;
1902
+ os?: string;
1903
+ runtimeExtra?: string;
1904
+ }
1905
+ export interface Worker {
1906
+ metadata: APIResourceMeta;
1907
+ /** The name of the worker. */
1908
+ name: string;
1909
+ type: WorkerType;
1866
1910
  /**
1867
- * The timestamp the task run was queued.
1911
+ * The time this worker last sent a heartbeat.
1868
1912
  * @format date-time
1913
+ * @example "2022-12-13T15:06:48.888358-05:00"
1869
1914
  */
1870
- queuedAt?: string;
1915
+ lastHeartbeatAt?: string;
1871
1916
  /**
1872
- * The timestamp the task run started.
1917
+ * The time this worker last sent a heartbeat.
1873
1918
  * @format date-time
1919
+ * @example "2022-12-13T15:06:48.888358-05:00"
1874
1920
  */
1875
- startedAt?: string;
1921
+ lastListenerEstablished?: string;
1922
+ /** The actions this worker can perform. */
1923
+ actions?: string[];
1924
+ /** The workflow ids registered on this worker. */
1925
+ registeredWorkflows?: RegisteredWorkflow[];
1926
+ /** The semaphore slot state for the worker. */
1927
+ slots?: SemaphoreSlots[];
1928
+ /** The recent step runs for the worker. */
1929
+ recentStepRuns?: RecentStepRuns[];
1930
+ /** The status of the worker. */
1931
+ status?: 'ACTIVE' | 'INACTIVE' | 'PAUSED';
1932
+ /** The maximum number of runs this worker can execute concurrently. */
1933
+ maxRuns?: number;
1934
+ /** The number of runs this worker can execute concurrently. */
1935
+ availableRuns?: number;
1876
1936
  /**
1877
- * The timestamp the task run finished.
1878
- * @format date-time
1937
+ * the id of the assigned dispatcher, in UUID format
1938
+ * @format uuid
1939
+ * @minLength 36
1940
+ * @maxLength 36
1941
+ * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
1879
1942
  */
1880
- finishedAt?: string;
1943
+ dispatcherId?: string;
1944
+ /** The current label state of the worker. */
1945
+ labels?: WorkerLabel[];
1946
+ /** The webhook URL for the worker. */
1947
+ webhookUrl?: string;
1881
1948
  /**
1882
- * The external ID of the workflow run.
1949
+ * The webhook ID for the worker.
1883
1950
  * @format uuid
1884
1951
  */
1885
- workflowRunId?: string;
1886
- /** The number of retries of the task. */
1887
- retryCount?: number;
1888
- /** The attempt number of the task. */
1889
- attempt?: number;
1952
+ webhookId?: string;
1953
+ runtimeInfo?: WorkerRuntimeInfo;
1890
1954
  }
1891
- export interface V1TaskTimingList {
1892
- pagination: PaginationResponse;
1893
- /** The list of task timings */
1894
- rows: V1TaskTiming[];
1955
+ export interface WorkerList {
1956
+ pagination?: PaginationResponse;
1957
+ rows?: Worker[];
1895
1958
  }
1896
- export interface V1CreateFilterRequest {
1959
+ export interface UpdateWorkerRequest {
1960
+ /** Whether the worker is paused and cannot accept new runs. */
1961
+ isPaused?: boolean;
1962
+ }
1963
+ export interface WebhookWorker {
1964
+ metadata: APIResourceMeta;
1965
+ /** The name of the webhook worker. */
1966
+ name: string;
1967
+ /** The webhook url. */
1968
+ url: string;
1969
+ }
1970
+ export interface WebhookWorkerListResponse {
1971
+ pagination?: PaginationResponse;
1972
+ rows?: WebhookWorker[];
1973
+ }
1974
+ export interface WebhookWorkerCreateRequest {
1975
+ /** The name of the webhook worker. */
1976
+ name: string;
1977
+ /** The webhook url. */
1978
+ url: string;
1897
1979
  /**
1898
- * The workflow id
1899
- * @format uuid
1900
- * @minLength 36
1901
- * @maxLength 36
1980
+ * The secret key for validation. If not provided, a random secret will be generated.
1981
+ * @minLength 32
1902
1982
  */
1903
- workflowId: string;
1904
- /** The expression for the filter */
1905
- expression: string;
1906
- /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
1907
- scope: string;
1908
- /** The payload for the filter */
1909
- payload?: object;
1983
+ secret?: string;
1910
1984
  }
1911
- export type V1CreateWebhookRequest = ({
1912
- /** The name of the source for this webhook */
1913
- sourceName: V1WebhookSourceName;
1914
- /** The name of the webhook */
1985
+ export interface WebhookWorkerCreated {
1986
+ metadata: APIResourceMeta;
1987
+ /** The name of the webhook worker. */
1915
1988
  name: string;
1916
- /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
1917
- eventKeyExpression: string;
1918
- } & {
1919
- /** The type of authentication to use for the webhook */
1920
- authType: 'BASIC';
1921
- auth: {
1922
- /** The username for basic auth */
1923
- username: string;
1924
- /** The password for basic auth */
1925
- password: string;
1926
- };
1927
- }) | {
1928
- /** The type of authentication to use for the webhook */
1929
- authType: 'API_KEY';
1930
- auth: {
1931
- /** The name of the header to use for the API key */
1932
- headerName: string;
1933
- /** The API key to use for authentication */
1934
- apiKey: string;
1935
- };
1936
- } | {
1937
- /** The type of authentication to use for the webhook */
1938
- authType: 'HMAC';
1939
- auth: {
1940
- /** The HMAC algorithm to use for the webhook */
1941
- algorithm: 'SHA1' | 'SHA256' | 'SHA512' | 'MD5';
1942
- /** The encoding to use for the HMAC signature */
1943
- encoding: 'HEX' | 'BASE64' | 'BASE64URL';
1944
- /** The name of the header to use for the HMAC signature */
1945
- signatureHeaderName: string;
1946
- /** The secret key used to sign the HMAC signature */
1947
- signingSecret: string;
1948
- };
1949
- };
1950
- export interface V1UpdateWebhookRequest {
1951
- /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
1952
- eventKeyExpression: string;
1989
+ /** The webhook url. */
1990
+ url: string;
1991
+ /** The secret key for validation. */
1992
+ secret: string;
1953
1993
  }
1954
- export interface V1UpdateFilterRequest {
1955
- /** The expression for the filter */
1994
+ export interface WebhookWorkerRequest {
1995
+ /**
1996
+ * The date and time the request was created.
1997
+ * @format date-time
1998
+ */
1999
+ created_at: string;
2000
+ /** The HTTP method used for the request. */
2001
+ method: WebhookWorkerRequestMethod;
2002
+ /** The HTTP status code of the response. */
2003
+ statusCode: number;
2004
+ }
2005
+ export interface WebhookWorkerRequestListResponse {
2006
+ /** The list of webhook requests. */
2007
+ requests?: WebhookWorkerRequest[];
2008
+ }
2009
+ export interface ConcurrencyStat {
1956
2010
  expression?: string;
1957
- /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
1958
- scope?: string;
1959
- /** The payload for the filter */
1960
- payload?: object;
2011
+ type?: string;
2012
+ keys?: Record<string, number>;
1961
2013
  }
1962
- export interface V1CELDebugRequest {
1963
- /** The CEL expression to evaluate */
1964
- expression: string;
1965
- /** The input, which simulates the workflow run input */
1966
- input: object;
1967
- /** The filter payload, which simulates a payload set on a previous-created filter */
1968
- filterPayload?: object;
1969
- /** Additional metadata, which simulates metadata that could be sent with an event or a workflow run */
1970
- additionalMetadata?: object;
2014
+ export interface TaskStatusStat {
2015
+ /** @format int64 */
2016
+ total?: number;
2017
+ queues?: Record<string, number>;
2018
+ concurrency?: ConcurrencyStat[];
2019
+ /** @format date-time */
2020
+ oldest?: string;
1971
2021
  }
1972
- export interface V1CELDebugResponse {
1973
- /** The status of the CEL evaluation */
1974
- status: V1CELDebugResponseStatus;
1975
- /** The result of the CEL expression evaluation, if successful */
1976
- output?: boolean;
1977
- /** The error message if the evaluation failed */
1978
- error?: string;
2022
+ export interface TaskStat {
2023
+ queued?: TaskStatusStat;
2024
+ running?: TaskStatusStat;
1979
2025
  }
1980
- /** The status of the CEL evaluation */
1981
- export declare enum V1CELDebugResponseStatus {
1982
- SUCCESS = "SUCCESS",
1983
- ERROR = "ERROR"
2026
+ export type TaskStats = Record<string, TaskStat>;
2027
+ export interface TenantList {
2028
+ pagination?: PaginationResponse;
2029
+ rows?: Tenant[];
2030
+ }
2031
+ export interface WorkflowVersionDefinition {
2032
+ /** The raw YAML definition of the workflow. */
2033
+ rawDefinition: string;
2034
+ }
2035
+ export interface CreatePullRequestFromStepRun {
2036
+ branchName: string;
2037
+ }
2038
+ export interface StepRunDiff {
2039
+ key: string;
2040
+ original: string;
2041
+ modified: string;
2042
+ }
2043
+ export interface GetStepRunDiffResponse {
2044
+ diffs: StepRunDiff[];
2045
+ }
2046
+ export interface PullRequest {
2047
+ repositoryOwner: string;
2048
+ repositoryName: string;
2049
+ pullRequestID: number;
2050
+ pullRequestTitle: string;
2051
+ pullRequestNumber: number;
2052
+ pullRequestHeadBranch: string;
2053
+ pullRequestBaseBranch: string;
2054
+ pullRequestState: PullRequestState;
2055
+ }
2056
+ export interface ListPullRequestsResponse {
2057
+ pullRequests: PullRequest[];
2058
+ }
2059
+ export interface WebhookWorkerCreateResponse {
2060
+ worker?: WebhookWorkerCreated;
1984
2061
  }
2062
+ export type BulkCreateEventResponse = Events;