@emilgroup/action-sdk 1.1.1-beta.27 → 1.1.1-beta.7
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/.openapi-generator/FILES +0 -6
- package/README.md +2 -2
- package/api/actions-api.ts +397 -219
- package/api/executions-api.ts +12 -119
- package/dist/api/actions-api.d.ts +270 -178
- package/dist/api/actions-api.js +328 -153
- package/dist/api/executions-api.d.ts +12 -69
- package/dist/api/executions-api.js +9 -102
- package/dist/models/action-class.d.ts +20 -9
- package/dist/models/action-execution-class.d.ts +0 -36
- package/dist/models/create-action-request-dto.d.ts +5 -47
- package/dist/models/create-action-request-dto.js +0 -6
- package/dist/models/index.d.ts +0 -6
- package/dist/models/index.js +0 -6
- package/dist/models/update-action-request-dto.d.ts +5 -41
- package/dist/models/update-action-request-dto.js +0 -6
- package/models/action-class.ts +20 -9
- package/models/action-execution-class.ts +0 -36
- package/models/create-action-request-dto.ts +5 -50
- package/models/index.ts +0 -6
- package/models/update-action-request-dto.ts +5 -44
- package/package.json +1 -1
- package/dist/models/action-ref-class.d.ts +0 -36
- package/dist/models/action-ref-class.js +0 -15
- package/dist/models/action-version-class.d.ts +0 -127
- package/dist/models/action-version-class.js +0 -21
- package/dist/models/get-action-version-response-class.d.ts +0 -25
- package/dist/models/get-action-version-response-class.js +0 -15
- package/dist/models/list-action-versions-response-class.d.ts +0 -43
- package/dist/models/list-action-versions-response-class.js +0 -15
- package/dist/models/trigger-action-request-dto.d.ts +0 -62
- package/dist/models/trigger-action-request-dto.js +0 -15
- package/dist/models/trigger-action-response-class.d.ts +0 -25
- package/dist/models/trigger-action-response-class.js +0 -15
- package/models/action-ref-class.ts +0 -42
- package/models/action-version-class.ts +0 -136
- package/models/get-action-version-response-class.ts +0 -31
- package/models/list-action-versions-response-class.ts +0 -49
- package/models/trigger-action-request-dto.ts +0 -66
- package/models/trigger-action-response-class.ts +0 -31
|
@@ -14,8 +14,6 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
16
16
|
import { ListActionExecutionsResponseClass } from '../models';
|
|
17
|
-
import { TriggerActionRequestDto } from '../models';
|
|
18
|
-
import { TriggerActionResponseClass } from '../models';
|
|
19
17
|
/**
|
|
20
18
|
* ExecutionsApi - axios parameter creator
|
|
21
19
|
* @export
|
|
@@ -37,24 +35,15 @@ export declare const ExecutionsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
37
35
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
36
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
39
37
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
40
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
38
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
41
39
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
42
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
40
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
43
41
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
44
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
42
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
45
43
|
* @param {*} [options] Override http request option.
|
|
46
44
|
* @throws {RequiredError}
|
|
47
45
|
*/
|
|
48
46
|
listActionExecutions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
-
/**
|
|
50
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
51
|
-
* @summary Create the actionExecution
|
|
52
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
53
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
54
|
-
* @param {*} [options] Override http request option.
|
|
55
|
-
* @throws {RequiredError}
|
|
56
|
-
*/
|
|
57
|
-
triggerAction: (triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
47
|
};
|
|
59
48
|
/**
|
|
60
49
|
* ExecutionsApi - functional programming interface
|
|
@@ -77,24 +66,15 @@ export declare const ExecutionsApiFp: (configuration?: Configuration) => {
|
|
|
77
66
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
78
67
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
79
68
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
80
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
69
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
81
70
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
82
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
71
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
83
72
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
84
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
73
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
85
74
|
* @param {*} [options] Override http request option.
|
|
86
75
|
* @throws {RequiredError}
|
|
87
76
|
*/
|
|
88
77
|
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionExecutionsResponseClass>>;
|
|
89
|
-
/**
|
|
90
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
91
|
-
* @summary Create the actionExecution
|
|
92
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
93
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
94
|
-
* @param {*} [options] Override http request option.
|
|
95
|
-
* @throws {RequiredError}
|
|
96
|
-
*/
|
|
97
|
-
triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerActionResponseClass>>;
|
|
98
78
|
};
|
|
99
79
|
/**
|
|
100
80
|
* ExecutionsApi - factory interface
|
|
@@ -117,24 +97,15 @@ export declare const ExecutionsApiFactory: (configuration?: Configuration, baseP
|
|
|
117
97
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
98
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
119
99
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
120
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
100
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
121
101
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
122
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
102
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
123
103
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
124
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
104
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
125
105
|
* @param {*} [options] Override http request option.
|
|
126
106
|
* @throws {RequiredError}
|
|
127
107
|
*/
|
|
128
108
|
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass>;
|
|
129
|
-
/**
|
|
130
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
131
|
-
* @summary Create the actionExecution
|
|
132
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
133
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
-
* @param {*} [options] Override http request option.
|
|
135
|
-
* @throws {RequiredError}
|
|
136
|
-
*/
|
|
137
|
-
triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerActionResponseClass>;
|
|
138
109
|
};
|
|
139
110
|
/**
|
|
140
111
|
* Request parameters for getActionExecutionStatus operation in ExecutionsApi.
|
|
@@ -186,7 +157,7 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
186
157
|
*/
|
|
187
158
|
readonly pageToken?: string;
|
|
188
159
|
/**
|
|
189
|
-
* Filter the response by one or multiple fields.
|
|
160
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
190
161
|
* @type {string}
|
|
191
162
|
* @memberof ExecutionsApiListActionExecutions
|
|
192
163
|
*/
|
|
@@ -198,7 +169,7 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
198
169
|
*/
|
|
199
170
|
readonly search?: string;
|
|
200
171
|
/**
|
|
201
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
172
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
202
173
|
* @type {string}
|
|
203
174
|
* @memberof ExecutionsApiListActionExecutions
|
|
204
175
|
*/
|
|
@@ -210,31 +181,12 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
210
181
|
*/
|
|
211
182
|
readonly expand?: string;
|
|
212
183
|
/**
|
|
213
|
-
* Filters the response by one or multiple fields.
|
|
184
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
214
185
|
* @type {string}
|
|
215
186
|
* @memberof ExecutionsApiListActionExecutions
|
|
216
187
|
*/
|
|
217
188
|
readonly filters?: string;
|
|
218
189
|
}
|
|
219
|
-
/**
|
|
220
|
-
* Request parameters for triggerAction operation in ExecutionsApi.
|
|
221
|
-
* @export
|
|
222
|
-
* @interface ExecutionsApiTriggerActionRequest
|
|
223
|
-
*/
|
|
224
|
-
export interface ExecutionsApiTriggerActionRequest {
|
|
225
|
-
/**
|
|
226
|
-
*
|
|
227
|
-
* @type {TriggerActionRequestDto}
|
|
228
|
-
* @memberof ExecutionsApiTriggerAction
|
|
229
|
-
*/
|
|
230
|
-
readonly triggerActionRequestDto: TriggerActionRequestDto;
|
|
231
|
-
/**
|
|
232
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
233
|
-
* @type {string}
|
|
234
|
-
* @memberof ExecutionsApiTriggerAction
|
|
235
|
-
*/
|
|
236
|
-
readonly authorization?: string;
|
|
237
|
-
}
|
|
238
190
|
/**
|
|
239
191
|
* ExecutionsApi - object-oriented interface
|
|
240
192
|
* @export
|
|
@@ -260,13 +212,4 @@ export declare class ExecutionsApi extends BaseAPI {
|
|
|
260
212
|
* @memberof ExecutionsApi
|
|
261
213
|
*/
|
|
262
214
|
listActionExecutions(requestParameters?: ExecutionsApiListActionExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionExecutionsResponseClass, any, {}>>;
|
|
263
|
-
/**
|
|
264
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
265
|
-
* @summary Create the actionExecution
|
|
266
|
-
* @param {ExecutionsApiTriggerActionRequest} requestParameters Request parameters.
|
|
267
|
-
* @param {*} [options] Override http request option.
|
|
268
|
-
* @throws {RequiredError}
|
|
269
|
-
* @memberof ExecutionsApi
|
|
270
|
-
*/
|
|
271
|
-
triggerAction(requestParameters: ExecutionsApiTriggerActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerActionResponseClass, any, {}>>;
|
|
272
215
|
}
|
|
@@ -150,11 +150,11 @@ var ExecutionsApiAxiosParamCreator = function (configuration) {
|
|
|
150
150
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
151
151
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
152
152
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
153
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
153
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
154
154
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
155
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
155
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
156
156
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
157
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
157
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
@@ -216,55 +216,6 @@ var ExecutionsApiAxiosParamCreator = function (configuration) {
|
|
|
216
216
|
});
|
|
217
217
|
});
|
|
218
218
|
},
|
|
219
|
-
/**
|
|
220
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
221
|
-
* @summary Create the actionExecution
|
|
222
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
223
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
224
|
-
* @param {*} [options] Override http request option.
|
|
225
|
-
* @throws {RequiredError}
|
|
226
|
-
*/
|
|
227
|
-
triggerAction: function (triggerActionRequestDto, authorization, options) {
|
|
228
|
-
if (options === void 0) { options = {}; }
|
|
229
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
230
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
231
|
-
return __generator(this, function (_a) {
|
|
232
|
-
switch (_a.label) {
|
|
233
|
-
case 0:
|
|
234
|
-
// verify required parameter 'triggerActionRequestDto' is not null or undefined
|
|
235
|
-
(0, common_1.assertParamExists)('triggerAction', 'triggerActionRequestDto', triggerActionRequestDto);
|
|
236
|
-
localVarPath = "/actionservice/v1/actions/trigger";
|
|
237
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
238
|
-
if (configuration) {
|
|
239
|
-
baseOptions = configuration.baseOptions;
|
|
240
|
-
baseAccessToken = configuration.accessToken;
|
|
241
|
-
}
|
|
242
|
-
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
243
|
-
localVarHeaderParameter = {};
|
|
244
|
-
localVarQueryParameter = {};
|
|
245
|
-
// authentication bearer required
|
|
246
|
-
// http bearer authentication required
|
|
247
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
248
|
-
case 1:
|
|
249
|
-
// authentication bearer required
|
|
250
|
-
// http bearer authentication required
|
|
251
|
-
_a.sent();
|
|
252
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
253
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
254
|
-
}
|
|
255
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
256
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
257
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
258
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
259
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerActionRequestDto, localVarRequestOptions, configuration);
|
|
260
|
-
return [2 /*return*/, {
|
|
261
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
262
|
-
options: localVarRequestOptions,
|
|
263
|
-
}];
|
|
264
|
-
}
|
|
265
|
-
});
|
|
266
|
-
});
|
|
267
|
-
},
|
|
268
219
|
};
|
|
269
220
|
};
|
|
270
221
|
exports.ExecutionsApiAxiosParamCreator = ExecutionsApiAxiosParamCreator;
|
|
@@ -303,11 +254,11 @@ var ExecutionsApiFp = function (configuration) {
|
|
|
303
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
304
255
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
256
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
306
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
257
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
258
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
308
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
259
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
309
260
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
310
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
261
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
311
262
|
* @param {*} [options] Override http request option.
|
|
312
263
|
* @throws {RequiredError}
|
|
313
264
|
*/
|
|
@@ -324,27 +275,6 @@ var ExecutionsApiFp = function (configuration) {
|
|
|
324
275
|
});
|
|
325
276
|
});
|
|
326
277
|
},
|
|
327
|
-
/**
|
|
328
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
329
|
-
* @summary Create the actionExecution
|
|
330
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
331
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
332
|
-
* @param {*} [options] Override http request option.
|
|
333
|
-
* @throws {RequiredError}
|
|
334
|
-
*/
|
|
335
|
-
triggerAction: function (triggerActionRequestDto, authorization, options) {
|
|
336
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
337
|
-
var localVarAxiosArgs;
|
|
338
|
-
return __generator(this, function (_a) {
|
|
339
|
-
switch (_a.label) {
|
|
340
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerAction(triggerActionRequestDto, authorization, options)];
|
|
341
|
-
case 1:
|
|
342
|
-
localVarAxiosArgs = _a.sent();
|
|
343
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
344
|
-
}
|
|
345
|
-
});
|
|
346
|
-
});
|
|
347
|
-
},
|
|
348
278
|
};
|
|
349
279
|
};
|
|
350
280
|
exports.ExecutionsApiFp = ExecutionsApiFp;
|
|
@@ -373,28 +303,17 @@ var ExecutionsApiFactory = function (configuration, basePath, axios) {
|
|
|
373
303
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
304
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
305
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
376
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
306
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
377
307
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
378
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
308
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
379
309
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
380
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
310
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
381
311
|
* @param {*} [options] Override http request option.
|
|
382
312
|
* @throws {RequiredError}
|
|
383
313
|
*/
|
|
384
314
|
listActionExecutions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
385
315
|
return localVarFp.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
386
316
|
},
|
|
387
|
-
/**
|
|
388
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
389
|
-
* @summary Create the actionExecution
|
|
390
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
391
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
392
|
-
* @param {*} [options] Override http request option.
|
|
393
|
-
* @throws {RequiredError}
|
|
394
|
-
*/
|
|
395
|
-
triggerAction: function (triggerActionRequestDto, authorization, options) {
|
|
396
|
-
return localVarFp.triggerAction(triggerActionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
397
|
-
},
|
|
398
317
|
};
|
|
399
318
|
};
|
|
400
319
|
exports.ExecutionsApiFactory = ExecutionsApiFactory;
|
|
@@ -435,18 +354,6 @@ var ExecutionsApi = /** @class */ (function (_super) {
|
|
|
435
354
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
436
355
|
return (0, exports.ExecutionsApiFp)(this.configuration).listActionExecutions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
437
356
|
};
|
|
438
|
-
/**
|
|
439
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
440
|
-
* @summary Create the actionExecution
|
|
441
|
-
* @param {ExecutionsApiTriggerActionRequest} requestParameters Request parameters.
|
|
442
|
-
* @param {*} [options] Override http request option.
|
|
443
|
-
* @throws {RequiredError}
|
|
444
|
-
* @memberof ExecutionsApi
|
|
445
|
-
*/
|
|
446
|
-
ExecutionsApi.prototype.triggerAction = function (requestParameters, options) {
|
|
447
|
-
var _this = this;
|
|
448
|
-
return (0, exports.ExecutionsApiFp)(this.configuration).triggerAction(requestParameters.triggerActionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
449
|
-
};
|
|
450
357
|
return ExecutionsApi;
|
|
451
358
|
}(base_1.BaseAPI));
|
|
452
359
|
exports.ExecutionsApi = ExecutionsApi;
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { ActionVersionClass } from './action-version-class';
|
|
13
12
|
/**
|
|
14
13
|
*
|
|
15
14
|
* @export
|
|
@@ -29,17 +28,35 @@ export interface ActionClass {
|
|
|
29
28
|
*/
|
|
30
29
|
'code': string;
|
|
31
30
|
/**
|
|
32
|
-
* Human readable action name
|
|
31
|
+
* Human readable action name
|
|
33
32
|
* @type {string}
|
|
34
33
|
* @memberof ActionClass
|
|
35
34
|
*/
|
|
36
35
|
'name': string;
|
|
37
36
|
/**
|
|
38
|
-
* Stable identifier; unique per tenant
|
|
37
|
+
* Stable identifier; unique per tenant
|
|
39
38
|
* @type {string}
|
|
40
39
|
* @memberof ActionClass
|
|
41
40
|
*/
|
|
42
41
|
'slug': string;
|
|
42
|
+
/**
|
|
43
|
+
* BPMN/workflow code to execute when this action is triggered
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ActionClass
|
|
46
|
+
*/
|
|
47
|
+
'workflowCode'?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Whether the action is enabled and can be triggered
|
|
50
|
+
* @type {boolean}
|
|
51
|
+
* @memberof ActionClass
|
|
52
|
+
*/
|
|
53
|
+
'isEnabled': boolean;
|
|
54
|
+
/**
|
|
55
|
+
* Detailed description of what this action does
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ActionClass
|
|
58
|
+
*/
|
|
59
|
+
'description'?: string;
|
|
43
60
|
/**
|
|
44
61
|
* Time at which the object was created.
|
|
45
62
|
* @type {string}
|
|
@@ -64,10 +81,4 @@ export interface ActionClass {
|
|
|
64
81
|
* @memberof ActionClass
|
|
65
82
|
*/
|
|
66
83
|
'updatedBy': string;
|
|
67
|
-
/**
|
|
68
|
-
* No expand: empty. expand=versions: active version only. All versions: use listActionVersions.
|
|
69
|
-
* @type {Array<ActionVersionClass>}
|
|
70
|
-
* @memberof ActionClass
|
|
71
|
-
*/
|
|
72
|
-
'versions': Array<ActionVersionClass>;
|
|
73
84
|
}
|
|
@@ -34,12 +34,6 @@ export interface ActionExecutionClass {
|
|
|
34
34
|
* @memberof ActionExecutionClass
|
|
35
35
|
*/
|
|
36
36
|
'actionCode': string;
|
|
37
|
-
/**
|
|
38
|
-
* Action config version (version_number) at trigger time for audit/tracing
|
|
39
|
-
* @type {number}
|
|
40
|
-
* @memberof ActionExecutionClass
|
|
41
|
-
*/
|
|
42
|
-
'actionVersion': number;
|
|
43
37
|
/**
|
|
44
38
|
* Execution status
|
|
45
39
|
* @type {string}
|
|
@@ -110,34 +104,4 @@ export interface ActionExecutionClass {
|
|
|
110
104
|
* @memberof ActionExecutionClass
|
|
111
105
|
*/
|
|
112
106
|
'workflowOutputReference'?: WorkflowOutputReferenceClass;
|
|
113
|
-
/**
|
|
114
|
-
* When true, execution was triggered with force (e.g. draft/disabled action)
|
|
115
|
-
* @type {boolean}
|
|
116
|
-
* @memberof ActionExecutionClass
|
|
117
|
-
*/
|
|
118
|
-
'force'?: boolean;
|
|
119
|
-
/**
|
|
120
|
-
* For entity actions: code of the entity the action was run on (e.g. policy code, lead code)
|
|
121
|
-
* @type {string}
|
|
122
|
-
* @memberof ActionExecutionClass
|
|
123
|
-
*/
|
|
124
|
-
'entityCode'?: string;
|
|
125
|
-
/**
|
|
126
|
-
* For entity actions: entity type (POLICY, LEAD, CLAIM) for lookup
|
|
127
|
-
* @type {string}
|
|
128
|
-
* @memberof ActionExecutionClass
|
|
129
|
-
*/
|
|
130
|
-
'entityType'?: string;
|
|
131
|
-
/**
|
|
132
|
-
* JWT sub of who triggered the action (set when trigger is from API; null for webhook/system)
|
|
133
|
-
* @type {string}
|
|
134
|
-
* @memberof ActionExecutionClass
|
|
135
|
-
*/
|
|
136
|
-
'triggeredBySub'?: string;
|
|
137
|
-
/**
|
|
138
|
-
* When the action was triggered (set at creation, same for all status rows of this execution)
|
|
139
|
-
* @type {string}
|
|
140
|
-
* @memberof ActionExecutionClass
|
|
141
|
-
*/
|
|
142
|
-
'triggeredAt'?: string;
|
|
143
107
|
}
|
|
@@ -22,69 +22,27 @@ export interface CreateActionRequestDto {
|
|
|
22
22
|
*/
|
|
23
23
|
'name': string;
|
|
24
24
|
/**
|
|
25
|
-
* Stable identifier; auto-generated from
|
|
25
|
+
* Stable identifier; auto-generated from action_name if not provided
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateActionRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'slug'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* BPMN/workflow
|
|
31
|
+
* BPMN/workflow code to execute when this action is triggered
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateActionRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'workflowCode': string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof CreateActionRequestDto
|
|
40
|
-
*/
|
|
41
|
-
'workflowCode'?: string;
|
|
42
|
-
/**
|
|
43
|
-
* true = published (triggerable), false = draft. Default true.
|
|
37
|
+
* Whether the action is enabled and can be triggered
|
|
44
38
|
* @type {boolean}
|
|
45
39
|
* @memberof CreateActionRequestDto
|
|
46
40
|
*/
|
|
47
|
-
'
|
|
48
|
-
/**
|
|
49
|
-
* Whether the action is available in the UI
|
|
50
|
-
* @type {boolean}
|
|
51
|
-
* @memberof CreateActionRequestDto
|
|
52
|
-
*/
|
|
53
|
-
'isAvailableInUi'?: boolean;
|
|
41
|
+
'isEnabled'?: boolean;
|
|
54
42
|
/**
|
|
55
43
|
* Detailed description of what this action does
|
|
56
44
|
* @type {string}
|
|
57
45
|
* @memberof CreateActionRequestDto
|
|
58
46
|
*/
|
|
59
47
|
'description'?: string;
|
|
60
|
-
/**
|
|
61
|
-
* Entity type. When provided, productVersionId is required (and vice versa).
|
|
62
|
-
* @type {string}
|
|
63
|
-
* @memberof CreateActionRequestDto
|
|
64
|
-
*/
|
|
65
|
-
'entityType'?: CreateActionRequestDtoEntityTypeEnum;
|
|
66
|
-
/**
|
|
67
|
-
* Product version ID. Required for entity actions (when entityType is set).
|
|
68
|
-
* @type {number}
|
|
69
|
-
* @memberof CreateActionRequestDto
|
|
70
|
-
*/
|
|
71
|
-
'productVersionId'?: number;
|
|
72
|
-
/**
|
|
73
|
-
* Product slug. Required for entity actions (when entityType is set). Must match the product that owns productVersionId.
|
|
74
|
-
* @type {string}
|
|
75
|
-
* @memberof CreateActionRequestDto
|
|
76
|
-
*/
|
|
77
|
-
'productSlug'?: string;
|
|
78
|
-
/**
|
|
79
|
-
* Optional JSON Schema to validate input_payload when triggering the action
|
|
80
|
-
* @type {object}
|
|
81
|
-
* @memberof CreateActionRequestDto
|
|
82
|
-
*/
|
|
83
|
-
'inputValidationSchema'?: object;
|
|
84
48
|
}
|
|
85
|
-
export declare const CreateActionRequestDtoEntityTypeEnum: {
|
|
86
|
-
readonly Policy: "POLICY";
|
|
87
|
-
readonly Lead: "LEAD";
|
|
88
|
-
readonly Claim: "CLAIM";
|
|
89
|
-
};
|
|
90
|
-
export type CreateActionRequestDtoEntityTypeEnum = typeof CreateActionRequestDtoEntityTypeEnum[keyof typeof CreateActionRequestDtoEntityTypeEnum];
|
|
@@ -13,9 +13,3 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.CreateActionRequestDtoEntityTypeEnum = void 0;
|
|
17
|
-
exports.CreateActionRequestDtoEntityTypeEnum = {
|
|
18
|
-
Policy: 'POLICY',
|
|
19
|
-
Lead: 'LEAD',
|
|
20
|
-
Claim: 'CLAIM'
|
|
21
|
-
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,19 +1,13 @@
|
|
|
1
1
|
export * from './action-class';
|
|
2
2
|
export * from './action-execution-class';
|
|
3
|
-
export * from './action-ref-class';
|
|
4
|
-
export * from './action-version-class';
|
|
5
3
|
export * from './create-action-request-dto';
|
|
6
4
|
export * from './create-action-response-class';
|
|
7
5
|
export * from './get-action-execution-status-response-class';
|
|
8
6
|
export * from './get-action-response-class';
|
|
9
|
-
export * from './get-action-version-response-class';
|
|
10
7
|
export * from './inline-response200';
|
|
11
8
|
export * from './inline-response503';
|
|
12
9
|
export * from './list-action-executions-response-class';
|
|
13
|
-
export * from './list-action-versions-response-class';
|
|
14
10
|
export * from './list-actions-response-class';
|
|
15
|
-
export * from './trigger-action-request-dto';
|
|
16
|
-
export * from './trigger-action-response-class';
|
|
17
11
|
export * from './update-action-request-dto';
|
|
18
12
|
export * from './update-action-response-class';
|
|
19
13
|
export * from './workflow-output-reference-class';
|
package/dist/models/index.js
CHANGED
|
@@ -16,20 +16,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./action-class"), exports);
|
|
18
18
|
__exportStar(require("./action-execution-class"), exports);
|
|
19
|
-
__exportStar(require("./action-ref-class"), exports);
|
|
20
|
-
__exportStar(require("./action-version-class"), exports);
|
|
21
19
|
__exportStar(require("./create-action-request-dto"), exports);
|
|
22
20
|
__exportStar(require("./create-action-response-class"), exports);
|
|
23
21
|
__exportStar(require("./get-action-execution-status-response-class"), exports);
|
|
24
22
|
__exportStar(require("./get-action-response-class"), exports);
|
|
25
|
-
__exportStar(require("./get-action-version-response-class"), exports);
|
|
26
23
|
__exportStar(require("./inline-response200"), exports);
|
|
27
24
|
__exportStar(require("./inline-response503"), exports);
|
|
28
25
|
__exportStar(require("./list-action-executions-response-class"), exports);
|
|
29
|
-
__exportStar(require("./list-action-versions-response-class"), exports);
|
|
30
26
|
__exportStar(require("./list-actions-response-class"), exports);
|
|
31
|
-
__exportStar(require("./trigger-action-request-dto"), exports);
|
|
32
|
-
__exportStar(require("./trigger-action-response-class"), exports);
|
|
33
27
|
__exportStar(require("./update-action-request-dto"), exports);
|
|
34
28
|
__exportStar(require("./update-action-response-class"), exports);
|
|
35
29
|
__exportStar(require("./workflow-output-reference-class"), exports);
|