@azure-rest/purview-workflow 1.0.0-beta.1

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.
@@ -0,0 +1,805 @@
1
+ ## API Report File for "@azure-rest/purview-workflow"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { Client } from '@azure-rest/core-client';
8
+ import { ClientOptions } from '@azure-rest/core-client';
9
+ import { HttpResponse } from '@azure-rest/core-client';
10
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
11
+ import { PathUncheckedResponse } from '@azure-rest/core-client';
12
+ import { RequestParameters } from '@azure-rest/core-client';
13
+ import { StreamableMethod } from '@azure-rest/core-client';
14
+ import { TokenCredential } from '@azure/core-auth';
15
+
16
+ // @public
17
+ export interface ApprovalDetailOutput {
18
+ approvalType: "PendingOnAny" | "PendingOnAll";
19
+ approvers: Record<string, ApproverResponseOutput>;
20
+ status: "Pending" | "Approved" | "Rejected" | "Canceled";
21
+ }
22
+
23
+ // @public
24
+ export interface ApprovalOutput extends WorkflowTaskOutputParent {
25
+ approvalDetail?: ApprovalDetailOutput;
26
+ // (undocumented)
27
+ type: "Approval";
28
+ }
29
+
30
+ // @public (undocumented)
31
+ export interface ApprovalResponseComment {
32
+ comment?: string;
33
+ }
34
+
35
+ // @public (undocumented)
36
+ export interface ApproveApprovalTask {
37
+ post(options: ApproveApprovalTaskParameters): StreamableMethod<ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse>;
38
+ }
39
+
40
+ // @public
41
+ export interface ApproveApprovalTask200Response extends HttpResponse {
42
+ // (undocumented)
43
+ body: Record<string, unknown>;
44
+ // (undocumented)
45
+ status: "200";
46
+ }
47
+
48
+ // @public (undocumented)
49
+ export interface ApproveApprovalTaskBodyParam {
50
+ body: ApprovalResponseComment;
51
+ }
52
+
53
+ // @public
54
+ export interface ApproveApprovalTaskDefaultResponse extends HttpResponse {
55
+ // (undocumented)
56
+ body: ErrorResponseOutput;
57
+ // (undocumented)
58
+ status: string;
59
+ }
60
+
61
+ // @public (undocumented)
62
+ export interface ApproveApprovalTaskMediaTypesParam {
63
+ contentType?: "application/json";
64
+ }
65
+
66
+ // @public (undocumented)
67
+ export type ApproveApprovalTaskParameters = ApproveApprovalTaskMediaTypesParam & ApproveApprovalTaskBodyParam & RequestParameters;
68
+
69
+ // @public
70
+ export interface ApproverResponseOutput {
71
+ comment?: string;
72
+ reply: "Approved" | "Rejected" | "Pending";
73
+ responseTime?: string;
74
+ }
75
+
76
+ // @public (undocumented)
77
+ export interface CancelWorkflowRun {
78
+ post(options: CancelWorkflowRunParameters): StreamableMethod<CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse>;
79
+ }
80
+
81
+ // @public
82
+ export interface CancelWorkflowRun200Response extends HttpResponse {
83
+ // (undocumented)
84
+ body: Record<string, unknown>;
85
+ // (undocumented)
86
+ status: "200";
87
+ }
88
+
89
+ // @public (undocumented)
90
+ export interface CancelWorkflowRunBodyParam {
91
+ body: WorkflowRunCancelRequest;
92
+ }
93
+
94
+ // @public
95
+ export interface CancelWorkflowRunDefaultResponse extends HttpResponse {
96
+ // (undocumented)
97
+ body: ErrorResponseOutput;
98
+ // (undocumented)
99
+ status: string;
100
+ }
101
+
102
+ // @public (undocumented)
103
+ export interface CancelWorkflowRunMediaTypesParam {
104
+ contentType?: "application/json";
105
+ }
106
+
107
+ // @public (undocumented)
108
+ export type CancelWorkflowRunParameters = CancelWorkflowRunMediaTypesParam & CancelWorkflowRunBodyParam & RequestParameters;
109
+
110
+ // @public
111
+ function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewWorkflowClient;
112
+ export default createClient;
113
+
114
+ // @public
115
+ export interface CreateOrReplaceWorkflow200Response extends HttpResponse {
116
+ // (undocumented)
117
+ body: WorkflowOutput;
118
+ // (undocumented)
119
+ status: "200";
120
+ }
121
+
122
+ // @public (undocumented)
123
+ export interface CreateOrReplaceWorkflowBodyParam {
124
+ body: WorkflowCreateOrUpdateCommand;
125
+ }
126
+
127
+ // @public
128
+ export interface CreateOrReplaceWorkflowDefaultResponse extends HttpResponse {
129
+ // (undocumented)
130
+ body: ErrorResponseOutput;
131
+ // (undocumented)
132
+ status: string;
133
+ }
134
+
135
+ // @public (undocumented)
136
+ export interface CreateOrReplaceWorkflowMediaTypesParam {
137
+ contentType?: "application/json";
138
+ }
139
+
140
+ // @public (undocumented)
141
+ export type CreateOrReplaceWorkflowParameters = CreateOrReplaceWorkflowMediaTypesParam & CreateOrReplaceWorkflowBodyParam & RequestParameters;
142
+
143
+ // @public
144
+ export interface DeleteWorkflow204Response extends HttpResponse {
145
+ // (undocumented)
146
+ status: "204";
147
+ }
148
+
149
+ // @public
150
+ export interface DeleteWorkflowDefaultResponse extends HttpResponse {
151
+ // (undocumented)
152
+ body: ErrorResponseOutput;
153
+ // (undocumented)
154
+ status: string;
155
+ }
156
+
157
+ // @public (undocumented)
158
+ export type DeleteWorkflowParameters = RequestParameters;
159
+
160
+ // @public
161
+ export interface ErrorModelOutput {
162
+ code: string;
163
+ details?: Array<ErrorModelOutput>;
164
+ message: string;
165
+ target?: string;
166
+ }
167
+
168
+ // @public
169
+ export interface ErrorResponseOutput {
170
+ error: ErrorModelOutput;
171
+ }
172
+
173
+ // @public
174
+ export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
175
+
176
+ // @public
177
+ export type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
178
+ page: TPage;
179
+ nextPageLink?: string;
180
+ }>;
181
+
182
+ // @public (undocumented)
183
+ export interface GetWorkflow {
184
+ delete(options?: DeleteWorkflowParameters): StreamableMethod<DeleteWorkflow204Response | DeleteWorkflowDefaultResponse>;
185
+ get(options?: GetWorkflowParameters): StreamableMethod<GetWorkflow200Response | GetWorkflowDefaultResponse>;
186
+ put(options: CreateOrReplaceWorkflowParameters): StreamableMethod<CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse>;
187
+ }
188
+
189
+ // @public
190
+ export interface GetWorkflow200Response extends HttpResponse {
191
+ // (undocumented)
192
+ body: WorkflowOutput;
193
+ // (undocumented)
194
+ status: "200";
195
+ }
196
+
197
+ // @public
198
+ export interface GetWorkflowDefaultResponse extends HttpResponse {
199
+ // (undocumented)
200
+ body: ErrorResponseOutput;
201
+ // (undocumented)
202
+ status: string;
203
+ }
204
+
205
+ // @public (undocumented)
206
+ export type GetWorkflowParameters = RequestParameters;
207
+
208
+ // @public (undocumented)
209
+ export interface GetWorkflowRun {
210
+ get(options?: GetWorkflowRunParameters): StreamableMethod<GetWorkflowRun200Response | GetWorkflowRunDefaultResponse>;
211
+ }
212
+
213
+ // @public
214
+ export interface GetWorkflowRun200Response extends HttpResponse {
215
+ // (undocumented)
216
+ body: WorkflowRunOutput;
217
+ // (undocumented)
218
+ status: "200";
219
+ }
220
+
221
+ // @public
222
+ export interface GetWorkflowRunDefaultResponse extends HttpResponse {
223
+ // (undocumented)
224
+ body: ErrorResponseOutput;
225
+ // (undocumented)
226
+ status: string;
227
+ }
228
+
229
+ // @public (undocumented)
230
+ export type GetWorkflowRunParameters = RequestParameters;
231
+
232
+ // @public (undocumented)
233
+ export interface GetWorkflowTask {
234
+ get(options?: GetWorkflowTaskParameters): StreamableMethod<GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse>;
235
+ }
236
+
237
+ // @public
238
+ export interface GetWorkflowTask200Response extends HttpResponse {
239
+ // (undocumented)
240
+ body: WorkflowTaskOutput;
241
+ // (undocumented)
242
+ status: "200";
243
+ }
244
+
245
+ // @public
246
+ export interface GetWorkflowTaskDefaultResponse extends HttpResponse {
247
+ // (undocumented)
248
+ body: ErrorResponseOutput;
249
+ // (undocumented)
250
+ status: string;
251
+ }
252
+
253
+ // @public (undocumented)
254
+ export type GetWorkflowTaskParameters = RequestParameters;
255
+
256
+ // @public (undocumented)
257
+ export function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response is ListWorkflowsDefaultResponse;
258
+
259
+ // @public (undocumented)
260
+ export function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response is GetWorkflowDefaultResponse;
261
+
262
+ // @public (undocumented)
263
+ export function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response is CreateOrReplaceWorkflowDefaultResponse;
264
+
265
+ // @public (undocumented)
266
+ export function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response is DeleteWorkflowDefaultResponse;
267
+
268
+ // @public (undocumented)
269
+ export function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response is SubmitUserRequestsDefaultResponse;
270
+
271
+ // @public (undocumented)
272
+ export function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response is ListWorkflowRunsDefaultResponse;
273
+
274
+ // @public (undocumented)
275
+ export function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response is GetWorkflowRunDefaultResponse;
276
+
277
+ // @public (undocumented)
278
+ export function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response is CancelWorkflowRunDefaultResponse;
279
+
280
+ // @public (undocumented)
281
+ export function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response is ListWorkflowTasksDefaultResponse;
282
+
283
+ // @public (undocumented)
284
+ export function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response is GetWorkflowTaskDefaultResponse;
285
+
286
+ // @public (undocumented)
287
+ export function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response is ApproveApprovalTaskDefaultResponse;
288
+
289
+ // @public (undocumented)
290
+ export function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response is RejectApprovalTaskDefaultResponse;
291
+
292
+ // @public (undocumented)
293
+ export function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response is ReassignWorkflowTaskDefaultResponse;
294
+
295
+ // @public (undocumented)
296
+ export function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response is UpdateTaskStatusDefaultResponse;
297
+
298
+ // @public (undocumented)
299
+ export interface ListWorkflowRuns {
300
+ get(options?: ListWorkflowRunsParameters): StreamableMethod<ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse>;
301
+ }
302
+
303
+ // @public
304
+ export interface ListWorkflowRuns200Response extends HttpResponse {
305
+ // (undocumented)
306
+ body: WorkflowRunListOutput;
307
+ // (undocumented)
308
+ status: "200";
309
+ }
310
+
311
+ // @public
312
+ export interface ListWorkflowRunsDefaultResponse extends HttpResponse {
313
+ // (undocumented)
314
+ body: ErrorResponseOutput;
315
+ // (undocumented)
316
+ status: string;
317
+ }
318
+
319
+ // @public (undocumented)
320
+ export type ListWorkflowRunsParameters = ListWorkflowRunsQueryParam & RequestParameters;
321
+
322
+ // @public (undocumented)
323
+ export interface ListWorkflowRunsQueryParam {
324
+ // (undocumented)
325
+ queryParameters?: ListWorkflowRunsQueryParamProperties;
326
+ }
327
+
328
+ // @public (undocumented)
329
+ export interface ListWorkflowRunsQueryParamProperties {
330
+ maxpagesize?: number;
331
+ orderby?: "status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc";
332
+ runStatuses?: Array<"InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history">;
333
+ timeWindow?: "1d" | "7d" | "30d" | "90d";
334
+ workflowIds?: Array<string>;
335
+ }
336
+
337
+ // @public (undocumented)
338
+ export interface ListWorkflows {
339
+ get(options?: ListWorkflowsParameters): StreamableMethod<ListWorkflows200Response | ListWorkflowsDefaultResponse>;
340
+ }
341
+
342
+ // @public
343
+ export interface ListWorkflows200Response extends HttpResponse {
344
+ // (undocumented)
345
+ body: WorkflowMetadataListOutput;
346
+ // (undocumented)
347
+ status: "200";
348
+ }
349
+
350
+ // @public
351
+ export interface ListWorkflowsDefaultResponse extends HttpResponse {
352
+ // (undocumented)
353
+ body: ErrorResponseOutput;
354
+ // (undocumented)
355
+ status: string;
356
+ }
357
+
358
+ // @public (undocumented)
359
+ export type ListWorkflowsParameters = RequestParameters;
360
+
361
+ // @public (undocumented)
362
+ export interface ListWorkflowTasks {
363
+ get(options?: ListWorkflowTasksParameters): StreamableMethod<ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse>;
364
+ }
365
+
366
+ // @public
367
+ export interface ListWorkflowTasks200Response extends HttpResponse {
368
+ // (undocumented)
369
+ body: TasksListOutput;
370
+ // (undocumented)
371
+ status: "200";
372
+ }
373
+
374
+ // @public
375
+ export interface ListWorkflowTasksDefaultResponse extends HttpResponse {
376
+ // (undocumented)
377
+ body: ErrorResponseOutput;
378
+ // (undocumented)
379
+ status: string;
380
+ }
381
+
382
+ // @public (undocumented)
383
+ export type ListWorkflowTasksParameters = ListWorkflowTasksQueryParam & RequestParameters;
384
+
385
+ // @public (undocumented)
386
+ export interface ListWorkflowTasksQueryParam {
387
+ // (undocumented)
388
+ queryParameters?: ListWorkflowTasksQueryParamProperties;
389
+ }
390
+
391
+ // @public (undocumented)
392
+ export interface ListWorkflowTasksQueryParamProperties {
393
+ maxpagesize?: number;
394
+ orderby?: "status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc";
395
+ taskStatuses?: Array<"InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history">;
396
+ taskTypes?: Array<"Approval" | "SimpleTask" | "approval" | "simpleTask">;
397
+ timeWindow?: "1d" | "7d" | "30d" | "90d";
398
+ viewMode?: string;
399
+ workflowIds?: Array<string>;
400
+ workflowNameKeyword?: string;
401
+ }
402
+
403
+ // @public
404
+ export interface Operation {
405
+ payload: Record<string, unknown>;
406
+ type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
407
+ }
408
+
409
+ // @public
410
+ export function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
411
+
412
+ // @public
413
+ export type PaginateReturn<TResult> = TResult extends {
414
+ body: {
415
+ value?: infer TPage;
416
+ };
417
+ } ? GetArrayType<TPage> : Array<unknown>;
418
+
419
+ // @public
420
+ export interface PagingOptions<TResponse> {
421
+ customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
422
+ }
423
+
424
+ // @public (undocumented)
425
+ export type PurviewWorkflowClient = Client & {
426
+ path: Routes;
427
+ };
428
+
429
+ // @public
430
+ export interface ReassignCommand {
431
+ reassignments?: Array<ReassignCommandReassignmentsItem>;
432
+ }
433
+
434
+ // @public (undocumented)
435
+ export interface ReassignCommandReassignmentsItem {
436
+ reassignFrom: string;
437
+ reassignTo: string;
438
+ }
439
+
440
+ // @public (undocumented)
441
+ export interface ReassignWorkflowTask {
442
+ post(options: ReassignWorkflowTaskParameters): StreamableMethod<ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse>;
443
+ }
444
+
445
+ // @public
446
+ export interface ReassignWorkflowTask200Response extends HttpResponse {
447
+ // (undocumented)
448
+ body: Record<string, unknown>;
449
+ // (undocumented)
450
+ status: "200";
451
+ }
452
+
453
+ // @public (undocumented)
454
+ export interface ReassignWorkflowTaskBodyParam {
455
+ body: ReassignCommand;
456
+ }
457
+
458
+ // @public
459
+ export interface ReassignWorkflowTaskDefaultResponse extends HttpResponse {
460
+ // (undocumented)
461
+ body: ErrorResponseOutput;
462
+ // (undocumented)
463
+ status: string;
464
+ }
465
+
466
+ // @public (undocumented)
467
+ export interface ReassignWorkflowTaskMediaTypesParam {
468
+ contentType?: "application/json";
469
+ }
470
+
471
+ // @public (undocumented)
472
+ export type ReassignWorkflowTaskParameters = ReassignWorkflowTaskMediaTypesParam & ReassignWorkflowTaskBodyParam & RequestParameters;
473
+
474
+ // @public (undocumented)
475
+ export interface RejectApprovalTask {
476
+ post(options: RejectApprovalTaskParameters): StreamableMethod<RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse>;
477
+ }
478
+
479
+ // @public
480
+ export interface RejectApprovalTask200Response extends HttpResponse {
481
+ // (undocumented)
482
+ body: Record<string, unknown>;
483
+ // (undocumented)
484
+ status: "200";
485
+ }
486
+
487
+ // @public (undocumented)
488
+ export interface RejectApprovalTaskBodyParam {
489
+ body: ApprovalResponseComment;
490
+ }
491
+
492
+ // @public
493
+ export interface RejectApprovalTaskDefaultResponse extends HttpResponse {
494
+ // (undocumented)
495
+ body: ErrorResponseOutput;
496
+ // (undocumented)
497
+ status: string;
498
+ }
499
+
500
+ // @public (undocumented)
501
+ export interface RejectApprovalTaskMediaTypesParam {
502
+ contentType?: "application/json";
503
+ }
504
+
505
+ // @public (undocumented)
506
+ export type RejectApprovalTaskParameters = RejectApprovalTaskMediaTypesParam & RejectApprovalTaskBodyParam & RequestParameters;
507
+
508
+ // @public (undocumented)
509
+ export interface Routes {
510
+ (path: "/workflows"): ListWorkflows;
511
+ (path: "/workflows/{workflowId}", workflowId: string): GetWorkflow;
512
+ (path: "/userrequests"): SubmitUserRequests;
513
+ (path: "/workflowruns"): ListWorkflowRuns;
514
+ (path: "/workflowruns/{workflowRunId}", workflowRunId: string): GetWorkflowRun;
515
+ (path: "/workflowruns/{workflowRunId}/cancel", workflowRunId: string): CancelWorkflowRun;
516
+ (path: "/workflowtasks"): ListWorkflowTasks;
517
+ (path: "/workflowtasks/{taskId}", taskId: string): GetWorkflowTask;
518
+ (path: "/workflowtasks/{taskId}/approve-approval", taskId: string): ApproveApprovalTask;
519
+ (path: "/workflowtasks/{taskId}/reject-approval", taskId: string): RejectApprovalTask;
520
+ (path: "/workflowtasks/{taskId}/reassign", taskId: string): ReassignWorkflowTask;
521
+ (path: "/workflowtasks/{taskId}/change-task-status", taskId: string): UpdateTaskStatus;
522
+ }
523
+
524
+ // @public
525
+ export interface SimpleTaskDetailOutput {
526
+ assignedTo: Array<string>;
527
+ // (undocumented)
528
+ changeHistory: Array<Record<string, unknown>>;
529
+ status: "NotStarted" | "InProgress" | "Completed" | "Canceled";
530
+ taskBody: string;
531
+ }
532
+
533
+ // @public
534
+ export interface SimpleTaskOutput extends WorkflowTaskOutputParent {
535
+ taskDetail?: SimpleTaskDetailOutput;
536
+ // (undocumented)
537
+ type: "SimpleTask";
538
+ }
539
+
540
+ // @public (undocumented)
541
+ export interface SubmitUserRequests {
542
+ post(options: SubmitUserRequestsParameters): StreamableMethod<SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse>;
543
+ }
544
+
545
+ // @public
546
+ export interface SubmitUserRequests200Response extends HttpResponse {
547
+ // (undocumented)
548
+ body: UserRequestResponseOutput;
549
+ // (undocumented)
550
+ status: "200";
551
+ }
552
+
553
+ // @public (undocumented)
554
+ export interface SubmitUserRequestsBodyParam {
555
+ body: UserRequestPayload;
556
+ }
557
+
558
+ // @public
559
+ export interface SubmitUserRequestsDefaultResponse extends HttpResponse {
560
+ // (undocumented)
561
+ body: ErrorResponseOutput;
562
+ // (undocumented)
563
+ status: string;
564
+ }
565
+
566
+ // @public (undocumented)
567
+ export interface SubmitUserRequestsMediaTypesParam {
568
+ contentType?: "application/json";
569
+ }
570
+
571
+ // @public (undocumented)
572
+ export type SubmitUserRequestsParameters = SubmitUserRequestsMediaTypesParam & SubmitUserRequestsBodyParam & RequestParameters;
573
+
574
+ // @public
575
+ export interface TaskPayloadOutput {
576
+ payload?: Record<string, unknown>;
577
+ targetValue: string;
578
+ type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
579
+ }
580
+
581
+ // @public (undocumented)
582
+ export interface TasksListOutput {
583
+ nextLink?: string;
584
+ value: Array<WorkflowTaskOutput>;
585
+ }
586
+
587
+ // @public (undocumented)
588
+ export interface TaskUpdateCommand {
589
+ comment?: string;
590
+ newStatus: "NotStarted" | "InProgress" | "Completed" | "Canceled";
591
+ }
592
+
593
+ // @public
594
+ export interface Trigger {
595
+ // (undocumented)
596
+ type: "when_term_creation_is_requested" | "when_term_deletion_is_requested" | "when_term_update_is_requested" | "when_terms_import_is_requested" | "when_data_access_grant_is_requested" | "when_asset_update_is_requested";
597
+ underCollection?: string;
598
+ underGlossary?: string;
599
+ underGlossaryHierarchy?: string;
600
+ }
601
+
602
+ // @public
603
+ export interface TriggerOutput {
604
+ // (undocumented)
605
+ type: "when_term_creation_is_requested" | "when_term_deletion_is_requested" | "when_term_update_is_requested" | "when_terms_import_is_requested" | "when_data_access_grant_is_requested" | "when_asset_update_is_requested";
606
+ underCollection?: string;
607
+ underGlossary?: string;
608
+ underGlossaryHierarchy?: string;
609
+ }
610
+
611
+ // @public (undocumented)
612
+ export interface UpdateTaskStatus {
613
+ post(options: UpdateTaskStatusParameters): StreamableMethod<UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse>;
614
+ }
615
+
616
+ // @public
617
+ export interface UpdateTaskStatus200Response extends HttpResponse {
618
+ // (undocumented)
619
+ body: Record<string, unknown>;
620
+ // (undocumented)
621
+ status: "200";
622
+ }
623
+
624
+ // @public (undocumented)
625
+ export interface UpdateTaskStatusBodyParam {
626
+ body: TaskUpdateCommand;
627
+ }
628
+
629
+ // @public
630
+ export interface UpdateTaskStatusDefaultResponse extends HttpResponse {
631
+ // (undocumented)
632
+ body: ErrorResponseOutput;
633
+ // (undocumented)
634
+ status: string;
635
+ }
636
+
637
+ // @public (undocumented)
638
+ export interface UpdateTaskStatusMediaTypesParam {
639
+ contentType?: "application/json";
640
+ }
641
+
642
+ // @public (undocumented)
643
+ export type UpdateTaskStatusParameters = UpdateTaskStatusMediaTypesParam & UpdateTaskStatusBodyParam & RequestParameters;
644
+
645
+ // @public (undocumented)
646
+ export interface UserRequestPayload {
647
+ comment?: string;
648
+ operations: Array<Operation>;
649
+ }
650
+
651
+ // @public
652
+ export interface UserRequestResponseOperationsItemOutput {
653
+ payload: Record<string, unknown>;
654
+ type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
655
+ // (undocumented)
656
+ workflowRunIds?: Array<string>;
657
+ }
658
+
659
+ // @public
660
+ export interface UserRequestResponseOutput {
661
+ comment?: string;
662
+ operations: Array<UserRequestResponseOperationsItemOutput>;
663
+ requestId: string;
664
+ requestor: string;
665
+ status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
666
+ }
667
+
668
+ // @public
669
+ export interface WorkflowCreateOrUpdateCommand {
670
+ actionDag?: Record<string, unknown>;
671
+ description: string;
672
+ isEnabled: boolean;
673
+ name: string;
674
+ triggers: Array<Trigger>;
675
+ }
676
+
677
+ // @public
678
+ export interface WorkflowMetadataListOutput {
679
+ nextLink?: string;
680
+ value: Array<WorkflowMetadataOutput>;
681
+ }
682
+
683
+ // @public
684
+ export interface WorkflowMetadataOutput {
685
+ createdBy?: string;
686
+ createdTime?: string;
687
+ description: string;
688
+ id: string;
689
+ isEnabled: boolean;
690
+ lastUpdateTime?: string;
691
+ name: string;
692
+ triggers: Array<TriggerOutput>;
693
+ updatedBy?: string;
694
+ }
695
+
696
+ // @public
697
+ export interface WorkflowOutput extends WorkflowMetadataOutput {
698
+ actionDag: Record<string, unknown>;
699
+ }
700
+
701
+ // @public (undocumented)
702
+ export interface WorkflowRunCancelRequest {
703
+ comment?: string;
704
+ }
705
+
706
+ // @public
707
+ export interface WorkflowRunDetailOutput {
708
+ actions: Record<string, unknown>;
709
+ runInput: Record<string, unknown>;
710
+ }
711
+
712
+ // @public (undocumented)
713
+ export interface WorkflowRunListOutput {
714
+ nextLink?: string;
715
+ value: Array<WorkflowRunMetadataOutput>;
716
+ }
717
+
718
+ // @public
719
+ export interface WorkflowRunMetadataOutput {
720
+ cancelComment?: string;
721
+ cancelTime?: string;
722
+ endTime?: string;
723
+ id: string;
724
+ requestor: string;
725
+ runPayload: WorkflowRunPayloadOutput;
726
+ startTime: string;
727
+ status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
728
+ userRequestId?: string;
729
+ workflowId: string;
730
+ }
731
+
732
+ // @public
733
+ export interface WorkflowRunOutput {
734
+ actionDag: Record<string, unknown>;
735
+ cancelComment?: string;
736
+ cancelTime?: string;
737
+ detail: WorkflowRunDetailOutput;
738
+ endTime?: string;
739
+ id?: string;
740
+ requestor?: string;
741
+ runPayload?: WorkflowRunRunPayloadOutput;
742
+ startTime?: string;
743
+ status?: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
744
+ userRequestId?: string;
745
+ workflowId?: string;
746
+ }
747
+
748
+ // @public
749
+ export interface WorkflowRunPayloadOutput {
750
+ targetValue: string;
751
+ type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
752
+ }
753
+
754
+ // @public
755
+ export interface WorkflowRunRunPayloadOutput {
756
+ payload: Record<string, unknown>;
757
+ targetValue: string;
758
+ type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
759
+ }
760
+
761
+ // @public (undocumented)
762
+ export interface WorkflowTaskExpiryInfoExpirySettingsOutput {
763
+ expireAfter: Record<string, unknown>;
764
+ // (undocumented)
765
+ notifyOnExpiration?: Array<string>;
766
+ }
767
+
768
+ // @public
769
+ export interface WorkflowTaskExpiryInfoOutput {
770
+ // (undocumented)
771
+ expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;
772
+ expiryTime: string;
773
+ lastExpiryNotificationTime?: string;
774
+ nextExpiryNotificationTime: string;
775
+ }
776
+
777
+ // @public
778
+ export type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;
779
+
780
+ // @public
781
+ export interface WorkflowTaskOutputParent {
782
+ createdTime: string;
783
+ expiryInfo?: WorkflowTaskExpiryInfoOutput;
784
+ id: string;
785
+ lastUpdateTime: string;
786
+ payload: TaskPayloadOutput;
787
+ reminderInfo?: WorkflowTaskReminderInfoOutput;
788
+ requestor: string;
789
+ title?: string;
790
+ // (undocumented)
791
+ type: "WorkflowTask" | "Approval" | "SimpleTask";
792
+ workflowId: string;
793
+ workflowRunId: string;
794
+ }
795
+
796
+ // @public
797
+ export interface WorkflowTaskReminderInfoOutput {
798
+ lastRemindTime?: string;
799
+ nextRemindTime: string;
800
+ reminderSettings: Record<string, unknown>;
801
+ }
802
+
803
+ // (No @packageDocumentation comment for this package)
804
+
805
+ ```