@io-orkes/conductor-javascript 2.1.4 → 2.2.0

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.
package/dist/index.d.mts CHANGED
@@ -1,1541 +1,2528 @@
1
- declare type ApiRequestOptions = {
2
- readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
3
- readonly url: string;
4
- readonly path?: Record<string, any>;
5
- readonly cookies?: Record<string, any>;
6
- readonly headers?: Record<string, any>;
7
- readonly query?: Record<string, any>;
8
- readonly formData?: Record<string, any>;
9
- readonly body?: any;
10
- readonly mediaType?: string;
11
- readonly responseHeader?: string;
12
- readonly errors?: Record<number, string>;
13
- };
14
-
15
- declare class CancelError extends Error {
16
- constructor(message: string);
17
- get isCancelled(): boolean;
18
- }
19
- interface OnCancel {
20
- readonly isResolved: boolean;
21
- readonly isRejected: boolean;
22
- readonly isCancelled: boolean;
23
- (cancelHandler: () => void): void;
1
+ interface ConductorLogger {
2
+ info(...args: unknown[]): void;
3
+ error(...args: unknown[]): void;
4
+ debug(...args: unknown[]): void;
24
5
  }
25
- declare class CancelablePromise<T> implements Promise<T> {
26
- readonly [Symbol.toStringTag]: string;
27
- private _isResolved;
28
- private _isRejected;
29
- private _isCancelled;
30
- private readonly _cancelHandlers;
31
- private readonly _promise;
32
- private _resolve?;
33
- private _reject?;
34
- constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
35
- then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
36
- catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
37
- finally(onFinally?: (() => void) | null): Promise<T>;
38
- cancel(): void;
39
- get isCancelled(): boolean;
6
+ type ConductorLogLevel = keyof typeof LOG_LEVELS;
7
+ interface DefaultLoggerConfig {
8
+ level?: ConductorLogLevel;
9
+ tags?: object[];
40
10
  }
41
-
42
- declare type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
43
- declare type Headers = Record<string, string>;
44
- declare type OpenAPIConfig = {
45
- BASE: string;
46
- VERSION: string;
47
- WITH_CREDENTIALS: boolean;
48
- CREDENTIALS: 'include' | 'omit' | 'same-origin';
49
- TOKEN?: string | Resolver<string>;
50
- USERNAME?: string | Resolver<string>;
51
- PASSWORD?: string | Resolver<string>;
52
- HEADERS?: Headers | Resolver<Headers>;
53
- ENCODE_PATH?: (path: string) => string;
11
+ declare const LOG_LEVELS: {
12
+ readonly DEBUG: 10;
13
+ readonly INFO: 30;
14
+ readonly ERROR: 60;
54
15
  };
55
-
56
- declare abstract class BaseHttpRequest {
57
- readonly config: OpenAPIConfig;
58
- constructor(config: OpenAPIConfig);
59
- abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
16
+ declare class DefaultLogger implements ConductorLogger {
17
+ private readonly tags;
18
+ private readonly level;
19
+ constructor(config?: DefaultLoggerConfig);
20
+ private log;
21
+ info: (...args: unknown[]) => void;
22
+ debug: (...args: unknown[]) => void;
23
+ error: (...args: unknown[]) => void;
60
24
  }
25
+ declare const noopLogger: ConductorLogger;
61
26
 
62
- declare type StartWorkflow = {
27
+ type Action = {
28
+ action?: 'start_workflow' | 'complete_task' | 'fail_task' | 'terminate_workflow' | 'update_workflow_variables';
29
+ complete_task?: TaskDetails;
30
+ expandInlineJSON?: boolean;
31
+ fail_task?: TaskDetails;
32
+ start_workflow?: StartWorkflowRequest;
33
+ terminate_workflow?: TerminateWorkflow;
34
+ update_workflow_variables?: UpdateWorkflowVariables;
35
+ };
36
+ type Any = {
37
+ allFields?: {
38
+ [key: string]: unknown;
39
+ };
40
+ defaultInstanceForType?: Any;
41
+ descriptorForType?: Descriptor;
42
+ initializationErrorString?: string;
43
+ initialized?: boolean;
44
+ parserForType?: ParserAny;
45
+ serializedSize?: number;
46
+ typeUrl?: string;
47
+ typeUrlBytes?: ByteString;
48
+ unknownFields?: UnknownFieldSet;
49
+ value?: ByteString;
50
+ };
51
+ type ByteString = {
52
+ empty?: boolean;
53
+ validUtf8?: boolean;
54
+ };
55
+ type CacheConfig = {
56
+ key?: string;
57
+ ttlInSecond?: number;
58
+ };
59
+ type CircuitBreakerTransitionResponse = {
60
+ currentState?: string;
61
+ message?: string;
62
+ previousState?: string;
63
+ service?: string;
64
+ transitionTimestamp?: number;
65
+ };
66
+ type Config$2 = {
67
+ circuitBreakerConfig?: OrkesCircuitBreakerConfig;
68
+ };
69
+ type Declaration = {
70
+ allFields?: {
71
+ [key: string]: unknown;
72
+ };
73
+ defaultInstanceForType?: Declaration;
74
+ descriptorForType?: Descriptor;
75
+ fullName?: string;
76
+ fullNameBytes?: ByteString;
77
+ initializationErrorString?: string;
78
+ initialized?: boolean;
79
+ number?: number;
80
+ parserForType?: ParserDeclaration;
81
+ repeated?: boolean;
82
+ reserved?: boolean;
83
+ serializedSize?: number;
84
+ type?: string;
85
+ typeBytes?: ByteString;
86
+ unknownFields?: UnknownFieldSet;
87
+ };
88
+ type DeclarationOrBuilder = {
89
+ allFields?: {
90
+ [key: string]: unknown;
91
+ };
92
+ defaultInstanceForType?: Message;
93
+ descriptorForType?: Descriptor;
94
+ fullName?: string;
95
+ fullNameBytes?: ByteString;
96
+ initializationErrorString?: string;
97
+ initialized?: boolean;
98
+ number?: number;
99
+ repeated?: boolean;
100
+ reserved?: boolean;
101
+ type?: string;
102
+ typeBytes?: ByteString;
103
+ unknownFields?: UnknownFieldSet;
104
+ };
105
+ type Descriptor = {
106
+ containingType?: Descriptor;
107
+ enumTypes?: Array<EnumDescriptor>;
108
+ extendable?: boolean;
109
+ extensions?: Array<FieldDescriptor>;
110
+ fields?: Array<FieldDescriptor>;
111
+ file?: FileDescriptor;
112
+ fullName?: string;
113
+ index?: number;
63
114
  name?: string;
64
- version?: number;
65
- correlationId?: string;
66
- input?: Record<string, any>;
67
- taskToDomain?: Record<string, string>;
115
+ nestedTypes?: Array<Descriptor>;
116
+ oneofs?: Array<OneofDescriptor>;
117
+ options?: MessageOptions;
118
+ proto?: DescriptorProto;
119
+ realOneofs?: Array<OneofDescriptor>;
68
120
  };
69
-
70
- declare type TaskDetails = {
71
- workflowId?: string;
72
- taskRefName?: string;
73
- output?: Record<string, any>;
74
- taskId?: string;
121
+ type DescriptorProto = {
122
+ allFields?: {
123
+ [key: string]: unknown;
124
+ };
125
+ defaultInstanceForType?: DescriptorProto;
126
+ descriptorForType?: Descriptor;
127
+ enumTypeCount?: number;
128
+ enumTypeList?: Array<EnumDescriptorProto>;
129
+ enumTypeOrBuilderList?: Array<EnumDescriptorProtoOrBuilder>;
130
+ extensionCount?: number;
131
+ extensionList?: Array<FieldDescriptorProto>;
132
+ extensionOrBuilderList?: Array<FieldDescriptorProtoOrBuilder>;
133
+ extensionRangeCount?: number;
134
+ extensionRangeList?: Array<ExtensionRange>;
135
+ extensionRangeOrBuilderList?: Array<ExtensionRangeOrBuilder>;
136
+ fieldCount?: number;
137
+ fieldList?: Array<FieldDescriptorProto>;
138
+ fieldOrBuilderList?: Array<FieldDescriptorProtoOrBuilder>;
139
+ initializationErrorString?: string;
140
+ initialized?: boolean;
141
+ name?: string;
142
+ nameBytes?: ByteString;
143
+ nestedTypeCount?: number;
144
+ nestedTypeList?: Array<DescriptorProto>;
145
+ nestedTypeOrBuilderList?: Array<DescriptorProtoOrBuilder>;
146
+ oneofDeclCount?: number;
147
+ oneofDeclList?: Array<OneofDescriptorProto>;
148
+ oneofDeclOrBuilderList?: Array<OneofDescriptorProtoOrBuilder>;
149
+ options?: MessageOptions;
150
+ optionsOrBuilder?: MessageOptionsOrBuilder;
151
+ parserForType?: ParserDescriptorProto;
152
+ reservedNameCount?: number;
153
+ reservedNameList?: Array<string>;
154
+ reservedRangeCount?: number;
155
+ reservedRangeList?: Array<ReservedRange>;
156
+ reservedRangeOrBuilderList?: Array<ReservedRangeOrBuilder>;
157
+ serializedSize?: number;
158
+ unknownFields?: UnknownFieldSet;
75
159
  };
76
-
77
- declare type Action = {
78
- action?: 'start_workflow' | 'complete_task' | 'fail_task';
79
- start_workflow?: StartWorkflow;
80
- complete_task?: TaskDetails;
81
- fail_task?: TaskDetails;
82
- expandInlineJSON?: boolean;
160
+ type DescriptorProtoOrBuilder = {
161
+ allFields?: {
162
+ [key: string]: unknown;
163
+ };
164
+ defaultInstanceForType?: Message;
165
+ descriptorForType?: Descriptor;
166
+ enumTypeCount?: number;
167
+ enumTypeList?: Array<EnumDescriptorProto>;
168
+ enumTypeOrBuilderList?: Array<EnumDescriptorProtoOrBuilder>;
169
+ extensionCount?: number;
170
+ extensionList?: Array<FieldDescriptorProto>;
171
+ extensionOrBuilderList?: Array<FieldDescriptorProtoOrBuilder>;
172
+ extensionRangeCount?: number;
173
+ extensionRangeList?: Array<ExtensionRange>;
174
+ extensionRangeOrBuilderList?: Array<ExtensionRangeOrBuilder>;
175
+ fieldCount?: number;
176
+ fieldList?: Array<FieldDescriptorProto>;
177
+ fieldOrBuilderList?: Array<FieldDescriptorProtoOrBuilder>;
178
+ initializationErrorString?: string;
179
+ initialized?: boolean;
180
+ name?: string;
181
+ nameBytes?: ByteString;
182
+ nestedTypeCount?: number;
183
+ nestedTypeList?: Array<DescriptorProto>;
184
+ oneofDeclCount?: number;
185
+ oneofDeclList?: Array<OneofDescriptorProto>;
186
+ oneofDeclOrBuilderList?: Array<OneofDescriptorProtoOrBuilder>;
187
+ options?: MessageOptions;
188
+ optionsOrBuilder?: MessageOptionsOrBuilder;
189
+ reservedNameCount?: number;
190
+ reservedNameList?: Array<string>;
191
+ reservedRangeCount?: number;
192
+ reservedRangeList?: Array<ReservedRange>;
193
+ reservedRangeOrBuilderList?: Array<ReservedRangeOrBuilder>;
194
+ unknownFields?: UnknownFieldSet;
83
195
  };
84
-
85
- declare type EventHandler = {
86
- name: string;
87
- event: string;
88
- condition?: string;
89
- actions: Array<Action>;
90
- active?: boolean;
91
- evaluatorType?: string;
196
+ type EditionDefault = {
197
+ allFields?: {
198
+ [key: string]: unknown;
199
+ };
200
+ defaultInstanceForType?: EditionDefault;
201
+ descriptorForType?: Descriptor;
202
+ edition?: 'EDITION_UNKNOWN' | 'EDITION_PROTO2' | 'EDITION_PROTO3' | 'EDITION_2023' | 'EDITION_1_TEST_ONLY' | 'EDITION_2_TEST_ONLY' | 'EDITION_99997_TEST_ONLY' | 'EDITION_99998_TEST_ONLY' | 'EDITION_99999_TEST_ONLY';
203
+ initializationErrorString?: string;
204
+ initialized?: boolean;
205
+ parserForType?: ParserEditionDefault;
206
+ serializedSize?: number;
207
+ unknownFields?: UnknownFieldSet;
208
+ value?: string;
209
+ valueBytes?: ByteString;
92
210
  };
93
-
94
- declare class EventResourceService {
95
- readonly httpRequest: BaseHttpRequest;
96
- constructor(httpRequest: BaseHttpRequest);
97
- /**
98
- * Get queue config by name
99
- * @param queueType
100
- * @param queueName
101
- * @returns any OK
102
- * @throws ApiError
103
- */
104
- getQueueConfig(queueType: string, queueName: string): CancelablePromise<any>;
105
- /**
106
- * Create or update queue config by name
107
- * @param queueType
108
- * @param queueName
109
- * @param requestBody
110
- * @returns any OK
111
- * @throws ApiError
112
- */
113
- putQueueConfig(queueType: string, queueName: string, requestBody: string): CancelablePromise<any>;
114
- /**
115
- * Delete queue config by name
116
- * @param queueType
117
- * @param queueName
118
- * @returns any OK
119
- * @throws ApiError
120
- */
121
- deleteQueueConfig(queueType: string, queueName: string): CancelablePromise<any>;
122
- /**
123
- * Get all the event handlers
124
- * @returns EventHandler OK
125
- * @throws ApiError
126
- */
127
- getEventHandlers(): CancelablePromise<Array<EventHandler>>;
128
- /**
129
- * Update an existing event handler.
130
- * @param requestBody
131
- * @returns any OK
132
- * @throws ApiError
133
- */
134
- updateEventHandler(requestBody: EventHandler): CancelablePromise<any>;
135
- /**
136
- * Add a new event handler.
137
- * @param requestBody
138
- * @returns any OK
139
- * @throws ApiError
140
- */
141
- addEventHandler(requestBody: EventHandler): CancelablePromise<any>;
142
- /**
143
- * Get all queue configs
144
- * @returns any OK
145
- * @throws ApiError
146
- */
147
- getQueueNames(): CancelablePromise<any>;
148
- /**
149
- * Remove an event handler
150
- * @param name
151
- * @returns any OK
152
- * @throws ApiError
153
- */
154
- removeEventHandlerStatus(name: string): CancelablePromise<any>;
211
+ type EditionDefaultOrBuilder = {
212
+ allFields?: {
213
+ [key: string]: unknown;
214
+ };
215
+ defaultInstanceForType?: Message;
216
+ descriptorForType?: Descriptor;
217
+ edition?: 'EDITION_UNKNOWN' | 'EDITION_PROTO2' | 'EDITION_PROTO3' | 'EDITION_2023' | 'EDITION_1_TEST_ONLY' | 'EDITION_2_TEST_ONLY' | 'EDITION_99997_TEST_ONLY' | 'EDITION_99998_TEST_ONLY' | 'EDITION_99999_TEST_ONLY';
218
+ initializationErrorString?: string;
219
+ initialized?: boolean;
220
+ unknownFields?: UnknownFieldSet;
221
+ value?: string;
222
+ valueBytes?: ByteString;
223
+ };
224
+ type EnumDescriptor = {
225
+ closed?: boolean;
226
+ containingType?: Descriptor;
227
+ file?: FileDescriptor;
228
+ fullName?: string;
229
+ index?: number;
230
+ name?: string;
231
+ options?: EnumOptions;
232
+ proto?: EnumDescriptorProto;
233
+ values?: Array<EnumValueDescriptor>;
234
+ };
235
+ type EnumDescriptorProto = {
236
+ allFields?: {
237
+ [key: string]: unknown;
238
+ };
239
+ defaultInstanceForType?: EnumDescriptorProto;
240
+ descriptorForType?: Descriptor;
241
+ initializationErrorString?: string;
242
+ initialized?: boolean;
243
+ name?: string;
244
+ nameBytes?: ByteString;
245
+ options?: EnumOptions;
246
+ optionsOrBuilder?: EnumOptionsOrBuilder;
247
+ parserForType?: ParserEnumDescriptorProto;
248
+ reservedNameCount?: number;
249
+ reservedNameList?: Array<string>;
250
+ reservedRangeCount?: number;
251
+ reservedRangeList?: Array<EnumReservedRange>;
252
+ reservedRangeOrBuilderList?: Array<EnumReservedRangeOrBuilder>;
253
+ serializedSize?: number;
254
+ unknownFields?: UnknownFieldSet;
255
+ valueCount?: number;
256
+ valueList?: Array<EnumValueDescriptorProto>;
257
+ valueOrBuilderList?: Array<EnumValueDescriptorProtoOrBuilder>;
258
+ };
259
+ type EnumDescriptorProtoOrBuilder = {
260
+ allFields?: {
261
+ [key: string]: unknown;
262
+ };
263
+ defaultInstanceForType?: Message;
264
+ descriptorForType?: Descriptor;
265
+ initializationErrorString?: string;
266
+ initialized?: boolean;
267
+ name?: string;
268
+ nameBytes?: ByteString;
269
+ options?: EnumOptions;
270
+ optionsOrBuilder?: EnumOptionsOrBuilder;
271
+ reservedNameCount?: number;
272
+ reservedNameList?: Array<string>;
273
+ reservedRangeCount?: number;
274
+ reservedRangeList?: Array<EnumReservedRange>;
275
+ reservedRangeOrBuilderList?: Array<EnumReservedRangeOrBuilder>;
276
+ unknownFields?: UnknownFieldSet;
277
+ valueCount?: number;
278
+ valueList?: Array<EnumValueDescriptorProto>;
279
+ valueOrBuilderList?: Array<EnumValueDescriptorProtoOrBuilder>;
280
+ };
281
+ type EnumOptions = {
282
+ allFields?: {
283
+ [key: string]: unknown;
284
+ };
285
+ allFieldsRaw?: {
286
+ [key: string]: unknown;
287
+ };
288
+ allowAlias?: boolean;
289
+ defaultInstanceForType?: EnumOptions;
290
+ deprecated?: boolean;
155
291
  /**
156
- * Get event handlers for a given event
157
- * @param event
158
- * @param activeOnly
159
- * @returns EventHandler OK
160
- * @throws ApiError
292
+ * @deprecated
161
293
  */
162
- getEventHandlersForEvent(event: string, activeOnly?: boolean): CancelablePromise<Array<EventHandler>>;
163
- }
164
-
165
- declare class HealthCheckResourceService {
166
- readonly httpRequest: BaseHttpRequest;
167
- constructor(httpRequest: BaseHttpRequest);
294
+ deprecatedLegacyJsonFieldConflicts?: boolean;
295
+ descriptorForType?: Descriptor;
296
+ features?: FeatureSet;
297
+ featuresOrBuilder?: FeatureSetOrBuilder;
298
+ initializationErrorString?: string;
299
+ initialized?: boolean;
300
+ parserForType?: ParserEnumOptions;
301
+ serializedSize?: number;
302
+ uninterpretedOptionCount?: number;
303
+ uninterpretedOptionList?: Array<UninterpretedOption>;
304
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
305
+ unknownFields?: UnknownFieldSet;
306
+ };
307
+ type EnumOptionsOrBuilder = {
308
+ allFields?: {
309
+ [key: string]: unknown;
310
+ };
311
+ allowAlias?: boolean;
312
+ defaultInstanceForType?: Message;
313
+ deprecated?: boolean;
168
314
  /**
169
- * @returns any OK
170
- * @throws ApiError
315
+ * @deprecated
171
316
  */
172
- doCheck(): CancelablePromise<Record<string, any>>;
173
- }
174
-
175
- declare type TaskDef = {
176
- ownerApp?: string;
317
+ deprecatedLegacyJsonFieldConflicts?: boolean;
318
+ descriptorForType?: Descriptor;
319
+ features?: FeatureSet;
320
+ featuresOrBuilder?: FeatureSetOrBuilder;
321
+ initializationErrorString?: string;
322
+ initialized?: boolean;
323
+ uninterpretedOptionCount?: number;
324
+ uninterpretedOptionList?: Array<UninterpretedOption>;
325
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
326
+ unknownFields?: UnknownFieldSet;
327
+ };
328
+ type EnumReservedRange = {
329
+ allFields?: {
330
+ [key: string]: unknown;
331
+ };
332
+ defaultInstanceForType?: EnumReservedRange;
333
+ descriptorForType?: Descriptor;
334
+ end?: number;
335
+ initializationErrorString?: string;
336
+ initialized?: boolean;
337
+ parserForType?: ParserEnumReservedRange;
338
+ serializedSize?: number;
339
+ start?: number;
340
+ unknownFields?: UnknownFieldSet;
341
+ };
342
+ type EnumReservedRangeOrBuilder = {
343
+ allFields?: {
344
+ [key: string]: unknown;
345
+ };
346
+ defaultInstanceForType?: Message;
347
+ descriptorForType?: Descriptor;
348
+ end?: number;
349
+ initializationErrorString?: string;
350
+ initialized?: boolean;
351
+ start?: number;
352
+ unknownFields?: UnknownFieldSet;
353
+ };
354
+ type EnumValueDescriptor = {
355
+ file?: FileDescriptor;
356
+ fullName?: string;
357
+ index?: number;
358
+ name?: string;
359
+ number?: number;
360
+ options?: EnumValueOptions;
361
+ proto?: EnumValueDescriptorProto;
362
+ type?: EnumDescriptor;
363
+ };
364
+ type EnumValueDescriptorProto = {
365
+ allFields?: {
366
+ [key: string]: unknown;
367
+ };
368
+ defaultInstanceForType?: EnumValueDescriptorProto;
369
+ descriptorForType?: Descriptor;
370
+ initializationErrorString?: string;
371
+ initialized?: boolean;
372
+ name?: string;
373
+ nameBytes?: ByteString;
374
+ number?: number;
375
+ options?: EnumValueOptions;
376
+ optionsOrBuilder?: EnumValueOptionsOrBuilder;
377
+ parserForType?: ParserEnumValueDescriptorProto;
378
+ serializedSize?: number;
379
+ unknownFields?: UnknownFieldSet;
380
+ };
381
+ type EnumValueDescriptorProtoOrBuilder = {
382
+ allFields?: {
383
+ [key: string]: unknown;
384
+ };
385
+ defaultInstanceForType?: Message;
386
+ descriptorForType?: Descriptor;
387
+ initializationErrorString?: string;
388
+ initialized?: boolean;
389
+ name?: string;
390
+ nameBytes?: ByteString;
391
+ number?: number;
392
+ options?: EnumValueOptions;
393
+ optionsOrBuilder?: EnumValueOptionsOrBuilder;
394
+ unknownFields?: UnknownFieldSet;
395
+ };
396
+ type EnumValueOptions = {
397
+ allFields?: {
398
+ [key: string]: unknown;
399
+ };
400
+ allFieldsRaw?: {
401
+ [key: string]: unknown;
402
+ };
403
+ debugRedact?: boolean;
404
+ defaultInstanceForType?: EnumValueOptions;
405
+ deprecated?: boolean;
406
+ descriptorForType?: Descriptor;
407
+ features?: FeatureSet;
408
+ featuresOrBuilder?: FeatureSetOrBuilder;
409
+ initializationErrorString?: string;
410
+ initialized?: boolean;
411
+ parserForType?: ParserEnumValueOptions;
412
+ serializedSize?: number;
413
+ uninterpretedOptionCount?: number;
414
+ uninterpretedOptionList?: Array<UninterpretedOption>;
415
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
416
+ unknownFields?: UnknownFieldSet;
417
+ };
418
+ type EnumValueOptionsOrBuilder = {
419
+ allFields?: {
420
+ [key: string]: unknown;
421
+ };
422
+ debugRedact?: boolean;
423
+ defaultInstanceForType?: Message;
424
+ deprecated?: boolean;
425
+ descriptorForType?: Descriptor;
426
+ features?: FeatureSet;
427
+ featuresOrBuilder?: FeatureSetOrBuilder;
428
+ initializationErrorString?: string;
429
+ initialized?: boolean;
430
+ uninterpretedOptionCount?: number;
431
+ uninterpretedOptionList?: Array<UninterpretedOption>;
432
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
433
+ unknownFields?: UnknownFieldSet;
434
+ };
435
+ type EventHandler = {
436
+ actions?: Array<Action>;
437
+ active?: boolean;
438
+ condition?: string;
439
+ createdBy?: string;
440
+ description?: string;
441
+ evaluatorType?: string;
442
+ event?: string;
443
+ name?: string;
444
+ orgId?: string;
445
+ tags?: Array<Tag>;
446
+ };
447
+ type ExtendedTaskDef$1 = {
448
+ backoffScaleFactor?: number;
449
+ baseType?: string;
450
+ concurrentExecLimit?: number;
177
451
  createTime?: number;
178
- updateTime?: number;
179
452
  createdBy?: string;
180
- updatedBy?: string;
181
- name: string;
182
453
  description?: string;
183
- retryCount?: number;
184
- timeoutSeconds: number;
454
+ enforceSchema?: boolean;
455
+ executionNameSpace?: string;
185
456
  inputKeys?: Array<string>;
186
- outputKeys?: Array<string>;
187
- timeoutPolicy?: 'RETRY' | 'TIME_OUT_WF' | 'ALERT_ONLY';
188
- retryLogic?: 'FIXED' | 'EXPONENTIAL_BACKOFF' | 'LINEAR_BACKOFF';
189
- retryDelaySeconds?: number;
190
- responseTimeoutSeconds?: number;
191
- concurrentExecLimit?: number;
192
- inputTemplate?: Record<string, any>;
193
- rateLimitPerFrequency?: number;
194
- rateLimitFrequencyInSeconds?: number;
457
+ inputSchema?: SchemaDef;
458
+ inputTemplate?: {
459
+ [key: string]: unknown;
460
+ };
195
461
  isolationGroupId?: string;
196
- executionNameSpace?: string;
462
+ name: string;
463
+ outputKeys?: Array<string>;
464
+ outputSchema?: SchemaDef;
465
+ overwriteTags?: boolean;
466
+ ownerApp?: string;
197
467
  ownerEmail?: string;
198
468
  pollTimeoutSeconds?: number;
199
- backoffScaleFactor?: number;
200
- };
201
-
202
- declare type SubWorkflowParams = {
203
- name: string;
204
- version?: number;
205
- taskToDomain?: Record<string, string>;
206
- workflowDefinition?: WorkflowDef$1;
207
- idempotencyKey?: string;
208
- idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING';
209
- };
210
-
211
- declare type WorkflowTask = {
212
- name: string;
213
- taskReferenceName: string;
214
- description?: string;
215
- inputParameters?: Record<string, any>;
216
- type?: string;
217
- dynamicTaskNameParam?: string;
218
- /**
219
- * @deprecated
220
- */
221
- caseValueParam?: string;
222
- /**
223
- * @deprecated
224
- */
225
- caseExpression?: string;
226
- scriptExpression?: string;
227
- decisionCases?: Record<string, Array<WorkflowTask>>;
228
- /**
229
- * @deprecated
230
- */
231
- dynamicForkJoinTasksParam?: string;
232
- dynamicForkTasksParam?: string;
233
- dynamicForkTasksInputParamName?: string;
234
- defaultCase?: Array<WorkflowTask>;
235
- forkTasks?: Array<Array<WorkflowTask>>;
236
- startDelay?: number;
237
- subWorkflowParam?: SubWorkflowParams;
238
- joinOn?: Array<string>;
239
- sink?: string;
240
- optional?: boolean;
241
- taskDefinition?: TaskDef;
242
- rateLimited?: boolean;
243
- defaultExclusiveJoinTask?: Array<string>;
244
- asyncComplete?: boolean;
245
- loopCondition?: string;
246
- loopOver?: Array<WorkflowTask>;
469
+ rateLimitFrequencyInSeconds?: number;
470
+ rateLimitPerFrequency?: number;
471
+ responseTimeoutSeconds?: number;
247
472
  retryCount?: number;
248
- evaluatorType?: string;
249
- expression?: string;
250
- workflowTaskType?: 'SIMPLE' | 'DYNAMIC' | 'FORK_JOIN' | 'FORK_JOIN_DYNAMIC' | 'DECISION' | 'SWITCH' | 'JOIN' | 'DO_WHILE' | 'SUB_WORKFLOW' | 'START_WORKFLOW' | 'EVENT' | 'WAIT' | 'HUMAN' | 'USER_DEFINED' | 'HTTP' | 'LAMBDA' | 'INLINE' | 'EXCLUSIVE_JOIN' | 'TERMINATE' | 'KAFKA_PUBLISH' | 'JSON_JQ_TRANSFORM' | 'SET_VARIABLE';
473
+ retryDelaySeconds?: number;
474
+ retryLogic?: 'FIXED' | 'EXPONENTIAL_BACKOFF' | 'LINEAR_BACKOFF';
475
+ tags?: Array<Tag>;
476
+ timeoutPolicy?: 'RETRY' | 'TIME_OUT_WF' | 'ALERT_ONLY';
477
+ timeoutSeconds: number;
478
+ totalTimeoutSeconds: number;
479
+ updateTime?: number;
480
+ updatedBy?: string;
251
481
  };
252
-
253
- declare type WorkflowDef$1 = {
254
- ownerApp?: string;
482
+ type ExtendedWorkflowDef = {
483
+ cacheConfig?: CacheConfig;
255
484
  createTime?: number;
256
- updateTime?: number;
257
485
  createdBy?: string;
258
- updatedBy?: string;
259
- name: string;
260
486
  description?: string;
261
- version?: number;
262
- tasks: Array<WorkflowTask>;
263
- inputParameters?: Array<string>;
264
- outputParameters?: Record<string, any>;
487
+ enforceSchema?: boolean;
265
488
  failureWorkflow?: string;
266
- schemaVersion?: number;
267
- restartable?: boolean;
268
- workflowStatusListenerEnabled?: boolean;
489
+ inputParameters?: Array<string>;
490
+ inputSchema?: SchemaDef;
491
+ inputTemplate?: {
492
+ [key: string]: unknown;
493
+ };
494
+ maskedFields?: Array<string>;
495
+ metadata?: {
496
+ [key: string]: unknown;
497
+ };
498
+ name: string;
499
+ outputParameters?: {
500
+ [key: string]: unknown;
501
+ };
502
+ outputSchema?: SchemaDef;
503
+ overwriteTags?: boolean;
504
+ ownerApp?: string;
269
505
  ownerEmail?: string;
506
+ rateLimitConfig?: RateLimitConfig;
507
+ restartable?: boolean;
508
+ schemaVersion?: number;
509
+ tags?: Array<Tag>;
510
+ tasks: Array<WorkflowTask>;
270
511
  timeoutPolicy?: 'TIME_OUT_WF' | 'ALERT_ONLY';
271
512
  timeoutSeconds: number;
272
- variables?: Record<string, any>;
273
- inputTemplate?: Record<string, any>;
513
+ updateTime?: number;
514
+ updatedBy?: string;
515
+ variables?: {
516
+ [key: string]: unknown;
517
+ };
518
+ version?: number;
519
+ workflowStatusListenerEnabled?: boolean;
520
+ workflowStatusListenerSink?: string;
274
521
  };
275
-
276
- declare class MetadataResourceService {
277
- readonly httpRequest: BaseHttpRequest;
278
- constructor(httpRequest: BaseHttpRequest);
279
- /**
280
- * Gets the task definition
281
- * @param tasktype
282
- * @param metadata
283
- * @returns TaskDef OK
284
- * @throws ApiError
285
- */
286
- getTaskDef(tasktype: string, metadata?: boolean): CancelablePromise<TaskDef>;
287
- /**
288
- * Remove a task definition
289
- * @param tasktype
290
- * @returns any OK
291
- * @throws ApiError
292
- */
293
- unregisterTaskDef(tasktype: string): CancelablePromise<any>;
294
- /**
295
- * Retrieves all workflow definition along with blueprint
296
- * @param access
297
- * @param metadata
298
- * @param tagKey
299
- * @param tagValue
300
- * @returns WorkflowDef OK
301
- * @throws ApiError
302
- */
303
- getAllWorkflows(access?: string, metadata?: boolean, tagKey?: string, tagValue?: string): CancelablePromise<Array<WorkflowDef$1>>;
304
- /**
305
- * Create or update workflow definition(s)
306
- * @param requestBody
307
- * @param overwrite
308
- * @returns any OK
309
- * @throws ApiError
310
- */
311
- update(requestBody: Array<WorkflowDef$1>, overwrite?: boolean): CancelablePromise<any>;
312
- /**
313
- * Create a new workflow definition
314
- * @param requestBody
315
- * @param overwrite
316
- * @returns any OK
317
- * @throws ApiError
318
- */
319
- create(requestBody: WorkflowDef$1, overwrite?: boolean): CancelablePromise<any>;
320
- /**
321
- * Gets all task definition
322
- * @param access
323
- * @param metadata
324
- * @param tagKey
325
- * @param tagValue
326
- * @returns TaskDef OK
327
- * @throws ApiError
328
- */
329
- getTaskDefs(access?: string, metadata?: boolean, tagKey?: string, tagValue?: string): CancelablePromise<Array<TaskDef>>;
330
- /**
331
- * Update an existing task
332
- * @param requestBody
333
- * @returns any OK
334
- * @throws ApiError
335
- */
336
- updateTaskDef(requestBody: TaskDef): CancelablePromise<any>;
522
+ type ExtensionRange = {
523
+ allFields?: {
524
+ [key: string]: unknown;
525
+ };
526
+ defaultInstanceForType?: ExtensionRange;
527
+ descriptorForType?: Descriptor;
528
+ end?: number;
529
+ initializationErrorString?: string;
530
+ initialized?: boolean;
531
+ options?: ExtensionRangeOptions;
532
+ optionsOrBuilder?: ExtensionRangeOptionsOrBuilder;
533
+ parserForType?: ParserExtensionRange;
534
+ serializedSize?: number;
535
+ start?: number;
536
+ unknownFields?: UnknownFieldSet;
537
+ };
538
+ type ExtensionRangeOptions = {
539
+ allFields?: {
540
+ [key: string]: unknown;
541
+ };
542
+ allFieldsRaw?: {
543
+ [key: string]: unknown;
544
+ };
545
+ declarationCount?: number;
546
+ declarationList?: Array<Declaration>;
547
+ declarationOrBuilderList?: Array<DeclarationOrBuilder>;
548
+ defaultInstanceForType?: ExtensionRangeOptions;
549
+ descriptorForType?: Descriptor;
550
+ features?: FeatureSet;
551
+ featuresOrBuilder?: FeatureSetOrBuilder;
552
+ initializationErrorString?: string;
553
+ initialized?: boolean;
554
+ parserForType?: ParserExtensionRangeOptions;
555
+ serializedSize?: number;
556
+ uninterpretedOptionCount?: number;
557
+ uninterpretedOptionList?: Array<UninterpretedOption>;
558
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
559
+ unknownFields?: UnknownFieldSet;
560
+ verification?: 'DECLARATION' | 'UNVERIFIED';
561
+ };
562
+ type ExtensionRangeOptionsOrBuilder = {
563
+ allFields?: {
564
+ [key: string]: unknown;
565
+ };
566
+ declarationCount?: number;
567
+ declarationList?: Array<Declaration>;
568
+ declarationOrBuilderList?: Array<DeclarationOrBuilder>;
569
+ defaultInstanceForType?: Message;
570
+ descriptorForType?: Descriptor;
571
+ features?: FeatureSet;
572
+ featuresOrBuilder?: FeatureSetOrBuilder;
573
+ initializationErrorString?: string;
574
+ initialized?: boolean;
575
+ uninterpretedOptionCount?: number;
576
+ uninterpretedOptionList?: Array<UninterpretedOption>;
577
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
578
+ unknownFields?: UnknownFieldSet;
579
+ verification?: 'DECLARATION' | 'UNVERIFIED';
580
+ };
581
+ type ExtensionRangeOrBuilder = {
582
+ allFields?: {
583
+ [key: string]: unknown;
584
+ };
585
+ defaultInstanceForType?: Message;
586
+ descriptorForType?: Descriptor;
587
+ end?: number;
588
+ initializationErrorString?: string;
589
+ initialized?: boolean;
590
+ options?: ExtensionRangeOptions;
591
+ optionsOrBuilder?: ExtensionRangeOptionsOrBuilder;
592
+ start?: number;
593
+ unknownFields?: UnknownFieldSet;
594
+ };
595
+ type FeatureSet = {
596
+ allFields?: {
597
+ [key: string]: unknown;
598
+ };
599
+ allFieldsRaw?: {
600
+ [key: string]: unknown;
601
+ };
602
+ defaultInstanceForType?: FeatureSet;
603
+ descriptorForType?: Descriptor;
604
+ enumType?: 'ENUM_TYPE_UNKNOWN' | 'OPEN' | 'CLOSED';
605
+ fieldPresence?: 'FIELD_PRESENCE_UNKNOWN' | 'EXPLICIT' | 'IMPLICIT' | 'LEGACY_REQUIRED';
606
+ initializationErrorString?: string;
607
+ initialized?: boolean;
608
+ jsonFormat?: 'JSON_FORMAT_UNKNOWN' | 'ALLOW' | 'LEGACY_BEST_EFFORT';
609
+ messageEncoding?: 'MESSAGE_ENCODING_UNKNOWN' | 'LENGTH_PREFIXED' | 'DELIMITED';
610
+ parserForType?: ParserFeatureSet;
611
+ repeatedFieldEncoding?: 'REPEATED_FIELD_ENCODING_UNKNOWN' | 'PACKED' | 'EXPANDED';
612
+ serializedSize?: number;
613
+ unknownFields?: UnknownFieldSet;
614
+ utf8Validation?: 'UTF8_VALIDATION_UNKNOWN' | 'NONE' | 'VERIFY';
615
+ };
616
+ type FeatureSetOrBuilder = {
617
+ allFields?: {
618
+ [key: string]: unknown;
619
+ };
620
+ defaultInstanceForType?: Message;
621
+ descriptorForType?: Descriptor;
622
+ enumType?: 'ENUM_TYPE_UNKNOWN' | 'OPEN' | 'CLOSED';
623
+ fieldPresence?: 'FIELD_PRESENCE_UNKNOWN' | 'EXPLICIT' | 'IMPLICIT' | 'LEGACY_REQUIRED';
624
+ initializationErrorString?: string;
625
+ initialized?: boolean;
626
+ jsonFormat?: 'JSON_FORMAT_UNKNOWN' | 'ALLOW' | 'LEGACY_BEST_EFFORT';
627
+ messageEncoding?: 'MESSAGE_ENCODING_UNKNOWN' | 'LENGTH_PREFIXED' | 'DELIMITED';
628
+ repeatedFieldEncoding?: 'REPEATED_FIELD_ENCODING_UNKNOWN' | 'PACKED' | 'EXPANDED';
629
+ unknownFields?: UnknownFieldSet;
630
+ utf8Validation?: 'UTF8_VALIDATION_UNKNOWN' | 'NONE' | 'VERIFY';
631
+ };
632
+ type FieldDescriptor = {
633
+ containingOneof?: OneofDescriptor;
634
+ containingType?: Descriptor;
635
+ defaultValue?: {
636
+ [key: string]: unknown;
637
+ };
638
+ enumType?: EnumDescriptor;
639
+ extension?: boolean;
640
+ extensionScope?: Descriptor;
641
+ file?: FileDescriptor;
642
+ fullName?: string;
643
+ index?: number;
644
+ javaType?: 'INT' | 'LONG' | 'FLOAT' | 'DOUBLE' | 'BOOLEAN' | 'STRING' | 'BYTE_STRING' | 'ENUM' | 'MESSAGE';
645
+ jsonName?: string;
646
+ liteJavaType?: 'INT' | 'LONG' | 'FLOAT' | 'DOUBLE' | 'BOOLEAN' | 'STRING' | 'BYTE_STRING' | 'ENUM' | 'MESSAGE';
647
+ liteType?: 'DOUBLE' | 'FLOAT' | 'INT64' | 'UINT64' | 'INT32' | 'FIXED64' | 'FIXED32' | 'BOOL' | 'STRING' | 'GROUP' | 'MESSAGE' | 'BYTES' | 'UINT32' | 'ENUM' | 'SFIXED32' | 'SFIXED64' | 'SINT32' | 'SINT64';
648
+ mapField?: boolean;
649
+ messageType?: Descriptor;
650
+ name?: string;
651
+ number?: number;
652
+ optional?: boolean;
653
+ options?: FieldOptions;
654
+ packable?: boolean;
655
+ packed?: boolean;
656
+ proto?: FieldDescriptorProto;
657
+ realContainingOneof?: OneofDescriptor;
658
+ repeated?: boolean;
659
+ required?: boolean;
660
+ type?: 'DOUBLE' | 'FLOAT' | 'INT64' | 'UINT64' | 'INT32' | 'FIXED64' | 'FIXED32' | 'BOOL' | 'STRING' | 'GROUP' | 'MESSAGE' | 'BYTES' | 'UINT32' | 'ENUM' | 'SFIXED32' | 'SFIXED64' | 'SINT32' | 'SINT64';
661
+ };
662
+ type FieldDescriptorProto = {
663
+ allFields?: {
664
+ [key: string]: unknown;
665
+ };
666
+ defaultInstanceForType?: FieldDescriptorProto;
667
+ defaultValue?: string;
668
+ defaultValueBytes?: ByteString;
669
+ descriptorForType?: Descriptor;
670
+ extendee?: string;
671
+ extendeeBytes?: ByteString;
672
+ initializationErrorString?: string;
673
+ initialized?: boolean;
674
+ jsonName?: string;
675
+ jsonNameBytes?: ByteString;
676
+ label?: 'LABEL_OPTIONAL' | 'LABEL_REPEATED' | 'LABEL_REQUIRED';
677
+ name?: string;
678
+ nameBytes?: ByteString;
679
+ number?: number;
680
+ oneofIndex?: number;
681
+ options?: FieldOptions;
682
+ optionsOrBuilder?: FieldOptionsOrBuilder;
683
+ parserForType?: ParserFieldDescriptorProto;
684
+ proto3Optional?: boolean;
685
+ serializedSize?: number;
686
+ type?: 'TYPE_DOUBLE' | 'TYPE_FLOAT' | 'TYPE_INT64' | 'TYPE_UINT64' | 'TYPE_INT32' | 'TYPE_FIXED64' | 'TYPE_FIXED32' | 'TYPE_BOOL' | 'TYPE_STRING' | 'TYPE_GROUP' | 'TYPE_MESSAGE' | 'TYPE_BYTES' | 'TYPE_UINT32' | 'TYPE_ENUM' | 'TYPE_SFIXED32' | 'TYPE_SFIXED64' | 'TYPE_SINT32' | 'TYPE_SINT64';
687
+ typeName?: string;
688
+ typeNameBytes?: ByteString;
689
+ unknownFields?: UnknownFieldSet;
690
+ };
691
+ type FieldDescriptorProtoOrBuilder = {
692
+ allFields?: {
693
+ [key: string]: unknown;
694
+ };
695
+ defaultInstanceForType?: Message;
696
+ defaultValue?: string;
697
+ defaultValueBytes?: ByteString;
698
+ descriptorForType?: Descriptor;
699
+ extendee?: string;
700
+ extendeeBytes?: ByteString;
701
+ initializationErrorString?: string;
702
+ initialized?: boolean;
703
+ jsonName?: string;
704
+ jsonNameBytes?: ByteString;
705
+ label?: 'LABEL_OPTIONAL' | 'LABEL_REPEATED' | 'LABEL_REQUIRED';
706
+ name?: string;
707
+ nameBytes?: ByteString;
708
+ number?: number;
709
+ oneofIndex?: number;
710
+ options?: FieldOptions;
711
+ optionsOrBuilder?: FieldOptionsOrBuilder;
712
+ proto3Optional?: boolean;
713
+ type?: 'TYPE_DOUBLE' | 'TYPE_FLOAT' | 'TYPE_INT64' | 'TYPE_UINT64' | 'TYPE_INT32' | 'TYPE_FIXED64' | 'TYPE_FIXED32' | 'TYPE_BOOL' | 'TYPE_STRING' | 'TYPE_GROUP' | 'TYPE_MESSAGE' | 'TYPE_BYTES' | 'TYPE_UINT32' | 'TYPE_ENUM' | 'TYPE_SFIXED32' | 'TYPE_SFIXED64' | 'TYPE_SINT32' | 'TYPE_SINT64';
714
+ typeName?: string;
715
+ typeNameBytes?: ByteString;
716
+ unknownFields?: UnknownFieldSet;
717
+ };
718
+ type FieldOptions = {
719
+ allFields?: {
720
+ [key: string]: unknown;
721
+ };
722
+ allFieldsRaw?: {
723
+ [key: string]: unknown;
724
+ };
725
+ ctype?: 'STRING' | 'CORD' | 'STRING_PIECE';
726
+ debugRedact?: boolean;
727
+ defaultInstanceForType?: FieldOptions;
728
+ deprecated?: boolean;
729
+ descriptorForType?: Descriptor;
730
+ editionDefaultsCount?: number;
731
+ editionDefaultsList?: Array<EditionDefault>;
732
+ editionDefaultsOrBuilderList?: Array<EditionDefaultOrBuilder>;
733
+ features?: FeatureSet;
734
+ featuresOrBuilder?: FeatureSetOrBuilder;
735
+ initializationErrorString?: string;
736
+ initialized?: boolean;
737
+ jstype?: 'JS_NORMAL' | 'JS_STRING' | 'JS_NUMBER';
738
+ lazy?: boolean;
739
+ packed?: boolean;
740
+ parserForType?: ParserFieldOptions;
741
+ retention?: 'RETENTION_UNKNOWN' | 'RETENTION_RUNTIME' | 'RETENTION_SOURCE';
742
+ serializedSize?: number;
743
+ targetsCount?: number;
744
+ targetsList?: Array<'TARGET_TYPE_UNKNOWN' | 'TARGET_TYPE_FILE' | 'TARGET_TYPE_EXTENSION_RANGE' | 'TARGET_TYPE_MESSAGE' | 'TARGET_TYPE_FIELD' | 'TARGET_TYPE_ONEOF' | 'TARGET_TYPE_ENUM' | 'TARGET_TYPE_ENUM_ENTRY' | 'TARGET_TYPE_SERVICE' | 'TARGET_TYPE_METHOD'>;
745
+ uninterpretedOptionCount?: number;
746
+ uninterpretedOptionList?: Array<UninterpretedOption>;
747
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
748
+ unknownFields?: UnknownFieldSet;
749
+ unverifiedLazy?: boolean;
750
+ weak?: boolean;
751
+ };
752
+ type FieldOptionsOrBuilder = {
753
+ allFields?: {
754
+ [key: string]: unknown;
755
+ };
756
+ ctype?: 'STRING' | 'CORD' | 'STRING_PIECE';
757
+ debugRedact?: boolean;
758
+ defaultInstanceForType?: Message;
759
+ deprecated?: boolean;
760
+ descriptorForType?: Descriptor;
761
+ editionDefaultsCount?: number;
762
+ editionDefaultsList?: Array<EditionDefault>;
763
+ editionDefaultsOrBuilderList?: Array<EditionDefaultOrBuilder>;
764
+ features?: FeatureSet;
765
+ featuresOrBuilder?: FeatureSetOrBuilder;
766
+ initializationErrorString?: string;
767
+ initialized?: boolean;
768
+ jstype?: 'JS_NORMAL' | 'JS_STRING' | 'JS_NUMBER';
769
+ lazy?: boolean;
770
+ packed?: boolean;
771
+ retention?: 'RETENTION_UNKNOWN' | 'RETENTION_RUNTIME' | 'RETENTION_SOURCE';
772
+ targetsCount?: number;
773
+ targetsList?: Array<'TARGET_TYPE_UNKNOWN' | 'TARGET_TYPE_FILE' | 'TARGET_TYPE_EXTENSION_RANGE' | 'TARGET_TYPE_MESSAGE' | 'TARGET_TYPE_FIELD' | 'TARGET_TYPE_ONEOF' | 'TARGET_TYPE_ENUM' | 'TARGET_TYPE_ENUM_ENTRY' | 'TARGET_TYPE_SERVICE' | 'TARGET_TYPE_METHOD'>;
774
+ uninterpretedOptionCount?: number;
775
+ uninterpretedOptionList?: Array<UninterpretedOption>;
776
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
777
+ unknownFields?: UnknownFieldSet;
778
+ unverifiedLazy?: boolean;
779
+ weak?: boolean;
780
+ };
781
+ type FileDescriptor = {
782
+ dependencies?: Array<FileDescriptor>;
783
+ edition?: 'EDITION_UNKNOWN' | 'EDITION_PROTO2' | 'EDITION_PROTO3' | 'EDITION_2023' | 'EDITION_1_TEST_ONLY' | 'EDITION_2_TEST_ONLY' | 'EDITION_99997_TEST_ONLY' | 'EDITION_99998_TEST_ONLY' | 'EDITION_99999_TEST_ONLY';
784
+ editionName?: string;
785
+ enumTypes?: Array<EnumDescriptor>;
786
+ extensions?: Array<FieldDescriptor>;
787
+ file?: FileDescriptor;
788
+ fullName?: string;
789
+ messageTypes?: Array<Descriptor>;
790
+ name?: string;
791
+ options?: FileOptions;
792
+ package?: string;
793
+ proto?: FileDescriptorProto;
794
+ publicDependencies?: Array<FileDescriptor>;
795
+ services?: Array<ServiceDescriptor>;
337
796
  /**
338
- * Create or update task definition(s)
339
- * @param requestBody
340
- * @returns any OK
341
- * @throws ApiError
797
+ * @deprecated
342
798
  */
343
- registerTaskDef(requestBody: Array<TaskDef>): CancelablePromise<any>;
799
+ syntax?: 'UNKNOWN' | 'PROTO2' | 'PROTO3' | 'EDITIONS';
800
+ };
801
+ type FileDescriptorProto = {
802
+ allFields?: {
803
+ [key: string]: unknown;
804
+ };
805
+ defaultInstanceForType?: FileDescriptorProto;
806
+ dependencyCount?: number;
807
+ dependencyList?: Array<string>;
808
+ descriptorForType?: Descriptor;
809
+ edition?: 'EDITION_UNKNOWN' | 'EDITION_PROTO2' | 'EDITION_PROTO3' | 'EDITION_2023' | 'EDITION_1_TEST_ONLY' | 'EDITION_2_TEST_ONLY' | 'EDITION_99997_TEST_ONLY' | 'EDITION_99998_TEST_ONLY' | 'EDITION_99999_TEST_ONLY';
810
+ enumTypeCount?: number;
811
+ enumTypeList?: Array<EnumDescriptorProto>;
812
+ enumTypeOrBuilderList?: Array<EnumDescriptorProtoOrBuilder>;
813
+ extensionCount?: number;
814
+ extensionList?: Array<FieldDescriptorProto>;
815
+ extensionOrBuilderList?: Array<FieldDescriptorProtoOrBuilder>;
816
+ initializationErrorString?: string;
817
+ initialized?: boolean;
818
+ messageTypeCount?: number;
819
+ messageTypeList?: Array<DescriptorProto>;
820
+ messageTypeOrBuilderList?: Array<DescriptorProtoOrBuilder>;
821
+ name?: string;
822
+ nameBytes?: ByteString;
823
+ options?: FileOptions;
824
+ optionsOrBuilder?: FileOptionsOrBuilder;
825
+ package?: string;
826
+ packageBytes?: ByteString;
827
+ parserForType?: ParserFileDescriptorProto;
828
+ publicDependencyCount?: number;
829
+ publicDependencyList?: Array<number>;
830
+ serializedSize?: number;
831
+ serviceCount?: number;
832
+ serviceList?: Array<ServiceDescriptorProto>;
833
+ serviceOrBuilderList?: Array<ServiceDescriptorProtoOrBuilder>;
834
+ sourceCodeInfo?: SourceCodeInfo;
835
+ sourceCodeInfoOrBuilder?: SourceCodeInfoOrBuilder;
836
+ syntax?: string;
837
+ syntaxBytes?: ByteString;
838
+ unknownFields?: UnknownFieldSet;
839
+ weakDependencyCount?: number;
840
+ weakDependencyList?: Array<number>;
841
+ };
842
+ type FileOptions = {
843
+ allFields?: {
844
+ [key: string]: unknown;
845
+ };
846
+ allFieldsRaw?: {
847
+ [key: string]: unknown;
848
+ };
849
+ ccEnableArenas?: boolean;
850
+ ccGenericServices?: boolean;
851
+ csharpNamespace?: string;
852
+ csharpNamespaceBytes?: ByteString;
853
+ defaultInstanceForType?: FileOptions;
854
+ deprecated?: boolean;
855
+ descriptorForType?: Descriptor;
856
+ features?: FeatureSet;
857
+ featuresOrBuilder?: FeatureSetOrBuilder;
858
+ goPackage?: string;
859
+ goPackageBytes?: ByteString;
860
+ initializationErrorString?: string;
861
+ initialized?: boolean;
344
862
  /**
345
- * Removes workflow definition. It does not remove workflows associated with the definition.
346
- * @param name
347
- * @param version
348
- * @returns any OK
349
- * @throws ApiError
863
+ * @deprecated
350
864
  */
351
- unregisterWorkflowDef(name: string, version: number): CancelablePromise<any>;
865
+ javaGenerateEqualsAndHash?: boolean;
866
+ javaGenericServices?: boolean;
867
+ javaMultipleFiles?: boolean;
868
+ javaOuterClassname?: string;
869
+ javaOuterClassnameBytes?: ByteString;
870
+ javaPackage?: string;
871
+ javaPackageBytes?: ByteString;
872
+ javaStringCheckUtf8?: boolean;
873
+ objcClassPrefix?: string;
874
+ objcClassPrefixBytes?: ByteString;
875
+ optimizeFor?: 'SPEED' | 'CODE_SIZE' | 'LITE_RUNTIME';
876
+ parserForType?: ParserFileOptions;
877
+ phpClassPrefix?: string;
878
+ phpClassPrefixBytes?: ByteString;
879
+ phpGenericServices?: boolean;
880
+ phpMetadataNamespace?: string;
881
+ phpMetadataNamespaceBytes?: ByteString;
882
+ phpNamespace?: string;
883
+ phpNamespaceBytes?: ByteString;
884
+ pyGenericServices?: boolean;
885
+ rubyPackage?: string;
886
+ rubyPackageBytes?: ByteString;
887
+ serializedSize?: number;
888
+ swiftPrefix?: string;
889
+ swiftPrefixBytes?: ByteString;
890
+ uninterpretedOptionCount?: number;
891
+ uninterpretedOptionList?: Array<UninterpretedOption>;
892
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
893
+ unknownFields?: UnknownFieldSet;
894
+ };
895
+ type FileOptionsOrBuilder = {
896
+ allFields?: {
897
+ [key: string]: unknown;
898
+ };
899
+ ccEnableArenas?: boolean;
900
+ ccGenericServices?: boolean;
901
+ csharpNamespace?: string;
902
+ csharpNamespaceBytes?: ByteString;
903
+ defaultInstanceForType?: Message;
904
+ deprecated?: boolean;
905
+ descriptorForType?: Descriptor;
906
+ features?: FeatureSet;
907
+ featuresOrBuilder?: FeatureSetOrBuilder;
908
+ goPackage?: string;
909
+ goPackageBytes?: ByteString;
910
+ initializationErrorString?: string;
911
+ initialized?: boolean;
352
912
  /**
353
- * Retrieves workflow definition along with blueprint
354
- * @param name
355
- * @param version
356
- * @param metadata
357
- * @returns WorkflowDef OK
358
- * @throws ApiError
913
+ * @deprecated
359
914
  */
360
- get(name: string, version?: number, metadata?: boolean): CancelablePromise<WorkflowDef$1>;
361
- }
362
-
363
- declare type StartWorkflowRequest = {
364
- name: string;
365
- version?: number;
366
- correlationId?: string;
367
- input?: Record<string, any>;
368
- taskToDomain?: Record<string, string>;
369
- workflowDef?: WorkflowDef$1;
370
- externalInputPayloadStoragePath?: string;
371
- idempotencyKey?: string;
372
- idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING';
373
- priority?: number;
374
- createdBy?: string;
915
+ javaGenerateEqualsAndHash?: boolean;
916
+ javaGenericServices?: boolean;
917
+ javaMultipleFiles?: boolean;
918
+ javaOuterClassname?: string;
919
+ javaOuterClassnameBytes?: ByteString;
920
+ javaPackage?: string;
921
+ javaPackageBytes?: ByteString;
922
+ javaStringCheckUtf8?: boolean;
923
+ objcClassPrefix?: string;
924
+ objcClassPrefixBytes?: ByteString;
925
+ optimizeFor?: 'SPEED' | 'CODE_SIZE' | 'LITE_RUNTIME';
926
+ phpClassPrefix?: string;
927
+ phpClassPrefixBytes?: ByteString;
928
+ phpGenericServices?: boolean;
929
+ phpMetadataNamespace?: string;
930
+ phpMetadataNamespaceBytes?: ByteString;
931
+ phpNamespace?: string;
932
+ phpNamespaceBytes?: ByteString;
933
+ pyGenericServices?: boolean;
934
+ rubyPackage?: string;
935
+ rubyPackageBytes?: ByteString;
936
+ swiftPrefix?: string;
937
+ swiftPrefixBytes?: ByteString;
938
+ uninterpretedOptionCount?: number;
939
+ uninterpretedOptionList?: Array<UninterpretedOption>;
940
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
941
+ unknownFields?: UnknownFieldSet;
375
942
  };
376
-
377
- declare type SaveScheduleRequest = {
378
- name: string;
379
- cronExpression: string;
380
- runCatchupScheduleInstances?: boolean;
381
- paused?: boolean;
382
- startWorkflowRequest?: StartWorkflowRequest;
943
+ type GenerateTokenRequest = {
944
+ expiration?: number;
945
+ keyId: string;
946
+ keySecret: string;
947
+ };
948
+ type HumanTaskAssignment = {
949
+ assignee?: HumanTaskUser;
950
+ slaMinutes?: number;
951
+ };
952
+ type HumanTaskDefinition = {
953
+ assignmentCompletionStrategy?: 'LEAVE_OPEN' | 'TERMINATE';
954
+ assignments?: Array<HumanTaskAssignment>;
955
+ displayName?: string;
956
+ fullTemplate?: HumanTaskTemplate;
957
+ taskTriggers?: Array<HumanTaskTrigger>;
958
+ userFormTemplate?: UserFormTemplate;
959
+ };
960
+ type HumanTaskEntry = {
961
+ assignee?: HumanTaskUser;
962
+ claimant?: HumanTaskUser;
383
963
  createdBy?: string;
964
+ createdOn?: number;
965
+ definitionName?: string;
966
+ displayName?: string;
967
+ humanTaskDef?: HumanTaskDefinition;
968
+ input?: {
969
+ [key: string]: unknown;
970
+ };
971
+ output?: {
972
+ [key: string]: unknown;
973
+ };
974
+ ownerApp?: string;
975
+ state?: 'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED';
976
+ taskId?: string;
977
+ taskRefName?: string;
384
978
  updatedBy?: string;
385
- scheduleStartTime?: number;
386
- scheduleEndTime?: number;
387
- };
388
-
389
- declare type WorkflowScheduleExecutionModel = {
390
- executionId?: string;
391
- scheduleName?: string;
392
- scheduledTime?: number;
393
- executionTime?: number;
394
- workflowName?: string;
979
+ updatedOn?: number;
395
980
  workflowId?: string;
396
- reason?: string;
397
- stackTrace?: string;
398
- startWorkflowRequest?: StartWorkflowRequest;
399
- state?: 'POLLED' | 'FAILED' | 'EXECUTED';
981
+ workflowName?: string;
400
982
  };
401
-
402
- declare type SearchResultWorkflowScheduleExecutionModel = {
983
+ type HumanTaskSearch = {
984
+ assignees?: Array<HumanTaskUser>;
985
+ claimants?: Array<HumanTaskUser>;
986
+ definitionNames?: Array<string>;
987
+ displayNames?: Array<string>;
988
+ fullTextQuery?: string;
989
+ searchType?: 'ADMIN' | 'INBOX';
990
+ size?: number;
991
+ start?: number;
992
+ states?: Array<'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED'>;
993
+ taskInputQuery?: string;
994
+ taskOutputQuery?: string;
995
+ taskRefNames?: Array<string>;
996
+ updateEndTime?: number;
997
+ updateStartTime?: number;
998
+ workflowIds?: Array<string>;
999
+ workflowNames?: Array<string>;
1000
+ };
1001
+ type HumanTaskSearchResult = {
1002
+ hits?: number;
1003
+ pageSizeLimit?: number;
1004
+ results?: Array<HumanTaskEntry>;
1005
+ start?: number;
403
1006
  totalHits?: number;
404
- results?: Array<WorkflowScheduleExecutionModel>;
405
1007
  };
406
-
407
- declare type WorkflowSchedule = {
408
- name?: string;
409
- cronExpression?: string;
410
- runCatchupScheduleInstances?: boolean;
411
- paused?: boolean;
412
- startWorkflowRequest?: StartWorkflowRequest;
413
- scheduleStartTime?: number;
414
- scheduleEndTime?: number;
1008
+ type HumanTaskTemplate = {
415
1009
  createTime?: number;
416
- updatedTime?: number;
417
1010
  createdBy?: string;
1011
+ jsonSchema: {
1012
+ [key: string]: unknown;
1013
+ };
1014
+ name: string;
1015
+ ownerApp?: string;
1016
+ tags?: Array<Tag>;
1017
+ templateUI: {
1018
+ [key: string]: unknown;
1019
+ };
1020
+ updateTime?: number;
418
1021
  updatedBy?: string;
1022
+ version: number;
419
1023
  };
420
-
421
- declare class SchedulerResourceService {
422
- readonly httpRequest: BaseHttpRequest;
423
- constructor(httpRequest: BaseHttpRequest);
424
- /**
425
- * Get an existing workflow schedule by name
426
- * @param name
427
- * @returns any OK
428
- * @throws ApiError
429
- */
430
- getSchedule(name: string): CancelablePromise<any>;
431
- /**
432
- * Deletes an existing workflow schedule by name
433
- * @param name
434
- * @returns any OK
435
- * @throws ApiError
436
- */
437
- deleteSchedule(name: string): CancelablePromise<any>;
1024
+ type HumanTaskTrigger = {
1025
+ startWorkflowRequest?: StartWorkflowRequest;
1026
+ triggerType?: 'ASSIGNEE_CHANGED' | 'CLAIMANT_CHANGED' | 'PENDING' | 'IN_PROGRESS' | 'ASSIGNED' | 'COMPLETED' | 'TIMED_OUT';
1027
+ };
1028
+ type HumanTaskUser = {
1029
+ user?: string;
1030
+ userType?: 'EXTERNAL_USER' | 'EXTERNAL_GROUP' | 'CONDUCTOR_USER' | 'CONDUCTOR_GROUP';
1031
+ };
1032
+ type Location = {
1033
+ allFields?: {
1034
+ [key: string]: unknown;
1035
+ };
1036
+ defaultInstanceForType?: Location;
1037
+ descriptorForType?: Descriptor;
1038
+ initializationErrorString?: string;
1039
+ initialized?: boolean;
1040
+ leadingComments?: string;
1041
+ leadingCommentsBytes?: ByteString;
1042
+ leadingDetachedCommentsCount?: number;
1043
+ leadingDetachedCommentsList?: Array<string>;
1044
+ parserForType?: ParserLocation;
1045
+ pathCount?: number;
1046
+ pathList?: Array<number>;
1047
+ serializedSize?: number;
1048
+ spanCount?: number;
1049
+ spanList?: Array<number>;
1050
+ trailingComments?: string;
1051
+ trailingCommentsBytes?: ByteString;
1052
+ unknownFields?: UnknownFieldSet;
1053
+ };
1054
+ type LocationOrBuilder = {
1055
+ allFields?: {
1056
+ [key: string]: unknown;
1057
+ };
1058
+ defaultInstanceForType?: Message;
1059
+ descriptorForType?: Descriptor;
1060
+ initializationErrorString?: string;
1061
+ initialized?: boolean;
1062
+ leadingComments?: string;
1063
+ leadingCommentsBytes?: ByteString;
1064
+ leadingDetachedCommentsCount?: number;
1065
+ leadingDetachedCommentsList?: Array<string>;
1066
+ pathCount?: number;
1067
+ pathList?: Array<number>;
1068
+ spanCount?: number;
1069
+ spanList?: Array<number>;
1070
+ trailingComments?: string;
1071
+ trailingCommentsBytes?: ByteString;
1072
+ unknownFields?: UnknownFieldSet;
1073
+ };
1074
+ type Message = {
1075
+ allFields?: {
1076
+ [key: string]: unknown;
1077
+ };
1078
+ defaultInstanceForType?: MessageLite;
1079
+ descriptorForType?: Descriptor;
1080
+ initializationErrorString?: string;
1081
+ initialized?: boolean;
1082
+ parserForType?: ParserMessage;
1083
+ serializedSize?: number;
1084
+ unknownFields?: UnknownFieldSet;
1085
+ };
1086
+ type MessageLite = {
1087
+ defaultInstanceForType?: MessageLite;
1088
+ initialized?: boolean;
1089
+ parserForType?: ParserMessageLite;
1090
+ serializedSize?: number;
1091
+ };
1092
+ type MessageOptions = {
1093
+ allFields?: {
1094
+ [key: string]: unknown;
1095
+ };
1096
+ allFieldsRaw?: {
1097
+ [key: string]: unknown;
1098
+ };
1099
+ defaultInstanceForType?: MessageOptions;
1100
+ deprecated?: boolean;
438
1101
  /**
439
- * Get list of the next x (default 3, max 5) execution times for a scheduler
440
- * @param cronExpression
441
- * @param scheduleStartTime
442
- * @param scheduleEndTime
443
- * @param limit
444
- * @returns number OK
445
- * @throws ApiError
1102
+ * @deprecated
446
1103
  */
447
- getNextFewSchedules(cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number): CancelablePromise<Array<number>>;
1104
+ deprecatedLegacyJsonFieldConflicts?: boolean;
1105
+ descriptorForType?: Descriptor;
1106
+ features?: FeatureSet;
1107
+ featuresOrBuilder?: FeatureSetOrBuilder;
1108
+ initializationErrorString?: string;
1109
+ initialized?: boolean;
1110
+ mapEntry?: boolean;
1111
+ messageSetWireFormat?: boolean;
1112
+ noStandardDescriptorAccessor?: boolean;
1113
+ parserForType?: ParserMessageOptions;
1114
+ serializedSize?: number;
1115
+ uninterpretedOptionCount?: number;
1116
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1117
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1118
+ unknownFields?: UnknownFieldSet;
1119
+ };
1120
+ type MessageOptionsOrBuilder = {
1121
+ allFields?: {
1122
+ [key: string]: unknown;
1123
+ };
1124
+ defaultInstanceForType?: Message;
1125
+ deprecated?: boolean;
448
1126
  /**
449
- * Pauses an existing schedule by name
450
- * @param name
451
- * @returns any OK
452
- * @throws ApiError
1127
+ * @deprecated
453
1128
  */
454
- pauseSchedule(name: string): CancelablePromise<any>;
1129
+ deprecatedLegacyJsonFieldConflicts?: boolean;
1130
+ descriptorForType?: Descriptor;
1131
+ features?: FeatureSet;
1132
+ featuresOrBuilder?: FeatureSetOrBuilder;
1133
+ initializationErrorString?: string;
1134
+ initialized?: boolean;
1135
+ mapEntry?: boolean;
1136
+ messageSetWireFormat?: boolean;
1137
+ noStandardDescriptorAccessor?: boolean;
1138
+ uninterpretedOptionCount?: number;
1139
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1140
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1141
+ unknownFields?: UnknownFieldSet;
1142
+ };
1143
+ type MethodDescriptor = {
1144
+ clientStreaming?: boolean;
1145
+ file?: FileDescriptor;
1146
+ fullName?: string;
1147
+ index?: number;
1148
+ inputType?: Descriptor;
1149
+ name?: string;
1150
+ options?: MethodOptions;
1151
+ outputType?: Descriptor;
1152
+ proto?: MethodDescriptorProto;
1153
+ serverStreaming?: boolean;
1154
+ service?: ServiceDescriptor;
1155
+ };
1156
+ type MethodDescriptorProto = {
1157
+ allFields?: {
1158
+ [key: string]: unknown;
1159
+ };
1160
+ clientStreaming?: boolean;
1161
+ defaultInstanceForType?: MethodDescriptorProto;
1162
+ descriptorForType?: Descriptor;
1163
+ initializationErrorString?: string;
1164
+ initialized?: boolean;
1165
+ inputType?: string;
1166
+ inputTypeBytes?: ByteString;
1167
+ name?: string;
1168
+ nameBytes?: ByteString;
1169
+ options?: MethodOptions;
1170
+ optionsOrBuilder?: MethodOptionsOrBuilder;
1171
+ outputType?: string;
1172
+ outputTypeBytes?: ByteString;
1173
+ parserForType?: ParserMethodDescriptorProto;
1174
+ serializedSize?: number;
1175
+ serverStreaming?: boolean;
1176
+ unknownFields?: UnknownFieldSet;
1177
+ };
1178
+ type MethodDescriptorProtoOrBuilder = {
1179
+ allFields?: {
1180
+ [key: string]: unknown;
1181
+ };
1182
+ clientStreaming?: boolean;
1183
+ defaultInstanceForType?: Message;
1184
+ descriptorForType?: Descriptor;
1185
+ initializationErrorString?: string;
1186
+ initialized?: boolean;
1187
+ inputType?: string;
1188
+ inputTypeBytes?: ByteString;
1189
+ name?: string;
1190
+ nameBytes?: ByteString;
1191
+ options?: MethodOptions;
1192
+ optionsOrBuilder?: MethodOptionsOrBuilder;
1193
+ outputType?: string;
1194
+ outputTypeBytes?: ByteString;
1195
+ serverStreaming?: boolean;
1196
+ unknownFields?: UnknownFieldSet;
1197
+ };
1198
+ type MethodOptions = {
1199
+ allFields?: {
1200
+ [key: string]: unknown;
1201
+ };
1202
+ allFieldsRaw?: {
1203
+ [key: string]: unknown;
1204
+ };
1205
+ defaultInstanceForType?: MethodOptions;
1206
+ deprecated?: boolean;
1207
+ descriptorForType?: Descriptor;
1208
+ features?: FeatureSet;
1209
+ featuresOrBuilder?: FeatureSetOrBuilder;
1210
+ idempotencyLevel?: 'IDEMPOTENCY_UNKNOWN' | 'NO_SIDE_EFFECTS' | 'IDEMPOTENT';
1211
+ initializationErrorString?: string;
1212
+ initialized?: boolean;
1213
+ parserForType?: ParserMethodOptions;
1214
+ serializedSize?: number;
1215
+ uninterpretedOptionCount?: number;
1216
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1217
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1218
+ unknownFields?: UnknownFieldSet;
1219
+ };
1220
+ type MethodOptionsOrBuilder = {
1221
+ allFields?: {
1222
+ [key: string]: unknown;
1223
+ };
1224
+ defaultInstanceForType?: Message;
1225
+ deprecated?: boolean;
1226
+ descriptorForType?: Descriptor;
1227
+ features?: FeatureSet;
1228
+ featuresOrBuilder?: FeatureSetOrBuilder;
1229
+ idempotencyLevel?: 'IDEMPOTENCY_UNKNOWN' | 'NO_SIDE_EFFECTS' | 'IDEMPOTENT';
1230
+ initializationErrorString?: string;
1231
+ initialized?: boolean;
1232
+ uninterpretedOptionCount?: number;
1233
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1234
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1235
+ unknownFields?: UnknownFieldSet;
1236
+ };
1237
+ type NamePart = {
1238
+ allFields?: {
1239
+ [key: string]: unknown;
1240
+ };
1241
+ defaultInstanceForType?: NamePart;
1242
+ descriptorForType?: Descriptor;
1243
+ initializationErrorString?: string;
1244
+ initialized?: boolean;
1245
+ isExtension?: boolean;
1246
+ namePart?: string;
1247
+ namePartBytes?: ByteString;
1248
+ parserForType?: ParserNamePart;
1249
+ serializedSize?: number;
1250
+ unknownFields?: UnknownFieldSet;
1251
+ };
1252
+ type NamePartOrBuilder = {
1253
+ allFields?: {
1254
+ [key: string]: unknown;
1255
+ };
1256
+ defaultInstanceForType?: Message;
1257
+ descriptorForType?: Descriptor;
1258
+ initializationErrorString?: string;
1259
+ initialized?: boolean;
1260
+ isExtension?: boolean;
1261
+ namePart?: string;
1262
+ namePartBytes?: ByteString;
1263
+ unknownFields?: UnknownFieldSet;
1264
+ };
1265
+ type OneofDescriptor = {
1266
+ containingType?: Descriptor;
1267
+ fieldCount?: number;
1268
+ file?: FileDescriptor;
1269
+ fullName?: string;
1270
+ index?: number;
1271
+ name?: string;
1272
+ options?: OneofOptions;
1273
+ proto?: OneofDescriptorProto;
455
1274
  /**
456
- * Pause all scheduling in a single conductor server instance (for debugging only)
457
- * @returns any OK
458
- * @throws ApiError
1275
+ * @deprecated
459
1276
  */
460
- pauseAllSchedules(): CancelablePromise<Record<string, any>>;
461
- /**
462
- * Resume a paused schedule by name
463
- * @param name
464
- * @returns any OK
465
- * @throws ApiError
466
- */
467
- resumeSchedule(name: string): CancelablePromise<any>;
468
- /**
469
- * Requeue all execution records
470
- * @returns any OK
471
- * @throws ApiError
472
- */
473
- requeueAllExecutionRecords(): CancelablePromise<Record<string, any>>;
474
- /**
475
- * Resume all scheduling
476
- * @returns any OK
477
- * @throws ApiError
478
- */
479
- resumeAllSchedules(): CancelablePromise<Record<string, any>>;
480
- /**
481
- * Get all existing workflow schedules and optionally filter by workflow name
482
- * @param workflowName
483
- * @returns WorkflowSchedule OK
484
- * @throws ApiError
485
- */
486
- getAllSchedules(workflowName?: string): CancelablePromise<Array<WorkflowSchedule>>;
487
- /**
488
- * Create or update a schedule for a specified workflow with a corresponding start workflow request
489
- * @param requestBody
490
- * @returns any OK
491
- * @throws ApiError
492
- */
493
- saveSchedule(requestBody: SaveScheduleRequest): CancelablePromise<any>;
494
- /**
495
- * Test timeout - do not use in production
496
- * @returns any OK
497
- * @throws ApiError
498
- */
499
- testTimeout(): CancelablePromise<any>;
500
- /**
501
- * Search for workflows based on payload and other parameters
502
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC.
503
- * @param start
504
- * @param size
505
- * @param sort
506
- * @param freeText
507
- * @param query
508
- * @returns SearchResultWorkflowScheduleExecutionModel OK
509
- * @throws ApiError
510
- */
511
- searchV21(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultWorkflowScheduleExecutionModel>;
512
- }
513
-
514
- declare type ExternalStorageLocation = {
515
- uri?: string;
516
- path?: string;
1277
+ synthetic?: boolean;
517
1278
  };
518
-
519
- declare type PollData = {
520
- queueName?: string;
1279
+ type OneofDescriptorProto = {
1280
+ allFields?: {
1281
+ [key: string]: unknown;
1282
+ };
1283
+ defaultInstanceForType?: OneofDescriptorProto;
1284
+ descriptorForType?: Descriptor;
1285
+ initializationErrorString?: string;
1286
+ initialized?: boolean;
1287
+ name?: string;
1288
+ nameBytes?: ByteString;
1289
+ options?: OneofOptions;
1290
+ optionsOrBuilder?: OneofOptionsOrBuilder;
1291
+ parserForType?: ParserOneofDescriptorProto;
1292
+ serializedSize?: number;
1293
+ unknownFields?: UnknownFieldSet;
1294
+ };
1295
+ type OneofDescriptorProtoOrBuilder = {
1296
+ allFields?: {
1297
+ [key: string]: unknown;
1298
+ };
1299
+ defaultInstanceForType?: Message;
1300
+ descriptorForType?: Descriptor;
1301
+ initializationErrorString?: string;
1302
+ initialized?: boolean;
1303
+ name?: string;
1304
+ nameBytes?: ByteString;
1305
+ options?: OneofOptions;
1306
+ optionsOrBuilder?: OneofOptionsOrBuilder;
1307
+ unknownFields?: UnknownFieldSet;
1308
+ };
1309
+ type OneofOptions = {
1310
+ allFields?: {
1311
+ [key: string]: unknown;
1312
+ };
1313
+ allFieldsRaw?: {
1314
+ [key: string]: unknown;
1315
+ };
1316
+ defaultInstanceForType?: OneofOptions;
1317
+ descriptorForType?: Descriptor;
1318
+ features?: FeatureSet;
1319
+ featuresOrBuilder?: FeatureSetOrBuilder;
1320
+ initializationErrorString?: string;
1321
+ initialized?: boolean;
1322
+ parserForType?: ParserOneofOptions;
1323
+ serializedSize?: number;
1324
+ uninterpretedOptionCount?: number;
1325
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1326
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1327
+ unknownFields?: UnknownFieldSet;
1328
+ };
1329
+ type OneofOptionsOrBuilder = {
1330
+ allFields?: {
1331
+ [key: string]: unknown;
1332
+ };
1333
+ defaultInstanceForType?: Message;
1334
+ descriptorForType?: Descriptor;
1335
+ features?: FeatureSet;
1336
+ featuresOrBuilder?: FeatureSetOrBuilder;
1337
+ initializationErrorString?: string;
1338
+ initialized?: boolean;
1339
+ uninterpretedOptionCount?: number;
1340
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1341
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1342
+ unknownFields?: UnknownFieldSet;
1343
+ };
1344
+ type OrkesCircuitBreakerConfig = {
1345
+ automaticTransitionFromOpenToHalfOpenEnabled?: boolean;
1346
+ failureRateThreshold?: number;
1347
+ maxWaitDurationInHalfOpenState?: number;
1348
+ minimumNumberOfCalls?: number;
1349
+ permittedNumberOfCallsInHalfOpenState?: number;
1350
+ slidingWindowSize?: number;
1351
+ slowCallDurationThreshold?: number;
1352
+ slowCallRateThreshold?: number;
1353
+ waitDurationInOpenState?: number;
1354
+ };
1355
+ type Parser = {
1356
+ [key: string]: unknown;
1357
+ };
1358
+ type ParserAny = {
1359
+ [key: string]: unknown;
1360
+ };
1361
+ type ParserDeclaration = {
1362
+ [key: string]: unknown;
1363
+ };
1364
+ type ParserDescriptorProto = {
1365
+ [key: string]: unknown;
1366
+ };
1367
+ type ParserEditionDefault = {
1368
+ [key: string]: unknown;
1369
+ };
1370
+ type ParserEnumDescriptorProto = {
1371
+ [key: string]: unknown;
1372
+ };
1373
+ type ParserEnumOptions = {
1374
+ [key: string]: unknown;
1375
+ };
1376
+ type ParserEnumReservedRange = {
1377
+ [key: string]: unknown;
1378
+ };
1379
+ type ParserEnumValueDescriptorProto = {
1380
+ [key: string]: unknown;
1381
+ };
1382
+ type ParserEnumValueOptions = {
1383
+ [key: string]: unknown;
1384
+ };
1385
+ type ParserExtensionRange = {
1386
+ [key: string]: unknown;
1387
+ };
1388
+ type ParserExtensionRangeOptions = {
1389
+ [key: string]: unknown;
1390
+ };
1391
+ type ParserFeatureSet = {
1392
+ [key: string]: unknown;
1393
+ };
1394
+ type ParserFieldDescriptorProto = {
1395
+ [key: string]: unknown;
1396
+ };
1397
+ type ParserFieldOptions = {
1398
+ [key: string]: unknown;
1399
+ };
1400
+ type ParserFileDescriptorProto = {
1401
+ [key: string]: unknown;
1402
+ };
1403
+ type ParserFileOptions = {
1404
+ [key: string]: unknown;
1405
+ };
1406
+ type ParserLocation = {
1407
+ [key: string]: unknown;
1408
+ };
1409
+ type ParserMessage = {
1410
+ [key: string]: unknown;
1411
+ };
1412
+ type ParserMessageLite = {
1413
+ [key: string]: unknown;
1414
+ };
1415
+ type ParserMessageOptions = {
1416
+ [key: string]: unknown;
1417
+ };
1418
+ type ParserMethodDescriptorProto = {
1419
+ [key: string]: unknown;
1420
+ };
1421
+ type ParserMethodOptions = {
1422
+ [key: string]: unknown;
1423
+ };
1424
+ type ParserNamePart = {
1425
+ [key: string]: unknown;
1426
+ };
1427
+ type ParserOneofDescriptorProto = {
1428
+ [key: string]: unknown;
1429
+ };
1430
+ type ParserOneofOptions = {
1431
+ [key: string]: unknown;
1432
+ };
1433
+ type ParserReservedRange = {
1434
+ [key: string]: unknown;
1435
+ };
1436
+ type ParserServiceDescriptorProto = {
1437
+ [key: string]: unknown;
1438
+ };
1439
+ type ParserServiceOptions = {
1440
+ [key: string]: unknown;
1441
+ };
1442
+ type ParserSourceCodeInfo = {
1443
+ [key: string]: unknown;
1444
+ };
1445
+ type ParserUninterpretedOption = {
1446
+ [key: string]: unknown;
1447
+ };
1448
+ type PollData = {
521
1449
  domain?: string;
522
- workerId?: string;
523
1450
  lastPollTime?: number;
1451
+ queueName?: string;
1452
+ workerId?: string;
524
1453
  };
525
-
526
- declare type Task = {
527
- taskType?: string;
528
- status?: 'IN_PROGRESS' | 'CANCELED' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'SCHEDULED' | 'TIMED_OUT' | 'SKIPPED';
529
- inputData?: Record<string, any>;
530
- referenceTaskName?: string;
531
- retryCount?: number;
532
- seq?: number;
1454
+ type ProtoRegistryEntry = {
1455
+ data?: string;
1456
+ filename?: string;
1457
+ serviceName?: string;
1458
+ };
1459
+ type RateLimitConfig = {
1460
+ concurrentExecLimit?: number;
1461
+ rateLimitKey?: string;
1462
+ };
1463
+ type RequestParam = {
1464
+ name?: string;
1465
+ required?: boolean;
1466
+ schema?: Schema;
1467
+ type?: string;
1468
+ };
1469
+ type RerunWorkflowRequest = {
533
1470
  correlationId?: string;
534
- pollCount?: number;
535
- taskDefName?: string;
536
- scheduledTime?: number;
537
- startTime?: number;
538
- endTime?: number;
1471
+ reRunFromTaskId?: string;
1472
+ reRunFromWorkflowId?: string;
1473
+ taskInput?: {
1474
+ [key: string]: unknown;
1475
+ };
1476
+ workflowInput?: {
1477
+ [key: string]: unknown;
1478
+ };
1479
+ };
1480
+ type ReservedRange = {
1481
+ allFields?: {
1482
+ [key: string]: unknown;
1483
+ };
1484
+ defaultInstanceForType?: ReservedRange;
1485
+ descriptorForType?: Descriptor;
1486
+ end?: number;
1487
+ initializationErrorString?: string;
1488
+ initialized?: boolean;
1489
+ parserForType?: ParserReservedRange;
1490
+ serializedSize?: number;
1491
+ start?: number;
1492
+ unknownFields?: UnknownFieldSet;
1493
+ };
1494
+ type ReservedRangeOrBuilder = {
1495
+ allFields?: {
1496
+ [key: string]: unknown;
1497
+ };
1498
+ defaultInstanceForType?: Message;
1499
+ descriptorForType?: Descriptor;
1500
+ end?: number;
1501
+ initializationErrorString?: string;
1502
+ initialized?: boolean;
1503
+ start?: number;
1504
+ unknownFields?: UnknownFieldSet;
1505
+ };
1506
+ type Response$1 = {
1507
+ [key: string]: unknown;
1508
+ };
1509
+ type SaveScheduleRequest = {
1510
+ createdBy?: string;
1511
+ cronExpression: string;
1512
+ description?: string;
1513
+ name: string;
1514
+ paused?: boolean;
1515
+ runCatchupScheduleInstances?: boolean;
1516
+ scheduleEndTime?: number;
1517
+ scheduleStartTime?: number;
1518
+ startWorkflowRequest: StartWorkflowRequest;
1519
+ updatedBy?: string;
1520
+ zoneId?: string;
1521
+ };
1522
+ type Schema = {
1523
+ defaultValue?: {
1524
+ [key: string]: unknown;
1525
+ };
1526
+ format?: string;
1527
+ type?: string;
1528
+ };
1529
+ type SchemaDef = {
1530
+ createTime?: number;
1531
+ createdBy?: string;
1532
+ data?: {
1533
+ [key: string]: unknown;
1534
+ };
1535
+ externalRef?: string;
1536
+ name: string;
1537
+ ownerApp?: string;
1538
+ type: 'JSON' | 'AVRO' | 'PROTOBUF';
539
1539
  updateTime?: number;
540
- startDelayInSeconds?: number;
541
- retriedTaskId?: string;
542
- retried?: boolean;
543
- executed?: boolean;
544
- callbackFromWorker?: boolean;
545
- responseTimeoutSeconds?: number;
546
- workflowInstanceId?: string;
547
- workflowType?: string;
548
- taskId?: string;
549
- reasonForIncompletion?: string;
550
- callbackAfterSeconds?: number;
551
- workerId?: string;
552
- outputData?: Record<string, any>;
553
- workflowTask?: WorkflowTask;
554
- domain?: string;
555
- rateLimitPerFrequency?: number;
556
- rateLimitFrequencyInSeconds?: number;
557
- externalInputPayloadStoragePath?: string;
558
- externalOutputPayloadStoragePath?: string;
559
- workflowPriority?: number;
560
- executionNameSpace?: string;
561
- isolationGroupId?: string;
562
- iteration?: number;
563
- subWorkflowId?: string;
564
- subworkflowChanged?: boolean;
565
- queueWaitTime?: number;
566
- taskDefinition?: TaskDef;
567
- loopOverTask?: boolean;
1540
+ updatedBy?: string;
1541
+ version: number;
568
1542
  };
569
-
570
- declare type SearchResultTask = {
1543
+ type ScrollableSearchResultWorkflowSummary = {
1544
+ queryId?: string;
1545
+ results?: Array<WorkflowSummary>;
571
1546
  totalHits?: number;
572
- results?: Array<Task>;
573
1547
  };
574
-
575
- declare type TaskSummary = {
576
- workflowId?: string;
577
- workflowType?: string;
578
- correlationId?: string;
579
- scheduledTime?: string;
580
- startTime?: string;
581
- updateTime?: string;
582
- endTime?: string;
583
- status?: 'IN_PROGRESS' | 'CANCELED' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'SCHEDULED' | 'TIMED_OUT' | 'SKIPPED';
584
- reasonForIncompletion?: string;
585
- executionTime?: number;
586
- queueWaitTime?: number;
587
- taskDefName?: string;
588
- taskType?: string;
589
- input?: string;
590
- output?: string;
591
- taskId?: string;
592
- externalInputPayloadStoragePath?: string;
593
- externalOutputPayloadStoragePath?: string;
594
- workflowPriority?: number;
1548
+ type SearchResultTaskSummary = {
1549
+ results?: Array<TaskSummary>;
1550
+ totalHits?: number;
595
1551
  };
596
-
597
- declare type SearchResultTaskSummary = {
1552
+ type SearchResultWorkflowScheduleExecutionModel = {
1553
+ results?: Array<WorkflowScheduleExecutionModel>;
598
1554
  totalHits?: number;
599
- results?: Array<TaskSummary>;
600
1555
  };
601
-
602
- declare type TaskExecLog = {
603
- log?: string;
604
- taskId?: string;
605
- createdTime?: number;
1556
+ type ServiceDescriptor = {
1557
+ file?: FileDescriptor;
1558
+ fullName?: string;
1559
+ index?: number;
1560
+ methods?: Array<MethodDescriptor>;
1561
+ name?: string;
1562
+ options?: ServiceOptions;
1563
+ proto?: ServiceDescriptorProto;
606
1564
  };
607
-
608
- declare type TaskResult = {
609
- workflowInstanceId: string;
610
- taskId: string;
611
- reasonForIncompletion?: string;
612
- callbackAfterSeconds?: number;
613
- workerId?: string;
614
- status?: 'IN_PROGRESS' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED';
615
- outputData?: Record<string, any>;
616
- logs?: Array<TaskExecLog>;
617
- externalOutputPayloadStoragePath?: string;
618
- subWorkflowId?: string;
1565
+ type ServiceDescriptorProto = {
1566
+ allFields?: {
1567
+ [key: string]: unknown;
1568
+ };
1569
+ defaultInstanceForType?: ServiceDescriptorProto;
1570
+ descriptorForType?: Descriptor;
1571
+ initializationErrorString?: string;
1572
+ initialized?: boolean;
1573
+ methodCount?: number;
1574
+ methodList?: Array<MethodDescriptorProto>;
1575
+ methodOrBuilderList?: Array<MethodDescriptorProtoOrBuilder>;
1576
+ name?: string;
1577
+ nameBytes?: ByteString;
1578
+ options?: ServiceOptions;
1579
+ optionsOrBuilder?: ServiceOptionsOrBuilder;
1580
+ parserForType?: ParserServiceDescriptorProto;
1581
+ serializedSize?: number;
1582
+ unknownFields?: UnknownFieldSet;
619
1583
  };
620
-
621
- declare class TaskResourceService {
622
- readonly httpRequest: BaseHttpRequest;
623
- constructor(httpRequest: BaseHttpRequest);
624
- /**
625
- * Poll for a task of a certain type
626
- * @param tasktype
627
- * @param workerid
628
- * @param domain
629
- * @returns Task OK
630
- * @throws ApiError
631
- */
632
- poll(tasktype: string, workerid?: string, domain?: string): CancelablePromise<Task>;
633
- /**
634
- * Get the details about each queue
635
- * @returns number OK
636
- * @throws ApiError
637
- */
638
- allVerbose(): CancelablePromise<Record<string, Record<string, Record<string, number>>>>;
639
- /**
640
- * Update a task By Ref Name
641
- * @param workflowId
642
- * @param taskRefName
643
- * @param status
644
- * @param requestBody
645
- * @returns string OK
646
- * @throws ApiError
647
- */
648
- updateTask(workflowId: string, taskRefName: string, status: 'IN_PROGRESS' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED', requestBody: Record<string, any>): CancelablePromise<string>;
649
- /**
650
- * Get task by Id
651
- * @param taskId
652
- * @returns Task OK
653
- * @throws ApiError
654
- */
655
- getTask(taskId: string): CancelablePromise<Task>;
656
- /**
657
- * Get the details about each queue
658
- * @returns number OK
659
- * @throws ApiError
660
- */
661
- all(): CancelablePromise<Record<string, number>>;
662
- /**
663
- * Requeue pending tasks
664
- * @param taskType
665
- * @returns string OK
666
- * @throws ApiError
667
- */
668
- requeuePendingTask(taskType: string): CancelablePromise<string>;
669
- /**
670
- * Search for tasks based in payload and other parameters
671
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC
672
- * @param start
673
- * @param size
674
- * @param sort
675
- * @param freeText
676
- * @param query
677
- * @returns SearchResultTaskSummary OK
678
- * @throws ApiError
679
- */
680
- search(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultTaskSummary>;
681
- /**
682
- * Search for tasks based in payload and other parameters
683
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC
684
- * @param start
685
- * @param size
686
- * @param sort
687
- * @param freeText
688
- * @param query
689
- * @returns SearchResultTask OK
690
- * @throws ApiError
691
- */
692
- searchV22(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultTask>;
693
- /**
694
- * Get the last poll data for a given task type
695
- * @param taskType
696
- * @returns PollData OK
697
- * @throws ApiError
698
- */
699
- getPollData(taskType: string): CancelablePromise<Array<PollData>>;
700
- /**
701
- * Get Task Execution Logs
702
- * @param taskId
703
- * @returns TaskExecLog OK
704
- * @throws ApiError
705
- */
706
- getTaskLogs(taskId: string): CancelablePromise<Array<TaskExecLog>>;
707
- /**
708
- * Log Task Execution Details
709
- * @param taskId
710
- * @param requestBody
711
- * @returns any OK
712
- * @throws ApiError
713
- */
714
- log(taskId: string, requestBody: string): CancelablePromise<any>;
715
- /**
716
- * Get the last poll data for all task types
717
- * @returns PollData OK
718
- * @throws ApiError
719
- */
720
- getAllPollData(): CancelablePromise<Array<PollData>>;
721
- /**
722
- * Batch poll for a task of a certain type
723
- * @param tasktype
724
- * @param workerid
725
- * @param domain
726
- * @param count
727
- * @param timeout
728
- * @returns Task OK
729
- * @throws ApiError
730
- */
731
- batchPoll(tasktype: string, workerid?: string, domain?: string, count?: number, timeout?: number): CancelablePromise<Array<Task>>;
732
- /**
733
- * Update a task
734
- * @param requestBody
735
- * @returns string OK
736
- * @throws ApiError
737
- */
738
- updateTask1(requestBody: TaskResult): CancelablePromise<string>;
739
- /**
740
- * Get Task type queue sizes
741
- * @param taskType
742
- * @returns number OK
743
- * @throws ApiError
744
- */
745
- size1(taskType?: Array<string>): CancelablePromise<Record<string, number>>;
746
- /**
747
- * Get the external uri where the task payload is to be stored
748
- * @param path
749
- * @param operation
750
- * @param payloadType
751
- * @returns ExternalStorageLocation OK
752
- * @throws ApiError
753
- */
754
- getExternalStorageLocation1(path: string, operation: string, payloadType: string): CancelablePromise<ExternalStorageLocation>;
755
- }
756
-
757
- declare type GenerateTokenRequest = {
758
- keyId: string;
759
- keySecret: string;
760
- refreshTokenInterval?: number;
1584
+ type ServiceDescriptorProtoOrBuilder = {
1585
+ allFields?: {
1586
+ [key: string]: unknown;
1587
+ };
1588
+ defaultInstanceForType?: Message;
1589
+ descriptorForType?: Descriptor;
1590
+ initializationErrorString?: string;
1591
+ initialized?: boolean;
1592
+ methodCount?: number;
1593
+ methodList?: Array<MethodDescriptorProto>;
1594
+ methodOrBuilderList?: Array<MethodDescriptorProtoOrBuilder>;
1595
+ name?: string;
1596
+ nameBytes?: ByteString;
1597
+ options?: ServiceOptions;
1598
+ optionsOrBuilder?: ServiceOptionsOrBuilder;
1599
+ unknownFields?: UnknownFieldSet;
761
1600
  };
762
-
763
- declare type Response$1 = {};
764
-
765
- declare class TokenResourceService {
766
- readonly httpRequest: BaseHttpRequest;
767
- constructor(httpRequest: BaseHttpRequest);
768
- /**
769
- * Generate JWT with the given access key
770
- * @param requestBody
771
- * @returns Response OK
772
- * @throws ApiError
773
- */
774
- generateToken(requestBody: GenerateTokenRequest): CancelablePromise<Response$1>;
775
- /**
776
- * Get the user info from the token
777
- * @returns any OK
778
- * @throws ApiError
779
- */
780
- getUserInfo(): CancelablePromise<any>;
781
- }
782
-
783
- declare type BulkResponse = {
784
- bulkErrorResults?: Record<string, string>;
785
- bulkSuccessfulResults?: Array<string>;
1601
+ type ServiceMethod = {
1602
+ exampleInput?: {
1603
+ [key: string]: unknown;
1604
+ };
1605
+ id?: number;
1606
+ inputType?: string;
1607
+ methodName?: string;
1608
+ methodType?: string;
1609
+ operationName?: string;
1610
+ outputType?: string;
1611
+ requestParams?: Array<RequestParam>;
786
1612
  };
787
-
788
- declare class WorkflowBulkResourceService {
789
- readonly httpRequest: BaseHttpRequest;
790
- constructor(httpRequest: BaseHttpRequest);
791
- /**
792
- * Retry the last failed task for each workflow from the list
793
- * @param requestBody
794
- * @returns BulkResponse OK
795
- * @throws ApiError
796
- */
797
- retry(requestBody: Array<string>): CancelablePromise<BulkResponse>;
798
- /**
799
- * Restart the list of completed workflow
800
- * @param requestBody
801
- * @param useLatestDefinitions
802
- * @returns BulkResponse OK
803
- * @throws ApiError
804
- */
805
- restart(requestBody: Array<string>, useLatestDefinitions?: boolean): CancelablePromise<BulkResponse>;
806
- /**
807
- * Terminate workflows execution
808
- * @param requestBody
809
- * @param reason
810
- * @returns BulkResponse OK
811
- * @throws ApiError
812
- */
813
- terminate(requestBody: Array<string>, reason?: string): CancelablePromise<BulkResponse>;
814
- /**
815
- * Resume the list of workflows
816
- * @param requestBody
817
- * @returns BulkResponse OK
818
- * @throws ApiError
819
- */
820
- resumeWorkflow(requestBody: Array<string>): CancelablePromise<BulkResponse>;
1613
+ type ServiceOptions = {
1614
+ allFields?: {
1615
+ [key: string]: unknown;
1616
+ };
1617
+ allFieldsRaw?: {
1618
+ [key: string]: unknown;
1619
+ };
1620
+ defaultInstanceForType?: ServiceOptions;
1621
+ deprecated?: boolean;
1622
+ descriptorForType?: Descriptor;
1623
+ features?: FeatureSet;
1624
+ featuresOrBuilder?: FeatureSetOrBuilder;
1625
+ initializationErrorString?: string;
1626
+ initialized?: boolean;
1627
+ parserForType?: ParserServiceOptions;
1628
+ serializedSize?: number;
1629
+ uninterpretedOptionCount?: number;
1630
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1631
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1632
+ unknownFields?: UnknownFieldSet;
1633
+ };
1634
+ type ServiceOptionsOrBuilder = {
1635
+ allFields?: {
1636
+ [key: string]: unknown;
1637
+ };
1638
+ defaultInstanceForType?: Message;
1639
+ deprecated?: boolean;
1640
+ descriptorForType?: Descriptor;
1641
+ features?: FeatureSet;
1642
+ featuresOrBuilder?: FeatureSetOrBuilder;
1643
+ initializationErrorString?: string;
1644
+ initialized?: boolean;
1645
+ uninterpretedOptionCount?: number;
1646
+ uninterpretedOptionList?: Array<UninterpretedOption>;
1647
+ uninterpretedOptionOrBuilderList?: Array<UninterpretedOptionOrBuilder>;
1648
+ unknownFields?: UnknownFieldSet;
1649
+ };
1650
+ type ServiceRegistry = {
1651
+ circuitBreakerEnabled?: boolean;
1652
+ config?: Config$2;
1653
+ methods?: Array<ServiceMethod>;
1654
+ name?: string;
1655
+ requestParams?: Array<RequestParam>;
1656
+ serviceURI?: string;
1657
+ type?: 'HTTP' | 'gRPC' | 'MCP_REMOTE';
1658
+ };
1659
+ type SignalResponse$1 = {
1660
+ correlationId?: string;
1661
+ input?: {
1662
+ [key: string]: unknown;
1663
+ };
1664
+ output?: {
1665
+ [key: string]: unknown;
1666
+ };
1667
+ requestId?: string;
1668
+ responseType?: 'TARGET_WORKFLOW' | 'BLOCKING_WORKFLOW' | 'BLOCKING_TASK' | 'BLOCKING_TASK_INPUT';
1669
+ targetWorkflowId?: string;
1670
+ targetWorkflowStatus?: string;
1671
+ workflowId?: string;
1672
+ };
1673
+ type SkipTaskRequest = {
1674
+ taskInput?: {
1675
+ [key: string]: unknown;
1676
+ };
1677
+ taskOutput?: {
1678
+ [key: string]: unknown;
1679
+ };
1680
+ };
1681
+ type SourceCodeInfo = {
1682
+ allFields?: {
1683
+ [key: string]: unknown;
1684
+ };
1685
+ defaultInstanceForType?: SourceCodeInfo;
1686
+ descriptorForType?: Descriptor;
1687
+ initializationErrorString?: string;
1688
+ initialized?: boolean;
1689
+ locationCount?: number;
1690
+ locationList?: Array<Location>;
1691
+ locationOrBuilderList?: Array<LocationOrBuilder>;
1692
+ parserForType?: ParserSourceCodeInfo;
1693
+ serializedSize?: number;
1694
+ unknownFields?: UnknownFieldSet;
1695
+ };
1696
+ type SourceCodeInfoOrBuilder = {
1697
+ allFields?: {
1698
+ [key: string]: unknown;
1699
+ };
1700
+ defaultInstanceForType?: Message;
1701
+ descriptorForType?: Descriptor;
1702
+ initializationErrorString?: string;
1703
+ initialized?: boolean;
1704
+ locationCount?: number;
1705
+ locationList?: Array<Location>;
1706
+ locationOrBuilderList?: Array<LocationOrBuilder>;
1707
+ unknownFields?: UnknownFieldSet;
1708
+ };
1709
+ type StartWorkflowRequest = {
1710
+ correlationId?: string;
1711
+ createdBy?: string;
1712
+ externalInputPayloadStoragePath?: string;
1713
+ idempotencyKey?: string;
1714
+ idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING' | 'FAIL_ON_RUNNING';
1715
+ input?: {
1716
+ [key: string]: unknown;
1717
+ };
1718
+ name: string;
1719
+ priority?: number;
1720
+ taskToDomain?: {
1721
+ [key: string]: string;
1722
+ };
1723
+ version?: number;
1724
+ workflowDef?: WorkflowDef$1;
1725
+ };
1726
+ type StateChangeEvent = {
1727
+ payload?: {
1728
+ [key: string]: unknown;
1729
+ };
1730
+ type: string;
1731
+ };
1732
+ type SubWorkflowParams = {
1733
+ idempotencyKey?: string;
1734
+ idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING' | 'FAIL_ON_RUNNING';
1735
+ name?: string;
1736
+ priority?: {
1737
+ [key: string]: unknown;
1738
+ };
1739
+ taskToDomain?: {
1740
+ [key: string]: string;
1741
+ };
1742
+ version?: number;
1743
+ workflowDefinition?: {
1744
+ [key: string]: unknown;
1745
+ };
1746
+ };
1747
+ type Tag = {
1748
+ key?: string;
821
1749
  /**
822
- * Pause the list of workflows
823
- * @param requestBody
824
- * @returns BulkResponse OK
825
- * @throws ApiError
1750
+ * @deprecated
826
1751
  */
827
- pauseWorkflow1(requestBody: Array<string>): CancelablePromise<BulkResponse>;
828
- }
829
-
830
- declare type RerunWorkflowRequest = {
831
- reRunFromWorkflowId?: string;
832
- workflowInput?: Record<string, any>;
833
- reRunFromTaskId?: string;
834
- taskInput?: Record<string, any>;
1752
+ type?: string;
1753
+ value?: string;
1754
+ };
1755
+ type Task = {
1756
+ callbackAfterSeconds?: number;
1757
+ callbackFromWorker?: boolean;
835
1758
  correlationId?: string;
1759
+ domain?: string;
1760
+ endTime?: number;
1761
+ executed?: boolean;
1762
+ executionNameSpace?: string;
1763
+ externalInputPayloadStoragePath?: string;
1764
+ externalOutputPayloadStoragePath?: string;
1765
+ firstStartTime?: number;
1766
+ inputData?: {
1767
+ [key: string]: unknown;
1768
+ };
1769
+ isolationGroupId?: string;
1770
+ iteration?: number;
1771
+ loopOverTask?: boolean;
1772
+ outputData?: {
1773
+ [key: string]: unknown;
1774
+ };
1775
+ parentTaskId?: string;
1776
+ pollCount?: number;
1777
+ queueWaitTime?: number;
1778
+ rateLimitFrequencyInSeconds?: number;
1779
+ rateLimitPerFrequency?: number;
1780
+ reasonForIncompletion?: string;
1781
+ referenceTaskName?: string;
1782
+ responseTimeoutSeconds?: number;
1783
+ retried?: boolean;
1784
+ retriedTaskId?: string;
1785
+ retryCount?: number;
1786
+ scheduledTime?: number;
1787
+ seq?: number;
1788
+ startDelayInSeconds?: number;
1789
+ startTime?: number;
1790
+ status?: 'IN_PROGRESS' | 'CANCELED' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'SCHEDULED' | 'TIMED_OUT' | 'SKIPPED';
1791
+ subWorkflowId?: string;
1792
+ subworkflowChanged?: boolean;
1793
+ taskDefName?: string;
1794
+ taskDefinition?: TaskDef;
1795
+ taskId?: string;
1796
+ taskType?: string;
1797
+ updateTime?: number;
1798
+ workerId?: string;
1799
+ workflowInstanceId?: string;
1800
+ workflowPriority?: number;
1801
+ workflowTask?: WorkflowTask;
1802
+ workflowType?: string;
1803
+ };
1804
+ type TaskDef = {
1805
+ backoffScaleFactor?: number;
1806
+ baseType?: string;
1807
+ concurrentExecLimit?: number;
1808
+ createTime?: number;
1809
+ createdBy?: string;
1810
+ description?: string;
1811
+ enforceSchema?: boolean;
1812
+ executionNameSpace?: string;
1813
+ inputKeys?: Array<string>;
1814
+ inputSchema?: SchemaDef;
1815
+ inputTemplate?: {
1816
+ [key: string]: unknown;
1817
+ };
1818
+ isolationGroupId?: string;
1819
+ name: string;
1820
+ outputKeys?: Array<string>;
1821
+ outputSchema?: SchemaDef;
1822
+ ownerApp?: string;
1823
+ ownerEmail?: string;
1824
+ pollTimeoutSeconds?: number;
1825
+ rateLimitFrequencyInSeconds?: number;
1826
+ rateLimitPerFrequency?: number;
1827
+ responseTimeoutSeconds?: number;
1828
+ retryCount?: number;
1829
+ retryDelaySeconds?: number;
1830
+ retryLogic?: 'FIXED' | 'EXPONENTIAL_BACKOFF' | 'LINEAR_BACKOFF';
1831
+ timeoutPolicy?: 'RETRY' | 'TIME_OUT_WF' | 'ALERT_ONLY';
1832
+ timeoutSeconds: number;
1833
+ totalTimeoutSeconds: number;
1834
+ updateTime?: number;
1835
+ updatedBy?: string;
836
1836
  };
837
-
838
- declare type WorkflowSummary = {
839
- workflowType?: string;
840
- version?: number;
1837
+ type TaskDetails = {
1838
+ output?: {
1839
+ [key: string]: unknown;
1840
+ };
1841
+ outputMessage?: Any;
1842
+ taskId?: string;
1843
+ taskRefName?: string;
841
1844
  workflowId?: string;
1845
+ };
1846
+ type TaskExecLog = {
1847
+ createdTime?: number;
1848
+ log?: string;
1849
+ taskId?: string;
1850
+ };
1851
+ type TaskListSearchResultSummary = {
1852
+ results?: Array<Task>;
1853
+ summary?: {
1854
+ [key: string]: number;
1855
+ };
1856
+ totalHits?: number;
1857
+ };
1858
+ type TaskResult = {
1859
+ callbackAfterSeconds?: number;
1860
+ extendLease?: boolean;
1861
+ externalOutputPayloadStoragePath?: string;
1862
+ logs?: Array<TaskExecLog>;
1863
+ outputData?: {
1864
+ [key: string]: unknown;
1865
+ };
1866
+ reasonForIncompletion?: string;
1867
+ status?: 'IN_PROGRESS' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED';
1868
+ subWorkflowId?: string;
1869
+ taskId: string;
1870
+ workerId?: string;
1871
+ workflowInstanceId: string;
1872
+ };
1873
+ type TaskSummary = {
842
1874
  correlationId?: string;
843
- startTime?: string;
844
- updateTime?: string;
845
1875
  endTime?: string;
846
- status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
847
- input?: string;
848
- output?: string;
849
- reasonForIncompletion?: string;
850
1876
  executionTime?: number;
851
- event?: string;
852
- failedReferenceTaskNames?: string;
853
1877
  externalInputPayloadStoragePath?: string;
854
1878
  externalOutputPayloadStoragePath?: string;
855
- priority?: number;
856
- createdBy?: string;
857
- outputSize?: number;
858
- inputSize?: number;
1879
+ input?: string;
1880
+ output?: string;
1881
+ queueWaitTime?: number;
1882
+ reasonForIncompletion?: string;
1883
+ scheduledTime?: string;
1884
+ startTime?: string;
1885
+ status?: 'IN_PROGRESS' | 'CANCELED' | 'FAILED' | 'FAILED_WITH_TERMINAL_ERROR' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'SCHEDULED' | 'TIMED_OUT' | 'SKIPPED';
1886
+ taskDefName?: string;
1887
+ taskId?: string;
1888
+ taskReferenceName?: string;
1889
+ taskType?: string;
1890
+ updateTime?: string;
1891
+ workflowId?: string;
1892
+ workflowPriority?: number;
1893
+ workflowType?: string;
859
1894
  };
860
-
861
- declare type ScrollableSearchResultWorkflowSummary = {
862
- results?: Array<WorkflowSummary>;
863
- totalHits?: number;
1895
+ type TerminateWorkflow = {
1896
+ terminationReason?: string;
1897
+ workflowId?: string;
864
1898
  };
865
-
866
- declare type Workflow = {
867
- ownerApp?: string;
1899
+ type UninterpretedOption = {
1900
+ aggregateValue?: string;
1901
+ aggregateValueBytes?: ByteString;
1902
+ allFields?: {
1903
+ [key: string]: unknown;
1904
+ };
1905
+ defaultInstanceForType?: UninterpretedOption;
1906
+ descriptorForType?: Descriptor;
1907
+ doubleValue?: number;
1908
+ identifierValue?: string;
1909
+ identifierValueBytes?: ByteString;
1910
+ initializationErrorString?: string;
1911
+ initialized?: boolean;
1912
+ nameCount?: number;
1913
+ nameList?: Array<NamePart>;
1914
+ nameOrBuilderList?: Array<NamePartOrBuilder>;
1915
+ negativeIntValue?: number;
1916
+ parserForType?: ParserUninterpretedOption;
1917
+ positiveIntValue?: number;
1918
+ serializedSize?: number;
1919
+ stringValue?: ByteString;
1920
+ unknownFields?: UnknownFieldSet;
1921
+ };
1922
+ type UninterpretedOptionOrBuilder = {
1923
+ aggregateValue?: string;
1924
+ aggregateValueBytes?: ByteString;
1925
+ allFields?: {
1926
+ [key: string]: unknown;
1927
+ };
1928
+ defaultInstanceForType?: Message;
1929
+ descriptorForType?: Descriptor;
1930
+ doubleValue?: number;
1931
+ identifierValue?: string;
1932
+ identifierValueBytes?: ByteString;
1933
+ initializationErrorString?: string;
1934
+ initialized?: boolean;
1935
+ nameCount?: number;
1936
+ nameList?: Array<NamePart>;
1937
+ nameOrBuilderList?: Array<NamePartOrBuilder>;
1938
+ negativeIntValue?: number;
1939
+ positiveIntValue?: number;
1940
+ stringValue?: ByteString;
1941
+ unknownFields?: UnknownFieldSet;
1942
+ };
1943
+ type UnknownFieldSet = {
1944
+ defaultInstanceForType?: UnknownFieldSet;
1945
+ initialized?: boolean;
1946
+ parserForType?: Parser;
1947
+ serializedSize?: number;
1948
+ serializedSizeAsMessageSet?: number;
1949
+ };
1950
+ type UpdateWorkflowVariables = {
1951
+ appendArray?: boolean;
1952
+ variables?: {
1953
+ [key: string]: unknown;
1954
+ };
1955
+ workflowId?: string;
1956
+ };
1957
+ type UserFormTemplate = {
1958
+ name?: string;
1959
+ version?: number;
1960
+ };
1961
+ type Workflow = {
1962
+ correlationId?: string;
868
1963
  createTime?: number;
869
- updateTime?: number;
870
1964
  createdBy?: string;
871
- updatedBy?: string;
872
- status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
873
- idempotencyKey?: string;
874
1965
  endTime?: number;
875
- workflowId?: string;
876
- parentWorkflowId?: string;
877
- parentWorkflowTaskId?: string;
878
- tasks?: Array<Task>;
879
- input?: Record<string, any>;
880
- output?: Record<string, any>;
881
- correlationId?: string;
882
- reRunFromWorkflowId?: string;
883
- reasonForIncompletion?: string;
884
1966
  event?: string;
885
- taskToDomain?: Record<string, string>;
886
- failedReferenceTaskNames?: Array<string>;
887
- workflowDefinition?: WorkflowDef$1;
888
1967
  externalInputPayloadStoragePath?: string;
889
1968
  externalOutputPayloadStoragePath?: string;
890
- priority?: number;
891
- variables?: Record<string, any>;
1969
+ failedReferenceTaskNames?: Array<string>;
1970
+ failedTaskNames?: Array<string>;
1971
+ history?: Array<Workflow>;
1972
+ idempotencyKey?: string;
1973
+ input?: {
1974
+ [key: string]: unknown;
1975
+ };
892
1976
  lastRetriedTime?: number;
1977
+ output?: {
1978
+ [key: string]: unknown;
1979
+ };
1980
+ ownerApp?: string;
1981
+ parentWorkflowId?: string;
1982
+ parentWorkflowTaskId?: string;
1983
+ priority?: number;
1984
+ rateLimitKey?: string;
1985
+ rateLimited?: boolean;
1986
+ reRunFromWorkflowId?: string;
1987
+ reasonForIncompletion?: string;
893
1988
  startTime?: number;
894
- workflowVersion?: number;
1989
+ status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
1990
+ taskToDomain?: {
1991
+ [key: string]: string;
1992
+ };
1993
+ tasks?: Array<Task>;
1994
+ updateTime?: number;
1995
+ updatedBy?: string;
1996
+ variables?: {
1997
+ [key: string]: unknown;
1998
+ };
1999
+ workflowDefinition?: WorkflowDef$1;
2000
+ workflowId?: string;
895
2001
  workflowName?: string;
2002
+ workflowVersion?: number;
896
2003
  };
897
-
898
- declare type SearchResultWorkflow = {
899
- totalHits?: number;
900
- results?: Array<Workflow>;
901
- };
902
-
903
- declare type SearchResultWorkflowSummary = {
904
- totalHits?: number;
905
- results?: Array<WorkflowSummary>;
906
- };
907
-
908
- declare type SkipTaskRequest = {
909
- taskInput?: Record<string, any>;
910
- taskOutput?: Record<string, any>;
2004
+ type WorkflowDef$1 = {
2005
+ cacheConfig?: CacheConfig;
2006
+ createTime?: number;
2007
+ createdBy?: string;
2008
+ description?: string;
2009
+ enforceSchema?: boolean;
2010
+ failureWorkflow?: string;
2011
+ inputParameters?: Array<string>;
2012
+ inputSchema?: SchemaDef;
2013
+ inputTemplate?: {
2014
+ [key: string]: unknown;
2015
+ };
2016
+ maskedFields?: Array<string>;
2017
+ metadata?: {
2018
+ [key: string]: unknown;
2019
+ };
2020
+ name: string;
2021
+ outputParameters?: {
2022
+ [key: string]: unknown;
2023
+ };
2024
+ outputSchema?: SchemaDef;
2025
+ ownerApp?: string;
2026
+ ownerEmail?: string;
2027
+ rateLimitConfig?: RateLimitConfig;
2028
+ restartable?: boolean;
2029
+ schemaVersion?: number;
2030
+ tasks: Array<WorkflowTask>;
2031
+ timeoutPolicy?: 'TIME_OUT_WF' | 'ALERT_ONLY';
2032
+ timeoutSeconds: number;
2033
+ updateTime?: number;
2034
+ updatedBy?: string;
2035
+ variables?: {
2036
+ [key: string]: unknown;
2037
+ };
2038
+ version?: number;
2039
+ workflowStatusListenerEnabled?: boolean;
2040
+ workflowStatusListenerSink?: string;
911
2041
  };
912
-
913
- declare type WorkflowRun = {
2042
+ type WorkflowRun = {
914
2043
  correlationId?: string;
915
2044
  createTime?: number;
916
2045
  createdBy?: string;
2046
+ input?: {
2047
+ [key: string]: unknown;
2048
+ };
2049
+ output?: {
2050
+ [key: string]: unknown;
2051
+ };
917
2052
  priority?: number;
918
2053
  requestId?: string;
919
- status?: string;
2054
+ responseType?: 'TARGET_WORKFLOW' | 'BLOCKING_WORKFLOW' | 'BLOCKING_TASK' | 'BLOCKING_TASK_INPUT';
2055
+ status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
2056
+ targetWorkflowId?: string;
2057
+ targetWorkflowStatus?: string;
920
2058
  tasks?: Array<Task>;
921
2059
  updateTime?: number;
2060
+ variables?: {
2061
+ [key: string]: unknown;
2062
+ };
922
2063
  workflowId?: string;
923
- variables?: Record<string, object>;
924
- input?: Record<string, object>;
925
- output?: Record<string, object>;
926
2064
  };
927
-
928
- declare type WorkflowStatus = {
929
- workflowId?: string;
930
- correlationId?: string;
931
- output?: Record<string, any>;
932
- variables?: Record<string, any>;
933
- status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
2065
+ type WorkflowSchedule = {
2066
+ createTime?: number;
2067
+ createdBy?: string;
2068
+ cronExpression?: string;
2069
+ description?: string;
2070
+ name?: string;
2071
+ paused?: boolean;
2072
+ pausedReason?: string;
2073
+ runCatchupScheduleInstances?: boolean;
2074
+ scheduleEndTime?: number;
2075
+ scheduleStartTime?: number;
2076
+ startWorkflowRequest?: StartWorkflowRequest;
2077
+ tags?: Array<Tag>;
2078
+ updatedBy?: string;
2079
+ updatedTime?: number;
2080
+ zoneId?: string;
934
2081
  };
935
-
936
- declare type TaskMock = {
2082
+ type WorkflowScheduleExecutionModel = {
2083
+ executionId?: string;
937
2084
  executionTime?: number;
938
- output: Record<string, any>;
939
- queueWaitTime?: number;
940
- status: "IN_PROGRESS" | "FAILED" | "FAILED_WITH_TERMINAL_ERROR" | "COMPLETED";
2085
+ orgId?: string;
2086
+ queueMsgId?: string;
2087
+ reason?: string;
2088
+ scheduleName?: string;
2089
+ scheduledTime?: number;
2090
+ stackTrace?: string;
2091
+ startWorkflowRequest?: StartWorkflowRequest;
2092
+ state?: 'POLLED' | 'FAILED' | 'EXECUTED';
2093
+ workflowId?: string;
2094
+ workflowName?: string;
2095
+ zoneId?: string;
941
2096
  };
942
-
943
- declare type WorkflowTestRequest = {
944
- correlationId?: string;
2097
+ type WorkflowScheduleModel = {
2098
+ createTime?: number;
945
2099
  createdBy?: string;
946
- externalInputPayloadStoragePath?: string;
947
- idempotencyKey?: string;
948
- idempotencyStrategy?: "FAIL" | "RETURN_EXISTING";
949
- input?: Record<string, Record<string, any>>;
950
- name: string;
951
- priority?: number;
952
- subWorkflowTestRequest?: Record<string, WorkflowTestRequest>;
953
- taskRefToMockOutput?: Record<string, Array<TaskMock>>;
954
- taskToDomain?: Record<string, string>;
955
- version?: number;
956
- workflowDef?: WorkflowDef$1;
957
- };
958
-
959
- declare class WorkflowResourceService {
960
- readonly httpRequest: BaseHttpRequest;
961
- constructor(httpRequest: BaseHttpRequest);
962
- /**
963
- * Retrieve all the running workflows
964
- * @param name
965
- * @param version
966
- * @param startTime
967
- * @param endTime
968
- * @returns string OK
969
- * @throws ApiError
970
- */
971
- getRunningWorkflow(name: string, version?: number, startTime?: number, endTime?: number): CancelablePromise<Array<string>>;
972
- /**
973
- * Execute a workflow synchronously
974
- * @param body
975
- * @param name
976
- * @param version
977
- * @param requestId
978
- * @param waitUntilTaskRef
979
- * @param callback
980
- * @returns workflowRun
981
- * @throws ApiError
982
- */
983
- executeWorkflow(body: StartWorkflowRequest, name: string, version: number, requestId: string, waitUntilTaskRef: string): CancelablePromise<WorkflowRun>;
984
- /**
985
- * Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain
986
- * @param requestBody
987
- * @returns string OK
988
- * @throws ApiError
989
- */
990
- startWorkflow(requestBody: StartWorkflowRequest): CancelablePromise<string>;
991
- /**
992
- * Starts the decision task for a workflow
993
- * @param workflowId
994
- * @returns any OK
995
- * @throws ApiError
996
- */
997
- decide(workflowId: string): CancelablePromise<any>;
998
- /**
999
- * Reruns the workflow from a specific task
1000
- * @param workflowId
1001
- * @param requestBody
1002
- * @returns string OK
1003
- * @throws ApiError
1004
- */
1005
- rerun(workflowId: string, requestBody: RerunWorkflowRequest): CancelablePromise<string>;
1006
- /**
1007
- * Search for workflows based on payload and other parameters
1008
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC.
1009
- * @param start
1010
- * @param size
1011
- * @param sort
1012
- * @param freeText
1013
- * @param query
1014
- * @returns SearchResultWorkflow OK
1015
- * @throws ApiError
1016
- */
1017
- searchV21(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultWorkflow>;
1018
- /**
1019
- * Pauses the workflow
1020
- * @param workflowId
1021
- * @returns any OK
1022
- * @throws ApiError
1023
- */
1024
- pauseWorkflow(workflowId: string): CancelablePromise<any>;
1025
- /**
1026
- * Skips a given task from a current running workflow
1027
- * @param workflowId
1028
- * @param taskReferenceName
1029
- * @param requestBody
1030
- * @returns any OK
1031
- * @throws ApiError
1032
- */
1033
- skipTaskFromWorkflow(workflowId: string, taskReferenceName: string, requestBody?: SkipTaskRequest): CancelablePromise<any>;
1034
- /**
1035
- * Lists workflows for the given correlation id list
1036
- * @param name
1037
- * @param requestBody
1038
- * @param includeClosed
1039
- * @param includeTasks
1040
- * @returns Workflow OK
1041
- * @throws ApiError
1042
- */
1043
- getWorkflows(name: string, requestBody: Array<string>, includeClosed?: boolean, includeTasks?: boolean): CancelablePromise<Record<string, Array<Workflow>>>;
1044
- /**
1045
- * Gets the workflow by workflow id
1046
- * @param workflowId
1047
- * @param includeOutput
1048
- * @param includeVariables
1049
- * @returns WorkflowStatus OK
1050
- * @throws ApiError
1051
- */
1052
- getWorkflowStatusSummary(workflowId: string, includeOutput?: boolean, includeVariables?: boolean): CancelablePromise<WorkflowStatus>;
2100
+ cronExpression?: string;
2101
+ description?: string;
2102
+ name?: string;
2103
+ orgId?: string;
2104
+ paused?: boolean;
2105
+ pausedReason?: string;
2106
+ queueMsgId?: string;
2107
+ runCatchupScheduleInstances?: boolean;
2108
+ scheduleEndTime?: number;
2109
+ scheduleStartTime?: number;
2110
+ startWorkflowRequest?: StartWorkflowRequest;
2111
+ tags?: Array<Tag>;
2112
+ updatedBy?: string;
2113
+ updatedTime?: number;
2114
+ zoneId?: string;
2115
+ };
2116
+ type WorkflowStatus = {
2117
+ correlationId?: string;
2118
+ output?: {
2119
+ [key: string]: unknown;
2120
+ };
2121
+ status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
2122
+ variables?: {
2123
+ [key: string]: unknown;
2124
+ };
2125
+ workflowId?: string;
2126
+ };
2127
+ type WorkflowSummary = {
2128
+ correlationId?: string;
2129
+ createdBy?: string;
2130
+ endTime?: string;
2131
+ event?: string;
2132
+ executionTime?: number;
2133
+ externalInputPayloadStoragePath?: string;
2134
+ externalOutputPayloadStoragePath?: string;
2135
+ failedReferenceTaskNames?: string;
2136
+ failedTaskNames?: Array<string>;
2137
+ idempotencyKey?: string;
2138
+ input?: string;
2139
+ inputSize?: number;
2140
+ output?: string;
2141
+ outputSize?: number;
2142
+ priority?: number;
2143
+ reasonForIncompletion?: string;
2144
+ startTime?: string;
2145
+ status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
2146
+ taskToDomain?: {
2147
+ [key: string]: string;
2148
+ };
2149
+ updateTime?: string;
2150
+ version?: number;
2151
+ workflowId?: string;
2152
+ workflowType?: string;
2153
+ };
2154
+ type WorkflowTask = {
2155
+ asyncComplete?: boolean;
2156
+ cacheConfig?: CacheConfig;
1053
2157
  /**
1054
- * Lists workflows for the given correlation id
1055
- * @param name
1056
- * @param correlationId
1057
- * @param includeClosed
1058
- * @param includeTasks
1059
- * @returns Workflow OK
1060
- * @throws ApiError
2158
+ * @deprecated
1061
2159
  */
1062
- getWorkflows1(name: string, correlationId: string, includeClosed?: boolean, includeTasks?: boolean): CancelablePromise<Array<Workflow>>;
2160
+ caseExpression?: string;
1063
2161
  /**
1064
- * Retries the last failed task
1065
- * @param workflowId
1066
- * @param resumeSubworkflowTasks
1067
- * @returns void
1068
- * @throws ApiError
2162
+ * @deprecated
1069
2163
  */
1070
- retry1(workflowId: string, resumeSubworkflowTasks?: boolean): CancelablePromise<void>;
2164
+ caseValueParam?: string;
2165
+ decisionCases?: {
2166
+ [key: string]: Array<WorkflowTask>;
2167
+ };
2168
+ defaultCase?: Array<WorkflowTask>;
2169
+ defaultExclusiveJoinTask?: Array<string>;
2170
+ description?: string;
1071
2171
  /**
1072
- * Gets the workflow by workflow id
1073
- * @param workflowId
1074
- * @param includeTasks
1075
- * @returns Workflow OK
1076
- * @throws ApiError
2172
+ * @deprecated
1077
2173
  */
1078
- getExecutionStatus(workflowId: string, includeTasks?: boolean): CancelablePromise<Workflow>;
2174
+ dynamicForkJoinTasksParam?: string;
2175
+ dynamicForkTasksInputParamName?: string;
2176
+ dynamicForkTasksParam?: string;
2177
+ dynamicTaskNameParam?: string;
2178
+ evaluatorType?: string;
2179
+ expression?: string;
2180
+ forkTasks?: Array<Array<WorkflowTask>>;
2181
+ inputParameters?: {
2182
+ [key: string]: unknown;
2183
+ };
2184
+ joinOn?: Array<string>;
2185
+ joinStatus?: string;
2186
+ loopCondition?: string;
2187
+ loopOver?: Array<WorkflowTask>;
2188
+ name: string;
2189
+ onStateChange?: {
2190
+ [key: string]: Array<StateChangeEvent>;
2191
+ };
2192
+ optional?: boolean;
2193
+ permissive?: boolean;
2194
+ rateLimited?: boolean;
2195
+ retryCount?: number;
2196
+ scriptExpression?: string;
2197
+ sink?: string;
2198
+ startDelay?: number;
2199
+ subWorkflowParam?: SubWorkflowParams;
2200
+ taskDefinition?: TaskDef;
2201
+ taskReferenceName: string;
2202
+ type?: string;
2203
+ };
2204
+
2205
+ type AuthToken = string | undefined;
2206
+ interface Auth {
1079
2207
  /**
1080
- * Terminate workflow execution
1081
- * @param workflowId
1082
- * @param reason
1083
- * @returns any OK
1084
- * @throws ApiError
2208
+ * Which part of the request do we use to send the auth?
2209
+ *
2210
+ * @default 'header'
1085
2211
  */
1086
- terminate1(workflowId: string, reason?: string): CancelablePromise<any>;
2212
+ in?: 'header' | 'query' | 'cookie';
1087
2213
  /**
1088
- * Resumes the workflow
1089
- * @param workflowId
1090
- * @returns any OK
1091
- * @throws ApiError
2214
+ * Header or query parameter name.
2215
+ *
2216
+ * @default 'Authorization'
1092
2217
  */
1093
- resumeWorkflow(workflowId: string): CancelablePromise<any>;
2218
+ name?: string;
2219
+ scheme?: 'basic' | 'bearer';
2220
+ type: 'apiKey' | 'http';
2221
+ }
2222
+
2223
+ interface SerializerOptions<T> {
1094
2224
  /**
1095
- * Removes the workflow from the system
1096
- * @param workflowId
1097
- * @param archiveWorkflow
1098
- * @returns any OK
1099
- * @throws ApiError
2225
+ * @default true
1100
2226
  */
1101
- delete(workflowId: string, archiveWorkflow?: boolean): CancelablePromise<any>;
2227
+ explode: boolean;
2228
+ style: T;
2229
+ }
2230
+ type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
2231
+ type ObjectStyle = 'form' | 'deepObject';
2232
+
2233
+ type QuerySerializer = (query: Record<string, unknown>) => string;
2234
+ type BodySerializer = (body: any) => any;
2235
+ interface QuerySerializerOptions {
2236
+ allowReserved?: boolean;
2237
+ array?: SerializerOptions<ArrayStyle>;
2238
+ object?: SerializerOptions<ObjectStyle>;
2239
+ }
2240
+
2241
+ type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
2242
+ type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
2243
+ /**
2244
+ * Returns the final request URL.
2245
+ */
2246
+ buildUrl: BuildUrlFn;
2247
+ getConfig: () => Config;
2248
+ request: RequestFn;
2249
+ setConfig: (config: Config) => Config;
2250
+ } & {
2251
+ [K in HttpMethod]: MethodFn;
2252
+ } & ([SseFn] extends [never] ? {
2253
+ sse?: never;
2254
+ } : {
2255
+ sse: {
2256
+ [K in HttpMethod]: SseFn;
2257
+ };
2258
+ });
2259
+ interface Config$1 {
1102
2260
  /**
1103
- * Search for workflows based on task parameters
1104
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC
1105
- * @param start
1106
- * @param size
1107
- * @param sort
1108
- * @param freeText
1109
- * @param query
1110
- * @returns SearchResultWorkflowSummary OK
1111
- * @throws ApiError
2261
+ * Auth token or a function returning auth token. The resolved value will be
2262
+ * added to the request payload as defined by its `security` array.
1112
2263
  */
1113
- searchWorkflowsByTasks(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultWorkflowSummary>;
2264
+ auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
1114
2265
  /**
1115
- * Get the uri and path of the external storage where the workflow payload is to be stored
1116
- * @param path
1117
- * @param operation
1118
- * @param payloadType
1119
- * @returns ExternalStorageLocation OK
1120
- * @throws ApiError
2266
+ * A function for serializing request body parameter. By default,
2267
+ * {@link JSON.stringify()} will be used.
1121
2268
  */
1122
- getExternalStorageLocation(path: string, operation: string, payloadType: string): CancelablePromise<ExternalStorageLocation>;
2269
+ bodySerializer?: BodySerializer | null;
1123
2270
  /**
1124
- * Start a new workflow. Returns the ID of the workflow instance that can be later used for tracking
1125
- * @param name
1126
- * @param requestBody
1127
- * @param version
1128
- * @param correlationId
1129
- * @param priority
1130
- * @returns string OK
1131
- * @throws ApiError
2271
+ * An object containing any HTTP headers that you want to pre-populate your
2272
+ * `Headers` object with.
2273
+ *
2274
+ * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
1132
2275
  */
1133
- startWorkflow1(name: string, requestBody: Record<string, any>, version?: number, correlationId?: string, priority?: number): CancelablePromise<string>;
2276
+ headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
1134
2277
  /**
1135
- * Restarts a completed workflow
1136
- * @param workflowId
1137
- * @param useLatestDefinitions
1138
- * @returns void
1139
- * @throws ApiError
2278
+ * The request method.
2279
+ *
2280
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
1140
2281
  */
1141
- restart1(workflowId: string, useLatestDefinitions?: boolean): CancelablePromise<void>;
2282
+ method?: Uppercase<HttpMethod>;
1142
2283
  /**
1143
- * Search for workflows based on payload and other parameters
1144
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC.
1145
- * @param queryId
1146
- * @param start
1147
- * @param size
1148
- * @param sort
1149
- * @param freeText
1150
- * @param query
1151
- * @param skipCache
1152
- * @returns ScrollableSearchResultWorkflowSummary OK
1153
- * @throws ApiError
2284
+ * A function for serializing request query parameters. By default, arrays
2285
+ * will be exploded in form style, objects will be exploded in deepObject
2286
+ * style, and reserved characters are percent-encoded.
2287
+ *
2288
+ * This method will have no effect if the native `paramsSerializer()` Axios
2289
+ * API function is used.
2290
+ *
2291
+ * {@link https://swagger.io/docs/specification/serialization/#query View examples}
1154
2292
  */
1155
- search1(queryId?: string, start?: number, size?: number, sort?: string, freeText?: string, query?: string, skipCache?: boolean): CancelablePromise<ScrollableSearchResultWorkflowSummary>;
2293
+ querySerializer?: QuerySerializer | QuerySerializerOptions;
1156
2294
  /**
1157
- * Search for workflows based on task parameters
1158
- * use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC
1159
- * @param start
1160
- * @param size
1161
- * @param sort
1162
- * @param freeText
1163
- * @param query
1164
- * @returns SearchResultWorkflow OK
1165
- * @throws ApiError
2295
+ * A function validating request data. This is useful if you want to ensure
2296
+ * the request conforms to the desired shape, so it can be safely sent to
2297
+ * the server.
1166
2298
  */
1167
- searchWorkflowsByTasksV2(start?: number, size?: number, sort?: string, freeText?: string, query?: string): CancelablePromise<SearchResultWorkflow>;
2299
+ requestValidator?: (data: unknown) => Promise<unknown>;
1168
2300
  /**
1169
- * Resets callback times of all non-terminal SIMPLE tasks to 0
1170
- * @param workflowId
1171
- * @returns void
1172
- * @throws ApiError
2301
+ * A function transforming response data before it's returned. This is useful
2302
+ * for post-processing data, e.g. converting ISO strings into Date objects.
1173
2303
  */
1174
- resetWorkflow(workflowId: string): CancelablePromise<void>;
2304
+ responseTransformer?: (data: unknown) => Promise<unknown>;
1175
2305
  /**
1176
- * Test workflow execution using mock data
1177
- * @param requestBody
1178
- * @returns Workflow OK
1179
- * @throws ApiError
2306
+ * A function validating response data. This is useful if you want to ensure
2307
+ * the response conforms to the desired shape, so it can be safely passed to
2308
+ * the transformers and returned to the user.
1180
2309
  */
1181
- testWorkflow(requestBody: WorkflowTestRequest): CancelablePromise<Workflow>;
2310
+ responseValidator?: (data: unknown) => Promise<unknown>;
1182
2311
  }
1183
2312
 
1184
- /**
1185
- * Request method
1186
- * @param config The OpenAPI configuration object
1187
- * @param options The request options from the service
1188
- * @returns CancelablePromise<T>
1189
- * @throws ApiError
1190
- */
1191
- declare const request$1: <T>(config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
1192
-
1193
- /**
1194
- * A handler to modify requests made by ConductorClient. Useful for metrics/option transformation/etc.
1195
- *
1196
- * @remarks
1197
- * Example: Customizing the request URL
1198
- * ```
1199
- *
1200
- * const requestCustomizer = (request, config, options) => {
1201
- * const url = options.url.replace(/^\/api/, '')
1202
- * return request(config, {...options, url });
1203
- * }
1204
- * const config = { BASE: "https://my-api.com"}
1205
- * const client = new ConductorClient(config, requestCustomizer)
1206
- * ```
1207
- *
1208
- * @param request the underlying node-fetch powered function
1209
- * @param config @see OpenAPIConfig
1210
- * @param options {see ApiRequestOptions}
1211
- */
1212
- declare type RequestType = typeof request$1;
1213
- declare type ConductorHttpRequest = <T>(request: RequestType, config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
1214
-
1215
- declare type HumanTaskUser = {
1216
- user?: string;
1217
- userType?: 'EXTERNAL_USER' | 'EXTERNAL_GROUP' | 'CONDUCTOR_USER' | 'CONDUCTOR_GROUP';
1218
- };
1219
-
1220
- declare type HumanTaskAssignment = {
1221
- assignee?: HumanTaskUser;
1222
- slaMinutes?: number;
1223
- };
1224
-
1225
- declare type HumanTaskTrigger = {
1226
- startWorkflowRequest?: StartWorkflowRequest;
1227
- triggerType?: 'ASSIGNEE_CHANGED' | 'PENDING' | 'IN_PROGRESS' | 'ASSIGNED' | 'COMPLETED' | 'TIMED_OUT';
1228
- };
1229
-
1230
- declare type UserFormTemplate = {
1231
- name?: string;
1232
- version?: number;
1233
- };
1234
-
1235
- declare type HumanTaskDefinition = {
1236
- assignmentCompletionStrategy?: 'LEAVE_OPEN' | 'TERMINATE';
1237
- assignments?: Array<HumanTaskAssignment>;
1238
- taskTriggers?: Array<HumanTaskTrigger>;
1239
- userFormTemplate?: UserFormTemplate;
1240
- };
1241
-
1242
- declare type HumanTaskEntry = {
1243
- assignee?: HumanTaskUser;
1244
- claimant?: HumanTaskUser;
1245
- createdBy?: string;
1246
- createdOn?: number;
1247
- definitionName?: string;
1248
- displayName?: string;
1249
- humanTaskDef?: HumanTaskDefinition;
1250
- input?: Record<string, any>;
1251
- output?: Record<string, any>;
1252
- state?: 'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED';
1253
- taskId?: string;
1254
- taskRefName?: string;
1255
- updatedBy?: string;
1256
- updatedOn?: number;
1257
- workflowId?: string;
1258
- workflowName?: string;
1259
- };
1260
-
1261
- declare type HumanTaskSearch = {
1262
- assignees?: Array<HumanTaskUser>;
1263
- claimants?: Array<HumanTaskUser>;
1264
- definitionNames?: Array<string>;
1265
- taskOutputQuery?: string;
1266
- taskInputQuery?: string;
1267
- searchType?: 'ADMIN' | 'INBOX';
1268
- size?: number;
1269
- start?: number;
1270
- states?: Array<'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED'>;
1271
- taskRefNames?: Array<string>;
1272
- workflowNames?: Array<string>;
1273
- };
1274
-
1275
- declare type HumanTaskSearchResult = {
1276
- results?: Array<HumanTaskEntry>;
1277
- totalHits?: number;
1278
- };
1279
-
1280
- declare type HumanTaskTemplate = {
1281
- createdBy?: string;
1282
- createdOn?: number;
1283
- jsonSchema: Record<string, any>;
1284
- name: string;
1285
- templateUI: Record<string, any>;
1286
- updatedBy?: string;
1287
- updatedOn?: number;
1288
- version: number;
1289
- };
1290
-
1291
- declare class HumanTaskService {
1292
- readonly httpRequest: BaseHttpRequest;
1293
- constructor(httpRequest: BaseHttpRequest);
1294
- /**
1295
- * If the workflow is disconnected from tasks, this API can be used to clean up (in bulk)
1296
- * @param requestBody
1297
- * @returns any OK
1298
- * @throws ApiError
1299
- */
1300
- deleteTaskFromHumanTaskRecords(requestBody: Array<string>): CancelablePromise<any>;
2313
+ type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
1301
2314
  /**
1302
- * If the workflow is disconnected from tasks, this API can be used to clean up
1303
- * @param taskId
1304
- * @returns any OK
1305
- * @throws ApiError
1306
- */
1307
- deleteTaskFromHumanTaskRecords1(taskId: string): CancelablePromise<any>;
1308
- /**
1309
- * Search human tasks
1310
- * @param requestBody
1311
- * @returns HumanTaskSearchResult OK
1312
- * @throws ApiError
2315
+ * Fetch API implementation. You can use this option to provide a custom
2316
+ * fetch instance.
2317
+ *
2318
+ * @default globalThis.fetch
1313
2319
  */
1314
- search(requestBody: HumanTaskSearch): CancelablePromise<HumanTaskSearchResult>;
2320
+ fetch?: typeof fetch;
1315
2321
  /**
1316
- * Update task output, optionally complete
1317
- * @param workflowId
1318
- * @param taskRefName
1319
- * @param requestBody
1320
- * @param complete
1321
- * @param iteration Populate this value if your task is in a loop and you want to update a specific iteration. If its not in a loop OR if you want to just update the latest iteration, leave this as empty
1322
- * @returns any OK
1323
- * @throws ApiError
2322
+ * Implementing clients can call request interceptors inside this hook.
1324
2323
  */
1325
- updateTaskOutputByRef(workflowId: string, taskRefName: string, requestBody: Record<string, any>, complete?: boolean, iteration?: Array<number>): CancelablePromise<any>;
2324
+ onRequest?: (url: string, init: RequestInit) => Promise<Request>;
1326
2325
  /**
1327
- * Get a task
1328
- * @param taskId
1329
- * @returns HumanTaskEntry OK
1330
- * @throws ApiError
2326
+ * Callback invoked when a network or parsing error occurs during streaming.
2327
+ *
2328
+ * This option applies only if the endpoint returns a stream of events.
2329
+ *
2330
+ * @param error The error that occurred.
1331
2331
  */
1332
- getTask1(taskId: string): CancelablePromise<HumanTaskEntry>;
2332
+ onSseError?: (error: unknown) => void;
1333
2333
  /**
1334
- * Claim a task by authenticated Conductor user
1335
- * @param taskId
1336
- * @param overrideAssignment
1337
- * @returns any OK
1338
- * @throws ApiError
2334
+ * Callback invoked when an event is streamed from the server.
2335
+ *
2336
+ * This option applies only if the endpoint returns a stream of events.
2337
+ *
2338
+ * @param event Event streamed from the server.
2339
+ * @returns Nothing (void).
1339
2340
  */
1340
- claimTask(taskId: string, overrideAssignment?: boolean, withTemplate?: boolean): CancelablePromise<HumanTaskEntry>;
2341
+ onSseEvent?: (event: StreamEvent<TData>) => void;
2342
+ serializedBody?: RequestInit['body'];
1341
2343
  /**
1342
- * Claim a task to an external user
1343
- * @param taskId
1344
- * @param userId
1345
- * @param overrideAssignment
1346
- * @returns any OK
1347
- * @throws ApiError
2344
+ * Default retry delay in milliseconds.
2345
+ *
2346
+ * This option applies only if the endpoint returns a stream of events.
2347
+ *
2348
+ * @default 3000
1348
2349
  */
1349
- assignAndClaim(taskId: string, userId: string, overrideAssignment?: boolean, withTemplate?: boolean): CancelablePromise<HumanTaskEntry>;
2350
+ sseDefaultRetryDelay?: number;
1350
2351
  /**
1351
- * Release a task without completing it
1352
- * @param taskId
1353
- * @param requestBody
1354
- * @returns any OK
1355
- * @throws ApiError
2352
+ * Maximum number of retry attempts before giving up.
1356
2353
  */
1357
- reassignTask(taskId: string, requestBody: Array<HumanTaskAssignment>): CancelablePromise<any>;
2354
+ sseMaxRetryAttempts?: number;
1358
2355
  /**
1359
- * Release a task without completing it
1360
- * @param taskId
1361
- * @returns any OK
1362
- * @throws ApiError
2356
+ * Maximum retry delay in milliseconds.
2357
+ *
2358
+ * Applies only when exponential backoff is used.
2359
+ *
2360
+ * This option applies only if the endpoint returns a stream of events.
2361
+ *
2362
+ * @default 30000
1363
2363
  */
1364
- releaseTask(taskId: string): CancelablePromise<any>;
2364
+ sseMaxRetryDelay?: number;
1365
2365
  /**
1366
- * If a task is assigned to a user, this API can be used to skip that assignment and move to the next assignee
1367
- * @param taskId
1368
- * @param reason
1369
- * @returns any OK
1370
- * @throws ApiError
2366
+ * Optional sleep function for retry backoff.
2367
+ *
2368
+ * Defaults to using `setTimeout`.
1371
2369
  */
1372
- skipTask(taskId: string, reason?: string): CancelablePromise<any>;
2370
+ sseSleepFn?: (ms: number) => Promise<void>;
2371
+ url: string;
2372
+ };
2373
+ interface StreamEvent<TData = unknown> {
2374
+ data: TData;
2375
+ event?: string;
2376
+ id?: string;
2377
+ retry?: number;
2378
+ }
2379
+ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
2380
+ stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
2381
+ };
2382
+
2383
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
2384
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
2385
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
2386
+ declare class Interceptors<Interceptor> {
2387
+ fns: Array<Interceptor | null>;
2388
+ clear(): void;
2389
+ eject(id: number | Interceptor): void;
2390
+ exists(id: number | Interceptor): boolean;
2391
+ getInterceptorIndex(id: number | Interceptor): number;
2392
+ update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
2393
+ use(fn: Interceptor): number;
2394
+ }
2395
+ interface Middleware<Req, Res, Err, Options> {
2396
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
2397
+ request: Interceptors<ReqInterceptor<Req, Options>>;
2398
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
2399
+ }
2400
+
2401
+ type ResponseStyle = 'data' | 'fields';
2402
+ interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
1373
2403
  /**
1374
- * Update task output, optionally complete
1375
- * @param taskId
1376
- * @param requestBody
1377
- * @param complete
1378
- * @returns any OK
1379
- * @throws ApiError
2404
+ * Base URL for all requests made by this client.
1380
2405
  */
1381
- updateTaskOutput(taskId: string, requestBody: Record<string, any>, complete?: boolean): CancelablePromise<any>;
2406
+ baseUrl?: T['baseUrl'];
1382
2407
  /**
1383
- * List all user form templates or get templates by name, or a template by name and version
1384
- * @param name
1385
- * @param version
1386
- * @returns HumanTaskTemplate OK
1387
- * @throws ApiError
2408
+ * Fetch API implementation. You can use this option to provide a custom
2409
+ * fetch instance.
2410
+ *
2411
+ * @default globalThis.fetch
1388
2412
  */
1389
- getAllTemplates(name?: string, version?: number): CancelablePromise<Array<HumanTaskTemplate>>;
2413
+ fetch?: typeof fetch;
1390
2414
  /**
1391
- * Save user form template
1392
- * @param requestBody
1393
- * @param newVersion
1394
- * @returns HumanTaskTemplate OK
1395
- * @throws ApiError
2415
+ * Please don't use the Fetch client for Next.js applications. The `next`
2416
+ * options won't have any effect.
2417
+ *
2418
+ * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
1396
2419
  */
1397
- saveTemplate(requestBody: HumanTaskTemplate, newVersion?: boolean): CancelablePromise<HumanTaskTemplate>;
2420
+ next?: never;
1398
2421
  /**
1399
- * Save user form template
1400
- * @param requestBody
1401
- * @param newVersion
1402
- * @returns HumanTaskTemplate OK
1403
- * @throws ApiError
2422
+ * Return the response data parsed in a specified format. By default, `auto`
2423
+ * will infer the appropriate method from the `Content-Type` response header.
2424
+ * You can override this behavior with any of the {@link Body} methods.
2425
+ * Select `stream` if you don't want to parse response data at all.
2426
+ *
2427
+ * @default 'auto'
1404
2428
  */
1405
- saveTemplates(requestBody: Array<HumanTaskTemplate>, newVersion?: boolean): CancelablePromise<Array<HumanTaskTemplate>>;
2429
+ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
1406
2430
  /**
1407
- * Delete all versions of user form template by name
1408
- * @param name
1409
- * @returns any OK
1410
- * @throws ApiError
2431
+ * Should we return only data or multiple fields (data, error, response, etc.)?
2432
+ *
2433
+ * @default 'fields'
1411
2434
  */
1412
- deleteTemplateByName(name: string): CancelablePromise<any>;
2435
+ responseStyle?: ResponseStyle;
1413
2436
  /**
1414
- * Delete a version of form template by name
1415
- * @param name
1416
- * @param version
1417
- * @returns any OK
1418
- * @throws ApiError
2437
+ * Throw an error instead of returning it in the response?
2438
+ *
2439
+ * @default false
1419
2440
  */
1420
- deleteTemplatesByNameAndVersion(name: string, version: number): CancelablePromise<any>;
2441
+ throwOnError?: T['throwOnError'];
2442
+ }
2443
+ interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
2444
+ responseStyle: TResponseStyle;
2445
+ throwOnError: ThrowOnError;
2446
+ }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
1421
2447
  /**
1422
- * Get user form template by name and version
1423
- * @param name
1424
- * @param version
1425
- * @returns HumanTaskTemplate OK
1426
- * @throws ApiError
2448
+ * Any body that you want to add to your request.
2449
+ *
2450
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
1427
2451
  */
1428
- getTemplateByNameAndVersion(name: string, version: number): CancelablePromise<HumanTaskTemplate>;
1429
- }
1430
-
1431
- declare class HumanTaskResourceService {
1432
- readonly httpRequest: BaseHttpRequest;
1433
- constructor(httpRequest: BaseHttpRequest);
2452
+ body?: unknown;
2453
+ path?: Record<string, unknown>;
2454
+ query?: Record<string, unknown>;
1434
2455
  /**
1435
- * Get Conductor task by id (for human tasks only)
1436
- * @param taskId
1437
- * @returns Task OK
1438
- * @throws ApiError
2456
+ * Security mechanism(s) to use for the request.
1439
2457
  */
1440
- getConductorTaskById(taskId: string): CancelablePromise<Task>;
1441
- }
1442
-
1443
- interface ConductorClientAPIConfig extends Omit<OpenAPIConfig, "BASE"> {
1444
- serverUrl: string;
1445
- useEnvVars: boolean;
1446
- }
1447
- declare class ConductorClient {
1448
- readonly eventResource: EventResourceService;
1449
- readonly healthCheckResource: HealthCheckResourceService;
1450
- readonly metadataResource: MetadataResourceService;
1451
- readonly schedulerResource: SchedulerResourceService;
1452
- readonly taskResource: TaskResourceService;
1453
- readonly tokenResource: TokenResourceService;
1454
- readonly workflowBulkResource: WorkflowBulkResourceService;
1455
- readonly workflowResource: WorkflowResourceService;
1456
- readonly humanTask: HumanTaskService;
1457
- readonly humanTaskResource: HumanTaskResourceService;
1458
- readonly request: BaseHttpRequest;
1459
- token?: string | Resolver<string>;
1460
- constructor(config?: Partial<ConductorClientAPIConfig>, requestHandler?: ConductorHttpRequest);
1461
- stop(): void;
1462
- }
1463
-
1464
- declare type ApiResult = {
1465
- readonly url: string;
1466
- readonly ok: boolean;
1467
- readonly status: number;
1468
- readonly statusText: string;
1469
- readonly body: any;
1470
- };
1471
-
1472
- declare class ApiError extends Error {
1473
- readonly url: string;
1474
- readonly status: number;
1475
- readonly statusText: string;
1476
- readonly body: any;
1477
- readonly request: ApiRequestOptions;
1478
- constructor(request: ApiRequestOptions, response: ApiResult, message: string);
1479
- }
1480
-
1481
- declare type HTScrollableSearchResultHumanTaskEntry = {
1482
- queryId?: string;
1483
- results?: Array<HumanTaskEntry>;
1484
- };
1485
-
1486
- declare type TimeoutPolicy = {
1487
- type: string;
1488
- };
1489
-
1490
- declare type Terminate = (TimeoutPolicy & {
1491
- timeoutSeconds?: number;
1492
- });
1493
-
1494
- /**
1495
- * Functional interface for defining a worker implementation that processes tasks from a conductor queue.
1496
- *
1497
- * @remarks
1498
- * Optional items allow overriding properties on a per-worker basis. Items not overridden
1499
- * here will be inherited from the `TaskManager` options.
1500
- */
1501
- interface ConductorWorker {
1502
- taskDefName: string;
1503
- execute: (task: Task) => Promise<Omit<TaskResult, "workflowInstanceId" | "taskId">>;
1504
- domain?: string;
1505
- concurrency?: number;
1506
- pollInterval?: number;
2458
+ security?: ReadonlyArray<Auth>;
2459
+ url: Url;
1507
2460
  }
1508
-
1509
- interface ConductorLogger {
1510
- info(...args: any): void;
1511
- error(...args: any): void;
1512
- debug(...args: any): void;
2461
+ interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
2462
+ serializedBody?: string;
1513
2463
  }
1514
- declare type ConductorLogLevel = keyof typeof LOG_LEVELS;
1515
- interface DefaultLoggerConfig {
1516
- level?: ConductorLogLevel;
1517
- tags?: Object[];
2464
+ type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
2465
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
2466
+ request: Request;
2467
+ response: Response;
2468
+ }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
2469
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
2470
+ error: undefined;
2471
+ } | {
2472
+ data: undefined;
2473
+ error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
2474
+ }) & {
2475
+ request: Request;
2476
+ response: Response;
2477
+ }>;
2478
+ interface ClientOptions {
2479
+ baseUrl?: string;
2480
+ responseStyle?: ResponseStyle;
2481
+ throwOnError?: boolean;
1518
2482
  }
1519
- declare const LOG_LEVELS: {
1520
- readonly DEBUG: 10;
1521
- readonly INFO: 30;
1522
- readonly ERROR: 60;
2483
+ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
2484
+ type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
2485
+ type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
2486
+ type BuildUrlFn = <TData extends {
2487
+ body?: unknown;
2488
+ path?: Record<string, unknown>;
2489
+ query?: Record<string, unknown>;
2490
+ url: string;
2491
+ }>(options: Pick<TData, 'url'> & Options<TData>) => string;
2492
+ type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
2493
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
1523
2494
  };
1524
- declare class DefaultLogger implements ConductorLogger {
1525
- private readonly tags;
1526
- private readonly level;
1527
- constructor(config?: DefaultLoggerConfig);
1528
- private log;
1529
- info: (...args: any) => void;
1530
- debug: (...args: any) => void;
1531
- error: (...args: any) => void;
2495
+ interface TDataShape {
2496
+ body?: unknown;
2497
+ headers?: unknown;
2498
+ path?: unknown;
2499
+ query?: unknown;
2500
+ url: string;
1532
2501
  }
1533
- declare const noopLogger: ConductorLogger;
2502
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
2503
+ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
1534
2504
 
1535
2505
  interface CommonTaskDef {
1536
2506
  name: string;
1537
2507
  taskReferenceName: string;
1538
2508
  }
2509
+ declare enum Consistency {
2510
+ SYNCHRONOUS = "SYNCHRONOUS",
2511
+ DURABLE = "DURABLE",
2512
+ REGION_DURABLE = "REGION_DURABLE"
2513
+ }
2514
+ declare enum ReturnStrategy {
2515
+ TARGET_WORKFLOW = "TARGET_WORKFLOW",
2516
+ BLOCKING_WORKFLOW = "BLOCKING_WORKFLOW",
2517
+ BLOCKING_TASK = "BLOCKING_TASK",
2518
+ BLOCKING_TASK_INPUT = "BLOCKING_TASK_INPUT"
2519
+ }
2520
+ declare enum TaskResultStatusEnum {
2521
+ IN_PROGRESS = "IN_PROGRESS",
2522
+ FAILED = "FAILED",
2523
+ FAILED_WITH_TERMINAL_ERROR = "FAILED_WITH_TERMINAL_ERROR",
2524
+ COMPLETED = "COMPLETED"
2525
+ }
1539
2526
  declare enum TaskType {
1540
2527
  START = "START",
1541
2528
  SIMPLE = "SIMPLE",
@@ -1560,7 +2547,12 @@ declare enum TaskType {
1560
2547
  JSON_JQ_TRANSFORM = "JSON_JQ_TRANSFORM",
1561
2548
  SET_VARIABLE = "SET_VARIABLE"
1562
2549
  }
1563
- declare type TaskDefTypes = SimpleTaskDef | DoWhileTaskDef | EventTaskDef | ForkJoinTaskDef | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDef | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDef | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
2550
+ declare enum ServiceType {
2551
+ HTTP = "HTTP",
2552
+ MCP_REMOTE = "MCP_REMOTE",
2553
+ gRPC = "gRPC"
2554
+ }
2555
+ type TaskDefTypes = SimpleTaskDef | DoWhileTaskDef | EventTaskDef | ForkJoinTaskDef | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDef | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDef | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
1564
2556
  interface DoWhileTaskDef extends CommonTaskDef {
1565
2557
  inputParameters: Record<string, unknown>;
1566
2558
  type: TaskType.DO_WHILE;
@@ -1574,11 +2566,12 @@ interface EventTaskDef extends CommonTaskDef {
1574
2566
  type: TaskType.EVENT;
1575
2567
  sink: string;
1576
2568
  asyncComplete?: boolean;
2569
+ optional?: boolean;
1577
2570
  }
1578
2571
  interface ForkJoinTaskDef extends CommonTaskDef {
1579
2572
  type: TaskType.FORK_JOIN;
1580
2573
  inputParameters?: Record<string, string>;
1581
- forkTasks: Array<Array<TaskDefTypes>>;
2574
+ forkTasks: TaskDefTypes[][];
1582
2575
  }
1583
2576
  interface JoinTaskDef extends CommonTaskDef {
1584
2577
  type: TaskType.JOIN;
@@ -1589,8 +2582,8 @@ interface JoinTaskDef extends CommonTaskDef {
1589
2582
  }
1590
2583
  interface ForkJoinDynamicDef extends CommonTaskDef {
1591
2584
  inputParameters: {
1592
- dynamicTasks: any;
1593
- dynamicTasksInput: any;
2585
+ dynamicTasks: TaskDefTypes[] | string;
2586
+ dynamicTasksInput: Record<string, unknown> | string;
1594
2587
  };
1595
2588
  type: TaskType.FORK_JOIN_DYNAMIC;
1596
2589
  dynamicForkTasksParam: string;
@@ -1615,6 +2608,8 @@ interface HttpTaskDef extends CommonTaskDef {
1615
2608
  http_request: HttpInputParameters;
1616
2609
  };
1617
2610
  type: TaskType.HTTP;
2611
+ asyncComplete?: boolean;
2612
+ optional?: boolean;
1618
2613
  }
1619
2614
  interface InlineTaskInputParameters {
1620
2615
  evaluatorType: "javascript" | "graaljs";
@@ -1624,6 +2619,7 @@ interface InlineTaskInputParameters {
1624
2619
  interface InlineTaskDef extends CommonTaskDef {
1625
2620
  type: TaskType.INLINE;
1626
2621
  inputParameters: InlineTaskInputParameters;
2622
+ optional?: boolean;
1627
2623
  }
1628
2624
  interface ContainingQueryExpression {
1629
2625
  queryExpression: string;
@@ -1632,6 +2628,7 @@ interface ContainingQueryExpression {
1632
2628
  interface JsonJQTransformTaskDef extends CommonTaskDef {
1633
2629
  type: TaskType.JSON_JQ_TRANSFORM;
1634
2630
  inputParameters: ContainingQueryExpression;
2631
+ optional?: boolean;
1635
2632
  }
1636
2633
  interface KafkaPublishInputParameters {
1637
2634
  topic: string;
@@ -1646,14 +2643,17 @@ interface KafkaPublishTaskDef extends CommonTaskDef {
1646
2643
  kafka_request: KafkaPublishInputParameters;
1647
2644
  };
1648
2645
  type: TaskType.KAFKA_PUBLISH;
2646
+ optional?: boolean;
1649
2647
  }
1650
2648
  interface SetVariableTaskDef extends CommonTaskDef {
1651
2649
  type: TaskType.SET_VARIABLE;
1652
2650
  inputParameters: Record<string, unknown>;
2651
+ optional?: boolean;
1653
2652
  }
1654
2653
  interface SimpleTaskDef extends CommonTaskDef {
1655
2654
  type: TaskType.SIMPLE;
1656
2655
  inputParameters?: Record<string, unknown>;
2656
+ optional?: boolean;
1657
2657
  }
1658
2658
  interface SubWorkflowTaskDef extends CommonTaskDef {
1659
2659
  type: TaskType.SUB_WORKFLOW;
@@ -1663,6 +2663,7 @@ interface SubWorkflowTaskDef extends CommonTaskDef {
1663
2663
  version?: number;
1664
2664
  taskToDomain?: Record<string, string>;
1665
2665
  };
2666
+ optional?: boolean;
1666
2667
  }
1667
2668
  interface SwitchTaskDef extends CommonTaskDef {
1668
2669
  inputParameters: Record<string, unknown>;
@@ -1671,6 +2672,7 @@ interface SwitchTaskDef extends CommonTaskDef {
1671
2672
  defaultCase: TaskDefTypes[];
1672
2673
  evaluatorType: "value-param" | "javascript";
1673
2674
  expression: string;
2675
+ optional?: boolean;
1674
2676
  }
1675
2677
  interface TerminateTaskDef extends CommonTaskDef {
1676
2678
  inputParameters: {
@@ -1680,7 +2682,6 @@ interface TerminateTaskDef extends CommonTaskDef {
1680
2682
  };
1681
2683
  type: TaskType.TERMINATE;
1682
2684
  startDelay?: number;
1683
- optional?: boolean;
1684
2685
  }
1685
2686
  interface WaitTaskDef extends CommonTaskDef {
1686
2687
  type: TaskType.WAIT;
@@ -1688,14 +2689,138 @@ interface WaitTaskDef extends CommonTaskDef {
1688
2689
  duration?: string;
1689
2690
  until?: string;
1690
2691
  };
2692
+ optional?: boolean;
1691
2693
  }
1692
- interface WorkflowDef extends Omit<WorkflowDef$1, "tasks" | "version" | "inputParameters"> {
1693
- inputParameters: string[];
1694
- version: number;
1695
- tasks: TaskDefTypes[];
2694
+ interface ExtendedTaskDef extends Omit<ExtendedTaskDef$1, "timeoutSeconds" | "totalTimeoutSeconds"> {
2695
+ totalTimeoutSeconds?: number;
2696
+ timeoutSeconds?: number;
2697
+ }
2698
+ interface SignalResponse extends SignalResponse$1 {
2699
+ priority?: number;
2700
+ variables?: Record<string, unknown>;
2701
+ tasks?: Task[];
2702
+ createdBy?: string;
2703
+ createTime?: number;
2704
+ status?: string;
2705
+ updateTime?: number;
2706
+ taskType?: string;
2707
+ taskId?: string;
2708
+ referenceTaskName?: string;
2709
+ retryCount?: number;
2710
+ taskDefName?: string;
2711
+ workflowType?: string;
2712
+ }
2713
+
2714
+ type TimeoutPolicy = {
2715
+ type: string;
2716
+ };
2717
+ type Terminate = TimeoutPolicy & {
2718
+ timeoutSeconds?: number;
2719
+ };
2720
+ type HTScrollableSearchResultHumanTaskEntry = {
2721
+ queryId?: string;
2722
+ results?: HumanTaskEntry[];
2723
+ };
2724
+ type StartWorkflow = {
2725
+ name?: string;
2726
+ version?: number;
2727
+ correlationId?: string;
2728
+ input?: Record<string, any>;
2729
+ taskToDomain?: Record<string, string>;
2730
+ };
2731
+ type SearchResultWorkflowSummary = ScrollableSearchResultWorkflowSummary;
2732
+ type SearchResultWorkflow = {
2733
+ totalHits?: number;
2734
+ results?: Array<Workflow>;
2735
+ };
2736
+ type SearchResultTask = TaskListSearchResultSummary;
2737
+ type ExternalStorageLocation = {
2738
+ uri?: string;
2739
+ path?: string;
2740
+ };
2741
+ interface OnCancel {
2742
+ readonly isResolved: boolean;
2743
+ readonly isRejected: boolean;
2744
+ readonly isCancelled: boolean;
2745
+ (cancelHandler: () => void): void;
2746
+ }
2747
+ type ApiRequestOptions = {
2748
+ readonly method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH";
2749
+ readonly url: string;
2750
+ readonly path?: Record<string, any>;
2751
+ readonly cookies?: Record<string, any>;
2752
+ readonly headers?: Record<string, any>;
2753
+ readonly query?: Record<string, any>;
2754
+ readonly formData?: Record<string, any>;
2755
+ readonly body?: any;
2756
+ readonly mediaType?: string;
2757
+ readonly responseHeader?: string;
2758
+ readonly errors?: Record<number, string>;
2759
+ };
2760
+ type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
2761
+ type OpenAPIConfig = {
2762
+ BASE: string;
2763
+ VERSION: string;
2764
+ WITH_CREDENTIALS: boolean;
2765
+ CREDENTIALS: "include" | "omit" | "same-origin";
2766
+ TOKEN?: string | Resolver<string> | undefined;
2767
+ USERNAME?: string | Resolver<string> | undefined;
2768
+ PASSWORD?: string | Resolver<string> | undefined;
2769
+ HEADERS?: Headers | Resolver<Headers> | undefined;
2770
+ ENCODE_PATH?: ((path: string) => string) | undefined;
2771
+ };
2772
+ type ApiResult = {
2773
+ readonly url: string;
2774
+ readonly ok: boolean;
2775
+ readonly status: number;
2776
+ readonly statusText: string;
2777
+ readonly body: any;
2778
+ };
2779
+ declare class ApiError extends Error {
2780
+ readonly url: string;
2781
+ readonly status: number;
2782
+ readonly statusText: string;
2783
+ readonly body: any;
2784
+ readonly request: ApiRequestOptions;
2785
+ constructor(request: ApiRequestOptions, response: ApiResult, message: string);
2786
+ }
2787
+ type ConductorClient = Client;
2788
+ declare class CancelError extends Error {
2789
+ constructor(message: string);
2790
+ get isCancelled(): boolean;
2791
+ }
2792
+ declare class CancelablePromise<T> implements Promise<T> {
2793
+ #private;
2794
+ constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
2795
+ get [Symbol.toStringTag](): string;
2796
+ then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
2797
+ catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
2798
+ finally(onFinally?: (() => void) | null): Promise<T>;
2799
+ cancel(): void;
2800
+ get isCancelled(): boolean;
2801
+ }
2802
+ declare abstract class BaseHttpRequest {
2803
+ readonly config: OpenAPIConfig;
2804
+ constructor(config: OpenAPIConfig);
2805
+ abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
1696
2806
  }
1697
2807
 
1698
- declare type TaskErrorHandler = (error: Error, task?: Task) => void;
2808
+ /**
2809
+ * Functional interface for defining a worker implementation that processes tasks from a conductor queue.
2810
+ *
2811
+ * @remarks
2812
+ * Optional items allow overriding properties on a per-worker basis. Items not overridden
2813
+ * here will be inherited from the `TaskManager` options.
2814
+ */
2815
+ interface ConductorWorker {
2816
+ taskDefName: string;
2817
+ execute: (task: Task) => Promise<Omit<TaskResult, "workflowInstanceId" | "taskId">>;
2818
+ domain?: string;
2819
+ concurrency?: number;
2820
+ pollInterval?: number;
2821
+ }
2822
+
2823
+ type TaskErrorHandler = (error: Error, task?: Task) => void;
1699
2824
  interface TaskRunnerOptions {
1700
2825
  workerID: string;
1701
2826
  domain: string | undefined;
@@ -1705,7 +2830,7 @@ interface TaskRunnerOptions {
1705
2830
  }
1706
2831
  interface RunnerArgs {
1707
2832
  worker: ConductorWorker;
1708
- taskResource: TaskResourceService;
2833
+ client: Client;
1709
2834
  options: TaskRunnerOptions;
1710
2835
  logger?: ConductorLogger;
1711
2836
  onError?: TaskErrorHandler;
@@ -1725,14 +2850,14 @@ declare const noopErrorHandler: TaskErrorHandler;
1725
2850
  *
1726
2851
  */
1727
2852
  declare class TaskRunner {
1728
- taskResource: TaskResourceService;
2853
+ _client: Client;
1729
2854
  worker: ConductorWorker;
1730
2855
  private logger;
1731
2856
  private options;
1732
2857
  errorHandler: TaskErrorHandler;
1733
2858
  private poller;
1734
2859
  private maxRetries;
1735
- constructor({ worker, taskResource, options, logger, onError: errorHandler, maxRetries, }: RunnerArgs);
2860
+ constructor({ worker, client, options, logger, onError: errorHandler, maxRetries, }: RunnerArgs);
1736
2861
  get isPolling(): boolean;
1737
2862
  /**
1738
2863
  * Starts polling for work
@@ -1750,7 +2875,7 @@ declare class TaskRunner {
1750
2875
  handleUnknownError: (unknownError: unknown) => void;
1751
2876
  }
1752
2877
 
1753
- declare type TaskManagerOptions = TaskRunnerOptions;
2878
+ type TaskManagerOptions = TaskRunnerOptions;
1754
2879
  interface TaskManagerConfig {
1755
2880
  logger?: ConductorLogger;
1756
2881
  options?: Partial<TaskManagerOptions>;
@@ -1769,7 +2894,7 @@ declare class TaskManager {
1769
2894
  readonly options: Required<TaskManagerOptions>;
1770
2895
  private polling;
1771
2896
  private maxRetries;
1772
- constructor(client: ConductorClient, workers: Array<ConductorWorker>, config?: TaskManagerConfig);
2897
+ constructor(client: Client, workers: ConductorWorker[], config?: TaskManagerConfig);
1773
2898
  private workerManagerWorkerOptions;
1774
2899
  get isPolling(): boolean;
1775
2900
  updatePollingOptionForWorker: (workerTaskDefName: string, options: Partial<TaskManagerOptions>) => void;
@@ -1789,25 +2914,46 @@ declare class TaskManager {
1789
2914
  stopPolling: () => Promise<void>;
1790
2915
  }
1791
2916
 
1792
- declare class ConductorError extends Error {
2917
+ declare class ConductorSdkError extends Error {
1793
2918
  private _trace;
1794
2919
  private __proto__;
1795
2920
  constructor(message?: string, innerError?: Error);
1796
2921
  }
1797
- declare type TaskResultStatus = NonNullable<TaskResult['status']>;
2922
+ type TaskResultStatus = NonNullable<TaskResult["status"]>;
2923
+ type TaskResultOutputData = NonNullable<TaskResult["outputData"]>;
2924
+ interface EnhancedSignalResponse extends SignalResponse {
2925
+ isTargetWorkflow(): boolean;
2926
+ isBlockingWorkflow(): boolean;
2927
+ isBlockingTask(): boolean;
2928
+ isBlockingTaskInput(): boolean;
2929
+ getWorkflow(): Workflow;
2930
+ getBlockingTask(): Task;
2931
+ getTaskInput(): Record<string, unknown>;
2932
+ getWorkflowId(): string;
2933
+ getTargetWorkflowId(): string;
2934
+ hasWorkflowData(): boolean;
2935
+ hasTaskData(): boolean;
2936
+ getResponseType(): string;
2937
+ isTerminal(): boolean;
2938
+ isRunning(): boolean;
2939
+ isPaused(): boolean;
2940
+ getSummary(): string;
2941
+ toDebugJSON(): Record<string, unknown>;
2942
+ toString(): string;
2943
+ }
1798
2944
 
1799
- declare type TaskFinderPredicate = (task: Task) => boolean;
2945
+ type TaskFinderPredicate = (task: Task) => boolean;
1800
2946
  declare const completedTaskMatchingType: (taskType: string) => TaskFinderPredicate;
1801
2947
  declare class WorkflowExecutor {
1802
- readonly _client: ConductorClient;
1803
- constructor(client: ConductorClient);
2948
+ readonly _client: Client;
2949
+ constructor(client: Client);
1804
2950
  /**
1805
2951
  * Will persist a workflow in conductor
1806
2952
  * @param override If true will override the existing workflow with the definition
1807
2953
  * @param workflow Complete workflow definition
1808
2954
  * @returns null
1809
2955
  */
1810
- registerWorkflow(override: boolean, workflow: WorkflowDef): Promise<void>;
2956
+ registerWorkflow(override: boolean, workflow: WorkflowDef$1): Promise<void>;
1811
2957
  /**
1812
2958
  * Takes a StartWorkflowRequest. returns a Promise<string> with the workflowInstanceId of the running workflow
1813
2959
  * @param workflowRequest
@@ -1815,11 +2961,13 @@ declare class WorkflowExecutor {
1815
2961
  */
1816
2962
  startWorkflow(workflowRequest: StartWorkflowRequest): Promise<string>;
1817
2963
  /**
1818
- * Execute a workflow synchronously. returns a Promise<WorkflowRun> with details of the running workflow
1819
- * @param workflowRequest
1820
- * @returns
2964
+ * Execute a workflow synchronously (original method - backward compatible)
1821
2965
  */
1822
2966
  executeWorkflow(workflowRequest: StartWorkflowRequest, name: string, version: number, requestId: string, waitUntilTaskRef?: string): Promise<WorkflowRun>;
2967
+ /**
2968
+ * Execute a workflow with return strategy support (new method)
2969
+ */
2970
+ executeWorkflow(workflowRequest: StartWorkflowRequest, name: string, version: number, requestId: string, waitUntilTaskRef: string, waitForSeconds: number, consistency: Consistency, returnStrategy: ReturnStrategy): Promise<EnhancedSignalResponse>;
1823
2971
  startWorkflows(workflowsRequest: StartWorkflowRequest[]): Promise<string>[];
1824
2972
  goBackToTask(workflowInstanceId: string, taskFinderPredicate: TaskFinderPredicate, rerunWorkflowRequestOverrides?: Partial<RerunWorkflowRequest>): Promise<void>;
1825
2973
  goBackToFirstTaskMatchingType(workflowInstanceId: string, taskType: string): Promise<void>;
@@ -1925,7 +3073,7 @@ declare class WorkflowExecutor {
1925
3073
  * @param taskOutput
1926
3074
  * @returns
1927
3075
  */
1928
- updateTask(taskId: string, workflowInstanceId: string, taskStatus: TaskResultStatus, outputData: Record<string, any>): Promise<string>;
3076
+ updateTask(taskId: string, workflowInstanceId: string, taskStatus: TaskResultStatus, outputData: TaskResultOutputData): Promise<string>;
1929
3077
  /**
1930
3078
  * Updates a task by reference Name
1931
3079
  * @param taskReferenceName
@@ -1934,22 +3082,49 @@ declare class WorkflowExecutor {
1934
3082
  * @param taskOutput
1935
3083
  * @returns
1936
3084
  */
1937
- updateTaskByRefName(taskReferenceName: string, workflowInstanceId: string, status: TaskResultStatus, taskOutput: Record<string, any>): Promise<string>;
3085
+ updateTaskByRefName(taskReferenceName: string, workflowInstanceId: string, status: TaskResultStatus, taskOutput: TaskResultOutputData): Promise<string>;
1938
3086
  /**
1939
3087
  *
1940
3088
  * @param taskId
1941
3089
  * @returns
1942
3090
  */
1943
3091
  getTask(taskId: string): Promise<Task>;
3092
+ /**
3093
+ * Updates a task by reference name synchronously and returns the complete workflow
3094
+ * @param taskReferenceName
3095
+ * @param workflowInstanceId
3096
+ * @param status
3097
+ * @param taskOutput
3098
+ * @param workerId - Optional
3099
+ * @returns Promise<Workflow>
3100
+ */
3101
+ updateTaskSync(taskReferenceName: string, workflowInstanceId: string, status: TaskResultStatusEnum, taskOutput: TaskResultOutputData, workerId?: string): Promise<Workflow>;
3102
+ /**
3103
+ * Signals a workflow task and returns data based on the specified return strategy
3104
+ * @param workflowInstanceId - Workflow instance ID to signal
3105
+ * @param status - Task status to set
3106
+ * @param taskOutput - Output data for the task
3107
+ * @param returnStrategy - Optional strategy for what data to return (defaults to TARGET_WORKFLOW)
3108
+ * @returns Promise<SignalResponse> with data based on the return strategy
3109
+ */
3110
+ signal(workflowInstanceId: string, status: TaskResultStatusEnum, taskOutput: TaskResultOutputData, returnStrategy?: ReturnStrategy): Promise<EnhancedSignalResponse>;
3111
+ /**
3112
+ * Signals a workflow task asynchronously (fire-and-forget)
3113
+ * @param workflowInstanceId - Workflow instance ID to signal
3114
+ * @param status - Task status to set
3115
+ * @param taskOutput - Output data for the task
3116
+ * @returns Promise<void>
3117
+ */
3118
+ signalAsync(workflowInstanceId: string, status: TaskResultStatusEnum, taskOutput: TaskResultOutputData): Promise<void>;
1944
3119
  }
1945
3120
 
1946
- declare type PollIntervalOptions = {
3121
+ interface PollIntervalOptions {
1947
3122
  pollInterval: number;
1948
3123
  maxPollTimes: number;
1949
- };
3124
+ }
1950
3125
  declare class HumanExecutor {
1951
- readonly _client: ConductorClient;
1952
- constructor(client: ConductorClient);
3126
+ readonly _client: Client;
3127
+ constructor(client: Client);
1953
3128
  /**
1954
3129
  * @deprecated use search instead
1955
3130
  * Takes a set of filter parameters. return matches of human tasks for that set of parameters
@@ -2031,53 +3206,53 @@ declare class HumanExecutor {
2031
3206
  * @param taskId
2032
3207
  * @param requestBody
2033
3208
  */
2034
- updateTaskOutput(taskId: string, requestBody: Record<string, Record<string, any>>): Promise<void>;
3209
+ updateTaskOutput(taskId: string, requestBody: Record<string, Record<string, unknown>>): Promise<void>;
2035
3210
  /**
2036
3211
  * Takes a taskId and an optional partial body. will complete the task with the given body
2037
3212
  * @param taskId
2038
3213
  * @param requestBody
2039
3214
  */
2040
- completeTask(taskId: string, requestBody?: Record<string, Record<string, any>>): Promise<void>;
3215
+ completeTask(taskId: string, requestBody?: Record<string, Record<string, unknown>>): Promise<void>;
2041
3216
  }
2042
3217
 
2043
- declare const doWhileTask: (taskRefName: string, terminationCondition: string, tasks: TaskDefTypes[]) => DoWhileTaskDef;
2044
- declare const newLoopTask: (taskRefName: string, iterations: number, tasks: TaskDefTypes[]) => DoWhileTaskDef;
3218
+ declare const doWhileTask: (taskRefName: string, terminationCondition: string, tasks: TaskDefTypes[], optional?: boolean) => DoWhileTaskDef;
3219
+ declare const newLoopTask: (taskRefName: string, iterations: number, tasks: TaskDefTypes[], optional?: boolean) => DoWhileTaskDef;
2045
3220
 
2046
- declare const dynamicForkTask: (taskReferenceName: string, preForkTasks?: TaskDefTypes[], dynamicTasksInput?: string) => ForkJoinDynamicDef;
3221
+ declare const dynamicForkTask: (taskReferenceName: string, preForkTasks?: TaskDefTypes[], dynamicTasksInput?: string, optional?: boolean) => ForkJoinDynamicDef;
2047
3222
 
2048
- declare const eventTask: (taskReferenceName: string, eventPrefix: string, eventSuffix: string) => EventTaskDef;
2049
- declare const sqsEventTask: (taskReferenceName: string, queueName: string) => EventTaskDef;
2050
- declare const conductorEventTask: (taskReferenceName: string, eventName: string) => EventTaskDef;
3223
+ declare const eventTask: (taskReferenceName: string, eventPrefix: string, eventSuffix: string, optional?: boolean) => EventTaskDef;
3224
+ declare const sqsEventTask: (taskReferenceName: string, queueName: string, optional?: boolean) => EventTaskDef;
3225
+ declare const conductorEventTask: (taskReferenceName: string, eventName: string, optional?: boolean) => EventTaskDef;
2051
3226
 
2052
3227
  declare const forkTask: (taskReferenceName: string, forkTasks: TaskDefTypes[]) => ForkJoinTaskDef;
2053
- declare const forkTaskJoin: (taskReferenceName: string, forkTasks: TaskDefTypes[]) => [ForkJoinTaskDef, JoinTaskDef];
3228
+ declare const forkTaskJoin: (taskReferenceName: string, forkTasks: TaskDefTypes[], optional?: boolean) => [ForkJoinTaskDef, JoinTaskDef];
2054
3229
 
2055
- declare const httpTask: (taskReferenceName: string, inputParameters: HttpInputParameters) => HttpTaskDef;
3230
+ declare const httpTask: (taskReferenceName: string, inputParameters: HttpInputParameters, asyncComplete?: boolean, optional?: boolean) => HttpTaskDef;
2056
3231
 
2057
- declare const inlineTask: (taskReferenceName: string, script: string, evaluatorType?: "javascript" | "graaljs") => InlineTaskDef;
3232
+ declare const inlineTask: (taskReferenceName: string, script: string, evaluatorType?: "javascript" | "graaljs", optional?: boolean) => InlineTaskDef;
2058
3233
 
2059
- declare const joinTask: (taskReferenceName: string, joinOn: string[]) => JoinTaskDef;
3234
+ declare const joinTask: (taskReferenceName: string, joinOn: string[], optional?: boolean) => JoinTaskDef;
2060
3235
 
2061
- declare const jsonJqTask: (taskReferenceName: string, script: string) => JsonJQTransformTaskDef;
3236
+ declare const jsonJqTask: (taskReferenceName: string, script: string, optional?: boolean) => JsonJQTransformTaskDef;
2062
3237
 
2063
- declare const kafkaPublishTask: (taskReferenceName: string, kafka_request: KafkaPublishInputParameters) => KafkaPublishTaskDef;
3238
+ declare const kafkaPublishTask: (taskReferenceName: string, kafka_request: KafkaPublishInputParameters, optional?: boolean) => KafkaPublishTaskDef;
2064
3239
 
2065
- declare const setVariableTask: (taskReferenceName: string, inputParameters: Record<string, unknown>) => SetVariableTaskDef;
3240
+ declare const setVariableTask: (taskReferenceName: string, inputParameters: Record<string, unknown>, optional?: boolean) => SetVariableTaskDef;
2066
3241
 
2067
- declare const simpleTask: (taskReferenceName: string, name: string, inputParameters: Record<string, unknown>) => SimpleTaskDef;
3242
+ declare const simpleTask: (taskReferenceName: string, name: string, inputParameters: Record<string, unknown>, optional?: boolean) => SimpleTaskDef;
2068
3243
 
2069
- declare const subWorkflowTask: (taskReferenceName: string, workflowName: string, version?: number | undefined) => SubWorkflowTaskDef;
3244
+ declare const subWorkflowTask: (taskReferenceName: string, workflowName: string, version?: number, optional?: boolean) => SubWorkflowTaskDef;
2070
3245
 
2071
- declare const switchTask: (taskReferenceName: string, expression: string, decisionCases?: Record<string, TaskDefTypes[]>, defaultCase?: TaskDefTypes[]) => SwitchTaskDef;
3246
+ declare const switchTask: (taskReferenceName: string, expression: string, decisionCases?: Record<string, TaskDefTypes[]>, defaultCase?: TaskDefTypes[], optional?: boolean) => SwitchTaskDef;
2072
3247
 
2073
- declare const taskDefinition: ({ name, ownerApp, description, retryCount, timeoutSeconds, inputKeys, outputKeys, timeoutPolicy, retryLogic, retryDelaySeconds, responseTimeoutSeconds, concurrentExecLimit, inputTemplate, rateLimitPerFrequency, rateLimitFrequencyInSeconds, ownerEmail, pollTimeoutSeconds, backoffScaleFactor, }: TaskDef) => TaskDef;
3248
+ declare const taskDefinition: ({ name, ownerApp, description, retryCount, timeoutSeconds, inputKeys, outputKeys, timeoutPolicy, retryLogic, retryDelaySeconds, responseTimeoutSeconds, concurrentExecLimit, inputTemplate, rateLimitPerFrequency, rateLimitFrequencyInSeconds, ownerEmail, pollTimeoutSeconds, backoffScaleFactor, }: ExtendedTaskDef) => TaskDef;
2074
3249
 
2075
- declare const terminateTask: (taskReferenceName: string, status: "COMPLETED" | "FAILED", terminationReason?: string | undefined) => TerminateTaskDef;
3250
+ declare const terminateTask: (taskReferenceName: string, status: "COMPLETED" | "FAILED", terminationReason?: string) => TerminateTaskDef;
2076
3251
 
2077
- declare const waitTaskDuration: (taskReferenceName: string, duration: string) => WaitTaskDef;
2078
- declare const waitTaskUntil: (taskReferenceName: string, until: string) => WaitTaskDef;
3252
+ declare const waitTaskDuration: (taskReferenceName: string, duration: string, optional?: boolean) => WaitTaskDef;
3253
+ declare const waitTaskUntil: (taskReferenceName: string, until: string, optional?: boolean) => WaitTaskDef;
2079
3254
 
2080
- declare const workflow: (name: string, tasks: TaskDefTypes[]) => WorkflowDef;
3255
+ declare const workflow: (name: string, tasks: TaskDefTypes[]) => WorkflowDef$1;
2081
3256
 
2082
3257
  /**
2083
3258
  * Takes an optional partial SimpleTaskDef
@@ -2097,29 +3272,27 @@ declare const generateSimpleTask: (overrides?: Partial<SimpleTaskDef>) => Simple
2097
3272
  */
2098
3273
  declare const generateEventTask: (overrides?: Partial<EventTaskDef>) => EventTaskDef;
2099
3274
 
2100
- declare type TaskDefTypesGen = SimpleTaskDef | DoWhileTaskDefGen | EventTaskDef | ForkJoinTaskDefGen | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDefGen | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDefGen | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
2101
- interface WorkflowDefGen extends Omit<WorkflowDef, "tasks"> {
3275
+ type TaskDefTypesGen = SimpleTaskDef | DoWhileTaskDefGen | EventTaskDef | ForkJoinTaskDefGen | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDefGen | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDefGen | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
3276
+ interface WorkflowDefGen extends Omit<WorkflowDef$1, "tasks"> {
2102
3277
  tasks: Partial<TaskDefTypesGen>[];
2103
3278
  }
2104
- declare type ForkJoinTaskDefGen = Omit<ForkJoinTaskDef, "forkTasks"> & {
2105
- forkTasks: Array<Array<Partial<TaskDefTypesGen>>>;
3279
+ type ForkJoinTaskDefGen = Omit<ForkJoinTaskDef, "forkTasks"> & {
3280
+ forkTasks: Partial<TaskDefTypesGen>[][];
2106
3281
  };
2107
- declare type SwitchTaskDefGen = Omit<SwitchTaskDef, "decisionCases" | "defaultCase"> & {
3282
+ type SwitchTaskDefGen = Omit<SwitchTaskDef, "decisionCases" | "defaultCase"> & {
2108
3283
  decisionCases: Record<string, Partial<TaskDefTypesGen>[]>;
2109
3284
  defaultCase: Partial<TaskDefTypesGen>[];
2110
3285
  };
2111
- declare type DoWhileTaskDefGen = Omit<DoWhileTaskDef, "loopOver"> & {
3286
+ type DoWhileTaskDefGen = Omit<DoWhileTaskDef, "loopOver"> & {
2112
3287
  loopOver: Partial<TaskDefTypesGen>[];
2113
3288
  };
2114
3289
  interface InlineTaskInputParametersGen extends Omit<InlineTaskInputParameters, "expression"> {
2115
- expression: string | Function;
3290
+ expression: string | ((...args: never[]) => unknown);
2116
3291
  }
2117
3292
  interface InlineTaskDefGen extends Omit<InlineTaskDef, "inputParameters"> {
2118
3293
  inputParameters: InlineTaskInputParametersGen;
2119
3294
  }
2120
- declare type NestedTaskMapper = {
2121
- (tasks: Partial<TaskDefTypesGen>[]): TaskDefTypes[];
2122
- };
3295
+ type NestedTaskMapper = (tasks: Partial<TaskDefTypesGen>[]) => TaskDefTypes[];
2123
3296
 
2124
3297
  declare const generateJoinTask: (overrides?: Partial<JoinTaskDef>) => JoinTaskDef;
2125
3298
 
@@ -2237,8 +3410,8 @@ declare const generateDoWhileTask: (overrides?: Partial<DoWhileTaskDefGen>, nest
2237
3410
  declare const generateForkJoinTask: (overrides?: Partial<ForkJoinTaskDefGen>, nestedMapper?: NestedTaskMapper) => ForkJoinTaskDef;
2238
3411
 
2239
3412
  declare class SchedulerClient {
2240
- readonly _client: ConductorClient;
2241
- constructor(client: ConductorClient);
3413
+ readonly _client: Client;
3414
+ constructor(client: Client);
2242
3415
  /**
2243
3416
  * Create or update a schedule for a specified workflow with a corresponding start workflow request
2244
3417
  * @param requestBody
@@ -2255,13 +3428,13 @@ declare class SchedulerClient {
2255
3428
  * @param query
2256
3429
  * @returns SearchResultWorkflowScheduleExecutionModel
2257
3430
  */
2258
- search(start: number, size: number, sort: string | undefined, freeText: string, query: string): Promise<SearchResultWorkflowScheduleExecutionModel>;
3431
+ search(start: number, size?: number, sort?: string, freeText?: string, query?: string): Promise<SearchResultWorkflowScheduleExecutionModel>;
2259
3432
  /**
2260
3433
  * Get an existing schedule by name
2261
3434
  * @param name
2262
- * @returns SaveScheduleRequest
3435
+ * @returns WorkflowSchedule
2263
3436
  */
2264
- getSchedule(name: string): Promise<SaveScheduleRequest>;
3437
+ getSchedule(name: string): Promise<WorkflowSchedule>;
2265
3438
  /**
2266
3439
  * Pauses an existing schedule by name
2267
3440
  * @param name
@@ -2285,9 +3458,9 @@ declare class SchedulerClient {
2285
3458
  /**
2286
3459
  * Get all existing workflow schedules and optionally filter by workflow name
2287
3460
  * @param workflowName
2288
- * @returns Array<WorkflowSchedule>
3461
+ * @returns Array<WorkflowScheduleModel>
2289
3462
  */
2290
- getAllSchedules(workflowName?: string): Promise<Array<WorkflowSchedule>>;
3463
+ getAllSchedules(workflowName?: string): Promise<WorkflowScheduleModel[]>;
2291
3464
  /**
2292
3465
  * Get list of the next x (default 3, max 5) execution times for a scheduler
2293
3466
  * @param cronExpression
@@ -2297,7 +3470,7 @@ declare class SchedulerClient {
2297
3470
  * @returns number OK
2298
3471
  * @throws ApiError
2299
3472
  */
2300
- getNextFewSchedules(cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number): Promise<Array<number[]>>;
3473
+ getNextFewSchedules(cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number): Promise<number[]>;
2301
3474
  /**
2302
3475
  * Pause all scheduling in a single conductor server instance (for debugging only)
2303
3476
  * @returns any OK
@@ -2319,8 +3492,8 @@ declare class SchedulerClient {
2319
3492
  }
2320
3493
 
2321
3494
  declare class TaskClient {
2322
- readonly _client: ConductorClient;
2323
- constructor(client: ConductorClient);
3495
+ readonly _client: Client;
3496
+ constructor(client: Client);
2324
3497
  /**
2325
3498
  * Searches for existing scheduler execution based on below parameters
2326
3499
  *
@@ -2331,7 +3504,7 @@ declare class TaskClient {
2331
3504
  * @param query
2332
3505
  * @returns SearchResultWorkflowScheduleExecutionModel
2333
3506
  */
2334
- search(start: number, size: number, sort: string | undefined, freeText: string, query: string): Promise<SearchResultTask>;
3507
+ search(start: number, size: number, sort: string | undefined, freeText: string, query: string): Promise<SearchResultTaskSummary>;
2335
3508
  /**
2336
3509
  * Get an existing schedule by Id
2337
3510
  * @param taskId
@@ -2348,12 +3521,12 @@ declare class TaskClient {
2348
3521
  * @param workerId
2349
3522
  * @returns
2350
3523
  */
2351
- updateTaskResult(workflowId: string, taskReferenceName: string, status: TaskResultStatus, outputData: Record<string, unknown>): Promise<TaskResult>;
3524
+ updateTaskResult(workflowId: string, taskRefName: string, status: TaskResultStatus, outputData: Record<string, unknown>): Promise<string>;
2352
3525
  }
2353
3526
 
2354
3527
  declare class TemplateClient {
2355
- readonly _client: ConductorClient;
2356
- constructor(client: ConductorClient);
3528
+ readonly _client: Client;
3529
+ constructor(client: Client);
2357
3530
  /**
2358
3531
  * Register a new human task template
2359
3532
  *
@@ -2364,8 +3537,8 @@ declare class TemplateClient {
2364
3537
  }
2365
3538
 
2366
3539
  declare class MetadataClient {
2367
- readonly _client: ConductorClient;
2368
- constructor(client: ConductorClient);
3540
+ readonly _client: Client;
3541
+ constructor(client: Client);
2369
3542
  /**
2370
3543
  * Unregisters an existing task definition by name
2371
3544
  *
@@ -2379,14 +3552,36 @@ declare class MetadataClient {
2379
3552
  * @param taskDef
2380
3553
  * @returns
2381
3554
  */
2382
- registerTask(taskDef: TaskDef): Promise<void>;
3555
+ registerTask(taskDef: ExtendedTaskDef): Promise<void>;
3556
+ /**
3557
+ * Registers multiple task definitions (array)
3558
+ *
3559
+ * @param taskDefs
3560
+ * @returns
3561
+ */
3562
+ registerTasks(taskDefs: ExtendedTaskDef[]): Promise<void>;
2383
3563
  /**
2384
3564
  * Update an existing task definition
2385
3565
  *
2386
3566
  * @param taskDef
2387
3567
  * @returns
2388
3568
  */
2389
- updateTask(taskDef: TaskDef): Promise<void>;
3569
+ updateTask(taskDef: ExtendedTaskDef): Promise<void>;
3570
+ /**
3571
+ * Get an existing task definition
3572
+ *
3573
+ * @param taskName
3574
+ * @returns
3575
+ */
3576
+ getTask(taskName: string): Promise<TaskDef>;
3577
+ /**
3578
+ * Creates or updates (overwrite: true) a workflow definition
3579
+ *
3580
+ * @param workflowDef
3581
+ * @param overwrite
3582
+ * @returns
3583
+ */
3584
+ registerWorkflowDef(workflowDef: ExtendedWorkflowDef, overwrite?: boolean): Promise<void>;
2390
3585
  /**
2391
3586
  * Creates or updates (overwrite: true) a workflow definition
2392
3587
  *
@@ -2394,42 +3589,34 @@ declare class MetadataClient {
2394
3589
  * @param overwrite
2395
3590
  * @returns
2396
3591
  */
2397
- registerWorkflowDef(workflowDef: WorkflowDef$1, overwrite?: boolean): any;
3592
+ getWorkflowDef(name: string, version?: number, metadata?: boolean): Promise<WorkflowDef$1>;
3593
+ /**
3594
+ * Unregister (overwrite: true) a workflow definition
3595
+ *
3596
+ * @param workflowDef
3597
+ * @param overwrite
3598
+ * @returns
3599
+ */
3600
+ unregisterWorkflow(workflowName: string, version?: number): Promise<void>;
2398
3601
  }
2399
3602
 
2400
- declare type FetchFn<T = RequestInit, R extends {
2401
- json: () => Promise<any>;
2402
- } = Response> = (input: RequestInfo, init?: T) => Promise<R>;
2403
- declare type OrkesApiConfig = ConductorClientAPIConfig & GenerateTokenRequest;
3603
+ interface OrkesApiConfig {
3604
+ serverUrl?: string;
3605
+ keyId?: string;
3606
+ keySecret?: string;
3607
+ refreshTokenInterval?: number;
3608
+ useEnvVars?: boolean;
3609
+ maxHttp2Connections?: number;
3610
+ }
2404
3611
 
2405
3612
  /**
2406
- * Takes a config with keyId and keySecret returns a promise with an instance of ConductorClient
3613
+ * Takes a config with keyId and keySecret returns a promise with an instance of Client
2407
3614
  *
2408
- * @param config ConductorClientConfig with keyId and keySecret
2409
- * @param requestHandler (optional) ConductorHttpRequest handler
3615
+ * @param config (optional) OrkesApiConfig with keyId and keySecret
3616
+ * @param customFetch (optional) custom fetch function
3617
+ * @param requestHandler DEPRECATED! (optional) ConductorHttpRequest handler, replaced with customFetch
2410
3618
  * @returns
2411
3619
  */
2412
- declare const orkesConductorClient: (config?: Partial<OrkesApiConfig> | undefined, requestHandler?: ConductorHttpRequest) => Promise<ConductorClient>;
2413
-
2414
- declare class AuthConductorClient extends ConductorClient {
2415
- intervalId?: NodeJS.Timeout;
2416
- constructor(config?: Partial<ConductorClientAPIConfig>, requestHandler?: ConductorHttpRequest);
2417
- /**
2418
- * Stops the interval that refreshes the token
2419
- */
2420
- stop(): void;
2421
- }
2422
- declare const baseOrkesConductorClient: <T = RequestInit, R extends {
2423
- json: () => Promise<any>;
2424
- } = Response>(fetchFn: FetchFn<T, R>, baseRequestHandler?: ConductorHttpRequest) => (config?: Partial<OrkesApiConfig> | undefined, requestHandler?: ConductorHttpRequest) => Promise<ConductorClient>;
2425
-
2426
- /**
2427
- * Request method
2428
- * @param config The OpenAPI configuration object
2429
- * @param options The request options from the service
2430
- * @returns CancelablePromise<T>
2431
- * @throws ApiError
2432
- */
2433
- declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions, fetchFn?: FetchFn) => CancelablePromise<T>;
3620
+ declare const orkesConductorClient: (config?: OrkesApiConfig, customFetch?: typeof fetch) => Promise<Client>;
2434
3621
 
2435
- export { Action, ApiError, ApiRequestOptions, ApiResult, AuthConductorClient, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorClientAPIConfig, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FetchFn, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskAssignment, HumanTaskDefinition, HumanTaskEntry, HumanTaskSearch, HumanTaskSearchResult, HumanTaskTemplate, HumanTaskTrigger, HumanTaskUser, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response$1 as Response, RunnerArgs, SaveScheduleRequest, SchedulerClient, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskClient, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskFinderPredicate, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, TemplateClient, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, UserFormTemplate, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, baseOrkesConductorClient, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, request, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
3622
+ export { type Action, ApiError, type ApiRequestOptions, type ApiResult, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, type EventHandler, type EventTaskDef, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type RerunWorkflowRequest, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };