@emilgroup/action-sdk 1.0.1-beta.23 → 1.1.1-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +2 -2
  3. package/api/actions-api.ts +313 -42
  4. package/api/executions-api.ts +471 -0
  5. package/api.ts +2 -0
  6. package/dist/api/actions-api.d.ts +188 -39
  7. package/dist/api/actions-api.js +251 -38
  8. package/dist/api/executions-api.d.ts +272 -0
  9. package/dist/api/executions-api.js +452 -0
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/action-class.d.ts +38 -2
  13. package/dist/models/action-execution-class.d.ts +137 -0
  14. package/dist/models/action-execution-class.js +15 -0
  15. package/dist/models/create-action-request-dto.d.ts +31 -1
  16. package/dist/models/create-action-request-dto.js +6 -0
  17. package/dist/models/export-actions-as-yaml-response-class.d.ts +24 -0
  18. package/dist/models/export-actions-as-yaml-response-class.js +15 -0
  19. package/dist/models/get-action-execution-status-response-class.d.ts +25 -0
  20. package/dist/models/get-action-execution-status-response-class.js +15 -0
  21. package/dist/models/import-actions-from-yaml-request-dto.d.ts +36 -0
  22. package/dist/models/import-actions-from-yaml-request-dto.js +15 -0
  23. package/dist/models/import-actions-from-yaml-response-class.d.ts +37 -0
  24. package/dist/models/import-actions-from-yaml-response-class.js +15 -0
  25. package/dist/models/index.d.ts +9 -0
  26. package/dist/models/index.js +9 -0
  27. package/dist/models/list-action-executions-response-class.d.ts +43 -0
  28. package/dist/models/list-action-executions-response-class.js +15 -0
  29. package/dist/models/trigger-action-request-dto.d.ts +62 -0
  30. package/dist/models/trigger-action-request-dto.js +15 -0
  31. package/dist/models/trigger-action-response-class.d.ts +25 -0
  32. package/dist/models/trigger-action-response-class.js +15 -0
  33. package/dist/models/update-action-request-dto.d.ts +30 -0
  34. package/dist/models/update-action-request-dto.js +6 -0
  35. package/dist/models/workflow-output-reference-class.d.ts +30 -0
  36. package/dist/models/workflow-output-reference-class.js +15 -0
  37. package/models/action-class.ts +38 -2
  38. package/models/action-execution-class.ts +139 -0
  39. package/models/create-action-request-dto.ts +34 -1
  40. package/models/export-actions-as-yaml-response-class.ts +30 -0
  41. package/models/get-action-execution-status-response-class.ts +31 -0
  42. package/models/import-actions-from-yaml-request-dto.ts +42 -0
  43. package/models/import-actions-from-yaml-response-class.ts +43 -0
  44. package/models/index.ts +9 -0
  45. package/models/list-action-executions-response-class.ts +49 -0
  46. package/models/trigger-action-request-dto.ts +66 -0
  47. package/models/trigger-action-response-class.ts +31 -0
  48. package/models/update-action-request-dto.ts +33 -0
  49. package/models/workflow-output-reference-class.ts +36 -0
  50. package/package.json +2 -1
@@ -5,20 +5,30 @@ README.md
5
5
  api.ts
6
6
  api/actions-api.ts
7
7
  api/default-api.ts
8
+ api/executions-api.ts
8
9
  base.ts
9
10
  common.ts
10
11
  configuration.ts
11
12
  git_push.sh
12
13
  index.ts
13
14
  models/action-class.ts
15
+ models/action-execution-class.ts
14
16
  models/create-action-request-dto.ts
15
17
  models/create-action-response-class.ts
18
+ models/export-actions-as-yaml-response-class.ts
19
+ models/get-action-execution-status-response-class.ts
16
20
  models/get-action-response-class.ts
21
+ models/import-actions-from-yaml-request-dto.ts
22
+ models/import-actions-from-yaml-response-class.ts
17
23
  models/index.ts
18
24
  models/inline-response200.ts
19
25
  models/inline-response503.ts
26
+ models/list-action-executions-response-class.ts
20
27
  models/list-actions-response-class.ts
28
+ models/trigger-action-request-dto.ts
29
+ models/trigger-action-response-class.ts
21
30
  models/update-action-request-dto.ts
22
31
  models/update-action-response-class.ts
32
+ models/workflow-output-reference-class.ts
23
33
  package.json
24
34
  tsconfig.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/action-sdk@1.0.1-beta.23 --save
20
+ npm install @emilgroup/action-sdk@1.1.1-beta.10 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/action-sdk@1.0.1-beta.23
24
+ yarn add @emilgroup/action-sdk@1.1.1-beta.10
25
25
  ```
26
26
 
27
27
  And then you can import `ActionsApi`.
@@ -25,8 +25,14 @@ import { CreateActionRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateActionResponseClass } from '../models';
27
27
  // @ts-ignore
28
+ import { ExportActionsAsYamlResponseClass } from '../models';
29
+ // @ts-ignore
28
30
  import { GetActionResponseClass } from '../models';
29
31
  // @ts-ignore
32
+ import { ImportActionsFromYamlRequestDto } from '../models';
33
+ // @ts-ignore
34
+ import { ImportActionsFromYamlResponseClass } from '../models';
35
+ // @ts-ignore
30
36
  import { ListActionsResponseClass } from '../models';
31
37
  // @ts-ignore
32
38
  import { UpdateActionRequestDto } from '../models';
@@ -39,7 +45,7 @@ import { UpdateActionResponseClass } from '../models';
39
45
  export const ActionsApiAxiosParamCreator = function (configuration?: Configuration) {
40
46
  return {
41
47
  /**
42
- * Creates a new action configuration
48
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
43
49
  * @summary Create the action
44
50
  * @param {CreateActionRequestDto} createActionRequestDto
45
51
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +92,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
86
92
  };
87
93
  },
88
94
  /**
89
- * Deletes an action configuration by its code
95
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
90
96
  * @summary Delete the action
91
97
  * @param {string} code Action code
92
98
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -131,14 +137,80 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
131
137
  };
132
138
  },
133
139
  /**
134
- * Retrieves an action configuration by its code
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
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
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
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`;
156
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
157
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
158
+ let baseOptions;
159
+ let baseAccessToken;
160
+ if (configuration) {
161
+ baseOptions = configuration.baseOptions;
162
+ baseAccessToken = configuration.accessToken;
163
+ }
164
+
165
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
166
+ const localVarHeaderParameter = {} as any;
167
+ const localVarQueryParameter = {} as any;
168
+
169
+ // authentication bearer required
170
+ // http bearer authentication required
171
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
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
+
189
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
190
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
191
+ }
192
+
193
+
194
+
195
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
196
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
197
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
198
+
199
+ return {
200
+ url: toPathString(localVarUrlObj),
201
+ options: localVarRequestOptions,
202
+ };
203
+ },
204
+ /**
205
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
135
206
  * @summary Retrieve the action
136
207
  * @param {string} code Action code
137
208
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
209
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
138
210
  * @param {*} [options] Override http request option.
139
211
  * @throws {RequiredError}
140
212
  */
141
- getAction: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
213
+ getAction: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
142
214
  // verify required parameter 'code' is not null or undefined
143
215
  assertParamExists('getAction', 'code', code)
144
216
  const localVarPath = `/actionservice/v1/actions/{code}`
@@ -160,6 +232,10 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
160
232
  // http bearer authentication required
161
233
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
162
234
 
235
+ if (expand !== undefined) {
236
+ localVarQueryParameter['expand'] = expand;
237
+ }
238
+
163
239
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
164
240
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
165
241
  }
@@ -176,16 +252,63 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
176
252
  };
177
253
  },
