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