@emilgroup/action-sdk 1.1.1-beta.23 → 1.1.1-beta.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -3
- package/README.md +2 -2
- package/api/actions-api.ts +178 -249
- package/dist/api/actions-api.d.ts +125 -156
- package/dist/api/actions-api.js +107 -185
- package/dist/models/{export-actions-as-yaml-response-class.d.ts → action-ref-class.d.ts} +17 -5
- package/dist/models/action-version-class.d.ts +7 -0
- package/dist/models/index.d.ts +1 -3
- package/dist/models/index.js +1 -3
- package/models/{export-actions-as-yaml-response-class.ts → action-ref-class.ts} +17 -5
- package/models/action-version-class.ts +7 -0
- package/models/index.ts +1 -3
- package/package.json +1 -1
- package/dist/models/import-actions-from-yaml-request-dto.d.ts +0 -36
- package/dist/models/import-actions-from-yaml-request-dto.js +0 -15
- package/dist/models/import-actions-from-yaml-response-class.d.ts +0 -37
- package/dist/models/import-actions-from-yaml-response-class.js +0 -15
- package/models/import-actions-from-yaml-request-dto.ts +0 -42
- package/models/import-actions-from-yaml-response-class.ts +0 -43
- /package/dist/models/{export-actions-as-yaml-response-class.js → action-ref-class.js} +0 -0
|
@@ -14,11 +14,8 @@ 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';
|
|
18
17
|
import { GetActionResponseClass } from '../models';
|
|
19
18
|
import { GetActionVersionResponseClass } from '../models';
|
|
20
|
-
import { ImportActionsFromYamlRequestDto } from '../models';
|
|
21
|
-
import { ImportActionsFromYamlResponseClass } from '../models';
|
|
22
19
|
import { ListActionVersionsResponseClass } from '../models';
|
|
23
20
|
import { ListActionsResponseClass } from '../models';
|
|
24
21
|
import { UpdateActionRequestDto } from '../models';
|
|
@@ -55,18 +52,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
55
52
|
* @throws {RequiredError}
|
|
56
53
|
*/
|
|
57
54
|
deleteActionVersion: (versionCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
-
/**
|
|
59
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
60
|
-
* @summary Retrieve the entity-actions-yaml
|
|
61
|
-
* @param {string} productSlug Product slug
|
|
62
|
-
* @param {number} productVersionId Product version ID
|
|
63
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
65
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
66
|
-
* @param {*} [options] Override http request option.
|
|
67
|
-
* @throws {RequiredError}
|
|
68
|
-
*/
|
|
69
|
-
exportActionsAsYaml: (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
55
|
/**
|
|
71
56
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
72
57
|
* @summary Retrieve the action
|
|
@@ -87,15 +72,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
87
72
|
* @throws {RequiredError}
|
|
88
73
|
*/
|
|
89
74
|
getActionVersion: (versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
|
-
/**
|
|
91
|
-
* 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\"
|
|
92
|
-
* @summary Update the entity-actions-yaml
|
|
93
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
94
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
|
-
* @param {*} [options] Override http request option.
|
|
96
|
-
* @throws {RequiredError}
|
|
97
|
-
*/
|
|
98
|
-
importActionsFromYaml: (importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
99
75
|
/**
|
|
100
76
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
101
77
|
* @summary List action versions
|
|
@@ -103,11 +79,11 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
103
79
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
80
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
105
81
|
* @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.
|
|
106
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
82
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
107
83
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
108
84
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
109
85
|
* @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>
|
|
110
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
86
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
111
87
|
* @param {*} [options] Override http request option.
|
|
112
88
|
* @throws {RequiredError}
|
|
113
89
|
*/
|
|
@@ -118,15 +94,30 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
118
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
119
95
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
120
96
|
* @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.
|
|
121
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
97
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
122
98
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
123
99
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
124
100
|
* @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>
|
|
125
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
101
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
126
102
|
* @param {*} [options] Override http request option.
|
|
127
103
|
* @throws {RequiredError}
|
|
128
104
|
*/
|
|
129
105
|
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
106
|
+
/**
|
|
107
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
108
|
+
* @summary List action versions
|
|
109
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
|
+
* @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.
|
|
112
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
113
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
115
|
+
* @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>
|
|
116
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
listAllActionVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
130
121
|
/**
|
|
131
122
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
132
123
|
* @summary Update the action
|
|
@@ -180,18 +171,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
180
171
|
* @throws {RequiredError}
|
|
181
172
|
*/
|
|
182
173
|
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
183
|
-
/**
|
|
184
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
185
|
-
* @summary Retrieve the entity-actions-yaml
|
|
186
|
-
* @param {string} productSlug Product slug
|
|
187
|
-
* @param {number} productVersionId Product version ID
|
|
188
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
190
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
191
|
-
* @param {*} [options] Override http request option.
|
|
192
|
-
* @throws {RequiredError}
|
|
193
|
-
*/
|
|
194
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>>;
|
|
195
174
|
/**
|
|
196
175
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
197
176
|
* @summary Retrieve the action
|
|
@@ -212,15 +191,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
212
191
|
* @throws {RequiredError}
|
|
213
192
|
*/
|
|
214
193
|
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionVersionResponseClass>>;
|
|
215
|
-
/**
|
|
216
|
-
* 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\"
|
|
217
|
-
* @summary Update the entity-actions-yaml
|
|
218
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
219
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
220
|
-
* @param {*} [options] Override http request option.
|
|
221
|
-
* @throws {RequiredError}
|
|
222
|
-
*/
|
|
223
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>>;
|
|
224
194
|
/**
|
|
225
195
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
226
196
|
* @summary List action versions
|
|
@@ -228,11 +198,11 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
228
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
199
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
230
200
|
* @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.
|
|
231
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
201
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
232
202
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
233
203
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
234
204
|
* @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>
|
|
235
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
205
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
236
206
|
* @param {*} [options] Override http request option.
|
|
237
207
|
* @throws {RequiredError}
|
|
238
208
|
*/
|
|
@@ -243,15 +213,30 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
243
213
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
214
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
215
|
* @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.
|
|
246
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
216
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
247
217
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
218
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
249
219
|
* @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>
|
|
250
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
220
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
251
221
|
* @param {*} [options] Override http request option.
|
|
252
222
|
* @throws {RequiredError}
|
|
253
223
|
*/
|
|
254
224
|
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>>;
|
|
225
|
+
/**
|
|
226
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
227
|
+
* @summary List action versions
|
|
228
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
230
|
+
* @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.
|
|
231
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
232
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
233
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
234
|
+
* @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>
|
|
235
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionVersionsResponseClass>>;
|
|
255
240
|
/**
|
|
256
241
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
257
242
|
* @summary Update the action
|
|
@@ -305,18 +290,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
305
290
|
* @throws {RequiredError}
|
|
306
291
|
*/
|
|
307
292
|
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
308
|
-
/**
|
|
309
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
310
|
-
* @summary Retrieve the entity-actions-yaml
|
|
311
|
-
* @param {string} productSlug Product slug
|
|
312
|
-
* @param {number} productVersionId Product version ID
|
|
313
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
314
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
315
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
316
|
-
* @param {*} [options] Override http request option.
|
|
317
|
-
* @throws {RequiredError}
|
|
318
|
-
*/
|
|
319
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass>;
|
|
320
293
|
/**
|
|
321
294
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
322
295
|
* @summary Retrieve the action
|
|
@@ -337,15 +310,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
337
310
|
* @throws {RequiredError}
|
|
338
311
|
*/
|
|
339
312
|
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass>;
|
|
340
|
-
/**
|
|
341
|
-
* 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\"
|
|
342
|
-
* @summary Update the entity-actions-yaml
|
|
343
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
344
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
345
|
-
* @param {*} [options] Override http request option.
|
|
346
|
-
* @throws {RequiredError}
|
|
347
|
-
*/
|
|
348
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass>;
|
|
349
313
|
/**
|
|
350
314
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
351
315
|
* @summary List action versions
|
|
@@ -353,11 +317,11 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
353
317
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
354
318
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
319
|
* @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.
|
|
356
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
320
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
357
321
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
358
322
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
359
323
|
* @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>
|
|
360
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
324
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
361
325
|
* @param {*} [options] Override http request option.
|
|
362
326
|
* @throws {RequiredError}
|
|
363
327
|
*/
|
|
@@ -368,15 +332,30 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
368
332
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
369
333
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
370
334
|
* @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.
|
|
371
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
335
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
372
336
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
373
337
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
374
338
|
* @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>
|
|
375
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
339
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
376
340
|
* @param {*} [options] Override http request option.
|
|
377
341
|
* @throws {RequiredError}
|
|
378
342
|
*/
|
|
379
343
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
344
|
+
/**
|
|
345
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
346
|
+
* @summary List action versions
|
|
347
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
349
|
+
* @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.
|
|
350
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
351
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
352
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
353
|
+
* @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>
|
|
354
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
355
|
+
* @param {*} [options] Override http request option.
|
|
356
|
+
* @throws {RequiredError}
|
|
357
|
+
*/
|
|
358
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
380
359
|
/**
|
|
381
360
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
382
361
|
* @summary Update the action
|
|
@@ -455,43 +434,6 @@ export interface ActionsApiDeleteActionVersionRequest {
|
|
|
455
434
|
*/
|
|
456
435
|
readonly authorization?: string;
|
|
457
436
|
}
|
|
458
|
-
/**
|
|
459
|
-
* Request parameters for exportActionsAsYaml operation in ActionsApi.
|
|
460
|
-
* @export
|
|
461
|
-
* @interface ActionsApiExportActionsAsYamlRequest
|
|
462
|
-
*/
|
|
463
|
-
export interface ActionsApiExportActionsAsYamlRequest {
|
|
464
|
-
/**
|
|
465
|
-
* Product slug
|
|
466
|
-
* @type {string}
|
|
467
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
468
|
-
*/
|
|
469
|
-
readonly productSlug: string;
|
|
470
|
-
/**
|
|
471
|
-
* Product version ID
|
|
472
|
-
* @type {number}
|
|
473
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
474
|
-
*/
|
|
475
|
-
readonly productVersionId: number;
|
|
476
|
-
/**
|
|
477
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
478
|
-
* @type {string}
|
|
479
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
480
|
-
*/
|
|
481
|
-
readonly authorization?: string;
|
|
482
|
-
/**
|
|
483
|
-
* Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
484
|
-
* @type {Array<string>}
|
|
485
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
486
|
-
*/
|
|
487
|
-
readonly actionSlugs?: Array<string>;
|
|
488
|
-
/**
|
|
489
|
-
* Include draft (disabled) actions
|
|
490
|
-
* @type {boolean}
|
|
491
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
492
|
-
*/
|
|
493
|
-
readonly includeDisabled?: boolean;
|
|
494
|
-
}
|
|
495
437
|
/**
|
|
496
438
|
* Request parameters for getAction operation in ActionsApi.
|
|
497
439
|
* @export
|
|
@@ -542,25 +484,6 @@ export interface ActionsApiGetActionVersionRequest {
|
|
|
542
484
|
*/
|
|
543
485
|
readonly expand?: string;
|
|
544
486
|
}
|
|
545
|
-
/**
|
|
546
|
-
* Request parameters for importActionsFromYaml operation in ActionsApi.
|
|
547
|
-
* @export
|
|
548
|
-
* @interface ActionsApiImportActionsFromYamlRequest
|
|
549
|
-
*/
|
|
550
|
-
export interface ActionsApiImportActionsFromYamlRequest {
|
|
551
|
-
/**
|
|
552
|
-
*
|
|
553
|
-
* @type {ImportActionsFromYamlRequestDto}
|
|
554
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
555
|
-
*/
|
|
556
|
-
readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto;
|
|
557
|
-
/**
|
|
558
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
559
|
-
* @type {string}
|
|
560
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
561
|
-
*/
|
|
562
|
-
readonly authorization?: string;
|
|
563
|
-
}
|
|
564
487
|
/**
|
|
565
488
|
* Request parameters for listActionVersions operation in ActionsApi.
|
|
566
489
|
* @export
|
|
@@ -592,7 +515,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
592
515
|
*/
|
|
593
516
|
readonly pageToken?: string;
|
|
594
517
|
/**
|
|
595
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
518
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
596
519
|
* @type {string}
|
|
597
520
|
* @memberof ActionsApiListActionVersions
|
|
598
521
|
*/
|
|
@@ -616,7 +539,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
616
539
|
*/
|
|
617
540
|
readonly expand?: string;
|
|
618
541
|
/**
|
|
619
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
542
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
620
543
|
* @type {string}
|
|
621
544
|
* @memberof ActionsApiListActionVersions
|
|
622
545
|
*/
|
|
@@ -647,7 +570,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
647
570
|
*/
|
|
648
571
|
readonly pageToken?: string;
|
|
649
572
|
/**
|
|
650
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
573
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
651
574
|
* @type {string}
|
|
652
575
|
* @memberof ActionsApiListActions
|
|
653
576
|
*/
|
|
@@ -671,12 +594,67 @@ export interface ActionsApiListActionsRequest {
|
|
|
671
594
|
*/
|
|
672
595
|
readonly expand?: string;
|
|
673
596
|
/**
|
|
674
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
597
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
675
598
|
* @type {string}
|
|
676
599
|
* @memberof ActionsApiListActions
|
|
677
600
|
*/
|
|
678
601
|
readonly filters?: string;
|
|
679
602
|
}
|
|
603
|
+
/**
|
|
604
|
+
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
605
|
+
* @export
|
|
606
|
+
* @interface ActionsApiListAllActionVersionsRequest
|
|
607
|
+
*/
|
|
608
|
+
export interface ActionsApiListAllActionVersionsRequest {
|
|
609
|
+
/**
|
|
610
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
611
|
+
* @type {string}
|
|
612
|
+
* @memberof ActionsApiListAllActionVersions
|
|
613
|
+
*/
|
|
614
|
+
readonly authorization?: string;
|
|
615
|
+
/**
|
|
616
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
617
|
+
* @type {number}
|
|
618
|
+
* @memberof ActionsApiListAllActionVersions
|
|
619
|
+
*/
|
|
620
|
+
readonly pageSize?: number;
|
|
621
|
+
/**
|
|
622
|
+
* 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.
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof ActionsApiListAllActionVersions
|
|
625
|
+
*/
|
|
626
|
+
readonly pageToken?: string;
|
|
627
|
+
/**
|
|
628
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
629
|
+
* @type {string}
|
|
630
|
+
* @memberof ActionsApiListAllActionVersions
|
|
631
|
+
*/
|
|
632
|
+
readonly filter?: string;
|
|
633
|
+
/**
|
|
634
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
635
|
+
* @type {string}
|
|
636
|
+
* @memberof ActionsApiListAllActionVersions
|
|
637
|
+
*/
|
|
638
|
+
readonly search?: string;
|
|
639
|
+
/**
|
|
640
|
+
* 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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
641
|
+
* @type {string}
|
|
642
|
+
* @memberof ActionsApiListAllActionVersions
|
|
643
|
+
*/
|
|
644
|
+
readonly order?: string;
|
|
645
|
+
/**
|
|
646
|
+
* 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>
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof ActionsApiListAllActionVersions
|
|
649
|
+
*/
|
|
650
|
+
readonly expand?: string;
|
|
651
|
+
/**
|
|
652
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
653
|
+
* @type {string}
|
|
654
|
+
* @memberof ActionsApiListAllActionVersions
|
|
655
|
+
*/
|
|
656
|
+
readonly filters?: string;
|
|
657
|
+
}
|
|
680
658
|
/**
|
|
681
659
|
* Request parameters for updateAction operation in ActionsApi.
|
|
682
660
|
* @export
|
|
@@ -761,15 +739,6 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
761
739
|
* @memberof ActionsApi
|
|
762
740
|
*/
|
|
763
741
|
deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
764
|
-
/**
|
|
765
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
766
|
-
* @summary Retrieve the entity-actions-yaml
|
|
767
|
-
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
768
|
-
* @param {*} [options] Override http request option.
|
|
769
|
-
* @throws {RequiredError}
|
|
770
|
-
* @memberof ActionsApi
|
|
771
|
-
*/
|
|
772
|
-
exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportActionsAsYamlResponseClass, any, {}>>;
|
|
773
742
|
/**
|
|
774
743
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
775
744
|
* @summary Retrieve the action
|
|
@@ -788,15 +757,6 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
788
757
|
* @memberof ActionsApi
|
|
789
758
|
*/
|
|
790
759
|
getActionVersion(requestParameters: ActionsApiGetActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionVersionResponseClass, any, {}>>;
|
|
791
|
-
/**
|
|
792
|
-
* 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\"
|
|
793
|
-
* @summary Update the entity-actions-yaml
|
|
794
|
-
* @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
|
|
795
|
-
* @param {*} [options] Override http request option.
|
|
796
|
-
* @throws {RequiredError}
|
|
797
|
-
* @memberof ActionsApi
|
|
798
|
-
*/
|
|
799
|
-
importActionsFromYaml(requestParameters: ActionsApiImportActionsFromYamlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportActionsFromYamlResponseClass, any, {}>>;
|
|
800
760
|
/**
|
|
801
761
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
802
762
|
* @summary List action versions
|
|
@@ -815,6 +775,15 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
815
775
|
* @memberof ActionsApi
|
|
816
776
|
*/
|
|
817
777
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
778
|
+
/**
|
|
779
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
780
|
+
* @summary List action versions
|
|
781
|
+
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
782
|
+
* @param {*} [options] Override http request option.
|
|
783
|
+
* @throws {RequiredError}
|
|
784
|
+
* @memberof ActionsApi
|
|
785
|
+
*/
|
|
786
|
+
listAllActionVersions(requestParameters?: ActionsApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
818
787
|
/**
|
|
819
788
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
820
789
|
* @summary Update the action
|