@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
@@ -14,7 +14,10 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateActionRequestDto } from '../models';
16
16
  import { CreateActionResponseClass } from '../models';
17
+ import { ExportActionsAsYamlResponseClass } from '../models';
17
18
  import { GetActionResponseClass } from '../models';
19
+ import { ImportActionsFromYamlRequestDto } from '../models';
20
+ import { ImportActionsFromYamlResponseClass } from '../models';
18
21
  import { ListActionsResponseClass } from '../models';
19
22
  import { UpdateActionRequestDto } from '../models';
20
23
  import { UpdateActionResponseClass } from '../models';
@@ -24,7 +27,7 @@ import { UpdateActionResponseClass } from '../models';
24
27
  */
25
28
  export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
26
29
  /**
27
- * Creates a new action configuration
30
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
28
31
  * @summary Create the action
29
32
  * @param {CreateActionRequestDto} createActionRequestDto
30
33
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -33,7 +36,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
33
36
  */
34
37
  createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
38
  /**
36
- * Deletes an action configuration by its code
39
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
37
40
  * @summary Delete the action
38
41
  * @param {string} code Action code
39
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -42,31 +45,53 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
42
45
  */
43
46
  deleteAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
47
  /**
45
- * Retrieves an action configuration by its code
48
+ * Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
49
+ * @summary Retrieve the entity-actions-yaml
50
+ * @param {string} productSlug Product slug
51
+ * @param {number} productVersionId Product version ID
52
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
+ * @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
54
+ * @param {boolean} [includeDisabled] Include draft (disabled) actions
55
+ * @param {*} [options] Override http request option.
56
+ * @throws {RequiredError}
57
+ */
58
+ exportActionsAsYaml: (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
+ /**
60
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
46
61
  * @summary Retrieve the action
47
62
  * @param {string} code Action code
48
63
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
64
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ getAction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ * 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\"
71
+ * @summary Update the entity-actions-yaml
72
+ * @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
73
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
74
  * @param {*} [options] Override http request option.
50
75
  * @throws {RequiredError}
51
76
  */
52
- getAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ importActionsFromYaml: (importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
78
  /**
54
- * Lists all action configurations with optional filters
79
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
55
80
  * @summary List actions
56
81
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
82
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
58
83
  * @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.
59
- * @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;
84
+ * @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;
60
85
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
61
- * @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;
62
- * @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;
63
- * @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;
86
+ * @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;
87
+ * @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;
88
+ * @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;
64
89
  * @param {*} [options] Override http request option.
65
90
  * @throws {RequiredError}
66
91
  */
67
92
  listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
93
  /**
69
- * Updates an existing action configuration (patch semantics)
94
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
70
95
  * @summary Update the action
71
96
  * @param {string} code Action code
72
97
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -82,7 +107,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
82
107
  */
83
108
  export declare const ActionsApiFp: (configuration?: Configuration) => {
84
109
  /**
85
- * Creates a new action configuration
110
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
86
111
  * @summary Create the action
87
112
  * @param {CreateActionRequestDto} createActionRequestDto
88
113
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -91,7 +116,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
91
116
  */
92
117
  createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
93
118
  /**
94
- * Deletes an action configuration by its code
119
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
95
120
  * @summary Delete the action
96
121
  * @param {string} code Action code
97
122
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -100,31 +125,53 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
100
125
  */
101
126
  deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
102
127
  /**
103
- * Retrieves an action configuration by its code
128
+ * Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
129
+ * @summary Retrieve the entity-actions-yaml
130
+ * @param {string} productSlug Product slug
131
+ * @param {number} productVersionId Product version ID
132
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
+ * @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
134
+ * @param {boolean} [includeDisabled] Include draft (disabled) actions
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>>;
139
+ /**
140
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
104
141
  * @summary Retrieve the action
105
142
  * @param {string} code Action code
106
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
149
+ /**
150
+ * 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\"
151
+ * @summary Update the entity-actions-yaml
152
+ * @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
153
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
154
  * @param {*} [options] Override http request option.
108
155
  * @throws {RequiredError}
109
156
  */
110
- getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
157
+ importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>>;
111
158
  /**
112
- * Lists all action configurations with optional filters
159
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
113
160
  * @summary List actions
114
161
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
162
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
163
  * @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.
117
- * @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;
164
+ * @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;
118
165
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
119
- * @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;
120
- * @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;
121
- * @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;
166
+ * @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;
167
+ * @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;
168
+ * @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;
122
169
  * @param {*} [options] Override http request option.
123
170
  * @throws {RequiredError}
124
171
  */
125
172
  listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionsResponseClass>>;
126
173
  /**
127
- * Updates an existing action configuration (patch semantics)
174
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
128
175
  * @summary Update the action
129
176
  * @param {string} code Action code
130
177
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -140,7 +187,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
140
187
  */
141
188
  export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
142
189
  /**
143
- * Creates a new action configuration
190
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
144
191
  * @summary Create the action
145
192
  * @param {CreateActionRequestDto} createActionRequestDto
146
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -149,7 +196,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
149
196
  */
150
197
  createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
151
198
  /**
152
- * Deletes an action configuration by its code
199
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
153
200
  * @summary Delete the action
154
201
  * @param {string} code Action code
155
202
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -158,31 +205,53 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
158
205
  */
159
206
  deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
160
207
  /**
161
- * Retrieves an action configuration by its code
208
+ * Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
209
+ * @summary Retrieve the entity-actions-yaml
210
+ * @param {string} productSlug Product slug
211
+ * @param {number} productVersionId Product version ID
212
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
213
+ * @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
214
+ * @param {boolean} [includeDisabled] Include draft (disabled) actions
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass>;
219
+ /**
220
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
162
221
  * @summary Retrieve the action
163
222
  * @param {string} code Action code
164
223
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
224
+ * @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
165
225
  * @param {*} [options] Override http request option.
166
226
  * @throws {RequiredError}
167
227
  */
168
- getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
228
+ getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass>;
169
229
  /**
170
- * Lists all action configurations with optional filters
230
+ * 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\"
231
+ * @summary Update the entity-actions-yaml
232
+ * @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
233
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
+ * @param {*} [options] Override http request option.
235
+ * @throws {RequiredError}
236
+ */
237
+ importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass>;
238
+ /**
239
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
171
240
  * @summary List actions
172
241
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
173
242
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
174
243
  * @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.
175
- * @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;
244
+ * @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;
176
245
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
177
- * @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;
178
- * @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;
179
- * @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;
246
+ * @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;
247
+ * @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;
248
+ * @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;
180
249
  * @param {*} [options] Override http request option.
181
250
  * @throws {RequiredError}
182
251
  */
183
252
  listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
184
253
  /**
185
- * Updates an existing action configuration (patch semantics)
254
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
186
255
  * @summary Update the action
187
256
  * @param {string} code Action code
188
257
  * @param {UpdateActionRequestDto} updateActionRequestDto
@@ -230,6 +299,43 @@ export interface ActionsApiDeleteActionRequest {
230
299
  */
231
300
  readonly authorization?: string;
232
301
  }
302
+ /**
303
+ * Request parameters for exportActionsAsYaml operation in ActionsApi.
304
+ * @export
305
+ * @interface ActionsApiExportActionsAsYamlRequest
306
+ */
307
+ export interface ActionsApiExportActionsAsYamlRequest {
308
+ /**
309
+ * Product slug
310
+ * @type {string}
311
+ * @memberof ActionsApiExportActionsAsYaml
312
+ */
313
+ readonly productSlug: string;
314
+ /**
315
+ * Product version ID
316
+ * @type {number}
317
+ * @memberof ActionsApiExportActionsAsYaml
318
+ */
319
+ readonly productVersionId: number;
320
+ /**
321
+ * Bearer Token: provided by the login endpoint under the name accessToken.
322
+ * @type {string}
323
+ * @memberof ActionsApiExportActionsAsYaml
324
+ */
325
+ readonly authorization?: string;
326
+ /**
327
+ * Optional list of action slugs to export; if omitted, all actions for the product version are exported
328
+ * @type {Array<string>}
329
+ * @memberof ActionsApiExportActionsAsYaml
330
+ */
331
+ readonly actionSlugs?: Array<string>;
332
+ /**
333
+ * Include draft (disabled) actions
334
+ * @type {boolean}
335
+ * @memberof ActionsApiExportActionsAsYaml
336
+ */
337
+ readonly includeDisabled?: boolean;
338
+ }
233
339
  /**
234
340
  * Request parameters for getAction operation in ActionsApi.
235
341
  * @export
@@ -248,6 +354,31 @@ export interface ActionsApiGetActionRequest {
248
354
  * @memberof ActionsApiGetAction
249
355
  */
250
356
  readonly authorization?: string;
357
+ /**
358
+ * Expand to fetch additional information (e.g. inputValidationSchema)
359
+ * @type {string}
360
+ * @memberof ActionsApiGetAction
361
+ */
362
+ readonly expand?: string;
363
+ }
364
+ /**
365
+ * Request parameters for importActionsFromYaml operation in ActionsApi.
366
+ * @export
367
+ * @interface ActionsApiImportActionsFromYamlRequest
368
+ */
369
+ export interface ActionsApiImportActionsFromYamlRequest {
370
+ /**
371
+ *
372
+ * @type {ImportActionsFromYamlRequestDto}
373
+ * @memberof ActionsApiImportActionsFromYaml
374
+ */
375
+ readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto;
376
+ /**
377
+ * Bearer Token: provided by the login endpoint under the name accessToken.
378
+ * @type {string}
379
+ * @memberof ActionsApiImportActionsFromYaml
380
+ */
381
+ readonly authorization?: string;
251
382
  }
252
383
  /**
253
384
  * Request parameters for listActions operation in ActionsApi.
@@ -274,7 +405,7 @@ export interface ActionsApiListActionsRequest {
274
405
  */
275
406
  readonly pageToken?: string;
276
407
  /**
277
- * 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;
408
+ * 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;
278
409
  * @type {string}
279
410
  * @memberof ActionsApiListActions
280
411
  */
@@ -286,19 +417,19 @@ export interface ActionsApiListActionsRequest {
286
417
  */
287
418
  readonly search?: string;
288
419
  /**
289
- * 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;
420
+ * 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;
290
421
  * @type {string}
291
422
  * @memberof ActionsApiListActions
292
423
  */
293
424
  readonly order?: string;
294
425
  /**
295
- * 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;
426
+ * 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;
296
427
  * @type {string}
297
428
  * @memberof ActionsApiListActions
298
429
  */
299
430
  readonly expand?: string;
300
431
  /**
301
- * 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;
432
+ * 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;
302
433
  * @type {string}
303
434
  * @memberof ActionsApiListActions
304
435
  */
@@ -337,7 +468,7 @@ export interface ActionsApiUpdateActionRequest {
337
468
  */
338
469
  export declare class ActionsApi extends BaseAPI {
339
470
  /**
340
- * Creates a new action configuration
471
+ * Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
341
472
  * @summary Create the action
342
473
  * @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
343
474
  * @param {*} [options] Override http request option.
@@ -346,7 +477,7 @@ export declare class ActionsApi extends BaseAPI {
346
477
  */
347
478
  createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
348
479
  /**
349
- * Deletes an action configuration by its code
480
+ * Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
350
481
  * @summary Delete the action
351
482
  * @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
352
483
  * @param {*} [options] Override http request option.
@@ -355,7 +486,16 @@ export declare class ActionsApi extends BaseAPI {
355
486
  */
356
487
  deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
357
488
  /**
358
- * Retrieves an action configuration by its code
489
+ * Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
490
+ * @summary Retrieve the entity-actions-yaml
491
+ * @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
492
+ * @param {*} [options] Override http request option.
493
+ * @throws {RequiredError}
494
+ * @memberof ActionsApi
495
+ */
496
+ exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportActionsAsYamlResponseClass, any, {}>>;
497
+ /**
498
+ * Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
359
499
  * @summary Retrieve the action
360
500
  * @param {ActionsApiGetActionRequest} requestParameters Request parameters.
361
501
  * @param {*} [options] Override http request option.
@@ -364,7 +504,16 @@ export declare class ActionsApi extends BaseAPI {
364
504
  */
365
505
  getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
366
506
  /**
367
- * Lists all action configurations with optional filters
507
+ * 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\"
508
+ * @summary Update the entity-actions-yaml
509
+ * @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
510
+ * @param {*} [options] Override http request option.
511
+ * @throws {RequiredError}
512
+ * @memberof ActionsApi
513
+ */
514
+ importActionsFromYaml(requestParameters: ActionsApiImportActionsFromYamlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportActionsFromYamlResponseClass, any, {}>>;
515
+ /**
516
+ * Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
368
517
  * @summary List actions
369
518
  * @param {ActionsApiListActionsRequest} requestParameters Request parameters.
370
519
  * @param {*} [options] Override http request option.
@@ -373,7 +522,7 @@ export declare class ActionsApi extends BaseAPI {
373
522
  */
374
523
  listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
375
524
  /**
376
- * Updates an existing action configuration (patch semantics)
525
+ * Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
377
526
  * @summary Update the action
378
527
  * @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
379
528
  * @param {*} [options] Override http request option.