@azure-rest/purview-workflow 1.0.0-beta.1 → 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/LICENSE +4 -4
- package/README.md +65 -92
- package/dist/browser/clientDefinitions.d.ts +85 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +11 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +13 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +16 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/isUnexpected.js +5 -6
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/dist/browser/logger.js +5 -0
- package/dist/browser/logger.js.map +1 -0
- package/dist/browser/models.d.ts +70 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/{dist-esm/src → dist/browser}/models.js.map +1 -1
- package/dist/browser/outputModels.d.ts +325 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/{dist-esm/src → dist/browser}/outputModels.js.map +1 -1
- package/dist/browser/package.json +3 -0
- package/dist/browser/paginateHelper.d.ts +68 -0
- package/dist/browser/paginateHelper.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/paginateHelper.js +70 -3
- package/dist/browser/paginateHelper.js.map +1 -0
- package/dist/browser/parameters.d.ts +109 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/purviewWorkflow.d.ts +16 -0
- package/dist/browser/purviewWorkflow.d.ts.map +1 -0
- package/dist/browser/purviewWorkflow.js +45 -0
- package/dist/browser/purviewWorkflow.js.map +1 -0
- package/dist/browser/responses.d.ts +137 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +85 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +11 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +16 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +16 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +85 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +70 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +325 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/paginateHelper.d.ts +68 -0
- package/dist/commonjs/paginateHelper.d.ts.map +1 -0
- package/dist/commonjs/paginateHelper.js +140 -0
- package/dist/commonjs/paginateHelper.js.map +1 -0
- package/dist/commonjs/parameters.d.ts +109 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/purviewWorkflow.d.ts +16 -0
- package/dist/commonjs/purviewWorkflow.d.ts.map +1 -0
- package/dist/commonjs/purviewWorkflow.js +48 -0
- package/dist/commonjs/purviewWorkflow.js.map +1 -0
- package/dist/commonjs/responses.d.ts +137 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/clientDefinitions.d.ts +85 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +11 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +13 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +16 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +82 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +70 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +325 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/paginateHelper.d.ts +68 -0
- package/dist/esm/paginateHelper.d.ts.map +1 -0
- package/dist/esm/paginateHelper.js +137 -0
- package/dist/esm/paginateHelper.js.map +1 -0
- package/dist/esm/parameters.d.ts +109 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/purviewWorkflow.d.ts +16 -0
- package/dist/esm/purviewWorkflow.d.ts.map +1 -0
- package/dist/esm/purviewWorkflow.js +45 -0
- package/dist/esm/purviewWorkflow.js.map +1 -0
- package/dist/esm/responses.d.ts +137 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +85 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +11 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +13 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +16 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +82 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +70 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +325 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/paginateHelper.d.ts +68 -0
- package/dist/react-native/paginateHelper.d.ts.map +1 -0
- package/dist/react-native/paginateHelper.js +137 -0
- package/dist/react-native/paginateHelper.js.map +1 -0
- package/dist/react-native/parameters.d.ts +109 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/purviewWorkflow.d.ts +16 -0
- package/dist/react-native/purviewWorkflow.d.ts.map +1 -0
- package/dist/react-native/purviewWorkflow.js +45 -0
- package/dist/react-native/purviewWorkflow.js.map +1 -0
- package/dist/react-native/responses.d.ts +137 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/package.json +84 -76
- package/review/{purview-workflow.api.md → purview-workflow-node.api.md} +26 -20
- package/dist/index.js +0 -188
- package/dist/index.js.map +0 -1
- package/dist-esm/src/clientDefinitions.js +0 -4
- package/dist-esm/src/clientDefinitions.js.map +0 -1
- package/dist-esm/src/index.js +0 -13
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/isUnexpected.js.map +0 -1
- package/dist-esm/src/models.js +0 -4
- package/dist-esm/src/outputModels.js +0 -4
- package/dist-esm/src/paginateHelper.js.map +0 -1
- package/dist-esm/src/parameters.js +0 -4
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/purviewWorkflow.js +0 -27
- package/dist-esm/src/purviewWorkflow.js.map +0 -1
- package/dist-esm/src/responses.js +0 -4
- package/dist-esm/src/responses.js.map +0 -1
- package/types/purview-workflow.d.ts +0 -920
|
@@ -1,920 +0,0 @@
|
|
|
1
|
-
import { Client } from '@azure-rest/core-client';
|
|
2
|
-
import { ClientOptions } from '@azure-rest/core-client';
|
|
3
|
-
import { HttpResponse } from '@azure-rest/core-client';
|
|
4
|
-
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
5
|
-
import { PathUncheckedResponse } from '@azure-rest/core-client';
|
|
6
|
-
import { RequestParameters } from '@azure-rest/core-client';
|
|
7
|
-
import { StreamableMethod } from '@azure-rest/core-client';
|
|
8
|
-
import { TokenCredential } from '@azure/core-auth';
|
|
9
|
-
|
|
10
|
-
/** The approval task details */
|
|
11
|
-
export declare interface ApprovalDetailOutput {
|
|
12
|
-
/** The approval type of an approval task. */
|
|
13
|
-
approvalType: "PendingOnAny" | "PendingOnAll";
|
|
14
|
-
/** The status of an approval task. */
|
|
15
|
-
status: "Pending" | "Approved" | "Rejected" | "Canceled";
|
|
16
|
-
/** The list of approvers with reply. */
|
|
17
|
-
approvers: Record<string, ApproverResponseOutput>;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
/** The workflow approval task properties. */
|
|
21
|
-
export declare interface ApprovalOutput extends WorkflowTaskOutputParent {
|
|
22
|
-
/** The approval task details */
|
|
23
|
-
approvalDetail?: ApprovalDetailOutput;
|
|
24
|
-
type: "Approval";
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
export declare interface ApprovalResponseComment {
|
|
28
|
-
/** The comment of approving or rejecting an approval request. */
|
|
29
|
-
comment?: string;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
export declare interface ApproveApprovalTask {
|
|
33
|
-
/** Approve an approval task. */
|
|
34
|
-
post(options: ApproveApprovalTaskParameters): StreamableMethod<ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse>;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/** Approve an approval task. */
|
|
38
|
-
export declare interface ApproveApprovalTask200Response extends HttpResponse {
|
|
39
|
-
status: "200";
|
|
40
|
-
body: Record<string, unknown>;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
export declare interface ApproveApprovalTaskBodyParam {
|
|
44
|
-
/** The request body of approving an approval request. */
|
|
45
|
-
body: ApprovalResponseComment;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/** Approve an approval task. */
|
|
49
|
-
export declare interface ApproveApprovalTaskDefaultResponse extends HttpResponse {
|
|
50
|
-
status: string;
|
|
51
|
-
body: ErrorResponseOutput;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
export declare interface ApproveApprovalTaskMediaTypesParam {
|
|
55
|
-
/** Request content type */
|
|
56
|
-
contentType?: "application/json";
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
export declare type ApproveApprovalTaskParameters = ApproveApprovalTaskMediaTypesParam & ApproveApprovalTaskBodyParam & RequestParameters;
|
|
60
|
-
|
|
61
|
-
/** The response of approvers for a workflow task. */
|
|
62
|
-
export declare interface ApproverResponseOutput {
|
|
63
|
-
/** The response for an approval task. */
|
|
64
|
-
reply: "Approved" | "Rejected" | "Pending";
|
|
65
|
-
/** The comment of approving or rejecting an approval request. */
|
|
66
|
-
comment?: string;
|
|
67
|
-
/** The reply time of approver to a workflow task. */
|
|
68
|
-
responseTime?: string;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
export declare interface CancelWorkflowRun {
|
|
72
|
-
/** Cancel a workflow run. */
|
|
73
|
-
post(options: CancelWorkflowRunParameters): StreamableMethod<CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse>;
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
/** Cancel a workflow run. */
|
|
77
|
-
export declare interface CancelWorkflowRun200Response extends HttpResponse {
|
|
78
|
-
status: "200";
|
|
79
|
-
body: Record<string, unknown>;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
export declare interface CancelWorkflowRunBodyParam {
|
|
83
|
-
/** Reply of canceling a workflow run. */
|
|
84
|
-
body: WorkflowRunCancelRequest;
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
/** Cancel a workflow run. */
|
|
88
|
-
export declare interface CancelWorkflowRunDefaultResponse extends HttpResponse {
|
|
89
|
-
status: string;
|
|
90
|
-
body: ErrorResponseOutput;
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
export declare interface CancelWorkflowRunMediaTypesParam {
|
|
94
|
-
/** Request content type */
|
|
95
|
-
contentType?: "application/json";
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
export declare type CancelWorkflowRunParameters = CancelWorkflowRunMediaTypesParam & CancelWorkflowRunBodyParam & RequestParameters;
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Initialize a new instance of `PurviewWorkflowClient`
|
|
102
|
-
* @param endpoint type: string, The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/
|
|
103
|
-
* @param credentials type: TokenCredential, uniquely identify client credential
|
|
104
|
-
* @param options type: ClientOptions, the parameter for all optional parameters
|
|
105
|
-
*/
|
|
106
|
-
declare function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewWorkflowClient;
|
|
107
|
-
export default createClient;
|
|
108
|
-
|
|
109
|
-
/** Create or replace a workflow. */
|
|
110
|
-
export declare interface CreateOrReplaceWorkflow200Response extends HttpResponse {
|
|
111
|
-
status: "200";
|
|
112
|
-
body: WorkflowOutput;
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
export declare interface CreateOrReplaceWorkflowBodyParam {
|
|
116
|
-
/** Create or update workflow payload. */
|
|
117
|
-
body: WorkflowCreateOrUpdateCommand;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
/** Create or replace a workflow. */
|
|
121
|
-
export declare interface CreateOrReplaceWorkflowDefaultResponse extends HttpResponse {
|
|
122
|
-
status: string;
|
|
123
|
-
body: ErrorResponseOutput;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
export declare interface CreateOrReplaceWorkflowMediaTypesParam {
|
|
127
|
-
/** Request content type */
|
|
128
|
-
contentType?: "application/json";
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
export declare type CreateOrReplaceWorkflowParameters = CreateOrReplaceWorkflowMediaTypesParam & CreateOrReplaceWorkflowBodyParam & RequestParameters;
|
|
132
|
-
|
|
133
|
-
/** Delete a workflow. */
|
|
134
|
-
export declare interface DeleteWorkflow204Response extends HttpResponse {
|
|
135
|
-
status: "204";
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
/** Delete a workflow. */
|
|
139
|
-
export declare interface DeleteWorkflowDefaultResponse extends HttpResponse {
|
|
140
|
-
status: string;
|
|
141
|
-
body: ErrorResponseOutput;
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
export declare type DeleteWorkflowParameters = RequestParameters;
|
|
145
|
-
|
|
146
|
-
/** Default error model */
|
|
147
|
-
export declare interface ErrorModelOutput {
|
|
148
|
-
/** Gets or sets the code. */
|
|
149
|
-
code: string;
|
|
150
|
-
/** Gets or sets the details. */
|
|
151
|
-
details?: Array<ErrorModelOutput>;
|
|
152
|
-
/** Gets or sets the messages. */
|
|
153
|
-
message: string;
|
|
154
|
-
/** Gets or sets the target. */
|
|
155
|
-
target?: string;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
/** Default error response model */
|
|
159
|
-
export declare interface ErrorResponseOutput {
|
|
160
|
-
/** Default error model */
|
|
161
|
-
error: ErrorModelOutput;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Helper type to extract the type of an array
|
|
166
|
-
*/
|
|
167
|
-
export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* The type of a custom function that defines how to get a page and a link to the next one if any.
|
|
171
|
-
*/
|
|
172
|
-
export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
|
|
173
|
-
page: TPage;
|
|
174
|
-
nextPageLink?: string;
|
|
175
|
-
}>;
|
|
176
|
-
|
|
177
|
-
export declare interface GetWorkflow {
|
|
178
|
-
/** Get a specific workflow. */
|
|
179
|
-
get(options?: GetWorkflowParameters): StreamableMethod<GetWorkflow200Response | GetWorkflowDefaultResponse>;
|
|
180
|
-
/** Create or replace a workflow. */
|
|
181
|
-
put(options: CreateOrReplaceWorkflowParameters): StreamableMethod<CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse>;
|
|
182
|
-
/** Delete a workflow. */
|
|
183
|
-
delete(options?: DeleteWorkflowParameters): StreamableMethod<DeleteWorkflow204Response | DeleteWorkflowDefaultResponse>;
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
/** Get a specific workflow. */
|
|
187
|
-
export declare interface GetWorkflow200Response extends HttpResponse {
|
|
188
|
-
status: "200";
|
|
189
|
-
body: WorkflowOutput;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
/** Get a specific workflow. */
|
|
193
|
-
export declare interface GetWorkflowDefaultResponse extends HttpResponse {
|
|
194
|
-
status: string;
|
|
195
|
-
body: ErrorResponseOutput;
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
export declare type GetWorkflowParameters = RequestParameters;
|
|
199
|
-
|
|
200
|
-
export declare interface GetWorkflowRun {
|
|
201
|
-
/** Get a workflow run. */
|
|
202
|
-
get(options?: GetWorkflowRunParameters): StreamableMethod<GetWorkflowRun200Response | GetWorkflowRunDefaultResponse>;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
/** Get a workflow run. */
|
|
206
|
-
export declare interface GetWorkflowRun200Response extends HttpResponse {
|
|
207
|
-
status: "200";
|
|
208
|
-
body: WorkflowRunOutput;
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
/** Get a workflow run. */
|
|
212
|
-
export declare interface GetWorkflowRunDefaultResponse extends HttpResponse {
|
|
213
|
-
status: string;
|
|
214
|
-
body: ErrorResponseOutput;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
export declare type GetWorkflowRunParameters = RequestParameters;
|
|
218
|
-
|
|
219
|
-
export declare interface GetWorkflowTask {
|
|
220
|
-
/** Get a workflow task. */
|
|
221
|
-
get(options?: GetWorkflowTaskParameters): StreamableMethod<GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse>;
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
/** Get a workflow task. */
|
|
225
|
-
export declare interface GetWorkflowTask200Response extends HttpResponse {
|
|
226
|
-
status: "200";
|
|
227
|
-
body: WorkflowTaskOutput;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
/** Get a workflow task. */
|
|
231
|
-
export declare interface GetWorkflowTaskDefaultResponse extends HttpResponse {
|
|
232
|
-
status: string;
|
|
233
|
-
body: ErrorResponseOutput;
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
export declare type GetWorkflowTaskParameters = RequestParameters;
|
|
237
|
-
|
|
238
|
-
export declare function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response is ListWorkflowsDefaultResponse;
|
|
239
|
-
|
|
240
|
-
export declare function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response is GetWorkflowDefaultResponse;
|
|
241
|
-
|
|
242
|
-
export declare function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response is CreateOrReplaceWorkflowDefaultResponse;
|
|
243
|
-
|
|
244
|
-
export declare function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response is DeleteWorkflowDefaultResponse;
|
|
245
|
-
|
|
246
|
-
export declare function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response is SubmitUserRequestsDefaultResponse;
|
|
247
|
-
|
|
248
|
-
export declare function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response is ListWorkflowRunsDefaultResponse;
|
|
249
|
-
|
|
250
|
-
export declare function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response is GetWorkflowRunDefaultResponse;
|
|
251
|
-
|
|
252
|
-
export declare function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response is CancelWorkflowRunDefaultResponse;
|
|
253
|
-
|
|
254
|
-
export declare function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response is ListWorkflowTasksDefaultResponse;
|
|
255
|
-
|
|
256
|
-
export declare function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response is GetWorkflowTaskDefaultResponse;
|
|
257
|
-
|
|
258
|
-
export declare function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response is ApproveApprovalTaskDefaultResponse;
|
|
259
|
-
|
|
260
|
-
export declare function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response is RejectApprovalTaskDefaultResponse;
|
|
261
|
-
|
|
262
|
-
export declare function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response is ReassignWorkflowTaskDefaultResponse;
|
|
263
|
-
|
|
264
|
-
export declare function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response is UpdateTaskStatusDefaultResponse;
|
|
265
|
-
|
|
266
|
-
export declare interface ListWorkflowRuns {
|
|
267
|
-
/** List workflow runs. */
|
|
268
|
-
get(options?: ListWorkflowRunsParameters): StreamableMethod<ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse>;
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
/** List workflow runs. */
|
|
272
|
-
export declare interface ListWorkflowRuns200Response extends HttpResponse {
|
|
273
|
-
status: "200";
|
|
274
|
-
body: WorkflowRunListOutput;
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
/** List workflow runs. */
|
|
278
|
-
export declare interface ListWorkflowRunsDefaultResponse extends HttpResponse {
|
|
279
|
-
status: string;
|
|
280
|
-
body: ErrorResponseOutput;
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
export declare type ListWorkflowRunsParameters = ListWorkflowRunsQueryParam & RequestParameters;
|
|
284
|
-
|
|
285
|
-
export declare interface ListWorkflowRunsQueryParam {
|
|
286
|
-
queryParameters?: ListWorkflowRunsQueryParamProperties;
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
export declare interface ListWorkflowRunsQueryParamProperties {
|
|
290
|
-
/** Time window of filtering items. */
|
|
291
|
-
timeWindow?: "1d" | "7d" | "30d" | "90d";
|
|
292
|
-
/** The key word which used to sort the results. */
|
|
293
|
-
orderby?: "status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc";
|
|
294
|
-
/** Filter workflow runs by workflow run status. */
|
|
295
|
-
runStatuses?: Array<"InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history">;
|
|
296
|
-
/** Filter items by workflow id list. */
|
|
297
|
-
workflowIds?: Array<string>;
|
|
298
|
-
/** The maximum page size to get the items at one time. */
|
|
299
|
-
maxpagesize?: number;
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
export declare interface ListWorkflows {
|
|
303
|
-
/** List all workflows. */
|
|
304
|
-
get(options?: ListWorkflowsParameters): StreamableMethod<ListWorkflows200Response | ListWorkflowsDefaultResponse>;
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
/** List all workflows. */
|
|
308
|
-
export declare interface ListWorkflows200Response extends HttpResponse {
|
|
309
|
-
status: "200";
|
|
310
|
-
body: WorkflowMetadataListOutput;
|
|
311
|
-
}
|
|
312
|
-
|
|
313
|
-
/** List all workflows. */
|
|
314
|
-
export declare interface ListWorkflowsDefaultResponse extends HttpResponse {
|
|
315
|
-
status: string;
|
|
316
|
-
body: ErrorResponseOutput;
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
export declare type ListWorkflowsParameters = RequestParameters;
|
|
320
|
-
|
|
321
|
-
export declare interface ListWorkflowTasks {
|
|
322
|
-
/** Get all workflow tasks. */
|
|
323
|
-
get(options?: ListWorkflowTasksParameters): StreamableMethod<ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse>;
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
/** Get all workflow tasks. */
|
|
327
|
-
export declare interface ListWorkflowTasks200Response extends HttpResponse {
|
|
328
|
-
status: "200";
|
|
329
|
-
body: TasksListOutput;
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
/** Get all workflow tasks. */
|
|
333
|
-
export declare interface ListWorkflowTasksDefaultResponse extends HttpResponse {
|
|
334
|
-
status: string;
|
|
335
|
-
body: ErrorResponseOutput;
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
export declare type ListWorkflowTasksParameters = ListWorkflowTasksQueryParam & RequestParameters;
|
|
339
|
-
|
|
340
|
-
export declare interface ListWorkflowTasksQueryParam {
|
|
341
|
-
queryParameters?: ListWorkflowTasksQueryParamProperties;
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
export declare interface ListWorkflowTasksQueryParamProperties {
|
|
345
|
-
/** To filter user's sent, received or history workflow tasks. */
|
|
346
|
-
viewMode?: string;
|
|
347
|
-
/** Filter items by workflow id list. */
|
|
348
|
-
workflowIds?: Array<string>;
|
|
349
|
-
/** Time window of filtering items. */
|
|
350
|
-
timeWindow?: "1d" | "7d" | "30d" | "90d";
|
|
351
|
-
/** The maximum page size to get the items at one time. */
|
|
352
|
-
maxpagesize?: number;
|
|
353
|
-
/** The key word which used to sort the results. */
|
|
354
|
-
orderby?: "status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc";
|
|
355
|
-
/** Filter items by workflow task type. */
|
|
356
|
-
taskTypes?: Array<"Approval" | "SimpleTask" | "approval" | "simpleTask">;
|
|
357
|
-
/** Filter workflow tasks by status. */
|
|
358
|
-
taskStatuses?: Array<"InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history">;
|
|
359
|
-
/** The key word which could used to filter workflow item with related workflow. */
|
|
360
|
-
workflowNameKeyword?: string;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
/** The operation user wants to perform. */
|
|
364
|
-
export declare interface Operation {
|
|
365
|
-
/** The operation type. */
|
|
366
|
-
type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
|
|
367
|
-
/** The payload of each operation which user want to submit. */
|
|
368
|
-
payload: Record<string, unknown>;
|
|
369
|
-
}
|
|
370
|
-
|
|
371
|
-
/**
|
|
372
|
-
* Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
|
|
373
|
-
* @param client - Client to use for sending the next page requests
|
|
374
|
-
* @param initialResponse - Initial response containing the nextLink and current page of elements
|
|
375
|
-
* @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
|
|
376
|
-
* @returns - PagedAsyncIterableIterator to iterate the elements
|
|
377
|
-
*/
|
|
378
|
-
export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* Helper type to infer the Type of the paged elements from the response type
|
|
382
|
-
* This type is generated based on the swagger information for x-ms-pageable
|
|
383
|
-
* specifically on the itemName property which indicates the property of the response
|
|
384
|
-
* where the page items are found. The default value is `value`.
|
|
385
|
-
* This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
|
|
386
|
-
*/
|
|
387
|
-
export declare type PaginateReturn<TResult> = TResult extends {
|
|
388
|
-
body: {
|
|
389
|
-
value?: infer TPage;
|
|
390
|
-
};
|
|
391
|
-
} ? GetArrayType<TPage> : Array<unknown>;
|
|
392
|
-
|
|
393
|
-
/**
|
|
394
|
-
* Options for the paging helper
|
|
395
|
-
*/
|
|
396
|
-
export declare interface PagingOptions<TResponse> {
|
|
397
|
-
/**
|
|
398
|
-
* Custom function to extract pagination details for crating the PagedAsyncIterableIterator
|
|
399
|
-
*/
|
|
400
|
-
customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
export declare type PurviewWorkflowClient = Client & {
|
|
404
|
-
path: Routes;
|
|
405
|
-
};
|
|
406
|
-
|
|
407
|
-
/** The request payload of reassigning a workflow task. */
|
|
408
|
-
export declare interface ReassignCommand {
|
|
409
|
-
/** The request body of reassigning a workflow task. */
|
|
410
|
-
reassignments?: Array<ReassignCommandReassignmentsItem>;
|
|
411
|
-
}
|
|
412
|
-
|
|
413
|
-
export declare interface ReassignCommandReassignmentsItem {
|
|
414
|
-
/**
|
|
415
|
-
* Reassign a workflow task from a user or a group.
|
|
416
|
-
*
|
|
417
|
-
* Value may contain a UUID
|
|
418
|
-
*/
|
|
419
|
-
reassignFrom: string;
|
|
420
|
-
/**
|
|
421
|
-
* Reassign a workflow task to a user or a group.
|
|
422
|
-
*
|
|
423
|
-
* Value may contain a UUID
|
|
424
|
-
*/
|
|
425
|
-
reassignTo: string;
|
|
426
|
-
}
|
|
427
|
-
|
|
428
|
-
export declare interface ReassignWorkflowTask {
|
|
429
|
-
/** Reassign a workflow task. */
|
|
430
|
-
post(options: ReassignWorkflowTaskParameters): StreamableMethod<ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse>;
|
|
431
|
-
}
|
|
432
|
-
|
|
433
|
-
/** Reassign a workflow task. */
|
|
434
|
-
export declare interface ReassignWorkflowTask200Response extends HttpResponse {
|
|
435
|
-
status: "200";
|
|
436
|
-
body: Record<string, unknown>;
|
|
437
|
-
}
|
|
438
|
-
|
|
439
|
-
export declare interface ReassignWorkflowTaskBodyParam {
|
|
440
|
-
/** The request body of reassigning a workflow task. */
|
|
441
|
-
body: ReassignCommand;
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
/** Reassign a workflow task. */
|
|
445
|
-
export declare interface ReassignWorkflowTaskDefaultResponse extends HttpResponse {
|
|
446
|
-
status: string;
|
|
447
|
-
body: ErrorResponseOutput;
|
|
448
|
-
}
|
|
449
|
-
|
|
450
|
-
export declare interface ReassignWorkflowTaskMediaTypesParam {
|
|
451
|
-
/** Request content type */
|
|
452
|
-
contentType?: "application/json";
|
|
453
|
-
}
|
|
454
|
-
|
|
455
|
-
export declare type ReassignWorkflowTaskParameters = ReassignWorkflowTaskMediaTypesParam & ReassignWorkflowTaskBodyParam & RequestParameters;
|
|
456
|
-
|
|
457
|
-
export declare interface RejectApprovalTask {
|
|
458
|
-
/** Reject an approval task. */
|
|
459
|
-
post(options: RejectApprovalTaskParameters): StreamableMethod<RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse>;
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
/** Reject an approval task. */
|
|
463
|
-
export declare interface RejectApprovalTask200Response extends HttpResponse {
|
|
464
|
-
status: "200";
|
|
465
|
-
body: Record<string, unknown>;
|
|
466
|
-
}
|
|
467
|
-
|
|
468
|
-
export declare interface RejectApprovalTaskBodyParam {
|
|
469
|
-
/** The request body of rejecting an approval request. */
|
|
470
|
-
body: ApprovalResponseComment;
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
/** Reject an approval task. */
|
|
474
|
-
export declare interface RejectApprovalTaskDefaultResponse extends HttpResponse {
|
|
475
|
-
status: string;
|
|
476
|
-
body: ErrorResponseOutput;
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
export declare interface RejectApprovalTaskMediaTypesParam {
|
|
480
|
-
/** Request content type */
|
|
481
|
-
contentType?: "application/json";
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
export declare type RejectApprovalTaskParameters = RejectApprovalTaskMediaTypesParam & RejectApprovalTaskBodyParam & RequestParameters;
|
|
485
|
-
|
|
486
|
-
export declare interface Routes {
|
|
487
|
-
/** Resource for '/workflows' has methods for the following verbs: get */
|
|
488
|
-
(path: "/workflows"): ListWorkflows;
|
|
489
|
-
/** Resource for '/workflows/\{workflowId\}' has methods for the following verbs: get, put, delete */
|
|
490
|
-
(path: "/workflows/{workflowId}", workflowId: string): GetWorkflow;
|
|
491
|
-
/** Resource for '/userrequests' has methods for the following verbs: post */
|
|
492
|
-
(path: "/userrequests"): SubmitUserRequests;
|
|
493
|
-
/** Resource for '/workflowruns' has methods for the following verbs: get */
|
|
494
|
-
(path: "/workflowruns"): ListWorkflowRuns;
|
|
495
|
-
/** Resource for '/workflowruns/\{workflowRunId\}' has methods for the following verbs: get */
|
|
496
|
-
(path: "/workflowruns/{workflowRunId}", workflowRunId: string): GetWorkflowRun;
|
|
497
|
-
/** Resource for '/workflowruns/\{workflowRunId\}/cancel' has methods for the following verbs: post */
|
|
498
|
-
(path: "/workflowruns/{workflowRunId}/cancel", workflowRunId: string): CancelWorkflowRun;
|
|
499
|
-
/** Resource for '/workflowtasks' has methods for the following verbs: get */
|
|
500
|
-
(path: "/workflowtasks"): ListWorkflowTasks;
|
|
501
|
-
/** Resource for '/workflowtasks/\{taskId\}' has methods for the following verbs: get */
|
|
502
|
-
(path: "/workflowtasks/{taskId}", taskId: string): GetWorkflowTask;
|
|
503
|
-
/** Resource for '/workflowtasks/\{taskId\}/approve-approval' has methods for the following verbs: post */
|
|
504
|
-
(path: "/workflowtasks/{taskId}/approve-approval", taskId: string): ApproveApprovalTask;
|
|
505
|
-
/** Resource for '/workflowtasks/\{taskId\}/reject-approval' has methods for the following verbs: post */
|
|
506
|
-
(path: "/workflowtasks/{taskId}/reject-approval", taskId: string): RejectApprovalTask;
|
|
507
|
-
/** Resource for '/workflowtasks/\{taskId\}/reassign' has methods for the following verbs: post */
|
|
508
|
-
(path: "/workflowtasks/{taskId}/reassign", taskId: string): ReassignWorkflowTask;
|
|
509
|
-
/** Resource for '/workflowtasks/\{taskId\}/change-task-status' has methods for the following verbs: post */
|
|
510
|
-
(path: "/workflowtasks/{taskId}/change-task-status", taskId: string): UpdateTaskStatus;
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
/** Workflow simple task details. */
|
|
514
|
-
export declare interface SimpleTaskDetailOutput {
|
|
515
|
-
/** The simple task body. */
|
|
516
|
-
taskBody: string;
|
|
517
|
-
/** The users or groups were assigned the simple task. */
|
|
518
|
-
assignedTo: Array<string>;
|
|
519
|
-
/** Simple task status. */
|
|
520
|
-
status: "NotStarted" | "InProgress" | "Completed" | "Canceled";
|
|
521
|
-
changeHistory: Array<Record<string, unknown>>;
|
|
522
|
-
}
|
|
523
|
-
|
|
524
|
-
/** The workflow simple task properties. */
|
|
525
|
-
export declare interface SimpleTaskOutput extends WorkflowTaskOutputParent {
|
|
526
|
-
/** Workflow simple task details. */
|
|
527
|
-
taskDetail?: SimpleTaskDetailOutput;
|
|
528
|
-
type: "SimpleTask";
|
|
529
|
-
}
|
|
530
|
-
|
|
531
|
-
export declare interface SubmitUserRequests {
|
|
532
|
-
/** Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. */
|
|
533
|
-
post(options: SubmitUserRequestsParameters): StreamableMethod<SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse>;
|
|
534
|
-
}
|
|
535
|
-
|
|
536
|
-
/** Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. */
|
|
537
|
-
export declare interface SubmitUserRequests200Response extends HttpResponse {
|
|
538
|
-
status: "200";
|
|
539
|
-
body: UserRequestResponseOutput;
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
export declare interface SubmitUserRequestsBodyParam {
|
|
543
|
-
/** The payload of submitting a user request. */
|
|
544
|
-
body: UserRequestPayload;
|
|
545
|
-
}
|
|
546
|
-
|
|
547
|
-
/** Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. */
|
|
548
|
-
export declare interface SubmitUserRequestsDefaultResponse extends HttpResponse {
|
|
549
|
-
status: string;
|
|
550
|
-
body: ErrorResponseOutput;
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
export declare interface SubmitUserRequestsMediaTypesParam {
|
|
554
|
-
/** Request content type */
|
|
555
|
-
contentType?: "application/json";
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
export declare type SubmitUserRequestsParameters = SubmitUserRequestsMediaTypesParam & SubmitUserRequestsBodyParam & RequestParameters;
|
|
559
|
-
|
|
560
|
-
/** Info and material that helps assignees to take action. */
|
|
561
|
-
export declare interface TaskPayloadOutput {
|
|
562
|
-
/** The task payload type. */
|
|
563
|
-
type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
|
|
564
|
-
/** The target value of entity which user want to involve workflow to update. */
|
|
565
|
-
targetValue: string;
|
|
566
|
-
/** The payload of the task. */
|
|
567
|
-
payload?: Record<string, unknown>;
|
|
568
|
-
}
|
|
569
|
-
|
|
570
|
-
export declare interface TasksListOutput {
|
|
571
|
-
/** The value of workflow tasks list. */
|
|
572
|
-
value: Array<WorkflowTaskOutput>;
|
|
573
|
-
/** The URL to get the next set of results. */
|
|
574
|
-
nextLink?: string;
|
|
575
|
-
}
|
|
576
|
-
|
|
577
|
-
export declare interface TaskUpdateCommand {
|
|
578
|
-
/** The new status will be used to update the task. */
|
|
579
|
-
newStatus: "NotStarted" | "InProgress" | "Completed" | "Canceled";
|
|
580
|
-
/** The comment when update a task. */
|
|
581
|
-
comment?: string;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
/** Describes under what condition a workflow will run. */
|
|
585
|
-
export declare interface Trigger {
|
|
586
|
-
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";
|
|
587
|
-
/** Glossary term hierarchy path. */
|
|
588
|
-
underGlossaryHierarchy?: string;
|
|
589
|
-
/** The collection name. */
|
|
590
|
-
underCollection?: string;
|
|
591
|
-
/** The glossary guid. */
|
|
592
|
-
underGlossary?: string;
|
|
593
|
-
}
|
|
594
|
-
|
|
595
|
-
/** Describes under what condition a workflow will run. */
|
|
596
|
-
export declare interface TriggerOutput {
|
|
597
|
-
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";
|
|
598
|
-
/** Glossary term hierarchy path. */
|
|
599
|
-
underGlossaryHierarchy?: string;
|
|
600
|
-
/** The collection name. */
|
|
601
|
-
underCollection?: string;
|
|
602
|
-
/** The glossary guid. */
|
|
603
|
-
underGlossary?: string;
|
|
604
|
-
}
|
|
605
|
-
|
|
606
|
-
export declare interface UpdateTaskStatus {
|
|
607
|
-
/** Update the status of a workflow task request. */
|
|
608
|
-
post(options: UpdateTaskStatusParameters): StreamableMethod<UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse>;
|
|
609
|
-
}
|
|
610
|
-
|
|
611
|
-
/** Update the status of a workflow task request. */
|
|
612
|
-
export declare interface UpdateTaskStatus200Response extends HttpResponse {
|
|
613
|
-
status: "200";
|
|
614
|
-
body: Record<string, unknown>;
|
|
615
|
-
}
|
|
616
|
-
|
|
617
|
-
export declare interface UpdateTaskStatusBodyParam {
|
|
618
|
-
/** Request body of updating workflow task request. */
|
|
619
|
-
body: TaskUpdateCommand;
|
|
620
|
-
}
|
|
621
|
-
|
|
622
|
-
/** Update the status of a workflow task request. */
|
|
623
|
-
export declare interface UpdateTaskStatusDefaultResponse extends HttpResponse {
|
|
624
|
-
status: string;
|
|
625
|
-
body: ErrorResponseOutput;
|
|
626
|
-
}
|
|
627
|
-
|
|
628
|
-
export declare interface UpdateTaskStatusMediaTypesParam {
|
|
629
|
-
/** Request content type */
|
|
630
|
-
contentType?: "application/json";
|
|
631
|
-
}
|
|
632
|
-
|
|
633
|
-
export declare type UpdateTaskStatusParameters = UpdateTaskStatusMediaTypesParam & UpdateTaskStatusBodyParam & RequestParameters;
|
|
634
|
-
|
|
635
|
-
export declare interface UserRequestPayload {
|
|
636
|
-
/** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */
|
|
637
|
-
operations: Array<Operation>;
|
|
638
|
-
/** The comment when submit a user request. */
|
|
639
|
-
comment?: string;
|
|
640
|
-
}
|
|
641
|
-
|
|
642
|
-
/** The operation user wants to perform. */
|
|
643
|
-
export declare interface UserRequestResponseOperationsItemOutput {
|
|
644
|
-
/** The operation type. */
|
|
645
|
-
type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
|
|
646
|
-
/** The payload of each operation which user want to submit. */
|
|
647
|
-
payload: Record<string, unknown>;
|
|
648
|
-
workflowRunIds?: Array<string>;
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
/** Describes user ask to do operation(s) on Purview. */
|
|
652
|
-
export declare interface UserRequestResponseOutput {
|
|
653
|
-
/**
|
|
654
|
-
* The user request id.
|
|
655
|
-
*
|
|
656
|
-
* Value may contain a UUID
|
|
657
|
-
*/
|
|
658
|
-
requestId: string;
|
|
659
|
-
/**
|
|
660
|
-
* The person who submitted the user request.
|
|
661
|
-
*
|
|
662
|
-
* Value may contain a UUID
|
|
663
|
-
*/
|
|
664
|
-
requestor: string;
|
|
665
|
-
/** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */
|
|
666
|
-
operations: Array<UserRequestResponseOperationsItemOutput>;
|
|
667
|
-
/** The comment when submit a user request. */
|
|
668
|
-
comment?: string;
|
|
669
|
-
/** The status. */
|
|
670
|
-
status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
|
|
671
|
-
}
|
|
672
|
-
|
|
673
|
-
/** Create or update workflow payload. */
|
|
674
|
-
export declare interface WorkflowCreateOrUpdateCommand {
|
|
675
|
-
/** It describes under what condition a workflow will run. */
|
|
676
|
-
triggers: Array<Trigger>;
|
|
677
|
-
/** The workflow name. */
|
|
678
|
-
name: string;
|
|
679
|
-
/** Whether the workflow enabled or not. */
|
|
680
|
-
isEnabled: boolean;
|
|
681
|
-
/** Description of a workflow. */
|
|
682
|
-
description: string;
|
|
683
|
-
/** The action DAG(Directed Acyclic Graph), it defines actual flow. */
|
|
684
|
-
actionDag?: Record<string, unknown>;
|
|
685
|
-
}
|
|
686
|
-
|
|
687
|
-
/** The workflow list. */
|
|
688
|
-
export declare interface WorkflowMetadataListOutput {
|
|
689
|
-
/** The value of workflow list. */
|
|
690
|
-
value: Array<WorkflowMetadataOutput>;
|
|
691
|
-
/** The URL to get the next set of results. */
|
|
692
|
-
nextLink?: string;
|
|
693
|
-
}
|
|
694
|
-
|
|
695
|
-
/** The workflow metadata, action DAGs are not included. */
|
|
696
|
-
export declare interface WorkflowMetadataOutput {
|
|
697
|
-
/**
|
|
698
|
-
* The id of workflow.
|
|
699
|
-
*
|
|
700
|
-
* Value may contain a UUID
|
|
701
|
-
*/
|
|
702
|
-
id: string;
|
|
703
|
-
/** It describes under what condition a workflow will run. */
|
|
704
|
-
triggers: Array<TriggerOutput>;
|
|
705
|
-
/** The created time of workflow. */
|
|
706
|
-
createdTime?: string;
|
|
707
|
-
/** The person who created the workflow. */
|
|
708
|
-
createdBy?: string;
|
|
709
|
-
/** The last update time. */
|
|
710
|
-
lastUpdateTime?: string;
|
|
711
|
-
/** The person who updated the workflow. */
|
|
712
|
-
updatedBy?: string;
|
|
713
|
-
/** The name of a workflow. */
|
|
714
|
-
name: string;
|
|
715
|
-
/** Whether the workflow is enabled or not. */
|
|
716
|
-
isEnabled: boolean;
|
|
717
|
-
/** Description of a workflow. */
|
|
718
|
-
description: string;
|
|
719
|
-
}
|
|
720
|
-
|
|
721
|
-
/** The workflow properties. It includes the triggers, actual flow and other properties of a workflow. */
|
|
722
|
-
export declare interface WorkflowOutput extends WorkflowMetadataOutput {
|
|
723
|
-
/** The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order. */
|
|
724
|
-
actionDag: Record<string, unknown>;
|
|
725
|
-
}
|
|
726
|
-
|
|
727
|
-
export declare interface WorkflowRunCancelRequest {
|
|
728
|
-
/** The comment of canceling a workflow run. */
|
|
729
|
-
comment?: string;
|
|
730
|
-
}
|
|
731
|
-
|
|
732
|
-
/** It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. */
|
|
733
|
-
export declare interface WorkflowRunDetailOutput {
|
|
734
|
-
/** Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. */
|
|
735
|
-
runInput: Record<string, unknown>;
|
|
736
|
-
/** Any object */
|
|
737
|
-
actions: Record<string, unknown>;
|
|
738
|
-
}
|
|
739
|
-
|
|
740
|
-
export declare interface WorkflowRunListOutput {
|
|
741
|
-
/** The value of workflow run list. */
|
|
742
|
-
value: Array<WorkflowRunMetadataOutput>;
|
|
743
|
-
/** The URL to get the next set of results. */
|
|
744
|
-
nextLink?: string;
|
|
745
|
-
}
|
|
746
|
-
|
|
747
|
-
/** The execution of a workflow. It includes status of the entire run and other properties of a run. */
|
|
748
|
-
export declare interface WorkflowRunMetadataOutput {
|
|
749
|
-
/**
|
|
750
|
-
* The workflow run id.
|
|
751
|
-
*
|
|
752
|
-
* Value may contain a UUID
|
|
753
|
-
*/
|
|
754
|
-
id: string;
|
|
755
|
-
/**
|
|
756
|
-
* The workflow id.
|
|
757
|
-
*
|
|
758
|
-
* Value may contain a UUID
|
|
759
|
-
*/
|
|
760
|
-
workflowId: string;
|
|
761
|
-
/** Workflow run start time. */
|
|
762
|
-
startTime: string;
|
|
763
|
-
/**
|
|
764
|
-
* The person who submitted the user request.
|
|
765
|
-
*
|
|
766
|
-
* Value may contain a UUID
|
|
767
|
-
*/
|
|
768
|
-
requestor: string;
|
|
769
|
-
/**
|
|
770
|
-
* The user request id.
|
|
771
|
-
*
|
|
772
|
-
* Value may contain a UUID
|
|
773
|
-
*/
|
|
774
|
-
userRequestId?: string;
|
|
775
|
-
/** The input of a workflow run. Align with operation in user request. */
|
|
776
|
-
runPayload: WorkflowRunPayloadOutput;
|
|
777
|
-
/** The status. */
|
|
778
|
-
status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
|
|
779
|
-
/** The time of workflow run completed. */
|
|
780
|
-
endTime?: string;
|
|
781
|
-
/** The time of workflow run be canceled. */
|
|
782
|
-
cancelTime?: string;
|
|
783
|
-
/** The comment when cancel a workflow run. */
|
|
784
|
-
cancelComment?: string;
|
|
785
|
-
}
|
|
786
|
-
|
|
787
|
-
/** The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. */
|
|
788
|
-
export declare interface WorkflowRunOutput {
|
|
789
|
-
/**
|
|
790
|
-
* The workflow run id.
|
|
791
|
-
*
|
|
792
|
-
* Value may contain a UUID
|
|
793
|
-
*/
|
|
794
|
-
id?: string;
|
|
795
|
-
/**
|
|
796
|
-
* The workflow id.
|
|
797
|
-
*
|
|
798
|
-
* Value may contain a UUID
|
|
799
|
-
*/
|
|
800
|
-
workflowId?: string;
|
|
801
|
-
/** Workflow run start time. */
|
|
802
|
-
startTime?: string;
|
|
803
|
-
/**
|
|
804
|
-
* The person who submitted the user request.
|
|
805
|
-
*
|
|
806
|
-
* Value may contain a UUID
|
|
807
|
-
*/
|
|
808
|
-
requestor?: string;
|
|
809
|
-
/**
|
|
810
|
-
* The user request id.
|
|
811
|
-
*
|
|
812
|
-
* Value may contain a UUID
|
|
813
|
-
*/
|
|
814
|
-
userRequestId?: string;
|
|
815
|
-
/** The input of a workflow run. Align with operation in user request. */
|
|
816
|
-
runPayload?: WorkflowRunRunPayloadOutput;
|
|
817
|
-
/** The status. */
|
|
818
|
-
status?: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
|
|
819
|
-
/** The time of workflow run completed. */
|
|
820
|
-
endTime?: string;
|
|
821
|
-
/** The time of workflow run be canceled. */
|
|
822
|
-
cancelTime?: string;
|
|
823
|
-
/** The comment when cancel a workflow run. */
|
|
824
|
-
cancelComment?: string;
|
|
825
|
-
/** The action DAG(Directed Acyclic Graph), it defines actual flow. */
|
|
826
|
-
actionDag: Record<string, unknown>;
|
|
827
|
-
/** It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. */
|
|
828
|
-
detail: WorkflowRunDetailOutput;
|
|
829
|
-
}
|
|
830
|
-
|
|
831
|
-
/** The input of a workflow run. Align with operation in user request. */
|
|
832
|
-
export declare interface WorkflowRunPayloadOutput {
|
|
833
|
-
/** The workflow run payload type. */
|
|
834
|
-
type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
|
|
835
|
-
/** The target value which need involve workflow to update. */
|
|
836
|
-
targetValue: string;
|
|
837
|
-
}
|
|
838
|
-
|
|
839
|
-
/** The input of a workflow run. Align with operation in user request. */
|
|
840
|
-
export declare interface WorkflowRunRunPayloadOutput {
|
|
841
|
-
/** The workflow run payload type. */
|
|
842
|
-
type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
|
|
843
|
-
/** The target value which need involve workflow to update. */
|
|
844
|
-
targetValue: string;
|
|
845
|
-
/** The payload of each operation which user want to submit. */
|
|
846
|
-
payload: Record<string, unknown>;
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
export declare interface WorkflowTaskExpiryInfoExpirySettingsOutput {
|
|
850
|
-
/** The time of expiry. */
|
|
851
|
-
expireAfter: Record<string, unknown>;
|
|
852
|
-
notifyOnExpiration?: Array<string>;
|
|
853
|
-
}
|
|
854
|
-
|
|
855
|
-
/** Info of task expiry. */
|
|
856
|
-
export declare interface WorkflowTaskExpiryInfoOutput {
|
|
857
|
-
/** The last expiry notification time. */
|
|
858
|
-
lastExpiryNotificationTime?: string;
|
|
859
|
-
/** The next expiry notification time. */
|
|
860
|
-
nextExpiryNotificationTime: string;
|
|
861
|
-
/** The expiry time. */
|
|
862
|
-
expiryTime: string;
|
|
863
|
-
expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;
|
|
864
|
-
}
|
|
865
|
-
|
|
866
|
-
/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */
|
|
867
|
-
export declare type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;
|
|
868
|
-
|
|
869
|
-
/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */
|
|
870
|
-
export declare interface WorkflowTaskOutputParent {
|
|
871
|
-
/**
|
|
872
|
-
* The workflow task id.
|
|
873
|
-
*
|
|
874
|
-
* Value may contain a UUID
|
|
875
|
-
*/
|
|
876
|
-
id: string;
|
|
877
|
-
/** The workflow task title. */
|
|
878
|
-
title?: string;
|
|
879
|
-
/**
|
|
880
|
-
* The workflow run id.
|
|
881
|
-
*
|
|
882
|
-
* Value may contain a UUID
|
|
883
|
-
*/
|
|
884
|
-
workflowRunId: string;
|
|
885
|
-
/**
|
|
886
|
-
* The workflow id.
|
|
887
|
-
*
|
|
888
|
-
* Value may contain a UUID
|
|
889
|
-
*/
|
|
890
|
-
workflowId: string;
|
|
891
|
-
/**
|
|
892
|
-
* The person who submitted the user request.
|
|
893
|
-
*
|
|
894
|
-
* Value may contain a UUID
|
|
895
|
-
*/
|
|
896
|
-
requestor: string;
|
|
897
|
-
/** The created time. */
|
|
898
|
-
createdTime: string;
|
|
899
|
-
/** The last update time. */
|
|
900
|
-
lastUpdateTime: string;
|
|
901
|
-
/** Info and material that helps assignees to take action. */
|
|
902
|
-
payload: TaskPayloadOutput;
|
|
903
|
-
/** Info of task reminder. */
|
|
904
|
-
reminderInfo?: WorkflowTaskReminderInfoOutput;
|
|
905
|
-
/** Info of task expiry. */
|
|
906
|
-
expiryInfo?: WorkflowTaskExpiryInfoOutput;
|
|
907
|
-
type: "WorkflowTask" | "Approval" | "SimpleTask";
|
|
908
|
-
}
|
|
909
|
-
|
|
910
|
-
/** Info of task reminder. */
|
|
911
|
-
export declare interface WorkflowTaskReminderInfoOutput {
|
|
912
|
-
/** The last update time. */
|
|
913
|
-
lastRemindTime?: string;
|
|
914
|
-
/** The next remind time. */
|
|
915
|
-
nextRemindTime: string;
|
|
916
|
-
/** The reminder settings. */
|
|
917
|
-
reminderSettings: Record<string, unknown>;
|
|
918
|
-
}
|
|
919
|
-
|
|
920
|
-
export { }
|