178
254
  /**
179
- * Lists all action configurations with optional filters
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
258
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ */
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`;
266
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
267
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
268
+ let baseOptions;
269
+ let baseAccessToken;
270
+ if (configuration) {
271
+ baseOptions = configuration.baseOptions;
272
+ baseAccessToken = configuration.accessToken;
273
+ }
274
+
275
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
276
+ const localVarHeaderParameter = {} as any;
277
+ const localVarQueryParameter = {} as any;
278
+
279
+ // authentication bearer required
280
+ // http bearer authentication required
281
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
282
+
283
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
284
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
285
+ }
286
+
287
+
288
+
289
+ localVarHeaderParameter['Content-Type'] = 'application/json';
290
+
291
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
292
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
293
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
294
+ localVarRequestOptions.data = serializeDataIfNeeded(importActionsFromYamlRequestDto, localVarRequestOptions, configuration)
295
+
296
+ return {
297
+ url: toPathString(localVarUrlObj),
298
+ options: localVarRequestOptions,
299
+ };
300
+ },
301
+ /**
302
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
180
303
  * @summary List actions
181
304
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
305
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
183
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
184
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
307
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
185
308
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
186
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt&lt;/i&gt;
187
- * @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.&lt;br/&gt; &lt;br/&gt;
188
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: inputValidationSchema&lt;i&gt;
311
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
189
312
  * @param {*} [options] Override http request option.
190
313
  * @throws {RequiredError}
191
314
  */
@@ -252,7 +375,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
252
375
  };
253
376
  },
254
377
  /**
255
- * Updates an existing action configuration (patch semantics)
378
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
256
379
  * @summary Update the action
257
380
  * @param {string} code Action code
258
381
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -313,7 +436,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
313
436
  const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration)
314
437
  return {
315
438
  /**
316
- * Creates a new action configuration
439
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
317
440
  * @summary Create the action
318
441
  * @param {CreateActionRequestDto} createActionRequestDto
319
442
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -325,7 +448,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
325
448
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
326
449
  },
327
450
  /**
328
- * Deletes an action configuration by its code
451
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
329
452
  * @summary Delete the action
330
453
  * @param {string} code Action code
331
454
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -337,28 +460,56 @@ export const ActionsApiFp = function(configuration?: Configuration) {
337
460
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
461
  },
339
462
  /**
340
- * Retrieves an action configuration by its code
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
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
470
+ * @param {*} [options] Override http request option.
471
+ * @throws {RequiredError}
472
+ */
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);
475
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
476
+ },
477
+ /**
478
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
341
479
  * @summary Retrieve the action
342
480
  * @param {string} code Action code
343
481
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
482
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
483
+ * @param {*} [options] Override http request option.
484
+ * @throws {RequiredError}
485
+ */
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);
488
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
489
+ },
490
+ /**
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
494
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
495
  * @param {*} [options] Override http request option.
345
496
  * @throws {RequiredError}
346
497
  */
347
- async getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
348
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
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);
349
500
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
501
  },
351
502
  /**
352
- * Lists all action configurations with optional filters
503
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
353
504
  * @summary List actions
354
505
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
506
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
357
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
508
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
358
509
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
359
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt&lt;/i&gt;
360
- * @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.&lt;br/&gt; &lt;br/&gt;
361
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: inputValidationSchema&lt;i&gt;
512
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
362
513
  * @param {*} [options] Override http request option.
363
514
  * @throws {RequiredError}
364
515
  */
@@ -367,7 +518,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
367
518
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
368
519
  },
369
520
  /**
370
- * Updates an existing action configuration (patch semantics)
521
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
371
522
  * @summary Update the action
372
523
  * @param {string} code Action code
373
524
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -390,7 +541,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
390
541
  const localVarFp = ActionsApiFp(configuration)
391
542
  return {
392
543
  /**
393
- * Creates a new action configuration
544
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
394
545
  * @summary Create the action
395
546
  * @param {CreateActionRequestDto} createActionRequestDto
396
547
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -401,7 +552,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
401
552
  return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
402
553
  },
403
554
  /**
404
- * Deletes an action configuration by its code
555
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
405
556
  * @summary Delete the action
406
557
  * @param {string} code Action code
407
558
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -412,27 +563,53 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
412
563
  return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
413
564
  },
414
565
  /**
415
- * Retrieves an action configuration by its code
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
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
573
+ * @param {*} [options] Override http request option.
574
+ * @throws {RequiredError}
575
+ */
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));
578
+ },
579
+ /**
580
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
416
581
  * @summary Retrieve the action
417
582
  * @param {string} code Action code
418
583
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
584
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
419
585
  * @param {*} [options] Override http request option.
420
586
  * @throws {RequiredError}
421
587
  */
422
- getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
423
- return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
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));
424
590
  },
425
591
  /**
426
- * Lists all action configurations with optional filters
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
595
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
596
+ * @param {*} [options] Override http request option.
597
+ * @throws {RequiredError}
598
+ */
599
+ importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass> {
600
+ return localVarFp.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options).then((request) => request(axios, basePath));
601
+ },
602
+ /**
603
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
427
604
  * @summary List actions
428
605
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
606
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
431
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
608
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
432
609
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt&lt;/i&gt;
434
- * @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.&lt;br/&gt; &lt;br/&gt;
435
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: inputValidationSchema&lt;i&gt;
612
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
436
613
  * @param {*} [options] Override http request option.
437
614
  * @throws {RequiredError}
438
615
  */
@@ -440,7 +617,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
440
617
  return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
441
618
  },
442
619
  /**
443
- * Updates an existing action configuration (patch semantics)
620
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
444
621
  * @summary Update the action
445
622
  * @param {string} code Action code
446
623
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -496,6 +673,48 @@ export interface ActionsApiDeleteActionRequest {
496
673
  readonly authorization?: string
497
674
  }
498
675
 
676
+ /**
677
+ * Request parameters for exportActionsAsYaml operation in ActionsApi.
678
+ * @export
679
+ * @interface ActionsApiExportActionsAsYamlRequest
680
+ */
681
+ export interface ActionsApiExportActionsAsYamlRequest {
682
+ /**
683
+ * Product slug
684
+ * @type {string}
685
+ * @memberof ActionsApiExportActionsAsYaml
686
+ */
687
+ readonly productSlug: string
688
+
689
+ /**
690
+ * Product version ID
691
+ * @type {number}
692
+ * @memberof ActionsApiExportActionsAsYaml
693
+ */
694
+ readonly productVersionId: number
695
+
696
+ /**
697
+ * Bearer Token: provided by the login endpoint under the name accessToken.
698
+ * @type {string}
699
+ * @memberof ActionsApiExportActionsAsYaml
700
+ */
701
+ readonly authorization?: string
702
+
703
+ /**
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
707
+ */
708
+ readonly actionSlugs?: Array<string>
709
+
710
+ /**
711
+ * Include draft (disabled) actions
712
+ * @type {boolean}
713
+ * @memberof ActionsApiExportActionsAsYaml
714
+ */
715
+ readonly includeDisabled?: boolean
716
+ }
717
+
499
718
  /**
500
719
  * Request parameters for getAction operation in ActionsApi.
501
720
  * @export
@@ -515,6 +734,34 @@ export interface ActionsApiGetActionRequest {
515
734
  * @memberof ActionsApiGetAction
516
735
  */
517
736
  readonly authorization?: string
737
+
738
+ /**
739
+ * Expand to fetch additional information (e.g. inputValidationSchema)
740
+ * @type {string}
741
+ * @memberof ActionsApiGetAction
742
+ */
743
+ readonly expand?: string
744
+ }
745
+
746
+ /**
747
+ * Request parameters for importActionsFromYaml operation in ActionsApi.
748
+ * @export
749
+ * @interface ActionsApiImportActionsFromYamlRequest
750
+ */
751
+ export interface ActionsApiImportActionsFromYamlRequest {
752
+ /**
753
+ *
754
+ * @type {ImportActionsFromYamlRequestDto}
755
+ * @memberof ActionsApiImportActionsFromYaml
756
+ */
757
+ readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto
758
+
759
+ /**
760
+ * Bearer Token: provided by the login endpoint under the name accessToken.
761
+ * @type {string}
762
+ * @memberof ActionsApiImportActionsFromYaml
763
+ */
764
+ readonly authorization?: string
518
765
  }
519
766
 
520
767
  /**
@@ -545,7 +792,7 @@ export interface ActionsApiListActionsRequest {
545
792
  readonly pageToken?: string
546
793
 
547
794
  /**
548
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
795
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
549
796
  * @type {string}
550
797
  * @memberof ActionsApiListActions
551
798
  */
@@ -559,21 +806,21 @@ export interface ActionsApiListActionsRequest {
559
806
  readonly search?: string
560
807
 
561
808
  /**
562
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt&lt;/i&gt;
809
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt&lt;/i&gt;
563
810
  * @type {string}
564
811
  * @memberof ActionsApiListActions
565
812
  */
566
813
  readonly order?: string
567
814
 
568
815
  /**
569
- * 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.&lt;br/&gt; &lt;br/&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: inputValidationSchema&lt;i&gt;
570
817
  * @type {string}
571
818
  * @memberof ActionsApiListActions
572
819
  */
573
820
  readonly expand?: string
574
821
 
575
822
  /**
576
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
823
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
577
824
  * @type {string}
578
825
  * @memberof ActionsApiListActions
579
826
  */
@@ -616,7 +863,7 @@ export interface ActionsApiUpdateActionRequest {
616
863
  */
617
864
  export class ActionsApi extends BaseAPI {
618
865
  /**
619
- * Creates a new action configuration
866
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
620
867
  * @summary Create the action
621
868
  * @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
622
869
  * @param {*} [options] Override http request option.
@@ -628,7 +875,7 @@ export class ActionsApi extends BaseAPI {
628
875
  }
629
876
 
630
877
  /**
631
- * Deletes an action configuration by its code
878
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
632
879
  * @summary Delete the action
633
880
  * @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
634
881
  * @param {*} [options] Override http request option.
@@ -640,7 +887,19 @@ export class ActionsApi extends BaseAPI {
640
887
  }
641
888
 
642
889
  /**
643
- * Retrieves an action configuration by its code
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.
893
+ * @param {*} [options] Override http request option.
894
+ * @throws {RequiredError}
895
+ * @memberof ActionsApi
896
+ */
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));
899
+ }
900
+
901
+ /**
902
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
644
903
  * @summary Retrieve the action
645
904
  * @param {ActionsApiGetActionRequest} requestParameters Request parameters.
646
905
  * @param {*} [options] Override http request option.
@@ -648,11 +907,23 @@ export class ActionsApi extends BaseAPI {
648
907
  * @memberof ActionsApi
649
908
  */
650
909
  public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
651
- return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
910
+ return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
911
+ }
912
+
913
+ /**
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.
917
+ * @param {*} [options] Override http request option.
918
+ * @throws {RequiredError}
919
+ * @memberof ActionsApi
920
+ */
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));
652
923
  }
653
924
 
654
925
  /**
655
- * Lists all action configurations with optional filters
926
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
656
927
  * @summary List actions
657
928
  * @param {ActionsApiListActionsRequest} requestParameters Request parameters.
658
929
  * @param {*} [options] Override http request option.
@@ -664,7 +935,7 @@ export class ActionsApi extends BaseAPI {
664
935
  }
665
936
 
666
937
  /**
667
- * Updates an existing action configuration (patch semantics)
938
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
668
939
  * @summary Update the action
669
940
  * @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
670
941
  * @param {*} [options] Override http request option.