@emilgroup/action-sdk 1.1.1-beta.7 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/README.md +2 -2
- package/api/actions-api.ts +219 -397
- package/api/executions-api.ts +119 -12
- package/dist/api/actions-api.d.ts +178 -270
- package/dist/api/actions-api.js +153 -328
- package/dist/api/executions-api.d.ts +69 -12
- package/dist/api/executions-api.js +102 -9
- package/dist/models/action-class.d.ts +9 -20
- package/dist/models/action-execution-class.d.ts +36 -0
- package/dist/models/action-ref-class.d.ts +36 -0
- package/dist/models/action-ref-class.js +15 -0
- package/dist/models/action-version-class.d.ts +127 -0
- package/dist/models/action-version-class.js +21 -0
- package/dist/models/create-action-request-dto.d.ts +47 -5
- package/dist/models/create-action-request-dto.js +6 -0
- package/dist/models/get-action-version-response-class.d.ts +25 -0
- package/dist/models/get-action-version-response-class.js +15 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/list-action-versions-response-class.d.ts +43 -0
- package/dist/models/list-action-versions-response-class.js +15 -0
- package/dist/models/trigger-action-request-dto.d.ts +62 -0
- package/dist/models/trigger-action-request-dto.js +15 -0
- package/dist/models/trigger-action-response-class.d.ts +25 -0
- package/dist/models/trigger-action-response-class.js +15 -0
- package/dist/models/update-action-request-dto.d.ts +41 -5
- package/dist/models/update-action-request-dto.js +6 -0
- package/models/action-class.ts +9 -20
- package/models/action-execution-class.ts +36 -0
- package/models/action-ref-class.ts +42 -0
- package/models/action-version-class.ts +136 -0
- package/models/create-action-request-dto.ts +50 -5
- package/models/get-action-version-response-class.ts +31 -0
- package/models/index.ts +6 -0
- package/models/list-action-versions-response-class.ts +49 -0
- package/models/trigger-action-request-dto.ts +66 -0
- package/models/trigger-action-response-class.ts +31 -0
- package/models/update-action-request-dto.ts +44 -5
- package/package.json +1 -1
|
@@ -14,9 +14,9 @@ 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 { GetActionExecutionStatusResponseClass } from '../models';
|
|
18
17
|
import { GetActionResponseClass } from '../models';
|
|
19
|
-
import {
|
|
18
|
+
import { GetActionVersionResponseClass } from '../models';
|
|
19
|
+
import { ListActionVersionsResponseClass } from '../models';
|
|
20
20
|
import { ListActionsResponseClass } from '../models';
|
|
21
21
|
import { UpdateActionRequestDto } from '../models';
|
|
22
22
|
import { UpdateActionResponseClass } from '../models';
|
|
@@ -34,15 +34,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
34
34
|
* @throws {RequiredError}
|
|
35
35
|
*/
|
|
36
36
|
createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
-
/**
|
|
38
|
-
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
39
|
-
* @summary Create the action
|
|
40
|
-
* @param {CreateActionRequestDto} createActionRequestDto
|
|
41
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
|
-
* @param {*} [options] Override http request option.
|
|
43
|
-
* @throws {RequiredError}
|
|
44
|
-
*/
|
|
45
|
-
createAction_1: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
37
|
/**
|
|
47
38
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
48
39
|
* @summary Delete the action
|
|
@@ -53,89 +44,82 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
53
44
|
*/
|
|
54
45
|
deleteAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
46
|
/**
|
|
56
|
-
* Deletes
|
|
57
|
-
* @summary Delete the action
|
|
58
|
-
* @param {string} code
|
|
47
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
48
|
+
* @summary Delete the action version
|
|
49
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
59
50
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
51
|
* @param {*} [options] Override http request option.
|
|
61
52
|
* @throws {RequiredError}
|
|
62
53
|
*/
|
|
63
|
-
|
|
54
|
+
deleteActionVersion: (versionCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
55
|
/**
|
|
65
56
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
66
57
|
* @summary Retrieve the action
|
|
67
58
|
* @param {string} code Action code
|
|
68
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
69
61
|
* @param {*} [options] Override http request option.
|
|
70
62
|
* @throws {RequiredError}
|
|
71
63
|
*/
|
|
72
|
-
getAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
getAction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
65
|
/**
|
|
74
|
-
*
|
|
75
|
-
* @summary Retrieve the
|
|
66
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
67
|
+
* @summary Retrieve the action version
|
|
68
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
76
69
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
-
* @param {string} [
|
|
78
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
70
|
+
* @param {string} [expand]
|
|
79
71
|
* @param {*} [options] Override http request option.
|
|
80
72
|
* @throws {RequiredError}
|
|
81
73
|
*/
|
|
82
|
-
|
|
74
|
+
getActionVersion: (versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
75
|
/**
|
|
84
|
-
*
|
|
85
|
-
* @summary
|
|
76
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
77
|
+
* @summary List action versions
|
|
86
78
|
* @param {string} code Action code
|
|
87
79
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
88
|
-
* @param {*} [options] Override http request option.
|
|
89
|
-
* @throws {RequiredError}
|
|
90
|
-
*/
|
|
91
|
-
getAction_3: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
|
-
/**
|
|
93
|
-
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
94
|
-
* @summary List actionExecutions
|
|
95
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
96
80
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
97
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.
|
|
98
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
99
83
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
100
|
-
* @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,
|
|
101
|
-
* @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/>
|
|
102
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
103
87
|
* @param {*} [options] Override http request option.
|
|
104
88
|
* @throws {RequiredError}
|
|
105
89
|
*/
|
|
106
|
-
|
|
90
|
+
listActionVersions: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
107
91
|
/**
|
|
108
92
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
109
93
|
* @summary List actions
|
|
110
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
111
95
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
112
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.
|
|
113
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
114
98
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
115
|
-
* @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,
|
|
116
|
-
* @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/>
|
|
117
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
118
102
|
* @param {*} [options] Override http request option.
|
|
119
103
|
* @throws {RequiredError}
|
|
120
104
|
*/
|
|
121
105
|
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
122
106
|
/**
|
|
123
|
-
* Lists all action
|
|
124
|
-
* @summary List
|
|
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
|
|
125
109
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
110
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
127
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.
|
|
128
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
129
113
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
130
|
-
* @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,
|
|
131
|
-
* @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/>
|
|
132
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
133
117
|
* @param {*} [options] Override http request option.
|
|
134
118
|
* @throws {RequiredError}
|
|
135
119
|
*/
|
|
136
|
-
|
|
120
|
+
listAllActionVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
137
121
|
/**
|
|
138
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
122
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
139
123
|
* @summary Update the action
|
|
140
124
|
* @param {string} code Action code
|
|
141
125
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -145,7 +129,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
145
129
|
*/
|
|
146
130
|
updateAction: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
147
131
|
/**
|
|
148
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
132
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
149
133
|
* @summary Update the action
|
|
150
134
|
* @param {string} code Action code
|
|
151
135
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -153,7 +137,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
153
137
|
* @param {*} [options] Override http request option.
|
|
154
138
|
* @throws {RequiredError}
|
|
155
139
|
*/
|
|
156
|
-
|
|
140
|
+
updateAction_1: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
157
141
|
};
|
|
158
142
|
/**
|
|
159
143
|
* ActionsApi - functional programming interface
|
|
@@ -169,15 +153,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
169
153
|
* @throws {RequiredError}
|
|
170
154
|
*/
|
|
171
155
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
|
|
172
|
-
/**
|
|
173
|
-
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
174
|
-
* @summary Create the action
|
|
175
|
-
* @param {CreateActionRequestDto} createActionRequestDto
|
|
176
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
|
-
* @param {*} [options] Override http request option.
|
|
178
|
-
* @throws {RequiredError}
|
|
179
|
-
*/
|
|
180
|
-
createAction_1(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
|
|
181
156
|
/**
|
|
182
157
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
183
158
|
* @summary Delete the action
|
|
@@ -188,89 +163,82 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
188
163
|
*/
|
|
189
164
|
deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
190
165
|
/**
|
|
191
|
-
* Deletes
|
|
192
|
-
* @summary Delete the action
|
|
193
|
-
* @param {string} code
|
|
166
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
167
|
+
* @summary Delete the action version
|
|
168
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
194
169
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
170
|
* @param {*} [options] Override http request option.
|
|
196
171
|
* @throws {RequiredError}
|
|
197
172
|
*/
|
|
198
|
-
|
|
173
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
199
174
|
/**
|
|
200
175
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
201
176
|
* @summary Retrieve the action
|
|
202
177
|
* @param {string} code Action code
|
|
203
178
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
179
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
204
180
|
* @param {*} [options] Override http request option.
|
|
205
181
|
* @throws {RequiredError}
|
|
206
182
|
*/
|
|
207
|
-
getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
183
|
+
getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
208
184
|
/**
|
|
209
|
-
*
|
|
210
|
-
* @summary Retrieve the
|
|
185
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
186
|
+
* @summary Retrieve the action version
|
|
187
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
211
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
-
* @param {string} [
|
|
213
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
189
|
+
* @param {string} [expand]
|
|
214
190
|
* @param {*} [options] Override http request option.
|
|
215
191
|
* @throws {RequiredError}
|
|
216
192
|
*/
|
|
217
|
-
|
|
193
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionVersionResponseClass>>;
|
|
218
194
|
/**
|
|
219
|
-
*
|
|
220
|
-
* @summary
|
|
195
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
196
|
+
* @summary List action versions
|
|
221
197
|
* @param {string} code Action code
|
|
222
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
223
|
-
* @param {*} [options] Override http request option.
|
|
224
|
-
* @throws {RequiredError}
|
|
225
|
-
*/
|
|
226
|
-
getAction_3(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
227
|
-
/**
|
|
228
|
-
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
229
|
-
* @summary List actionExecutions
|
|
230
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
199
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
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.
|
|
233
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
234
202
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
235
|
-
* @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,
|
|
236
|
-
* @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/>
|
|
237
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
238
206
|
* @param {*} [options] Override http request option.
|
|
239
207
|
* @throws {RequiredError}
|
|
240
208
|
*/
|
|
241
|
-
|
|
209
|
+
listActionVersions(code: string, 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>>;
|
|
242
210
|
/**
|
|
243
211
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
244
212
|
* @summary List actions
|
|
245
213
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
214
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
247
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.
|
|
248
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
249
217
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
250
|
-
* @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,
|
|
251
|
-
* @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/>
|
|
252
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
253
221
|
* @param {*} [options] Override http request option.
|
|
254
222
|
* @throws {RequiredError}
|
|
255
223
|
*/
|
|
256
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>>;
|
|
257
225
|
/**
|
|
258
|
-
* Lists all action
|
|
259
|
-
* @summary List
|
|
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
|
|
260
228
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
261
229
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
262
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.
|
|
263
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
264
232
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
265
|
-
* @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,
|
|
266
|
-
* @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/>
|
|
267
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
268
236
|
* @param {*} [options] Override http request option.
|
|
269
237
|
* @throws {RequiredError}
|
|
270
238
|
*/
|
|
271
|
-
|
|
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>>;
|
|
272
240
|
/**
|
|
273
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
241
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
274
242
|
* @summary Update the action
|
|
275
243
|
* @param {string} code Action code
|
|
276
244
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -280,7 +248,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
280
248
|
*/
|
|
281
249
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
282
250
|
/**
|
|
283
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
251
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
284
252
|
* @summary Update the action
|
|
285
253
|
* @param {string} code Action code
|
|
286
254
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -288,7 +256,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
288
256
|
* @param {*} [options] Override http request option.
|
|
289
257
|
* @throws {RequiredError}
|
|
290
258
|
*/
|
|
291
|
-
|
|
259
|
+
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
292
260
|
};
|
|
293
261
|
/**
|
|
294
262
|
* ActionsApi - factory interface
|
|
@@ -304,15 +272,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
304
272
|
* @throws {RequiredError}
|
|
305
273
|
*/
|
|
306
274
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
|
|
307
|
-
/**
|
|
308
|
-
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
309
|
-
* @summary Create the action
|
|
310
|
-
* @param {CreateActionRequestDto} createActionRequestDto
|
|
311
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
312
|
-
* @param {*} [options] Override http request option.
|
|
313
|
-
* @throws {RequiredError}
|
|
314
|
-
*/
|
|
315
|
-
createAction_1(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
|
|
316
275
|
/**
|
|
317
276
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
318
277
|
* @summary Delete the action
|
|
@@ -323,89 +282,82 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
323
282
|
*/
|
|
324
283
|
deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
325
284
|
/**
|
|
326
|
-
* Deletes
|
|
327
|
-
* @summary Delete the action
|
|
328
|
-
* @param {string} code
|
|
285
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
286
|
+
* @summary Delete the action version
|
|
287
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
329
288
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
330
289
|
* @param {*} [options] Override http request option.
|
|
331
290
|
* @throws {RequiredError}
|
|
332
291
|
*/
|
|
333
|
-
|
|
292
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
334
293
|
/**
|
|
335
294
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
336
295
|
* @summary Retrieve the action
|
|
337
296
|
* @param {string} code Action code
|
|
338
297
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
339
299
|
* @param {*} [options] Override http request option.
|
|
340
300
|
* @throws {RequiredError}
|
|
341
301
|
*/
|
|
342
|
-
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
302
|
+
getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
343
303
|
/**
|
|
344
|
-
*
|
|
345
|
-
* @summary Retrieve the
|
|
304
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
305
|
+
* @summary Retrieve the action version
|
|
306
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
346
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
347
|
-
* @param {string} [
|
|
348
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
308
|
+
* @param {string} [expand]
|
|
349
309
|
* @param {*} [options] Override http request option.
|
|
350
310
|
* @throws {RequiredError}
|
|
351
311
|
*/
|
|
352
|
-
|
|
312
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass>;
|
|
353
313
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @summary
|
|
314
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
315
|
+
* @summary List action versions
|
|
356
316
|
* @param {string} code Action code
|
|
357
317
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
358
|
-
* @param {*} [options] Override http request option.
|
|
359
|
-
* @throws {RequiredError}
|
|
360
|
-
*/
|
|
361
|
-
getAction_3(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
362
|
-
/**
|
|
363
|
-
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
364
|
-
* @summary List actionExecutions
|
|
365
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
366
318
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
367
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.
|
|
368
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
369
321
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
370
|
-
* @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,
|
|
371
|
-
* @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/>
|
|
372
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
373
325
|
* @param {*} [options] Override http request option.
|
|
374
326
|
* @throws {RequiredError}
|
|
375
327
|
*/
|
|
376
|
-
|
|
328
|
+
listActionVersions(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
377
329
|
/**
|
|
378
330
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
379
331
|
* @summary List actions
|
|
380
332
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
381
333
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
382
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.
|
|
383
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
384
336
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
385
|
-
* @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,
|
|
386
|
-
* @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/>
|
|
387
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
388
340
|
* @param {*} [options] Override http request option.
|
|
389
341
|
* @throws {RequiredError}
|
|
390
342
|
*/
|
|
391
343
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
392
344
|
/**
|
|
393
|
-
* Lists all action
|
|
394
|
-
* @summary List
|
|
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
|
|
395
347
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
348
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
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.
|
|
398
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
399
351
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
|
-
* @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,
|
|
401
|
-
* @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/>
|
|
402
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
403
355
|
* @param {*} [options] Override http request option.
|
|
404
356
|
* @throws {RequiredError}
|
|
405
357
|
*/
|
|
406
|
-
|
|
358
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
407
359
|
/**
|
|
408
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
360
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
409
361
|
* @summary Update the action
|
|
410
362
|
* @param {string} code Action code
|
|
411
363
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -415,7 +367,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
415
367
|
*/
|
|
416
368
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
417
369
|
/**
|
|
418
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
370
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
419
371
|
* @summary Update the action
|
|
420
372
|
* @param {string} code Action code
|
|
421
373
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -423,7 +375,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
423
375
|
* @param {*} [options] Override http request option.
|
|
424
376
|
* @throws {RequiredError}
|
|
425
377
|
*/
|
|
426
|
-
|
|
378
|
+
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
427
379
|
};
|
|
428
380
|
/**
|
|
429
381
|
* Request parameters for createAction operation in ActionsApi.
|
|
@@ -444,25 +396,6 @@ export interface ActionsApiCreateActionRequest {
|
|
|
444
396
|
*/
|
|
445
397
|
readonly authorization?: string;
|
|
446
398
|
}
|
|
447
|
-
/**
|
|
448
|
-
* Request parameters for createAction_1 operation in ActionsApi.
|
|
449
|
-
* @export
|
|
450
|
-
* @interface ActionsApiCreateAction0Request
|
|
451
|
-
*/
|
|
452
|
-
export interface ActionsApiCreateAction0Request {
|
|
453
|
-
/**
|
|
454
|
-
*
|
|
455
|
-
* @type {CreateActionRequestDto}
|
|
456
|
-
* @memberof ActionsApiCreateAction0
|
|
457
|
-
*/
|
|
458
|
-
readonly createActionRequestDto: CreateActionRequestDto;
|
|
459
|
-
/**
|
|
460
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
461
|
-
* @type {string}
|
|
462
|
-
* @memberof ActionsApiCreateAction0
|
|
463
|
-
*/
|
|
464
|
-
readonly authorization?: string;
|
|
465
|
-
}
|
|
466
399
|
/**
|
|
467
400
|
* Request parameters for deleteAction operation in ActionsApi.
|
|
468
401
|
* @export
|
|
@@ -483,21 +416,21 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
483
416
|
readonly authorization?: string;
|
|
484
417
|
}
|
|
485
418
|
/**
|
|
486
|
-
* Request parameters for
|
|
419
|
+
* Request parameters for deleteActionVersion operation in ActionsApi.
|
|
487
420
|
* @export
|
|
488
|
-
* @interface
|
|
421
|
+
* @interface ActionsApiDeleteActionVersionRequest
|
|
489
422
|
*/
|
|
490
|
-
export interface
|
|
423
|
+
export interface ActionsApiDeleteActionVersionRequest {
|
|
491
424
|
/**
|
|
492
|
-
*
|
|
425
|
+
* Version code (e.g. acv_<nanoid>)
|
|
493
426
|
* @type {string}
|
|
494
|
-
* @memberof
|
|
427
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
495
428
|
*/
|
|
496
|
-
readonly
|
|
429
|
+
readonly versionCode: string;
|
|
497
430
|
/**
|
|
498
431
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
432
|
* @type {string}
|
|
500
|
-
* @memberof
|
|
433
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
501
434
|
*/
|
|
502
435
|
readonly authorization?: string;
|
|
503
436
|
}
|
|
@@ -519,103 +452,96 @@ export interface ActionsApiGetActionRequest {
|
|
|
519
452
|
* @memberof ActionsApiGetAction
|
|
520
453
|
*/
|
|
521
454
|
readonly authorization?: string;
|
|
455
|
+
/**
|
|
456
|
+
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
457
|
+
* @type {string}
|
|
458
|
+
* @memberof ActionsApiGetAction
|
|
459
|
+
*/
|
|
460
|
+
readonly expand?: string;
|
|
522
461
|
}
|
|
523
462
|
/**
|
|
524
|
-
* Request parameters for
|
|
463
|
+
* Request parameters for getActionVersion operation in ActionsApi.
|
|
525
464
|
* @export
|
|
526
|
-
* @interface
|
|
465
|
+
* @interface ActionsApiGetActionVersionRequest
|
|
527
466
|
*/
|
|
528
|
-
export interface
|
|
467
|
+
export interface ActionsApiGetActionVersionRequest {
|
|
529
468
|
/**
|
|
530
|
-
*
|
|
469
|
+
* Version code (e.g. acv_<nanoid>)
|
|
531
470
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
471
|
+
* @memberof ActionsApiGetActionVersion
|
|
533
472
|
*/
|
|
534
|
-
readonly
|
|
473
|
+
readonly versionCode: string;
|
|
535
474
|
/**
|
|
536
|
-
*
|
|
475
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
537
476
|
* @type {string}
|
|
538
|
-
* @memberof
|
|
477
|
+
* @memberof ActionsApiGetActionVersion
|
|
539
478
|
*/
|
|
540
|
-
readonly
|
|
479
|
+
readonly authorization?: string;
|
|
541
480
|
/**
|
|
542
|
-
*
|
|
481
|
+
*
|
|
543
482
|
* @type {string}
|
|
544
|
-
* @memberof
|
|
483
|
+
* @memberof ActionsApiGetActionVersion
|
|
545
484
|
*/
|
|
546
|
-
readonly
|
|
485
|
+
readonly expand?: string;
|
|
547
486
|
}
|
|
548
487
|
/**
|
|
549
|
-
* Request parameters for
|
|
488
|
+
* Request parameters for listActionVersions operation in ActionsApi.
|
|
550
489
|
* @export
|
|
551
|
-
* @interface
|
|
490
|
+
* @interface ActionsApiListActionVersionsRequest
|
|
552
491
|
*/
|
|
553
|
-
export interface
|
|
492
|
+
export interface ActionsApiListActionVersionsRequest {
|
|
554
493
|
/**
|
|
555
494
|
* Action code
|
|
556
495
|
* @type {string}
|
|
557
|
-
* @memberof
|
|
496
|
+
* @memberof ActionsApiListActionVersions
|
|
558
497
|
*/
|
|
559
498
|
readonly code: string;
|
|
560
499
|
/**
|
|
561
500
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
562
501
|
* @type {string}
|
|
563
|
-
* @memberof
|
|
564
|
-
*/
|
|
565
|
-
readonly authorization?: string;
|
|
566
|
-
}
|
|
567
|
-
/**
|
|
568
|
-
* Request parameters for listActionExecutions operation in ActionsApi.
|
|
569
|
-
* @export
|
|
570
|
-
* @interface ActionsApiListActionExecutionsRequest
|
|
571
|
-
*/
|
|
572
|
-
export interface ActionsApiListActionExecutionsRequest {
|
|
573
|
-
/**
|
|
574
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
575
|
-
* @type {string}
|
|
576
|
-
* @memberof ActionsApiListActionExecutions
|
|
502
|
+
* @memberof ActionsApiListActionVersions
|
|
577
503
|
*/
|
|
578
504
|
readonly authorization?: string;
|
|
579
505
|
/**
|
|
580
506
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
581
507
|
* @type {number}
|
|
582
|
-
* @memberof
|
|
508
|
+
* @memberof ActionsApiListActionVersions
|
|
583
509
|
*/
|
|
584
510
|
readonly pageSize?: number;
|
|
585
511
|
/**
|
|
586
512
|
* 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.
|
|
587
513
|
* @type {string}
|
|
588
|
-
* @memberof
|
|
514
|
+
* @memberof ActionsApiListActionVersions
|
|
589
515
|
*/
|
|
590
516
|
readonly pageToken?: string;
|
|
591
517
|
/**
|
|
592
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
593
519
|
* @type {string}
|
|
594
|
-
* @memberof
|
|
520
|
+
* @memberof ActionsApiListActionVersions
|
|
595
521
|
*/
|
|
596
522
|
readonly filter?: string;
|
|
597
523
|
/**
|
|
598
524
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
599
525
|
* @type {string}
|
|
600
|
-
* @memberof
|
|
526
|
+
* @memberof ActionsApiListActionVersions
|
|
601
527
|
*/
|
|
602
528
|
readonly search?: string;
|
|
603
529
|
/**
|
|
604
|
-
* 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,
|
|
530
|
+
* 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>
|
|
605
531
|
* @type {string}
|
|
606
|
-
* @memberof
|
|
532
|
+
* @memberof ActionsApiListActionVersions
|
|
607
533
|
*/
|
|
608
534
|
readonly order?: string;
|
|
609
535
|
/**
|
|
610
|
-
* 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/>
|
|
536
|
+
* 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>
|
|
611
537
|
* @type {string}
|
|
612
|
-
* @memberof
|
|
538
|
+
* @memberof ActionsApiListActionVersions
|
|
613
539
|
*/
|
|
614
540
|
readonly expand?: string;
|
|
615
541
|
/**
|
|
616
|
-
* Filters the response by one or multiple fields.
|
|
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>
|
|
617
543
|
* @type {string}
|
|
618
|
-
* @memberof
|
|
544
|
+
* @memberof ActionsApiListActionVersions
|
|
619
545
|
*/
|
|
620
546
|
readonly filters?: string;
|
|
621
547
|
}
|
|
@@ -644,7 +570,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
644
570
|
*/
|
|
645
571
|
readonly pageToken?: string;
|
|
646
572
|
/**
|
|
647
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
648
574
|
* @type {string}
|
|
649
575
|
* @memberof ActionsApiListActions
|
|
650
576
|
*/
|
|
@@ -656,76 +582,76 @@ export interface ActionsApiListActionsRequest {
|
|
|
656
582
|
*/
|
|
657
583
|
readonly search?: string;
|
|
658
584
|
/**
|
|
659
|
-
* 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,
|
|
585
|
+
* 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>
|
|
660
586
|
* @type {string}
|
|
661
587
|
* @memberof ActionsApiListActions
|
|
662
588
|
*/
|
|
663
589
|
readonly order?: string;
|
|
664
590
|
/**
|
|
665
|
-
* 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/>
|
|
591
|
+
* 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>
|
|
666
592
|
* @type {string}
|
|
667
593
|
* @memberof ActionsApiListActions
|
|
668
594
|
*/
|
|
669
595
|
readonly expand?: string;
|
|
670
596
|
/**
|
|
671
|
-
* Filters the response by one or multiple fields.
|
|
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>
|
|
672
598
|
* @type {string}
|
|
673
599
|
* @memberof ActionsApiListActions
|
|
674
600
|
*/
|
|
675
601
|
readonly filters?: string;
|
|
676
602
|
}
|
|
677
603
|
/**
|
|
678
|
-
* Request parameters for
|
|
604
|
+
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
679
605
|
* @export
|
|
680
|
-
* @interface
|
|
606
|
+
* @interface ActionsApiListAllActionVersionsRequest
|
|
681
607
|
*/
|
|
682
|
-
export interface
|
|
608
|
+
export interface ActionsApiListAllActionVersionsRequest {
|
|
683
609
|
/**
|
|
684
610
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
685
611
|
* @type {string}
|
|
686
|
-
* @memberof
|
|
612
|
+
* @memberof ActionsApiListAllActionVersions
|
|
687
613
|
*/
|
|
688
614
|
readonly authorization?: string;
|
|
689
615
|
/**
|
|
690
616
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
691
617
|
* @type {number}
|
|
692
|
-
* @memberof
|
|
618
|
+
* @memberof ActionsApiListAllActionVersions
|
|
693
619
|
*/
|
|
694
620
|
readonly pageSize?: number;
|
|
695
621
|
/**
|
|
696
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.
|
|
697
623
|
* @type {string}
|
|
698
|
-
* @memberof
|
|
624
|
+
* @memberof ActionsApiListAllActionVersions
|
|
699
625
|
*/
|
|
700
626
|
readonly pageToken?: string;
|
|
701
627
|
/**
|
|
702
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
703
629
|
* @type {string}
|
|
704
|
-
* @memberof
|
|
630
|
+
* @memberof ActionsApiListAllActionVersions
|
|
705
631
|
*/
|
|
706
632
|
readonly filter?: string;
|
|
707
633
|
/**
|
|
708
634
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
709
635
|
* @type {string}
|
|
710
|
-
* @memberof
|
|
636
|
+
* @memberof ActionsApiListAllActionVersions
|
|
711
637
|
*/
|
|
712
638
|
readonly search?: string;
|
|
713
639
|
/**
|
|
714
|
-
* 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,
|
|
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>
|
|
715
641
|
* @type {string}
|
|
716
|
-
* @memberof
|
|
642
|
+
* @memberof ActionsApiListAllActionVersions
|
|
717
643
|
*/
|
|
718
644
|
readonly order?: string;
|
|
719
645
|
/**
|
|
720
|
-
* 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/>
|
|
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>
|
|
721
647
|
* @type {string}
|
|
722
|
-
* @memberof
|
|
648
|
+
* @memberof ActionsApiListAllActionVersions
|
|
723
649
|
*/
|
|
724
650
|
readonly expand?: string;
|
|
725
651
|
/**
|
|
726
|
-
* Filters the response by one or multiple fields.
|
|
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>
|
|
727
653
|
* @type {string}
|
|
728
|
-
* @memberof
|
|
654
|
+
* @memberof ActionsApiListAllActionVersions
|
|
729
655
|
*/
|
|
730
656
|
readonly filters?: string;
|
|
731
657
|
}
|
|
@@ -755,7 +681,7 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
755
681
|
readonly authorization?: string;
|
|
756
682
|
}
|
|
757
683
|
/**
|
|
758
|
-
* Request parameters for
|
|
684
|
+
* Request parameters for updateAction_1 operation in ActionsApi.
|
|
759
685
|
* @export
|
|
760
686
|
* @interface ActionsApiUpdateAction0Request
|
|
761
687
|
*/
|
|
@@ -795,15 +721,6 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
795
721
|
* @memberof ActionsApi
|
|
796
722
|
*/
|
|
797
723
|
createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
|
|
798
|
-
/**
|
|
799
|
-
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
800
|
-
* @summary Create the action
|
|
801
|
-
* @param {ActionsApiCreateAction0Request} requestParameters Request parameters.
|
|
802
|
-
* @param {*} [options] Override http request option.
|
|
803
|
-
* @throws {RequiredError}
|
|
804
|
-
* @memberof ActionsApi
|
|
805
|
-
*/
|
|
806
|
-
createAction_1(requestParameters: ActionsApiCreateAction0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
|
|
807
724
|
/**
|
|
808
725
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
809
726
|
* @summary Delete the action
|
|
@@ -814,14 +731,14 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
814
731
|
*/
|
|
815
732
|
deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
816
733
|
/**
|
|
817
|
-
* Deletes
|
|
818
|
-
* @summary Delete the action
|
|
819
|
-
* @param {
|
|
734
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
735
|
+
* @summary Delete the action version
|
|
736
|
+
* @param {ActionsApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
820
737
|
* @param {*} [options] Override http request option.
|
|
821
738
|
* @throws {RequiredError}
|
|
822
739
|
* @memberof ActionsApi
|
|
823
740
|
*/
|
|
824
|
-
|
|
741
|
+
deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
825
742
|
/**
|
|
826
743
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
827
744
|
* @summary Retrieve the action
|
|
@@ -832,32 +749,23 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
832
749
|
*/
|
|
833
750
|
getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
|
|
834
751
|
/**
|
|
835
|
-
*
|
|
836
|
-
* @summary Retrieve the
|
|
837
|
-
* @param {
|
|
838
|
-
* @param {*} [options] Override http request option.
|
|
839
|
-
* @throws {RequiredError}
|
|
840
|
-
* @memberof ActionsApi
|
|
841
|
-
*/
|
|
842
|
-
getActionExecutionStatus(requestParameters?: ActionsApiGetActionExecutionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionExecutionStatusResponseClass, any, {}>>;
|
|
843
|
-
/**
|
|
844
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
845
|
-
* @summary Retrieve the action
|
|
846
|
-
* @param {ActionsApiGetAction0Request} requestParameters Request parameters.
|
|
752
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
753
|
+
* @summary Retrieve the action version
|
|
754
|
+
* @param {ActionsApiGetActionVersionRequest} requestParameters Request parameters.
|
|
847
755
|
* @param {*} [options] Override http request option.
|
|
848
756
|
* @throws {RequiredError}
|
|
849
757
|
* @memberof ActionsApi
|
|
850
758
|
*/
|
|
851
|
-
|
|
759
|
+
getActionVersion(requestParameters: ActionsApiGetActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionVersionResponseClass, any, {}>>;
|
|
852
760
|
/**
|
|
853
|
-
* Lists
|
|
854
|
-
* @summary List
|
|
855
|
-
* @param {
|
|
761
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
762
|
+
* @summary List action versions
|
|
763
|
+
* @param {ActionsApiListActionVersionsRequest} requestParameters Request parameters.
|
|
856
764
|
* @param {*} [options] Override http request option.
|
|
857
765
|
* @throws {RequiredError}
|
|
858
766
|
* @memberof ActionsApi
|
|
859
767
|
*/
|
|
860
|
-
|
|
768
|
+
listActionVersions(requestParameters: ActionsApiListActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
861
769
|
/**
|
|
862
770
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
863
771
|
* @summary List actions
|
|
@@ -868,16 +776,16 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
868
776
|
*/
|
|
869
777
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
870
778
|
/**
|
|
871
|
-
* Lists all action
|
|
872
|
-
* @summary List
|
|
873
|
-
* @param {
|
|
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.
|
|
874
782
|
* @param {*} [options] Override http request option.
|
|
875
783
|
* @throws {RequiredError}
|
|
876
784
|
* @memberof ActionsApi
|
|
877
785
|
*/
|
|
878
|
-
|
|
786
|
+
listAllActionVersions(requestParameters?: ActionsApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
879
787
|
/**
|
|
880
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
788
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
881
789
|
* @summary Update the action
|
|
882
790
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
883
791
|
* @param {*} [options] Override http request option.
|
|
@@ -886,12 +794,12 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
886
794
|
*/
|
|
887
795
|
updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
888
796
|
/**
|
|
889
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
797
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
890
798
|
* @summary Update the action
|
|
891
799
|
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
892
800
|
* @param {*} [options] Override http request option.
|
|
893
801
|
* @throws {RequiredError}
|
|
894
802
|
* @memberof ActionsApi
|
|
895
803
|
*/
|
|
896
|
-
|
|
804
|
+
updateAction_1(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
897
805
|
}
|