@emilgroup/action-sdk 1.0.1-beta.23 → 1.1.1-beta.10
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 +10 -0
- package/README.md +2 -2
- package/api/actions-api.ts +313 -42
- package/api/executions-api.ts +471 -0
- package/api.ts +2 -0
- package/dist/api/actions-api.d.ts +188 -39
- package/dist/api/actions-api.js +251 -38
- package/dist/api/executions-api.d.ts +272 -0
- package/dist/api/executions-api.js +452 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/action-class.d.ts +38 -2
- package/dist/models/action-execution-class.d.ts +137 -0
- package/dist/models/action-execution-class.js +15 -0
- package/dist/models/create-action-request-dto.d.ts +31 -1
- package/dist/models/create-action-request-dto.js +6 -0
- package/dist/models/export-actions-as-yaml-response-class.d.ts +24 -0
- package/dist/models/export-actions-as-yaml-response-class.js +15 -0
- package/dist/models/get-action-execution-status-response-class.d.ts +25 -0
- package/dist/models/get-action-execution-status-response-class.js +15 -0
- package/dist/models/import-actions-from-yaml-request-dto.d.ts +36 -0
- package/dist/models/import-actions-from-yaml-request-dto.js +15 -0
- package/dist/models/import-actions-from-yaml-response-class.d.ts +37 -0
- package/dist/models/import-actions-from-yaml-response-class.js +15 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/dist/models/list-action-executions-response-class.d.ts +43 -0
- package/dist/models/list-action-executions-response-class.js +15 -0
- package/dist/models/trigger-action-request-dto.d.ts +62 -0
- package/dist/models/trigger-action-request-dto.js +15 -0
- package/dist/models/trigger-action-response-class.d.ts +25 -0
- package/dist/models/trigger-action-response-class.js +15 -0
- package/dist/models/update-action-request-dto.d.ts +30 -0
- package/dist/models/update-action-request-dto.js +6 -0
- package/dist/models/workflow-output-reference-class.d.ts +30 -0
- package/dist/models/workflow-output-reference-class.js +15 -0
- package/models/action-class.ts +38 -2
- package/models/action-execution-class.ts +139 -0
- package/models/create-action-request-dto.ts +34 -1
- package/models/export-actions-as-yaml-response-class.ts +30 -0
- package/models/get-action-execution-status-response-class.ts +31 -0
- package/models/import-actions-from-yaml-request-dto.ts +42 -0
- package/models/import-actions-from-yaml-response-class.ts +43 -0
- package/models/index.ts +9 -0
- package/models/list-action-executions-response-class.ts +49 -0
- package/models/trigger-action-request-dto.ts +66 -0
- package/models/trigger-action-response-class.ts +31 -0
- package/models/update-action-request-dto.ts +33 -0
- package/models/workflow-output-reference-class.ts +36 -0
- package/package.json +2 -1
package/dist/api/actions-api.js
CHANGED
|
@@ -93,7 +93,7 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Creates a new action configuration
|
|
96
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
97
97
|
* @summary Create the action
|
|
98
98
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -142,7 +142,7 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* Deletes an action configuration by its code
|
|
145
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
146
146
|
* @summary Delete the action
|
|
147
147
|
* @param {string} code Action code
|
|
148
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -190,14 +190,79 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
193
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
194
|
+
* @summary Retrieve the entity-actions-yaml
|
|
195
|
+
* @param {string} productSlug Product slug
|
|
196
|
+
* @param {number} productVersionId Product version ID
|
|
197
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
199
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
200
|
+
* @param {*} [options] Override http request option.
|
|
201
|
+
* @throws {RequiredError}
|
|
202
|
+
*/
|
|
203
|
+
exportActionsAsYaml: function (productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options) {
|
|
204
|
+
if (options === void 0) { options = {}; }
|
|
205
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
206
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
207
|
+
return __generator(this, function (_a) {
|
|
208
|
+
switch (_a.label) {
|
|
209
|
+
case 0:
|
|
210
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
211
|
+
(0, common_1.assertParamExists)('exportActionsAsYaml', 'productSlug', productSlug);
|
|
212
|
+
// verify required parameter 'productVersionId' is not null or undefined
|
|
213
|
+
(0, common_1.assertParamExists)('exportActionsAsYaml', 'productVersionId', productVersionId);
|
|
214
|
+
localVarPath = "/actionservice/v1/actions/entity-actions-yaml";
|
|
215
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
216
|
+
if (configuration) {
|
|
217
|
+
baseOptions = configuration.baseOptions;
|
|
218
|
+
baseAccessToken = configuration.accessToken;
|
|
219
|
+
}
|
|
220
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
221
|
+
localVarHeaderParameter = {};
|
|
222
|
+
localVarQueryParameter = {};
|
|
223
|
+
// authentication bearer required
|
|
224
|
+
// http bearer authentication required
|
|
225
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
226
|
+
case 1:
|
|
227
|
+
// authentication bearer required
|
|
228
|
+
// http bearer authentication required
|
|
229
|
+
_a.sent();
|
|
230
|
+
if (productSlug !== undefined) {
|
|
231
|
+
localVarQueryParameter['productSlug'] = productSlug;
|
|
232
|
+
}
|
|
233
|
+
if (productVersionId !== undefined) {
|
|
234
|
+
localVarQueryParameter['productVersionId'] = productVersionId;
|
|
235
|
+
}
|
|
236
|
+
if (actionSlugs) {
|
|
237
|
+
localVarQueryParameter['actionSlugs'] = actionSlugs;
|
|
238
|
+
}
|
|
239
|
+
if (includeDisabled !== undefined) {
|
|
240
|
+
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
241
|
+
}
|
|
242
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
243
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
244
|
+
}
|
|
245
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
246
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
247
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
248
|
+
return [2 /*return*/, {
|
|
249
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
250
|
+
options: localVarRequestOptions,
|
|
251
|
+
}];
|
|
252
|
+
}
|
|
253
|
+
});
|
|
254
|
+
});
|
|
255
|
+
},
|
|
256
|
+
/**
|
|
257
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
194
258
|
* @summary Retrieve the action
|
|
195
259
|
* @param {string} code Action code
|
|
196
260
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
261
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
197
262
|
* @param {*} [options] Override http request option.
|
|
198
263
|
* @throws {RequiredError}
|
|
199
264
|
*/
|
|
200
|
-
getAction: function (code, authorization, options) {
|
|
265
|
+
getAction: function (code, authorization, expand, options) {
|
|
201
266
|
if (options === void 0) { options = {}; }
|
|
202
267
|
return __awaiter(_this, void 0, void 0, function () {
|
|
203
268
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -219,6 +284,56 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
219
284
|
// authentication bearer required
|
|
220
285
|
// http bearer authentication required
|
|
221
286
|
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
287
|
+
case 1:
|
|
288
|
+
// authentication bearer required
|
|
289
|
+
// http bearer authentication required
|
|
290
|
+
_a.sent();
|
|
291
|
+
if (expand !== undefined) {
|
|
292
|
+
localVarQueryParameter['expand'] = expand;
|
|
293
|
+
}
|
|
294
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
295
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
296
|
+
}
|
|
297
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
298
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
299
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
300
|
+
return [2 /*return*/, {
|
|
301
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
302
|
+
options: localVarRequestOptions,
|
|
303
|
+
}];
|
|
304
|
+
}
|
|
305
|
+
});
|
|
306
|
+
});
|
|
307
|
+
},
|
|
308
|
+
/**
|
|
309
|
+
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
310
|
+
* @summary Update the entity-actions-yaml
|
|
311
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
312
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
313
|
+
* @param {*} [options] Override http request option.
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
*/
|
|
316
|
+
importActionsFromYaml: function (importActionsFromYamlRequestDto, authorization, options) {
|
|
317
|
+
if (options === void 0) { options = {}; }
|
|
318
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
319
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
320
|
+
return __generator(this, function (_a) {
|
|
321
|
+
switch (_a.label) {
|
|
322
|
+
case 0:
|
|
323
|
+
// verify required parameter 'importActionsFromYamlRequestDto' is not null or undefined
|
|
324
|
+
(0, common_1.assertParamExists)('importActionsFromYaml', 'importActionsFromYamlRequestDto', importActionsFromYamlRequestDto);
|
|
325
|
+
localVarPath = "/actionservice/v1/actions/entity-actions-yaml";
|
|
326
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
327
|
+
if (configuration) {
|
|
328
|
+
baseOptions = configuration.baseOptions;
|
|
329
|
+
baseAccessToken = configuration.accessToken;
|
|
330
|
+
}
|
|
331
|
+
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
|
|
332
|
+
localVarHeaderParameter = {};
|
|
333
|
+
localVarQueryParameter = {};
|
|
334
|
+
// authentication bearer required
|
|
335
|
+
// http bearer authentication required
|
|
336
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
222
337
|
case 1:
|
|
223
338
|
// authentication bearer required
|
|
224
339
|
// http bearer authentication required
|
|
@@ -226,9 +341,11 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
226
341
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
227
342
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
228
343
|
}
|
|
344
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
229
345
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
230
346
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
231
347
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
348
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(importActionsFromYamlRequestDto, localVarRequestOptions, configuration);
|
|
232
349
|
return [2 /*return*/, {
|
|
233
350
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
234
351
|
options: localVarRequestOptions,
|
|
@@ -238,16 +355,16 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
238
355
|
});
|
|
239
356
|
},
|
|
240
357
|
/**
|
|
241
|
-
* Lists all action configurations with optional filters
|
|
358
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
242
359
|
* @summary List actions
|
|
243
360
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
361
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
362
|
* @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.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
363
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
247
364
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
|
-
* @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, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
249
|
-
* @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/>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
365
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
366
|
+
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
367
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
251
368
|
* @param {*} [options] Override http request option.
|
|
252
369
|
* @throws {RequiredError}
|
|
253
370
|
*/
|
|
@@ -310,7 +427,7 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
310
427
|
});
|
|
311
428
|
},
|
|
312
429
|
/**
|
|
313
|
-
* Updates an existing action configuration (patch semantics)
|
|
430
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
314
431
|
* @summary Update the action
|
|
315
432
|
* @param {string} code Action code
|
|
316
433
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -373,7 +490,7 @@ var ActionsApiFp = function (configuration) {
|
|
|
373
490
|
var localVarAxiosParamCreator = (0, exports.ActionsApiAxiosParamCreator)(configuration);
|
|
374
491
|
return {
|
|
375
492
|
/**
|
|
376
|
-
* Creates a new action configuration
|
|
493
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
377
494
|
* @summary Create the action
|
|
378
495
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
379
496
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -394,7 +511,7 @@ var ActionsApiFp = function (configuration) {
|
|
|
394
511
|
});
|
|
395
512
|
},
|
|
396
513
|
/**
|
|
397
|
-
* Deletes an action configuration by its code
|
|
514
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
398
515
|
* @summary Delete the action
|
|
399
516
|
* @param {string} code Action code
|
|
400
517
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -415,19 +532,44 @@ var ActionsApiFp = function (configuration) {
|
|
|
415
532
|
});
|
|
416
533
|
},
|
|
417
534
|
/**
|
|
418
|
-
*
|
|
535
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
536
|
+
* @summary Retrieve the entity-actions-yaml
|
|
537
|
+
* @param {string} productSlug Product slug
|
|
538
|
+
* @param {number} productVersionId Product version ID
|
|
539
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
541
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
542
|
+
* @param {*} [options] Override http request option.
|
|
543
|
+
* @throws {RequiredError}
|
|
544
|
+
*/
|
|
545
|
+
exportActionsAsYaml: function (productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options) {
|
|
546
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
547
|
+
var localVarAxiosArgs;
|
|
548
|
+
return __generator(this, function (_a) {
|
|
549
|
+
switch (_a.label) {
|
|
550
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options)];
|
|
551
|
+
case 1:
|
|
552
|
+
localVarAxiosArgs = _a.sent();
|
|
553
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
554
|
+
}
|
|
555
|
+
});
|
|
556
|
+
});
|
|
557
|
+
},
|
|
558
|
+
/**
|
|
559
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
419
560
|
* @summary Retrieve the action
|
|
420
561
|
* @param {string} code Action code
|
|
421
562
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
563
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
422
564
|
* @param {*} [options] Override http request option.
|
|
423
565
|
* @throws {RequiredError}
|
|
424
566
|
*/
|
|
425
|
-
getAction: function (code, authorization, options) {
|
|
567
|
+
getAction: function (code, authorization, expand, options) {
|
|
426
568
|
return __awaiter(this, void 0, void 0, function () {
|
|
427
569
|
var localVarAxiosArgs;
|
|
428
570
|
return __generator(this, function (_a) {
|
|
429
571
|
switch (_a.label) {
|
|
430
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getAction(code, authorization, options)];
|
|
572
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getAction(code, authorization, expand, options)];
|
|
431
573
|
case 1:
|
|
432
574
|
localVarAxiosArgs = _a.sent();
|
|
433
575
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -436,16 +578,37 @@ var ActionsApiFp = function (configuration) {
|
|
|
436
578
|
});
|
|
437
579
|
},
|
|
438
580
|
/**
|
|
439
|
-
*
|
|
581
|
+
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
582
|
+
* @summary Update the entity-actions-yaml
|
|
583
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
584
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
585
|
+
* @param {*} [options] Override http request option.
|
|
586
|
+
* @throws {RequiredError}
|
|
587
|
+
*/
|
|
588
|
+
importActionsFromYaml: function (importActionsFromYamlRequestDto, authorization, options) {
|
|
589
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
590
|
+
var localVarAxiosArgs;
|
|
591
|
+
return __generator(this, function (_a) {
|
|
592
|
+
switch (_a.label) {
|
|
593
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options)];
|
|
594
|
+
case 1:
|
|
595
|
+
localVarAxiosArgs = _a.sent();
|
|
596
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
597
|
+
}
|
|
598
|
+
});
|
|
599
|
+
});
|
|
600
|
+
},
|
|
601
|
+
/**
|
|
602
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
440
603
|
* @summary List actions
|
|
441
604
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
605
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
606
|
* @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.
|
|
444
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
607
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
445
608
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
446
|
-
* @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, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
447
|
-
* @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/>
|
|
448
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
609
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
610
|
+
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
611
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
449
612
|
* @param {*} [options] Override http request option.
|
|
450
613
|
* @throws {RequiredError}
|
|
451
614
|
*/
|
|
@@ -463,7 +626,7 @@ var ActionsApiFp = function (configuration) {
|
|
|
463
626
|
});
|
|
464
627
|
},
|
|
465
628
|
/**
|
|
466
|
-
* Updates an existing action configuration (patch semantics)
|
|
629
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
467
630
|
* @summary Update the action
|
|
468
631
|
* @param {string} code Action code
|
|
469
632
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -495,7 +658,7 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
495
658
|
var localVarFp = (0, exports.ActionsApiFp)(configuration);
|
|
496
659
|
return {
|
|
497
660
|
/**
|
|
498
|
-
* Creates a new action configuration
|
|
661
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
499
662
|
* @summary Create the action
|
|
500
663
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
501
664
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -506,7 +669,7 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
506
669
|
return localVarFp.createAction(createActionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
507
670
|
},
|
|
508
671
|
/**
|
|
509
|
-
* Deletes an action configuration by its code
|
|
672
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
510
673
|
* @summary Delete the action
|
|
511
674
|
* @param {string} code Action code
|
|
512
675
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -517,27 +680,53 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
517
680
|
return localVarFp.deleteAction(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
518
681
|
},
|
|
519
682
|
/**
|
|
520
|
-
*
|
|
683
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
684
|
+
* @summary Retrieve the entity-actions-yaml
|
|
685
|
+
* @param {string} productSlug Product slug
|
|
686
|
+
* @param {number} productVersionId Product version ID
|
|
687
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
688
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
689
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
690
|
+
* @param {*} [options] Override http request option.
|
|
691
|
+
* @throws {RequiredError}
|
|
692
|
+
*/
|
|
693
|
+
exportActionsAsYaml: function (productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options) {
|
|
694
|
+
return localVarFp.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options).then(function (request) { return request(axios, basePath); });
|
|
695
|
+
},
|
|
696
|
+
/**
|
|
697
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
521
698
|
* @summary Retrieve the action
|
|
522
699
|
* @param {string} code Action code
|
|
523
700
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
701
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
702
|
+
* @param {*} [options] Override http request option.
|
|
703
|
+
* @throws {RequiredError}
|
|
704
|
+
*/
|
|
705
|
+
getAction: function (code, authorization, expand, options) {
|
|
706
|
+
return localVarFp.getAction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
707
|
+
},
|
|
708
|
+
/**
|
|
709
|
+
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
710
|
+
* @summary Update the entity-actions-yaml
|
|
711
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
712
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
713
|
* @param {*} [options] Override http request option.
|
|
525
714
|
* @throws {RequiredError}
|
|
526
715
|
*/
|
|
527
|
-
|
|
528
|
-
return localVarFp.
|
|
716
|
+
importActionsFromYaml: function (importActionsFromYamlRequestDto, authorization, options) {
|
|
717
|
+
return localVarFp.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
529
718
|
},
|
|
530
719
|
/**
|
|
531
|
-
* Lists all action configurations with optional filters
|
|
720
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
532
721
|
* @summary List actions
|
|
533
722
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
534
723
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
535
724
|
* @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.
|
|
536
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
725
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
537
726
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
538
|
-
* @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, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
539
|
-
* @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/>
|
|
540
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
727
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
728
|
+
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
729
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
541
730
|
* @param {*} [options] Override http request option.
|
|
542
731
|
* @throws {RequiredError}
|
|
543
732
|
*/
|
|
@@ -545,7 +734,7 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
545
734
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
546
735
|
},
|
|
547
736
|
/**
|
|
548
|
-
* Updates an existing action configuration (patch semantics)
|
|
737
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
549
738
|
* @summary Update the action
|
|
550
739
|
* @param {string} code Action code
|
|
551
740
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -571,7 +760,7 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
571
760
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
572
761
|
}
|
|
573
762
|
/**
|
|
574
|
-
* Creates a new action configuration
|
|
763
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
575
764
|
* @summary Create the action
|
|
576
765
|
* @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
|
|
577
766
|
* @param {*} [options] Override http request option.
|
|
@@ -583,7 +772,7 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
583
772
|
return (0, exports.ActionsApiFp)(this.configuration).createAction(requestParameters.createActionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
584
773
|
};
|
|
585
774
|
/**
|
|
586
|
-
* Deletes an action configuration by its code
|
|
775
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
587
776
|
* @summary Delete the action
|
|
588
777
|
* @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
|
|
589
778
|
* @param {*} [options] Override http request option.
|
|
@@ -595,7 +784,19 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
595
784
|
return (0, exports.ActionsApiFp)(this.configuration).deleteAction(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
596
785
|
};
|
|
597
786
|
/**
|
|
598
|
-
*
|
|
787
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
788
|
+
* @summary Retrieve the entity-actions-yaml
|
|
789
|
+
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
790
|
+
* @param {*} [options] Override http request option.
|
|
791
|
+
* @throws {RequiredError}
|
|
792
|
+
* @memberof ActionsApi
|
|
793
|
+
*/
|
|
794
|
+
ActionsApi.prototype.exportActionsAsYaml = function (requestParameters, options) {
|
|
795
|
+
var _this = this;
|
|
796
|
+
return (0, exports.ActionsApiFp)(this.configuration).exportActionsAsYaml(requestParameters.productSlug, requestParameters.productVersionId, requestParameters.authorization, requestParameters.actionSlugs, requestParameters.includeDisabled, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
797
|
+
};
|
|
798
|
+
/**
|
|
799
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
599
800
|
* @summary Retrieve the action
|
|
600
801
|
* @param {ActionsApiGetActionRequest} requestParameters Request parameters.
|
|
601
802
|
* @param {*} [options] Override http request option.
|
|
@@ -604,10 +805,22 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
604
805
|
*/
|
|
605
806
|
ActionsApi.prototype.getAction = function (requestParameters, options) {
|
|
606
807
|
var _this = this;
|
|
607
|
-
return (0, exports.ActionsApiFp)(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
808
|
+
return (0, exports.ActionsApiFp)(this.configuration).getAction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
809
|
+
};
|
|
810
|
+
/**
|
|
811
|
+
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
812
|
+
* @summary Update the entity-actions-yaml
|
|
813
|
+
* @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
|
|
814
|
+
* @param {*} [options] Override http request option.
|
|
815
|
+
* @throws {RequiredError}
|
|
816
|
+
* @memberof ActionsApi
|
|
817
|
+
*/
|
|
818
|
+
ActionsApi.prototype.importActionsFromYaml = function (requestParameters, options) {
|
|
819
|
+
var _this = this;
|
|
820
|
+
return (0, exports.ActionsApiFp)(this.configuration).importActionsFromYaml(requestParameters.importActionsFromYamlRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
608
821
|
};
|
|
609
822
|
/**
|
|
610
|
-
* Lists all action configurations with optional filters
|
|
823
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
611
824
|
* @summary List actions
|
|
612
825
|
* @param {ActionsApiListActionsRequest} requestParameters Request parameters.
|
|
613
826
|
* @param {*} [options] Override http request option.
|
|
@@ -620,7 +833,7 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
620
833
|
return (0, exports.ActionsApiFp)(this.configuration).listActions(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); });
|
|
621
834
|
};
|
|
622
835
|
/**
|
|
623
|
-
* Updates an existing action configuration (patch semantics)
|
|
836
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
624
837
|
* @summary Update the action
|
|
625
838
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
626
839
|
* @param {*} [options] Override http request option.
|