@emilgroup/action-sdk 1.2.0 → 1.2.1-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -1
- package/README.md +2 -2
- package/api/action-client-api.ts +1709 -0
- package/api/actions-api.ts +4 -120
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api.ts +4 -2
- package/base.ts +1 -0
- package/dist/api/action-client-api.d.ts +973 -0
- package/dist/api/action-client-api.js +1416 -0
- package/dist/api/actions-api.d.ts +4 -68
- package/dist/api/actions-api.js +4 -103
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/list-action-executions-response-class.d.ts +10 -10
- package/dist/models/list-action-versions-response-class.d.ts +10 -10
- package/dist/models/list-actions-response-class.d.ts +10 -10
- package/models/list-action-executions-response-class.ts +10 -10
- package/models/list-action-versions-response-class.ts +10 -10
- package/models/list-actions-response-class.ts +10 -10
- package/package.json +2 -2
|
@@ -0,0 +1,973 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL ActionService
|
|
3
|
+
* The EMIL ActionService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateActionRequestDto } from '../models';
|
|
16
|
+
import { CreateActionResponseClass } from '../models';
|
|
17
|
+
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
18
|
+
import { GetActionResponseClass } from '../models';
|
|
19
|
+
import { GetActionVersionResponseClass } from '../models';
|
|
20
|
+
import { ListActionExecutionsResponseClass } from '../models';
|
|
21
|
+
import { ListActionVersionsResponseClass } from '../models';
|
|
22
|
+
import { ListActionsResponseClass } from '../models';
|
|
23
|
+
import { TriggerActionRequestDto } from '../models';
|
|
24
|
+
import { TriggerActionResponseClass } from '../models';
|
|
25
|
+
import { UpdateActionRequestDto } from '../models';
|
|
26
|
+
import { UpdateActionResponseClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* ActionClientApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export declare const ActionClientApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
|
+
/**
|
|
33
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
34
|
+
* @summary Create the action
|
|
35
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
36
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
/**
|
|
42
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
43
|
+
* @summary Delete the action
|
|
44
|
+
* @param {string} code Action code
|
|
45
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
deleteAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
52
|
+
* @summary Delete the action version
|
|
53
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
54
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
deleteActionVersion: (versionCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
61
|
+
* @summary Retrieve the action
|
|
62
|
+
* @param {string} code Action code
|
|
63
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
getAction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
71
|
+
* @summary Retrieve the actionExecution
|
|
72
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
|
+
* @param {string} [executionCode] Action execution code
|
|
74
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
getActionExecutionStatus: (authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
81
|
+
* @summary Retrieve the action version
|
|
82
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
83
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
|
+
* @param {string} [expand]
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
*/
|
|
88
|
+
getActionVersion: (versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
|
+
/**
|
|
90
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
91
|
+
* @summary List actionExecutions
|
|
92
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
93
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
94
|
+
* @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.
|
|
95
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
96
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
97
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, triggeredAt, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, createdAt, updatedAt</i>
|
|
98
|
+
* @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/>
|
|
99
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
listActionExecutions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
106
|
+
* @summary List action versions
|
|
107
|
+
* @param {string} code Action code
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
110
|
+
* @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.
|
|
111
|
+
* @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>
|
|
112
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
113
|
+
* @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>
|
|
114
|
+
* @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>
|
|
115
|
+
* @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>
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
listActionVersions: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
|
+
/**
|
|
121
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
122
|
+
* @summary List actions
|
|
123
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
125
|
+
* @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.
|
|
126
|
+
* @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>
|
|
127
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
128
|
+
* @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>
|
|
129
|
+
* @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>
|
|
130
|
+
* @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>
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
135
|
+
/**
|
|
136
|
+
* 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\"
|
|
137
|
+
* @summary List action versions
|
|
138
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
140
|
+
* @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.
|
|
141
|
+
* @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>
|
|
142
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
143
|
+
* @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>
|
|
144
|
+
* @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>
|
|
145
|
+
* @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>
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
listAllActionVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
150
|
+
/**
|
|
151
|
+
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
152
|
+
* @summary Create the actionExecution
|
|
153
|
+
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
154
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
triggerAction: (triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
159
|
+
/**
|
|
160
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
161
|
+
* @summary Update the action
|
|
162
|
+
* @param {string} code Action code
|
|
163
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
164
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
updateAction: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* ActionClientApi - functional programming interface
|
|
172
|
+
* @export
|
|
173
|
+
*/
|
|
174
|
+
export declare const ActionClientApiFp: (configuration?: Configuration) => {
|
|
175
|
+
/**
|
|
176
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
177
|
+
* @summary Create the action
|
|
178
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
179
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
|
|
184
|
+
/**
|
|
185
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
186
|
+
* @summary Delete the action
|
|
187
|
+
* @param {string} code Action code
|
|
188
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
193
|
+
/**
|
|
194
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
195
|
+
* @summary Delete the action version
|
|
196
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
197
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
202
|
+
/**
|
|
203
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
204
|
+
* @summary Retrieve the action
|
|
205
|
+
* @param {string} code Action code
|
|
206
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
207
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
212
|
+
/**
|
|
213
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
214
|
+
* @summary Retrieve the actionExecution
|
|
215
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
216
|
+
* @param {string} [executionCode] Action execution code
|
|
217
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>>;
|
|
222
|
+
/**
|
|
223
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
224
|
+
* @summary Retrieve the action version
|
|
225
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
226
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
227
|
+
* @param {string} [expand]
|
|
228
|
+
* @param {*} [options] Override http request option.
|
|
229
|
+
* @throws {RequiredError}
|
|
230
|
+
*/
|
|
231
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionVersionResponseClass>>;
|
|
232
|
+
/**
|
|
233
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
234
|
+
* @summary List actionExecutions
|
|
235
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
236
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
237
|
+
* @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.
|
|
238
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
239
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
240
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, triggeredAt, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, createdAt, updatedAt</i>
|
|
241
|
+
* @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/>
|
|
242
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
243
|
+
* @param {*} [options] Override http request option.
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionExecutionsResponseClass>>;
|
|
247
|
+
/**
|
|
248
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
249
|
+
* @summary List action versions
|
|
250
|
+
* @param {string} code Action code
|
|
251
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
|
+
* @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.
|
|
254
|
+
* @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>
|
|
255
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
256
|
+
* @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>
|
|
257
|
+
* @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>
|
|
258
|
+
* @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>
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
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>>;
|
|
263
|
+
/**
|
|
264
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
265
|
+
* @summary List actions
|
|
266
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
267
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
268
|
+
* @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.
|
|
269
|
+
* @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>
|
|
270
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
271
|
+
* @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>
|
|
272
|
+
* @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>
|
|
273
|
+
* @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>
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
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>>;
|
|
278
|
+
/**
|
|
279
|
+
* 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\"
|
|
280
|
+
* @summary List action versions
|
|
281
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
282
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
283
|
+
* @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.
|
|
284
|
+
* @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>
|
|
285
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
286
|
+
* @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>
|
|
287
|
+
* @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>
|
|
288
|
+
* @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>
|
|
289
|
+
* @param {*} [options] Override http request option.
|
|
290
|
+
* @throws {RequiredError}
|
|
291
|
+
*/
|
|
292
|
+
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>>;
|
|
293
|
+
/**
|
|
294
|
+
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
295
|
+
* @summary Create the actionExecution
|
|
296
|
+
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
297
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerActionResponseClass>>;
|
|
302
|
+
/**
|
|
303
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
304
|
+
* @summary Update the action
|
|
305
|
+
* @param {string} code Action code
|
|
306
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
307
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
+
* @param {*} [options] Override http request option.
|
|
309
|
+
* @throws {RequiredError}
|
|
310
|
+
*/
|
|
311
|
+
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
312
|
+
};
|
|
313
|
+
/**
|
|
314
|
+
* ActionClientApi - factory interface
|
|
315
|
+
* @export
|
|
316
|
+
*/
|
|
317
|
+
export declare const ActionClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
318
|
+
/**
|
|
319
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
320
|
+
* @summary Create the action
|
|
321
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
322
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
323
|
+
* @param {*} [options] Override http request option.
|
|
324
|
+
* @throws {RequiredError}
|
|
325
|
+
*/
|
|
326
|
+
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
|
|
327
|
+
/**
|
|
328
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
329
|
+
* @summary Delete the action
|
|
330
|
+
* @param {string} code Action code
|
|
331
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
332
|
+
* @param {*} [options] Override http request option.
|
|
333
|
+
* @throws {RequiredError}
|
|
334
|
+
*/
|
|
335
|
+
deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
336
|
+
/**
|
|
337
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
338
|
+
* @summary Delete the action version
|
|
339
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
340
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
341
|
+
* @param {*} [options] Override http request option.
|
|
342
|
+
* @throws {RequiredError}
|
|
343
|
+
*/
|
|
344
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
345
|
+
/**
|
|
346
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
347
|
+
* @summary Retrieve the action
|
|
348
|
+
* @param {string} code Action code
|
|
349
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
350
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
351
|
+
* @param {*} [options] Override http request option.
|
|
352
|
+
* @throws {RequiredError}
|
|
353
|
+
*/
|
|
354
|
+
getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
355
|
+
/**
|
|
356
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
357
|
+
* @summary Retrieve the actionExecution
|
|
358
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
359
|
+
* @param {string} [executionCode] Action execution code
|
|
360
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
*/
|
|
364
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass>;
|
|
365
|
+
/**
|
|
366
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
367
|
+
* @summary Retrieve the action version
|
|
368
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
369
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
|
+
* @param {string} [expand]
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
*/
|
|
374
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass>;
|
|
375
|
+
/**
|
|
376
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
377
|
+
* @summary List actionExecutions
|
|
378
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
379
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
380
|
+
* @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.
|
|
381
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
382
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
383
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, triggeredAt, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, createdAt, updatedAt</i>
|
|
384
|
+
* @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/>
|
|
385
|
+
* @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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
386
|
+
* @param {*} [options] Override http request option.
|
|
387
|
+
* @throws {RequiredError}
|
|
388
|
+
*/
|
|
389
|
+
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass>;
|
|
390
|
+
/**
|
|
391
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
392
|
+
* @summary List action versions
|
|
393
|
+
* @param {string} code Action code
|
|
394
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
396
|
+
* @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.
|
|
397
|
+
* @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>
|
|
398
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
399
|
+
* @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>
|
|
400
|
+
* @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>
|
|
401
|
+
* @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>
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
*/
|
|
405
|
+
listActionVersions(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
406
|
+
/**
|
|
407
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
408
|
+
* @summary List actions
|
|
409
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
410
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
411
|
+
* @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.
|
|
412
|
+
* @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>
|
|
413
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
414
|
+
* @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>
|
|
415
|
+
* @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>
|
|
416
|
+
* @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>
|
|
417
|
+
* @param {*} [options] Override http request option.
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
421
|
+
/**
|
|
422
|
+
* 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\"
|
|
423
|
+
* @summary List action versions
|
|
424
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
425
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
426
|
+
* @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.
|
|
427
|
+
* @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>
|
|
428
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
429
|
+
* @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>
|
|
430
|
+
* @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>
|
|
431
|
+
* @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>
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
436
|
+
/**
|
|
437
|
+
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
438
|
+
* @summary Create the actionExecution
|
|
439
|
+
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
440
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
441
|
+
* @param {*} [options] Override http request option.
|
|
442
|
+
* @throws {RequiredError}
|
|
443
|
+
*/
|
|
444
|
+
triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerActionResponseClass>;
|
|
445
|
+
/**
|
|
446
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
447
|
+
* @summary Update the action
|
|
448
|
+
* @param {string} code Action code
|
|
449
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
450
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
451
|
+
* @param {*} [options] Override http request option.
|
|
452
|
+
* @throws {RequiredError}
|
|
453
|
+
*/
|
|
454
|
+
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
455
|
+
};
|
|
456
|
+
/**
|
|
457
|
+
* Request parameters for createAction operation in ActionClientApi.
|
|
458
|
+
* @export
|
|
459
|
+
* @interface ActionClientApiCreateActionRequest
|
|
460
|
+
*/
|
|
461
|
+
export interface ActionClientApiCreateActionRequest {
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @type {CreateActionRequestDto}
|
|
465
|
+
* @memberof ActionClientApiCreateAction
|
|
466
|
+
*/
|
|
467
|
+
readonly createActionRequestDto: CreateActionRequestDto;
|
|
468
|
+
/**
|
|
469
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
470
|
+
* @type {string}
|
|
471
|
+
* @memberof ActionClientApiCreateAction
|
|
472
|
+
*/
|
|
473
|
+
readonly authorization?: string;
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* Request parameters for deleteAction operation in ActionClientApi.
|
|
477
|
+
* @export
|
|
478
|
+
* @interface ActionClientApiDeleteActionRequest
|
|
479
|
+
*/
|
|
480
|
+
export interface ActionClientApiDeleteActionRequest {
|
|
481
|
+
/**
|
|
482
|
+
* Action code
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof ActionClientApiDeleteAction
|
|
485
|
+
*/
|
|
486
|
+
readonly code: string;
|
|
487
|
+
/**
|
|
488
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof ActionClientApiDeleteAction
|
|
491
|
+
*/
|
|
492
|
+
readonly authorization?: string;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* Request parameters for deleteActionVersion operation in ActionClientApi.
|
|
496
|
+
* @export
|
|
497
|
+
* @interface ActionClientApiDeleteActionVersionRequest
|
|
498
|
+
*/
|
|
499
|
+
export interface ActionClientApiDeleteActionVersionRequest {
|
|
500
|
+
/**
|
|
501
|
+
* Version code (e.g. acv_<nanoid>)
|
|
502
|
+
* @type {string}
|
|
503
|
+
* @memberof ActionClientApiDeleteActionVersion
|
|
504
|
+
*/
|
|
505
|
+
readonly versionCode: string;
|
|
506
|
+
/**
|
|
507
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
508
|
+
* @type {string}
|
|
509
|
+
* @memberof ActionClientApiDeleteActionVersion
|
|
510
|
+
*/
|
|
511
|
+
readonly authorization?: string;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* Request parameters for getAction operation in ActionClientApi.
|
|
515
|
+
* @export
|
|
516
|
+
* @interface ActionClientApiGetActionRequest
|
|
517
|
+
*/
|
|
518
|
+
export interface ActionClientApiGetActionRequest {
|
|
519
|
+
/**
|
|
520
|
+
* Action code
|
|
521
|
+
* @type {string}
|
|
522
|
+
* @memberof ActionClientApiGetAction
|
|
523
|
+
*/
|
|
524
|
+
readonly code: string;
|
|
525
|
+
/**
|
|
526
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
527
|
+
* @type {string}
|
|
528
|
+
* @memberof ActionClientApiGetAction
|
|
529
|
+
*/
|
|
530
|
+
readonly authorization?: string;
|
|
531
|
+
/**
|
|
532
|
+
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
533
|
+
* @type {string}
|
|
534
|
+
* @memberof ActionClientApiGetAction
|
|
535
|
+
*/
|
|
536
|
+
readonly expand?: string;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* Request parameters for getActionExecutionStatus operation in ActionClientApi.
|
|
540
|
+
* @export
|
|
541
|
+
* @interface ActionClientApiGetActionExecutionStatusRequest
|
|
542
|
+
*/
|
|
543
|
+
export interface ActionClientApiGetActionExecutionStatusRequest {
|
|
544
|
+
/**
|
|
545
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
|
+
* @type {string}
|
|
547
|
+
* @memberof ActionClientApiGetActionExecutionStatus
|
|
548
|
+
*/
|
|
549
|
+
readonly authorization?: string;
|
|
550
|
+
/**
|
|
551
|
+
* Action execution code
|
|
552
|
+
* @type {string}
|
|
553
|
+
* @memberof ActionClientApiGetActionExecutionStatus
|
|
554
|
+
*/
|
|
555
|
+
readonly executionCode?: string;
|
|
556
|
+
/**
|
|
557
|
+
* Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof ActionClientApiGetActionExecutionStatus
|
|
560
|
+
*/
|
|
561
|
+
readonly correlationId?: string;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Request parameters for getActionVersion operation in ActionClientApi.
|
|
565
|
+
* @export
|
|
566
|
+
* @interface ActionClientApiGetActionVersionRequest
|
|
567
|
+
*/
|
|
568
|
+
export interface ActionClientApiGetActionVersionRequest {
|
|
569
|
+
/**
|
|
570
|
+
* Version code (e.g. acv_<nanoid>)
|
|
571
|
+
* @type {string}
|
|
572
|
+
* @memberof ActionClientApiGetActionVersion
|
|
573
|
+
*/
|
|
574
|
+
readonly versionCode: string;
|
|
575
|
+
/**
|
|
576
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
577
|
+
* @type {string}
|
|
578
|
+
* @memberof ActionClientApiGetActionVersion
|
|
579
|
+
*/
|
|
580
|
+
readonly authorization?: string;
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof ActionClientApiGetActionVersion
|
|
585
|
+
*/
|
|
586
|
+
readonly expand?: string;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* Request parameters for listActionExecutions operation in ActionClientApi.
|
|
590
|
+
* @export
|
|
591
|
+
* @interface ActionClientApiListActionExecutionsRequest
|
|
592
|
+
*/
|
|
593
|
+
export interface ActionClientApiListActionExecutionsRequest {
|
|
594
|
+
/**
|
|
595
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
596
|
+
* @type {string}
|
|
597
|
+
* @memberof ActionClientApiListActionExecutions
|
|
598
|
+
*/
|
|
599
|
+
readonly authorization?: string;
|
|
600
|
+
/**
|
|
601
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
602
|
+
* @type {number}
|
|
603
|
+
* @memberof ActionClientApiListActionExecutions
|
|
604
|
+
*/
|
|
605
|
+
readonly pageSize?: number;
|
|
606
|
+
/**
|
|
607
|
+
* 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.
|
|
608
|
+
* @type {string}
|
|
609
|
+
* @memberof ActionClientApiListActionExecutions
|
|
610
|
+
*/
|
|
611
|
+
readonly pageToken?: string;
|
|
612
|
+
/**
|
|
613
|
+
* 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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
614
|
+
* @type {string}
|
|
615
|
+
* @memberof ActionClientApiListActionExecutions
|
|
616
|
+
*/
|
|
617
|
+
readonly filter?: string;
|
|
618
|
+
/**
|
|
619
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
620
|
+
* @type {string}
|
|
621
|
+
* @memberof ActionClientApiListActionExecutions
|
|
622
|
+
*/
|
|
623
|
+
readonly search?: string;
|
|
624
|
+
/**
|
|
625
|
+
* 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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, triggeredAt, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, createdAt, updatedAt</i>
|
|
626
|
+
* @type {string}
|
|
627
|
+
* @memberof ActionClientApiListActionExecutions
|
|
628
|
+
*/
|
|
629
|
+
readonly order?: string;
|
|
630
|
+
/**
|
|
631
|
+
* 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/>
|
|
632
|
+
* @type {string}
|
|
633
|
+
* @memberof ActionClientApiListActionExecutions
|
|
634
|
+
*/
|
|
635
|
+
readonly expand?: string;
|
|
636
|
+
/**
|
|
637
|
+
* 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, executionCode, actionCode, actionSlug, actionVersion, entityCode, entityType, triggeredBySub, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, force, completedAt, triggeredAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
638
|
+
* @type {string}
|
|
639
|
+
* @memberof ActionClientApiListActionExecutions
|
|
640
|
+
*/
|
|
641
|
+
readonly filters?: string;
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* Request parameters for listActionVersions operation in ActionClientApi.
|
|
645
|
+
* @export
|
|
646
|
+
* @interface ActionClientApiListActionVersionsRequest
|
|
647
|
+
*/
|
|
648
|
+
export interface ActionClientApiListActionVersionsRequest {
|
|
649
|
+
/**
|
|
650
|
+
* Action code
|
|
651
|
+
* @type {string}
|
|
652
|
+
* @memberof ActionClientApiListActionVersions
|
|
653
|
+
*/
|
|
654
|
+
readonly code: string;
|
|
655
|
+
/**
|
|
656
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
657
|
+
* @type {string}
|
|
658
|
+
* @memberof ActionClientApiListActionVersions
|
|
659
|
+
*/
|
|
660
|
+
readonly authorization?: string;
|
|
661
|
+
/**
|
|
662
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
663
|
+
* @type {number}
|
|
664
|
+
* @memberof ActionClientApiListActionVersions
|
|
665
|
+
*/
|
|
666
|
+
readonly pageSize?: number;
|
|
667
|
+
/**
|
|
668
|
+
* 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.
|
|
669
|
+
* @type {string}
|
|
670
|
+
* @memberof ActionClientApiListActionVersions
|
|
671
|
+
*/
|
|
672
|
+
readonly pageToken?: string;
|
|
673
|
+
/**
|
|
674
|
+
* 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>
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof ActionClientApiListActionVersions
|
|
677
|
+
*/
|
|
678
|
+
readonly filter?: string;
|
|
679
|
+
/**
|
|
680
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
681
|
+
* @type {string}
|
|
682
|
+
* @memberof ActionClientApiListActionVersions
|
|
683
|
+
*/
|
|
684
|
+
readonly search?: string;
|
|
685
|
+
/**
|
|
686
|
+
* 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>
|
|
687
|
+
* @type {string}
|
|
688
|
+
* @memberof ActionClientApiListActionVersions
|
|
689
|
+
*/
|
|
690
|
+
readonly order?: string;
|
|
691
|
+
/**
|
|
692
|
+
* 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>
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof ActionClientApiListActionVersions
|
|
695
|
+
*/
|
|
696
|
+
readonly expand?: string;
|
|
697
|
+
/**
|
|
698
|
+
* 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>
|
|
699
|
+
* @type {string}
|
|
700
|
+
* @memberof ActionClientApiListActionVersions
|
|
701
|
+
*/
|
|
702
|
+
readonly filters?: string;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* Request parameters for listActions operation in ActionClientApi.
|
|
706
|
+
* @export
|
|
707
|
+
* @interface ActionClientApiListActionsRequest
|
|
708
|
+
*/
|
|
709
|
+
export interface ActionClientApiListActionsRequest {
|
|
710
|
+
/**
|
|
711
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof ActionClientApiListActions
|
|
714
|
+
*/
|
|
715
|
+
readonly authorization?: string;
|
|
716
|
+
/**
|
|
717
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
718
|
+
* @type {number}
|
|
719
|
+
* @memberof ActionClientApiListActions
|
|
720
|
+
*/
|
|
721
|
+
readonly pageSize?: number;
|
|
722
|
+
/**
|
|
723
|
+
* 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.
|
|
724
|
+
* @type {string}
|
|
725
|
+
* @memberof ActionClientApiListActions
|
|
726
|
+
*/
|
|
727
|
+
readonly pageToken?: string;
|
|
728
|
+
/**
|
|
729
|
+
* 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>
|
|
730
|
+
* @type {string}
|
|
731
|
+
* @memberof ActionClientApiListActions
|
|
732
|
+
*/
|
|
733
|
+
readonly filter?: string;
|
|
734
|
+
/**
|
|
735
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
736
|
+
* @type {string}
|
|
737
|
+
* @memberof ActionClientApiListActions
|
|
738
|
+
*/
|
|
739
|
+
readonly search?: string;
|
|
740
|
+
/**
|
|
741
|
+
* 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>
|
|
742
|
+
* @type {string}
|
|
743
|
+
* @memberof ActionClientApiListActions
|
|
744
|
+
*/
|
|
745
|
+
readonly order?: string;
|
|
746
|
+
/**
|
|
747
|
+
* 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>
|
|
748
|
+
* @type {string}
|
|
749
|
+
* @memberof ActionClientApiListActions
|
|
750
|
+
*/
|
|
751
|
+
readonly expand?: string;
|
|
752
|
+
/**
|
|
753
|
+
* 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>
|
|
754
|
+
* @type {string}
|
|
755
|
+
* @memberof ActionClientApiListActions
|
|
756
|
+
*/
|
|
757
|
+
readonly filters?: string;
|
|
758
|
+
}
|
|
759
|
+
/**
|
|
760
|
+
* Request parameters for listAllActionVersions operation in ActionClientApi.
|
|
761
|
+
* @export
|
|
762
|
+
* @interface ActionClientApiListAllActionVersionsRequest
|
|
763
|
+
*/
|
|
764
|
+
export interface ActionClientApiListAllActionVersionsRequest {
|
|
765
|
+
/**
|
|
766
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
767
|
+
* @type {string}
|
|
768
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
769
|
+
*/
|
|
770
|
+
readonly authorization?: string;
|
|
771
|
+
/**
|
|
772
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
773
|
+
* @type {number}
|
|
774
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
775
|
+
*/
|
|
776
|
+
readonly pageSize?: number;
|
|
777
|
+
/**
|
|
778
|
+
* 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.
|
|
779
|
+
* @type {string}
|
|
780
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
781
|
+
*/
|
|
782
|
+
readonly pageToken?: string;
|
|
783
|
+
/**
|
|
784
|
+
* 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>
|
|
785
|
+
* @type {string}
|
|
786
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
787
|
+
*/
|
|
788
|
+
readonly filter?: string;
|
|
789
|
+
/**
|
|
790
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
791
|
+
* @type {string}
|
|
792
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
793
|
+
*/
|
|
794
|
+
readonly search?: string;
|
|
795
|
+
/**
|
|
796
|
+
* 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>
|
|
797
|
+
* @type {string}
|
|
798
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
799
|
+
*/
|
|
800
|
+
readonly order?: string;
|
|
801
|
+
/**
|
|
802
|
+
* 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>
|
|
803
|
+
* @type {string}
|
|
804
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
805
|
+
*/
|
|
806
|
+
readonly expand?: string;
|
|
807
|
+
/**
|
|
808
|
+
* 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>
|
|
809
|
+
* @type {string}
|
|
810
|
+
* @memberof ActionClientApiListAllActionVersions
|
|
811
|
+
*/
|
|
812
|
+
readonly filters?: string;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* Request parameters for triggerAction operation in ActionClientApi.
|
|
816
|
+
* @export
|
|
817
|
+
* @interface ActionClientApiTriggerActionRequest
|
|
818
|
+
*/
|
|
819
|
+
export interface ActionClientApiTriggerActionRequest {
|
|
820
|
+
/**
|
|
821
|
+
*
|
|
822
|
+
* @type {TriggerActionRequestDto}
|
|
823
|
+
* @memberof ActionClientApiTriggerAction
|
|
824
|
+
*/
|
|
825
|
+
readonly triggerActionRequestDto: TriggerActionRequestDto;
|
|
826
|
+
/**
|
|
827
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
828
|
+
* @type {string}
|
|
829
|
+
* @memberof ActionClientApiTriggerAction
|
|
830
|
+
*/
|
|
831
|
+
readonly authorization?: string;
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* Request parameters for updateAction operation in ActionClientApi.
|
|
835
|
+
* @export
|
|
836
|
+
* @interface ActionClientApiUpdateActionRequest
|
|
837
|
+
*/
|
|
838
|
+
export interface ActionClientApiUpdateActionRequest {
|
|
839
|
+
/**
|
|
840
|
+
* Action code
|
|
841
|
+
* @type {string}
|
|
842
|
+
* @memberof ActionClientApiUpdateAction
|
|
843
|
+
*/
|
|
844
|
+
readonly code: string;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {UpdateActionRequestDto}
|
|
848
|
+
* @memberof ActionClientApiUpdateAction
|
|
849
|
+
*/
|
|
850
|
+
readonly updateActionRequestDto: UpdateActionRequestDto;
|
|
851
|
+
/**
|
|
852
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof ActionClientApiUpdateAction
|
|
855
|
+
*/
|
|
856
|
+
readonly authorization?: string;
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* ActionClientApi - object-oriented interface
|
|
860
|
+
* @export
|
|
861
|
+
* @class ActionClientApi
|
|
862
|
+
* @extends {BaseAPI}
|
|
863
|
+
*/
|
|
864
|
+
export declare class ActionClientApi extends BaseAPI {
|
|
865
|
+
/**
|
|
866
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
867
|
+
* @summary Create the action
|
|
868
|
+
* @param {ActionClientApiCreateActionRequest} requestParameters Request parameters.
|
|
869
|
+
* @param {*} [options] Override http request option.
|
|
870
|
+
* @throws {RequiredError}
|
|
871
|
+
* @memberof ActionClientApi
|
|
872
|
+
*/
|
|
873
|
+
createAction(requestParameters: ActionClientApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
|
|
874
|
+
/**
|
|
875
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
876
|
+
* @summary Delete the action
|
|
877
|
+
* @param {ActionClientApiDeleteActionRequest} requestParameters Request parameters.
|
|
878
|
+
* @param {*} [options] Override http request option.
|
|
879
|
+
* @throws {RequiredError}
|
|
880
|
+
* @memberof ActionClientApi
|
|
881
|
+
*/
|
|
882
|
+
deleteAction(requestParameters: ActionClientApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
883
|
+
/**
|
|
884
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
885
|
+
* @summary Delete the action version
|
|
886
|
+
* @param {ActionClientApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
887
|
+
* @param {*} [options] Override http request option.
|
|
888
|
+
* @throws {RequiredError}
|
|
889
|
+
* @memberof ActionClientApi
|
|
890
|
+
*/
|
|
891
|
+
deleteActionVersion(requestParameters: ActionClientApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
892
|
+
/**
|
|
893
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
894
|
+
* @summary Retrieve the action
|
|
895
|
+
* @param {ActionClientApiGetActionRequest} requestParameters Request parameters.
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
* @memberof ActionClientApi
|
|
899
|
+
*/
|
|
900
|
+
getAction(requestParameters: ActionClientApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
|
|
901
|
+
/**
|
|
902
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
903
|
+
* @summary Retrieve the actionExecution
|
|
904
|
+
* @param {ActionClientApiGetActionExecutionStatusRequest} requestParameters Request parameters.
|
|
905
|
+
* @param {*} [options] Override http request option.
|
|
906
|
+
* @throws {RequiredError}
|
|
907
|
+
* @memberof ActionClientApi
|
|
908
|
+
*/
|
|
909
|
+
getActionExecutionStatus(requestParameters?: ActionClientApiGetActionExecutionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionExecutionStatusResponseClass, any, {}>>;
|
|
910
|
+
/**
|
|
911
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
912
|
+
* @summary Retrieve the action version
|
|
913
|
+
* @param {ActionClientApiGetActionVersionRequest} requestParameters Request parameters.
|
|
914
|
+
* @param {*} [options] Override http request option.
|
|
915
|
+
* @throws {RequiredError}
|
|
916
|
+
* @memberof ActionClientApi
|
|
917
|
+
*/
|
|
918
|
+
getActionVersion(requestParameters: ActionClientApiGetActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionVersionResponseClass, any, {}>>;
|
|
919
|
+
/**
|
|
920
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
921
|
+
* @summary List actionExecutions
|
|
922
|
+
* @param {ActionClientApiListActionExecutionsRequest} requestParameters Request parameters.
|
|
923
|
+
* @param {*} [options] Override http request option.
|
|
924
|
+
* @throws {RequiredError}
|
|
925
|
+
* @memberof ActionClientApi
|
|
926
|
+
*/
|
|
927
|
+
listActionExecutions(requestParameters?: ActionClientApiListActionExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionExecutionsResponseClass, any, {}>>;
|
|
928
|
+
/**
|
|
929
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
930
|
+
* @summary List action versions
|
|
931
|
+
* @param {ActionClientApiListActionVersionsRequest} requestParameters Request parameters.
|
|
932
|
+
* @param {*} [options] Override http request option.
|
|
933
|
+
* @throws {RequiredError}
|
|
934
|
+
* @memberof ActionClientApi
|
|
935
|
+
*/
|
|
936
|
+
listActionVersions(requestParameters: ActionClientApiListActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
937
|
+
/**
|
|
938
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
939
|
+
* @summary List actions
|
|
940
|
+
* @param {ActionClientApiListActionsRequest} requestParameters Request parameters.
|
|
941
|
+
* @param {*} [options] Override http request option.
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
* @memberof ActionClientApi
|
|
944
|
+
*/
|
|
945
|
+
listActions(requestParameters?: ActionClientApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
946
|
+
/**
|
|
947
|
+
* 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\"
|
|
948
|
+
* @summary List action versions
|
|
949
|
+
* @param {ActionClientApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
950
|
+
* @param {*} [options] Override http request option.
|
|
951
|
+
* @throws {RequiredError}
|
|
952
|
+
* @memberof ActionClientApi
|
|
953
|
+
*/
|
|
954
|
+
listAllActionVersions(requestParameters?: ActionClientApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
955
|
+
/**
|
|
956
|
+
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
957
|
+
* @summary Create the actionExecution
|
|
958
|
+
* @param {ActionClientApiTriggerActionRequest} requestParameters Request parameters.
|
|
959
|
+
* @param {*} [options] Override http request option.
|
|
960
|
+
* @throws {RequiredError}
|
|
961
|
+
* @memberof ActionClientApi
|
|
962
|
+
*/
|
|
963
|
+
triggerAction(requestParameters: ActionClientApiTriggerActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerActionResponseClass, any, {}>>;
|
|
964
|
+
/**
|
|
965
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
966
|
+
* @summary Update the action
|
|
967
|
+
* @param {ActionClientApiUpdateActionRequest} requestParameters Request parameters.
|
|
968
|
+
* @param {*} [options] Override http request option.
|
|
969
|
+
* @throws {RequiredError}
|
|
970
|
+
* @memberof ActionClientApi
|
|
971
|
+
*/
|
|
972
|
+
updateAction(requestParameters: ActionClientApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
973
|
+
}
|