@emilgroup/action-sdk-node 1.0.1-beta.39 → 1.0.1-beta.41
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/README.md +2 -2
- package/api/actions-api.ts +12 -12
- package/dist/api/actions-api.d.ts +12 -12
- package/dist/api/actions-api.js +9 -9
- package/dist/models/action-class.d.ts +7 -1
- package/dist/models/create-action-request-dto.d.ts +9 -3
- package/dist/models/trigger-action-request-dto.d.ts +1 -1
- package/dist/models/update-action-request-dto.d.ts +3 -3
- package/models/action-class.ts +7 -1
- package/models/create-action-request-dto.ts +9 -3
- package/models/trigger-action-request-dto.ts +1 -1
- package/models/update-action-request-dto.ts +3 -3
- package/package.json +1 -1
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-node@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/action-sdk-node@1.0.1-beta.41 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/action-sdk-node@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/action-sdk-node@1.0.1-beta.41
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `ActionsApi`.
|
package/api/actions-api.ts
CHANGED
|
@@ -308,11 +308,11 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
308
308
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
309
309
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
310
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
311
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
311
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
312
312
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
313
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
313
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
314
314
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
315
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
315
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
@@ -574,11 +574,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
574
574
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
575
575
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
576
576
|
* @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.
|
|
577
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
577
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
578
578
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
579
|
-
* @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>
|
|
579
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
580
580
|
* @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>
|
|
581
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
581
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
582
582
|
* @param {*} [options] Override http request option.
|
|
583
583
|
* @throws {RequiredError}
|
|
584
584
|
*/
|
|
@@ -689,11 +689,11 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
689
689
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
690
690
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
691
691
|
* @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.
|
|
692
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
692
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
693
693
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
694
|
-
* @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>
|
|
694
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
695
695
|
* @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>
|
|
696
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
696
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
697
697
|
* @param {*} [options] Override http request option.
|
|
698
698
|
* @throws {RequiredError}
|
|
699
699
|
*/
|
|
@@ -890,7 +890,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
890
890
|
readonly pageToken?: string
|
|
891
891
|
|
|
892
892
|
/**
|
|
893
|
-
* 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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
893
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
894
894
|
* @type {string}
|
|
895
895
|
* @memberof ActionsApiListActions
|
|
896
896
|
*/
|
|
@@ -904,7 +904,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
904
904
|
readonly search?: string
|
|
905
905
|
|
|
906
906
|
/**
|
|
907
|
-
* 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>
|
|
907
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
908
908
|
* @type {string}
|
|
909
909
|
* @memberof ActionsApiListActions
|
|
910
910
|
*/
|
|
@@ -918,7 +918,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
918
918
|
readonly expand?: string
|
|
919
919
|
|
|
920
920
|
/**
|
|
921
|
-
* 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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
921
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
922
922
|
* @type {string}
|
|
923
923
|
* @memberof ActionsApiListActions
|
|
924
924
|
*/
|
|
@@ -81,11 +81,11 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
81
81
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
82
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
84
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
84
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
85
85
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
87
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.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
88
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
88
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
@@ -173,11 +173,11 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
173
173
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
174
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
175
175
|
* @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.
|
|
176
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
176
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
177
177
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
178
|
-
* @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>
|
|
178
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
179
179
|
* @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>
|
|
180
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
180
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
182
182
|
* @throws {RequiredError}
|
|
183
183
|
*/
|
|
@@ -265,11 +265,11 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
265
265
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
266
266
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
267
267
|
* @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.
|
|
268
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
268
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
269
269
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
270
|
-
* @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>
|
|
270
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
271
271
|
* @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>
|
|
272
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
272
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
273
273
|
* @param {*} [options] Override http request option.
|
|
274
274
|
* @throws {RequiredError}
|
|
275
275
|
*/
|
|
@@ -441,7 +441,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
441
441
|
*/
|
|
442
442
|
readonly pageToken?: string;
|
|
443
443
|
/**
|
|
444
|
-
* 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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
444
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
445
445
|
* @type {string}
|
|
446
446
|
* @memberof ActionsApiListActions
|
|
447
447
|
*/
|
|
@@ -453,7 +453,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
453
453
|
*/
|
|
454
454
|
readonly search?: string;
|
|
455
455
|
/**
|
|
456
|
-
* 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>
|
|
456
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
457
457
|
* @type {string}
|
|
458
458
|
* @memberof ActionsApiListActions
|
|
459
459
|
*/
|
|
@@ -465,7 +465,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
465
465
|
*/
|
|
466
466
|
readonly expand?: string;
|
|
467
467
|
/**
|
|
468
|
-
* 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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
468
|
+
* 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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
469
469
|
* @type {string}
|
|
470
470
|
* @memberof ActionsApiListActions
|
|
471
471
|
*/
|
package/dist/api/actions-api.js
CHANGED
|
@@ -364,11 +364,11 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
364
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
365
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
366
|
* @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.
|
|
367
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
367
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
368
368
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
369
|
-
* @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>
|
|
369
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
370
370
|
* @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>
|
|
371
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
371
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
372
372
|
* @param {*} [options] Override http request option.
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
@@ -672,11 +672,11 @@ var ActionsApiFp = function (configuration) {
|
|
|
672
672
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
673
673
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
674
674
|
* @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.
|
|
675
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
675
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
676
676
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
677
|
-
* @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>
|
|
677
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
678
678
|
* @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>
|
|
679
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
679
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
680
680
|
* @param {*} [options] Override http request option.
|
|
681
681
|
* @throws {RequiredError}
|
|
682
682
|
*/
|
|
@@ -814,11 +814,11 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
814
814
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
815
815
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
816
816
|
* @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.
|
|
817
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
817
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
818
818
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
819
|
-
* @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>
|
|
819
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
820
820
|
* @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>
|
|
821
|
-
* @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, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
821
|
+
* @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, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
822
822
|
* @param {*} [options] Override http request option.
|
|
823
823
|
* @throws {RequiredError}
|
|
824
824
|
*/
|
|
@@ -40,7 +40,13 @@ export interface ActionClass {
|
|
|
40
40
|
*/
|
|
41
41
|
'slug': string;
|
|
42
42
|
/**
|
|
43
|
-
* BPMN/workflow
|
|
43
|
+
* BPMN/workflow slug identifying the workflow to execute when this action is triggered
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ActionClass
|
|
46
|
+
*/
|
|
47
|
+
'workflowSlug': string;
|
|
48
|
+
/**
|
|
49
|
+
* BPMN/workflow code resolved from workflow_slug or provided directly (used when triggering)
|
|
44
50
|
* @type {string}
|
|
45
51
|
* @memberof ActionClass
|
|
46
52
|
*/
|
|
@@ -22,17 +22,23 @@ export interface CreateActionRequestDto {
|
|
|
22
22
|
*/
|
|
23
23
|
'name': string;
|
|
24
24
|
/**
|
|
25
|
-
* Stable identifier; auto-generated from
|
|
25
|
+
* Stable identifier; auto-generated from name if not provided. Lowercase letters, digits, hyphens only; no spaces, special symbols, umlauts, or leading/trailing hyphen (max 200 chars).
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateActionRequestDto
|
|
28
28
|
*/
|
|
29
29
|
'slug'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* BPMN/workflow
|
|
31
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow. At least one of workflowSlug or workflowCode required.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateActionRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'workflowSlug'?: string;
|
|
36
|
+
/**
|
|
37
|
+
* BPMN/workflow code. At least one of workflowSlug or workflowCode is required.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof CreateActionRequestDto
|
|
40
|
+
*/
|
|
41
|
+
'workflowCode'?: string;
|
|
36
42
|
/**
|
|
37
43
|
* true = published (triggerable), false = draft. Default true.
|
|
38
44
|
* @type {boolean}
|
|
@@ -22,7 +22,7 @@ export interface TriggerActionRequestDto {
|
|
|
22
22
|
*/
|
|
23
23
|
'actionSlug': string;
|
|
24
24
|
/**
|
|
25
|
-
* Input payload for the action execution. When the action has input_validation_schema set, this payload is validated against it; validation failures return 400 with validation errors.
|
|
25
|
+
* Input payload for the action execution. When the action has input_validation_schema set, this payload is validated against it; validation failures return 400 with validation errors. Must be a JSON object (key-value map).
|
|
26
26
|
* @type {{ [key: string]: object; }}
|
|
27
27
|
* @memberof TriggerActionRequestDto
|
|
28
28
|
*/
|
|
@@ -28,13 +28,13 @@ export interface UpdateActionRequestDto {
|
|
|
28
28
|
*/
|
|
29
29
|
'name'?: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof UpdateActionRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'workflowSlug'?: string;
|
|
36
36
|
/**
|
|
37
|
-
* BPMN/workflow code
|
|
37
|
+
* BPMN/workflow code. When provided, used directly (no product required for resolution).
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof UpdateActionRequestDto
|
|
40
40
|
*/
|
package/models/action-class.ts
CHANGED
|
@@ -45,7 +45,13 @@ export interface ActionClass {
|
|
|
45
45
|
*/
|
|
46
46
|
'slug': string;
|
|
47
47
|
/**
|
|
48
|
-
* BPMN/workflow
|
|
48
|
+
* BPMN/workflow slug identifying the workflow to execute when this action is triggered
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof ActionClass
|
|
51
|
+
*/
|
|
52
|
+
'workflowSlug': string;
|
|
53
|
+
/**
|
|
54
|
+
* BPMN/workflow code resolved from workflow_slug or provided directly (used when triggering)
|
|
49
55
|
* @type {string}
|
|
50
56
|
* @memberof ActionClass
|
|
51
57
|
*/
|
|
@@ -27,17 +27,23 @@ export interface CreateActionRequestDto {
|
|
|
27
27
|
*/
|
|
28
28
|
'name': string;
|
|
29
29
|
/**
|
|
30
|
-
* Stable identifier; auto-generated from
|
|
30
|
+
* Stable identifier; auto-generated from name if not provided. Lowercase letters, digits, hyphens only; no spaces, special symbols, umlauts, or leading/trailing hyphen (max 200 chars).
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof CreateActionRequestDto
|
|
33
33
|
*/
|
|
34
34
|
'slug'?: string;
|
|
35
35
|
/**
|
|
36
|
-
* BPMN/workflow
|
|
36
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow. At least one of workflowSlug or workflowCode required.
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof CreateActionRequestDto
|
|
39
39
|
*/
|
|
40
|
-
'
|
|
40
|
+
'workflowSlug'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* BPMN/workflow code. At least one of workflowSlug or workflowCode is required.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof CreateActionRequestDto
|
|
45
|
+
*/
|
|
46
|
+
'workflowCode'?: string;
|
|
41
47
|
/**
|
|
42
48
|
* true = published (triggerable), false = draft. Default true.
|
|
43
49
|
* @type {boolean}
|
|
@@ -27,7 +27,7 @@ export interface TriggerActionRequestDto {
|
|
|
27
27
|
*/
|
|
28
28
|
'actionSlug': string;
|
|
29
29
|
/**
|
|
30
|
-
* Input payload for the action execution. When the action has input_validation_schema set, this payload is validated against it; validation failures return 400 with validation errors.
|
|
30
|
+
* Input payload for the action execution. When the action has input_validation_schema set, this payload is validated against it; validation failures return 400 with validation errors. Must be a JSON object (key-value map).
|
|
31
31
|
* @type {{ [key: string]: object; }}
|
|
32
32
|
* @memberof TriggerActionRequestDto
|
|
33
33
|
*/
|
|
@@ -33,13 +33,13 @@ export interface UpdateActionRequestDto {
|
|
|
33
33
|
*/
|
|
34
34
|
'name'?: string;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow.
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof UpdateActionRequestDto
|
|
39
39
|
*/
|
|
40
|
-
'
|
|
40
|
+
'workflowSlug'?: string;
|
|
41
41
|
/**
|
|
42
|
-
* BPMN/workflow code
|
|
42
|
+
* BPMN/workflow code. When provided, used directly (no product required for resolution).
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof UpdateActionRequestDto
|
|
45
45
|
*/
|