@emilgroup/action-sdk-node 1.0.1-beta.31 → 1.0.1-beta.35
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 +6 -0
- package/README.md +2 -2
- package/api/actions-api.ts +184 -219
- package/api/executions-api.ts +475 -0
- package/api.ts +2 -0
- package/dist/api/actions-api.d.ts +140 -166
- package/dist/api/actions-api.js +126 -141
- package/dist/api/executions-api.d.ts +272 -0
- package/dist/api/executions-api.js +456 -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 +30 -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/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 +5 -0
- package/dist/models/index.js +5 -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/models/action-class.ts +38 -2
- package/models/action-execution-class.ts +30 -0
- package/models/create-action-request-dto.ts +34 -1
- package/models/export-actions-as-yaml-response-class.ts +30 -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 +5 -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/package.json +1 -1
package/api/actions-api.ts
CHANGED
|
@@ -25,11 +25,13 @@ import { CreateActionRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateActionResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import {
|
|
28
|
+
import { ExportActionsAsYamlResponseClass } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { GetActionResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
32
|
-
import {
|
|
32
|
+
import { ImportActionsFromYamlRequestDto } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { ImportActionsFromYamlResponseClass } from '../models';
|
|
33
35
|
// @ts-ignore
|
|
34
36
|
import { ListActionsResponseClass } from '../models';
|
|
35
37
|
// @ts-ignore
|
|
@@ -47,7 +49,7 @@ const FormData = require('form-data');
|
|
|
47
49
|
export const ActionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
50
|
return {
|
|
49
51
|
/**
|
|
50
|
-
* Creates a new action configuration
|
|
52
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
51
53
|
* @summary Create the action
|
|
52
54
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
53
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -94,7 +96,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
94
96
|
};
|
|
95
97
|
},
|
|
96
98
|
/**
|
|
97
|
-
* Deletes an action configuration by its code
|
|
99
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
98
100
|
* @summary Delete the action
|
|
99
101
|
* @param {string} code Action code
|
|
100
102
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -139,18 +141,22 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
139
141
|
};
|
|
140
142
|
},
|
|
141
143
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @summary Retrieve the
|
|
144
|
-
* @param {string}
|
|
144
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
145
|
+
* @summary Retrieve the entity-actions-yaml
|
|
146
|
+
* @param {string} productSlug Product slug
|
|
147
|
+
* @param {number} productVersionId Product version ID
|
|
145
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
150
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
146
151
|
* @param {*} [options] Override http request option.
|
|
147
152
|
* @throws {RequiredError}
|
|
148
153
|
*/
|
|
149
|
-
|
|
150
|
-
// verify required parameter '
|
|
151
|
-
assertParamExists('
|
|
152
|
-
|
|
153
|
-
|
|
154
|
+
exportActionsAsYaml: async (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
155
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
156
|
+
assertParamExists('exportActionsAsYaml', 'productSlug', productSlug)
|
|
157
|
+
// verify required parameter 'productVersionId' is not null or undefined
|
|
158
|
+
assertParamExists('exportActionsAsYaml', 'productVersionId', productVersionId)
|
|
159
|
+
const localVarPath = `/actionservice/v1/actions/entity-actions-yaml`;
|
|
154
160
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
155
161
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
156
162
|
let baseOptions;
|
|
@@ -168,6 +174,22 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
168
174
|
// http bearer authentication required
|
|
169
175
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
170
176
|
|
|
177
|
+
if (productSlug !== undefined) {
|
|
178
|
+
localVarQueryParameter['productSlug'] = productSlug;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
if (productVersionId !== undefined) {
|
|
182
|
+
localVarQueryParameter['productVersionId'] = productVersionId;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
if (actionSlugs) {
|
|
186
|
+
localVarQueryParameter['actionSlugs'] = actionSlugs;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
if (includeDisabled !== undefined) {
|
|
190
|
+
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
191
|
+
}
|
|
192
|
+
|
|
171
193
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
172
194
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
173
195
|
}
|
|
@@ -184,16 +206,19 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
184
206
|
};
|
|
185
207
|
},
|
|
186
208
|
/**
|
|
187
|
-
* Retrieves
|
|
188
|
-
* @summary Retrieve the
|
|
209
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
210
|
+
* @summary Retrieve the action
|
|
211
|
+
* @param {string} code Action code
|
|
189
212
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
-
* @param {string} [
|
|
191
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
213
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
192
214
|
* @param {*} [options] Override http request option.
|
|
193
215
|
* @throws {RequiredError}
|
|
194
216
|
*/
|
|
195
|
-
|
|
196
|
-
|
|
217
|
+
getAction: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
218
|
+
// verify required parameter 'code' is not null or undefined
|
|
219
|
+
assertParamExists('getAction', 'code', code)
|
|
220
|
+
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
221
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
197
222
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
223
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
199
224
|
let baseOptions;
|
|
@@ -211,12 +236,8 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
211
236
|
// http bearer authentication required
|
|
212
237
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
213
238
|
|
|
214
|
-
if (
|
|
215
|
-
localVarQueryParameter['
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
if (correlationId !== undefined) {
|
|
219
|
-
localVarQueryParameter['correlationId'] = correlationId;
|
|
239
|
+
if (expand !== undefined) {
|
|
240
|
+
localVarQueryParameter['expand'] = expand;
|
|
220
241
|
}
|
|
221
242
|
|
|
222
243
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
@@ -235,21 +256,17 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
235
256
|
};
|
|
236
257
|
},
|
|
237
258
|
/**
|
|
238
|
-
*
|
|
239
|
-
* @summary
|
|
259
|
+
* 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\"
|
|
260
|
+
* @summary Update the entity-actions-yaml
|
|
261
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
240
262
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
241
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
242
|
-
* @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.
|
|
243
|
-
* @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>
|
|
244
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
245
|
-
* @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>
|
|
246
|
-
* @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/>
|
|
247
|
-
* @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>
|
|
248
263
|
* @param {*} [options] Override http request option.
|
|
249
264
|
* @throws {RequiredError}
|
|
250
265
|
*/
|
|
251
|
-
|
|
252
|
-
|
|
266
|
+
importActionsFromYaml: async (importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
267
|
+
// verify required parameter 'importActionsFromYamlRequestDto' is not null or undefined
|
|
268
|
+
assertParamExists('importActionsFromYaml', 'importActionsFromYamlRequestDto', importActionsFromYamlRequestDto)
|
|
269
|
+
const localVarPath = `/actionservice/v1/actions/entity-actions-yaml`;
|
|
253
270
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
254
271
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
255
272
|
let baseOptions;
|
|
@@ -259,7 +276,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
259
276
|
baseAccessToken = configuration.accessToken;
|
|
260
277
|
}
|
|
261
278
|
|
|
262
|
-
const localVarRequestOptions = { method: '
|
|
279
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
263
280
|
const localVarHeaderParameter = {} as any;
|
|
264
281
|
const localVarQueryParameter = {} as any;
|
|
265
282
|
|
|
@@ -267,43 +284,18 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
267
284
|
// http bearer authentication required
|
|
268
285
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
269
286
|
|
|
270
|
-
if (pageSize !== undefined) {
|
|
271
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
if (pageToken !== undefined) {
|
|
275
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
if (filter !== undefined) {
|
|
279
|
-
localVarQueryParameter['filter'] = filter;
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
if (search !== undefined) {
|
|
283
|
-
localVarQueryParameter['search'] = search;
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
if (order !== undefined) {
|
|
287
|
-
localVarQueryParameter['order'] = order;
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
if (expand !== undefined) {
|
|
291
|
-
localVarQueryParameter['expand'] = expand;
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
if (filters !== undefined) {
|
|
295
|
-
localVarQueryParameter['filters'] = filters;
|
|
296
|
-
}
|
|
297
|
-
|
|
298
287
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
299
288
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
300
289
|
}
|
|
301
290
|
|
|
302
291
|
|
|
303
292
|
|
|
293
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
294
|
+
|
|
304
295
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
305
296
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
306
297
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
298
|
+
localVarRequestOptions.data = serializeDataIfNeeded(importActionsFromYamlRequestDto, localVarRequestOptions, configuration)
|
|
307
299
|
|
|
308
300
|
return {
|
|
309
301
|
url: toPathString(localVarUrlObj),
|
|
@@ -311,16 +303,16 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
311
303
|
};
|
|
312
304
|
},
|
|
313
305
|
/**
|
|
314
|
-
* Lists all action configurations with optional filters
|
|
306
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
315
307
|
* @summary List actions
|
|
316
308
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
317
309
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
318
310
|
* @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.
|
|
319
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
311
|
+
* @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>
|
|
320
312
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
321
|
-
* @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>
|
|
322
|
-
* @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/>
|
|
323
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
313
|
+
* @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>
|
|
314
|
+
* @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>
|
|
315
|
+
* @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>
|
|
324
316
|
* @param {*} [options] Override http request option.
|
|
325
317
|
* @throws {RequiredError}
|
|
326
318
|
*/
|
|
@@ -387,7 +379,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
387
379
|
};
|
|
388
380
|
},
|
|
389
381
|
/**
|
|
390
|
-
* Updates an existing action configuration (patch semantics)
|
|
382
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
391
383
|
* @summary Update the action
|
|
392
384
|
* @param {string} code Action code
|
|
393
385
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -448,7 +440,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
448
440
|
const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration)
|
|
449
441
|
return {
|
|
450
442
|
/**
|
|
451
|
-
* Creates a new action configuration
|
|
443
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
452
444
|
* @summary Create the action
|
|
453
445
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
454
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -460,7 +452,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
460
452
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
461
453
|
},
|
|
462
454
|
/**
|
|
463
|
-
* Deletes an action configuration by its code
|
|
455
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
464
456
|
* @summary Delete the action
|
|
465
457
|
* @param {string} code Action code
|
|
466
458
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -472,59 +464,56 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
472
464
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
473
465
|
},
|
|
474
466
|
/**
|
|
475
|
-
*
|
|
476
|
-
* @summary Retrieve the
|
|
477
|
-
* @param {string}
|
|
467
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
468
|
+
* @summary Retrieve the entity-actions-yaml
|
|
469
|
+
* @param {string} productSlug Product slug
|
|
470
|
+
* @param {number} productVersionId Product version ID
|
|
478
471
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
472
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
473
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
479
474
|
* @param {*} [options] Override http request option.
|
|
480
475
|
* @throws {RequiredError}
|
|
481
476
|
*/
|
|
482
|
-
async
|
|
483
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
477
|
+
async exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>> {
|
|
478
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options);
|
|
484
479
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
485
480
|
},
|
|
486
481
|
/**
|
|
487
|
-
* Retrieves
|
|
488
|
-
* @summary Retrieve the
|
|
482
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
483
|
+
* @summary Retrieve the action
|
|
484
|
+
* @param {string} code Action code
|
|
489
485
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
490
|
-
* @param {string} [
|
|
491
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
486
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
492
487
|
* @param {*} [options] Override http request option.
|
|
493
488
|
* @throws {RequiredError}
|
|
494
489
|
*/
|
|
495
|
-
async
|
|
496
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
490
|
+
async getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
|
|
491
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, expand, options);
|
|
497
492
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
498
493
|
},
|
|
499
494
|
/**
|
|
500
|
-
*
|
|
501
|
-
* @summary
|
|
495
|
+
* 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\"
|
|
496
|
+
* @summary Update the entity-actions-yaml
|
|
497
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
502
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
503
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
504
|
-
* @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.
|
|
505
|
-
* @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>
|
|
506
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
507
|
-
* @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>
|
|
508
|
-
* @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/>
|
|
509
|
-
* @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>
|
|
510
499
|
* @param {*} [options] Override http request option.
|
|
511
500
|
* @throws {RequiredError}
|
|
512
501
|
*/
|
|
513
|
-
async
|
|
514
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
502
|
+
async importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>> {
|
|
503
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options);
|
|
515
504
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
516
505
|
},
|
|
517
506
|
/**
|
|
518
|
-
* Lists all action configurations with optional filters
|
|
507
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
519
508
|
* @summary List actions
|
|
520
509
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
521
510
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
522
511
|
* @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.
|
|
523
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
512
|
+
* @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>
|
|
524
513
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
525
|
-
* @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>
|
|
526
|
-
* @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/>
|
|
527
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
514
|
+
* @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>
|
|
515
|
+
* @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>
|
|
516
|
+
* @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>
|
|
528
517
|
* @param {*} [options] Override http request option.
|
|
529
518
|
* @throws {RequiredError}
|
|
530
519
|
*/
|
|
@@ -533,7 +522,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
533
522
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
534
523
|
},
|
|
535
524
|
/**
|
|
536
|
-
* Updates an existing action configuration (patch semantics)
|
|
525
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
537
526
|
* @summary Update the action
|
|
538
527
|
* @param {string} code Action code
|
|
539
528
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -556,7 +545,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
556
545
|
const localVarFp = ActionsApiFp(configuration)
|
|
557
546
|
return {
|
|
558
547
|
/**
|
|
559
|
-
* Creates a new action configuration
|
|
548
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
560
549
|
* @summary Create the action
|
|
561
550
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
562
551
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -567,7 +556,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
567
556
|
return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
568
557
|
},
|
|
569
558
|
/**
|
|
570
|
-
* Deletes an action configuration by its code
|
|
559
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
571
560
|
* @summary Delete the action
|
|
572
561
|
* @param {string} code Action code
|
|
573
562
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -578,56 +567,53 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
578
567
|
return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
|
|
579
568
|
},
|
|
580
569
|
/**
|
|
581
|
-
*
|
|
582
|
-
* @summary Retrieve the
|
|
583
|
-
* @param {string}
|
|
570
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
571
|
+
* @summary Retrieve the entity-actions-yaml
|
|
572
|
+
* @param {string} productSlug Product slug
|
|
573
|
+
* @param {number} productVersionId Product version ID
|
|
584
574
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
575
|
+
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
576
|
+
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
585
577
|
* @param {*} [options] Override http request option.
|
|
586
578
|
* @throws {RequiredError}
|
|
587
579
|
*/
|
|
588
|
-
|
|
589
|
-
return localVarFp.
|
|
580
|
+
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass> {
|
|
581
|
+
return localVarFp.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options).then((request) => request(axios, basePath));
|
|
590
582
|
},
|
|
591
583
|
/**
|
|
592
|
-
* Retrieves
|
|
593
|
-
* @summary Retrieve the
|
|
584
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
585
|
+
* @summary Retrieve the action
|
|
586
|
+
* @param {string} code Action code
|
|
594
587
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
595
|
-
* @param {string} [
|
|
596
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
588
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
597
589
|
* @param {*} [options] Override http request option.
|
|
598
590
|
* @throws {RequiredError}
|
|
599
591
|
*/
|
|
600
|
-
|
|
601
|
-
return localVarFp.
|
|
592
|
+
getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass> {
|
|
593
|
+
return localVarFp.getAction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
602
594
|
},
|
|
603
595
|
/**
|
|
604
|
-
*
|
|
605
|
-
* @summary
|
|
596
|
+
* 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\"
|
|
597
|
+
* @summary Update the entity-actions-yaml
|
|
598
|
+
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
606
599
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
607
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
608
|
-
* @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.
|
|
609
|
-
* @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>
|
|
610
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
611
|
-
* @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>
|
|
612
|
-
* @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/>
|
|
613
|
-
* @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>
|
|
614
600
|
* @param {*} [options] Override http request option.
|
|
615
601
|
* @throws {RequiredError}
|
|
616
602
|
*/
|
|
617
|
-
|
|
618
|
-
return localVarFp.
|
|
603
|
+
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass> {
|
|
604
|
+
return localVarFp.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
619
605
|
},
|
|
620
606
|
/**
|
|
621
|
-
* Lists all action configurations with optional filters
|
|
607
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
622
608
|
* @summary List actions
|
|
623
609
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
624
610
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
625
611
|
* @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.
|
|
626
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
612
|
+
* @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>
|
|
627
613
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
628
|
-
* @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>
|
|
629
|
-
* @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/>
|
|
630
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
614
|
+
* @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>
|
|
615
|
+
* @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>
|
|
616
|
+
* @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>
|
|
631
617
|
* @param {*} [options] Override http request option.
|
|
632
618
|
* @throws {RequiredError}
|
|
633
619
|
*/
|
|
@@ -635,7 +621,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
635
621
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
636
622
|
},
|
|
637
623
|
/**
|
|
638
|
-
* Updates an existing action configuration (patch semantics)
|
|
624
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
639
625
|
* @summary Update the action
|
|
640
626
|
* @param {string} code Action code
|
|
641
627
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -692,115 +678,94 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
692
678
|
}
|
|
693
679
|
|
|
694
680
|
/**
|
|
695
|
-
* Request parameters for
|
|
681
|
+
* Request parameters for exportActionsAsYaml operation in ActionsApi.
|
|
696
682
|
* @export
|
|
697
|
-
* @interface
|
|
683
|
+
* @interface ActionsApiExportActionsAsYamlRequest
|
|
698
684
|
*/
|
|
699
|
-
export interface
|
|
685
|
+
export interface ActionsApiExportActionsAsYamlRequest {
|
|
700
686
|
/**
|
|
701
|
-
*
|
|
687
|
+
* Product slug
|
|
702
688
|
* @type {string}
|
|
703
|
-
* @memberof
|
|
689
|
+
* @memberof ActionsApiExportActionsAsYaml
|
|
704
690
|
*/
|
|
705
|
-
readonly
|
|
691
|
+
readonly productSlug: string
|
|
706
692
|
|
|
707
693
|
/**
|
|
708
|
-
*
|
|
709
|
-
* @type {
|
|
710
|
-
* @memberof
|
|
694
|
+
* Product version ID
|
|
695
|
+
* @type {number}
|
|
696
|
+
* @memberof ActionsApiExportActionsAsYaml
|
|
711
697
|
*/
|
|
712
|
-
readonly
|
|
713
|
-
}
|
|
698
|
+
readonly productVersionId: number
|
|
714
699
|
|
|
715
|
-
/**
|
|
716
|
-
* Request parameters for getActionExecutionStatus operation in ActionsApi.
|
|
717
|
-
* @export
|
|
718
|
-
* @interface ActionsApiGetActionExecutionStatusRequest
|
|
719
|
-
*/
|
|
720
|
-
export interface ActionsApiGetActionExecutionStatusRequest {
|
|
721
700
|
/**
|
|
722
701
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
723
702
|
* @type {string}
|
|
724
|
-
* @memberof
|
|
703
|
+
* @memberof ActionsApiExportActionsAsYaml
|
|
725
704
|
*/
|
|
726
705
|
readonly authorization?: string
|
|
727
706
|
|
|
728
707
|
/**
|
|
729
|
-
*
|
|
730
|
-
* @type {string}
|
|
731
|
-
* @memberof
|
|
708
|
+
* Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
709
|
+
* @type {Array<string>}
|
|
710
|
+
* @memberof ActionsApiExportActionsAsYaml
|
|
732
711
|
*/
|
|
733
|
-
readonly
|
|
712
|
+
readonly actionSlugs?: Array<string>
|
|
734
713
|
|
|
735
714
|
/**
|
|
736
|
-
*
|
|
737
|
-
* @type {
|
|
738
|
-
* @memberof
|
|
715
|
+
* Include draft (disabled) actions
|
|
716
|
+
* @type {boolean}
|
|
717
|
+
* @memberof ActionsApiExportActionsAsYaml
|
|
739
718
|
*/
|
|
740
|
-
readonly
|
|
719
|
+
readonly includeDisabled?: boolean
|
|
741
720
|
}
|
|
742
721
|
|
|
743
722
|
/**
|
|
744
|
-
* Request parameters for
|
|
723
|
+
* Request parameters for getAction operation in ActionsApi.
|
|
745
724
|
* @export
|
|
746
|
-
* @interface
|
|
725
|
+
* @interface ActionsApiGetActionRequest
|
|
747
726
|
*/
|
|
748
|
-
export interface
|
|
749
|
-
/**
|
|
750
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
751
|
-
* @type {string}
|
|
752
|
-
* @memberof ActionsApiListActionExecutions
|
|
753
|
-
*/
|
|
754
|
-
readonly authorization?: string
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
758
|
-
* @type {number}
|
|
759
|
-
* @memberof ActionsApiListActionExecutions
|
|
760
|
-
*/
|
|
761
|
-
readonly pageSize?: number
|
|
762
|
-
|
|
763
|
-
/**
|
|
764
|
-
* 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.
|
|
765
|
-
* @type {string}
|
|
766
|
-
* @memberof ActionsApiListActionExecutions
|
|
767
|
-
*/
|
|
768
|
-
readonly pageToken?: string
|
|
769
|
-
|
|
727
|
+
export interface ActionsApiGetActionRequest {
|
|
770
728
|
/**
|
|
771
|
-
*
|
|
729
|
+
* Action code
|
|
772
730
|
* @type {string}
|
|
773
|
-
* @memberof
|
|
731
|
+
* @memberof ActionsApiGetAction
|
|
774
732
|
*/
|
|
775
|
-
readonly
|
|
733
|
+
readonly code: string
|
|
776
734
|
|
|
777
735
|
/**
|
|
778
|
-
*
|
|
736
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
779
737
|
* @type {string}
|
|
780
|
-
* @memberof
|
|
738
|
+
* @memberof ActionsApiGetAction
|
|
781
739
|
*/
|
|
782
|
-
readonly
|
|
740
|
+
readonly authorization?: string
|
|
783
741
|
|
|
784
742
|
/**
|
|
785
|
-
*
|
|
743
|
+
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
786
744
|
* @type {string}
|
|
787
|
-
* @memberof
|
|
745
|
+
* @memberof ActionsApiGetAction
|
|
788
746
|
*/
|
|
789
|
-
readonly
|
|
747
|
+
readonly expand?: string
|
|
748
|
+
}
|
|
790
749
|
|
|
750
|
+
/**
|
|
751
|
+
* Request parameters for importActionsFromYaml operation in ActionsApi.
|
|
752
|
+
* @export
|
|
753
|
+
* @interface ActionsApiImportActionsFromYamlRequest
|
|
754
|
+
*/
|
|
755
|
+
export interface ActionsApiImportActionsFromYamlRequest {
|
|
791
756
|
/**
|
|
792
|
-
*
|
|
793
|
-
* @type {
|
|
794
|
-
* @memberof
|
|
757
|
+
*
|
|
758
|
+
* @type {ImportActionsFromYamlRequestDto}
|
|
759
|
+
* @memberof ActionsApiImportActionsFromYaml
|
|
795
760
|
*/
|
|
796
|
-
readonly
|
|
761
|
+
readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto
|
|
797
762
|
|
|
798
763
|
/**
|
|
799
|
-
*
|
|
764
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
800
765
|
* @type {string}
|
|
801
|
-
* @memberof
|
|
766
|
+
* @memberof ActionsApiImportActionsFromYaml
|
|
802
767
|
*/
|
|
803
|
-
readonly
|
|
768
|
+
readonly authorization?: string
|
|
804
769
|
}
|
|
805
770
|
|
|
806
771
|
/**
|
|
@@ -831,7 +796,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
831
796
|
readonly pageToken?: string
|
|
832
797
|
|
|
833
798
|
/**
|
|
834
|
-
* Filter the response by one or multiple fields.
|
|
799
|
+
* 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>
|
|
835
800
|
* @type {string}
|
|
836
801
|
* @memberof ActionsApiListActions
|
|
837
802
|
*/
|
|
@@ -845,21 +810,21 @@ export interface ActionsApiListActionsRequest {
|
|
|
845
810
|
readonly search?: string
|
|
846
811
|
|
|
847
812
|
/**
|
|
848
|
-
* 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>
|
|
813
|
+
* 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>
|
|
849
814
|
* @type {string}
|
|
850
815
|
* @memberof ActionsApiListActions
|
|
851
816
|
*/
|
|
852
817
|
readonly order?: string
|
|
853
818
|
|
|
854
819
|
/**
|
|
855
|
-
* 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/>
|
|
820
|
+
* 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>
|
|
856
821
|
* @type {string}
|
|
857
822
|
* @memberof ActionsApiListActions
|
|
858
823
|
*/
|
|
859
824
|
readonly expand?: string
|
|
860
825
|
|
|
861
826
|
/**
|
|
862
|
-
* Filters the response by one or multiple fields.
|
|
827
|
+
* 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>
|
|
863
828
|
* @type {string}
|
|
864
829
|
* @memberof ActionsApiListActions
|
|
865
830
|
*/
|
|
@@ -902,7 +867,7 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
902
867
|
*/
|
|
903
868
|
export class ActionsApi extends BaseAPI {
|
|
904
869
|
/**
|
|
905
|
-
* Creates a new action configuration
|
|
870
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
906
871
|
* @summary Create the action
|
|
907
872
|
* @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
|
|
908
873
|
* @param {*} [options] Override http request option.
|
|
@@ -914,7 +879,7 @@ export class ActionsApi extends BaseAPI {
|
|
|
914
879
|
}
|
|
915
880
|
|
|
916
881
|
/**
|
|
917
|
-
* Deletes an action configuration by its code
|
|
882
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
918
883
|
* @summary Delete the action
|
|
919
884
|
* @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
|
|
920
885
|
* @param {*} [options] Override http request option.
|
|
@@ -926,43 +891,43 @@ export class ActionsApi extends BaseAPI {
|
|
|
926
891
|
}
|
|
927
892
|
|
|
928
893
|
/**
|
|
929
|
-
*
|
|
930
|
-
* @summary Retrieve the
|
|
931
|
-
* @param {
|
|
894
|
+
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
895
|
+
* @summary Retrieve the entity-actions-yaml
|
|
896
|
+
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
932
897
|
* @param {*} [options] Override http request option.
|
|
933
898
|
* @throws {RequiredError}
|
|
934
899
|
* @memberof ActionsApi
|
|
935
900
|
*/
|
|
936
|
-
public
|
|
937
|
-
return ActionsApiFp(this.configuration).
|
|
901
|
+
public exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig) {
|
|
902
|
+
return ActionsApiFp(this.configuration).exportActionsAsYaml(requestParameters.productSlug, requestParameters.productVersionId, requestParameters.authorization, requestParameters.actionSlugs, requestParameters.includeDisabled, options).then((request) => request(this.axios, this.basePath));
|
|
938
903
|
}
|
|
939
904
|
|
|
940
905
|
/**
|
|
941
|
-
* Retrieves
|
|
942
|
-
* @summary Retrieve the
|
|
943
|
-
* @param {
|
|
906
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
907
|
+
* @summary Retrieve the action
|
|
908
|
+
* @param {ActionsApiGetActionRequest} requestParameters Request parameters.
|
|
944
909
|
* @param {*} [options] Override http request option.
|
|
945
910
|
* @throws {RequiredError}
|
|
946
911
|
* @memberof ActionsApi
|
|
947
912
|
*/
|
|
948
|
-
public
|
|
949
|
-
return ActionsApiFp(this.configuration).
|
|
913
|
+
public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
|
|
914
|
+
return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
950
915
|
}
|
|
951
916
|
|
|
952
917
|
/**
|
|
953
|
-
*
|
|
954
|
-
* @summary
|
|
955
|
-
* @param {
|
|
918
|
+
* 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\"
|
|
919
|
+
* @summary Update the entity-actions-yaml
|
|
920
|
+
* @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
|
|
956
921
|
* @param {*} [options] Override http request option.
|
|
957
922
|
* @throws {RequiredError}
|
|
958
923
|
* @memberof ActionsApi
|
|
959
924
|
*/
|
|
960
|
-
public
|
|
961
|
-
return ActionsApiFp(this.configuration).
|
|
925
|
+
public importActionsFromYaml(requestParameters: ActionsApiImportActionsFromYamlRequest, options?: AxiosRequestConfig) {
|
|
926
|
+
return ActionsApiFp(this.configuration).importActionsFromYaml(requestParameters.importActionsFromYamlRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
962
927
|
}
|
|
963
928
|
|
|
964
929
|
/**
|
|
965
|
-
* Lists all action configurations with optional filters
|
|
930
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
966
931
|
* @summary List actions
|
|
967
932
|
* @param {ActionsApiListActionsRequest} requestParameters Request parameters.
|
|
968
933
|
* @param {*} [options] Override http request option.
|
|
@@ -974,7 +939,7 @@ export class ActionsApi extends BaseAPI {
|
|
|
974
939
|
}
|
|
975
940
|
|
|
976
941
|
/**
|
|
977
|
-
* Updates an existing action configuration (patch semantics)
|
|
942
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
978
943
|
* @summary Update the action
|
|
979
944
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
980
945
|
* @param {*} [options] Override http request option.
|