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