@emilgroup/action-sdk 1.1.1-beta.7 → 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 +8 -1
- package/README.md +2 -2
- package/api/action-client-api.ts +1709 -0
- package/api/actions-api.ts +201 -495
- package/api/executions-api.ts +119 -12
- 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 +165 -321
- package/dist/api/actions-api.js +136 -410
- package/dist/api/executions-api.d.ts +69 -12
- package/dist/api/executions-api.js +102 -9
- 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/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-executions-response-class.d.ts +10 -10
- 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/list-actions-response-class.d.ts +10 -10
- 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-executions-response-class.ts +10 -10
- package/models/list-action-versions-response-class.ts +49 -0
- package/models/list-actions-response-class.ts +10 -10
- 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 +2 -2
|
@@ -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,87 +44,80 @@ 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
122
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
139
123
|
* @summary Update the action
|
|
@@ -144,16 +128,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
144
128
|
* @throws {RequiredError}
|
|
145
129
|
*/
|
|
146
130
|
updateAction: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
147
|
-
/**
|
|
148
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
149
|
-
* @summary Update the action
|
|
150
|
-
* @param {string} code Action code
|
|
151
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
152
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
-
* @param {*} [options] Override http request option.
|
|
154
|
-
* @throws {RequiredError}
|
|
155
|
-
*/
|
|
156
|
-
updateAction_5: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
157
131
|
};
|
|
158
132
|
/**
|
|
159
133
|
* ActionsApi - functional programming interface
|
|
@@ -169,15 +143,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
169
143
|
* @throws {RequiredError}
|
|
170
144
|
*/
|
|
171
145
|
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
146
|
/**
|
|
182
147
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
183
148
|
* @summary Delete the action
|
|
@@ -188,87 +153,80 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
188
153
|
*/
|
|
189
154
|
deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
190
155
|
/**
|
|
191
|
-
* Deletes
|
|
192
|
-
* @summary Delete the action
|
|
193
|
-
* @param {string} code
|
|
156
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
157
|
+
* @summary Delete the action version
|
|
158
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
194
159
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
160
|
* @param {*} [options] Override http request option.
|
|
196
161
|
* @throws {RequiredError}
|
|
197
162
|
*/
|
|
198
|
-
|
|
163
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
199
164
|
/**
|
|
200
165
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
201
166
|
* @summary Retrieve the action
|
|
202
167
|
* @param {string} code Action code
|
|
203
168
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
204
170
|
* @param {*} [options] Override http request option.
|
|
205
171
|
* @throws {RequiredError}
|
|
206
172
|
*/
|
|
207
|
-
getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
173
|
+
getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
208
174
|
/**
|
|
209
|
-
*
|
|
210
|
-
* @summary Retrieve the
|
|
175
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
176
|
+
* @summary Retrieve the action version
|
|
177
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
211
178
|
* @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)
|
|
179
|
+
* @param {string} [expand]
|
|
214
180
|
* @param {*} [options] Override http request option.
|
|
215
181
|
* @throws {RequiredError}
|
|
216
182
|
*/
|
|
217
|
-
|
|
183
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionVersionResponseClass>>;
|
|
218
184
|
/**
|
|
219
|
-
*
|
|
220
|
-
* @summary
|
|
185
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
186
|
+
* @summary List action versions
|
|
221
187
|
* @param {string} code Action code
|
|
222
188
|
* @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
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
232
190
|
* @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.
|
|
191
|
+
* @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
192
|
* @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.
|
|
193
|
+
* @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>
|
|
194
|
+
* @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>
|
|
195
|
+
* @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
196
|
* @param {*} [options] Override http request option.
|
|
239
197
|
* @throws {RequiredError}
|
|
240
198
|
*/
|
|
241
|
-
|
|
199
|
+
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
200
|
/**
|
|
243
201
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
244
202
|
* @summary List actions
|
|
245
203
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
204
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
247
205
|
* @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.
|
|
206
|
+
* @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
207
|
* @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.
|
|
208
|
+
* @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>
|
|
209
|
+
* @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>
|
|
210
|
+
* @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
211
|
* @param {*} [options] Override http request option.
|
|
254
212
|
* @throws {RequiredError}
|
|
255
213
|
*/
|
|
256
214
|
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
215
|
/**
|
|
258
|
-
* Lists all action
|
|
259
|
-
* @summary List
|
|
216
|
+
* 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\"
|
|
217
|
+
* @summary List action versions
|
|
260
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
261
219
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
262
220
|
* @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.
|
|
221
|
+
* @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
222
|
* @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.
|
|
223
|
+
* @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>
|
|
224
|
+
* @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>
|
|
225
|
+
* @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
226
|
* @param {*} [options] Override http request option.
|
|
269
227
|
* @throws {RequiredError}
|
|
270
228
|
*/
|
|
271
|
-
|
|
229
|
+
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
230
|
/**
|
|
273
231
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
274
232
|
* @summary Update the action
|
|
@@ -279,16 +237,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
279
237
|
* @throws {RequiredError}
|
|
280
238
|
*/
|
|
281
239
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
282
|
-
/**
|
|
283
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
284
|
-
* @summary Update the action
|
|
285
|
-
* @param {string} code Action code
|
|
286
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
287
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
288
|
-
* @param {*} [options] Override http request option.
|
|
289
|
-
* @throws {RequiredError}
|
|
290
|
-
*/
|
|
291
|
-
updateAction_5(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
292
240
|
};
|
|
293
241
|
/**
|
|
294
242
|
* ActionsApi - factory interface
|
|
@@ -304,15 +252,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
304
252
|
* @throws {RequiredError}
|
|
305
253
|
*/
|
|
306
254
|
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
255
|
/**
|
|
317
256
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
318
257
|
* @summary Delete the action
|
|
@@ -323,87 +262,80 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
323
262
|
*/
|
|
324
263
|
deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
325
264
|
/**
|
|
326
|
-
* Deletes
|
|
327
|
-
* @summary Delete the action
|
|
328
|
-
* @param {string} code
|
|
265
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
266
|
+
* @summary Delete the action version
|
|
267
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
329
268
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
330
269
|
* @param {*} [options] Override http request option.
|
|
331
270
|
* @throws {RequiredError}
|
|
332
271
|
*/
|
|
333
|
-
|
|
272
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
334
273
|
/**
|
|
335
274
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
336
275
|
* @summary Retrieve the action
|
|
337
276
|
* @param {string} code Action code
|
|
338
277
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
278
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
339
279
|
* @param {*} [options] Override http request option.
|
|
340
280
|
* @throws {RequiredError}
|
|
341
281
|
*/
|
|
342
|
-
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
282
|
+
getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
343
283
|
/**
|
|
344
|
-
*
|
|
345
|
-
* @summary Retrieve the
|
|
284
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
285
|
+
* @summary Retrieve the action version
|
|
286
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
346
287
|
* @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)
|
|
288
|
+
* @param {string} [expand]
|
|
349
289
|
* @param {*} [options] Override http request option.
|
|
350
290
|
* @throws {RequiredError}
|
|
351
291
|
*/
|
|
352
|
-
|
|
292
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass>;
|
|
353
293
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @summary
|
|
294
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
295
|
+
* @summary List action versions
|
|
356
296
|
* @param {string} code Action code
|
|
357
297
|
* @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
298
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
367
299
|
* @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.
|
|
300
|
+
* @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
301
|
* @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.
|
|
302
|
+
* @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>
|
|
303
|
+
* @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>
|
|
304
|
+
* @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
305
|
* @param {*} [options] Override http request option.
|
|
374
306
|
* @throws {RequiredError}
|
|
375
307
|
*/
|
|
376
|
-
|
|
308
|
+
listActionVersions(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
377
309
|
/**
|
|
378
310
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
379
311
|
* @summary List actions
|
|
380
312
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
381
313
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
382
314
|
* @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.
|
|
315
|
+
* @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
316
|
* @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.
|
|
317
|
+
* @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>
|
|
318
|
+
* @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>
|
|
319
|
+
* @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
320
|
* @param {*} [options] Override http request option.
|
|
389
321
|
* @throws {RequiredError}
|
|
390
322
|
*/
|
|
391
323
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
392
324
|
/**
|
|
393
|
-
* Lists all action
|
|
394
|
-
* @summary List
|
|
325
|
+
* 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\"
|
|
326
|
+
* @summary List action versions
|
|
395
327
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
328
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
329
|
* @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.
|
|
330
|
+
* @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
331
|
* @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.
|
|
332
|
+
* @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>
|
|
333
|
+
* @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>
|
|
334
|
+
* @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
335
|
* @param {*} [options] Override http request option.
|
|
404
336
|
* @throws {RequiredError}
|
|
405
337
|
*/
|
|
406
|
-
|
|
338
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
407
339
|
/**
|
|
408
340
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
409
341
|
* @summary Update the action
|
|
@@ -414,16 +346,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
414
346
|
* @throws {RequiredError}
|
|
415
347
|
*/
|
|
416
348
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
417
|
-
/**
|
|
418
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
419
|
-
* @summary Update the action
|
|
420
|
-
* @param {string} code Action code
|
|
421
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
422
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
423
|
-
* @param {*} [options] Override http request option.
|
|
424
|
-
* @throws {RequiredError}
|
|
425
|
-
*/
|
|
426
|
-
updateAction_5(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
427
349
|
};
|
|
428
350
|
/**
|
|
429
351
|
* Request parameters for createAction operation in ActionsApi.
|
|
@@ -444,25 +366,6 @@ export interface ActionsApiCreateActionRequest {
|
|
|
444
366
|
*/
|
|
445
367
|
readonly authorization?: string;
|
|
446
368
|
}
|
|
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
369
|
/**
|
|
467
370
|
* Request parameters for deleteAction operation in ActionsApi.
|
|
468
371
|
* @export
|
|
@@ -483,21 +386,21 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
483
386
|
readonly authorization?: string;
|
|
484
387
|
}
|
|
485
388
|
/**
|
|
486
|
-
* Request parameters for
|
|
389
|
+
* Request parameters for deleteActionVersion operation in ActionsApi.
|
|
487
390
|
* @export
|
|
488
|
-
* @interface
|
|
391
|
+
* @interface ActionsApiDeleteActionVersionRequest
|
|
489
392
|
*/
|
|
490
|
-
export interface
|
|
393
|
+
export interface ActionsApiDeleteActionVersionRequest {
|
|
491
394
|
/**
|
|
492
|
-
*
|
|
395
|
+
* Version code (e.g. acv_<nanoid>)
|
|
493
396
|
* @type {string}
|
|
494
|
-
* @memberof
|
|
397
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
495
398
|
*/
|
|
496
|
-
readonly
|
|
399
|
+
readonly versionCode: string;
|
|
497
400
|
/**
|
|
498
401
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
402
|
* @type {string}
|
|
500
|
-
* @memberof
|
|
403
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
501
404
|
*/
|
|
502
405
|
readonly authorization?: string;
|
|
503
406
|
}
|
|
@@ -519,103 +422,96 @@ export interface ActionsApiGetActionRequest {
|
|
|
519
422
|
* @memberof ActionsApiGetAction
|
|
520
423
|
*/
|
|
521
424
|
readonly authorization?: string;
|
|
425
|
+
/**
|
|
426
|
+
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
427
|
+
* @type {string}
|
|
428
|
+
* @memberof ActionsApiGetAction
|
|
429
|
+
*/
|
|
430
|
+
readonly expand?: string;
|
|
522
431
|
}
|
|
523
432
|
/**
|
|
524
|
-
* Request parameters for
|
|
433
|
+
* Request parameters for getActionVersion operation in ActionsApi.
|
|
525
434
|
* @export
|
|
526
|
-
* @interface
|
|
435
|
+
* @interface ActionsApiGetActionVersionRequest
|
|
527
436
|
*/
|
|
528
|
-
export interface
|
|
437
|
+
export interface ActionsApiGetActionVersionRequest {
|
|
529
438
|
/**
|
|
530
|
-
*
|
|
439
|
+
* Version code (e.g. acv_<nanoid>)
|
|
531
440
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
441
|
+
* @memberof ActionsApiGetActionVersion
|
|
533
442
|
*/
|
|
534
|
-
readonly
|
|
443
|
+
readonly versionCode: string;
|
|
535
444
|
/**
|
|
536
|
-
*
|
|
445
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
537
446
|
* @type {string}
|
|
538
|
-
* @memberof
|
|
447
|
+
* @memberof ActionsApiGetActionVersion
|
|
539
448
|
*/
|
|
540
|
-
readonly
|
|
449
|
+
readonly authorization?: string;
|
|
541
450
|
/**
|
|
542
|
-
*
|
|
451
|
+
*
|
|
543
452
|
* @type {string}
|
|
544
|
-
* @memberof
|
|
453
|
+
* @memberof ActionsApiGetActionVersion
|
|
545
454
|
*/
|
|
546
|
-
readonly
|
|
455
|
+
readonly expand?: string;
|
|
547
456
|
}
|
|
548
457
|
/**
|
|
549
|
-
* Request parameters for
|
|
458
|
+
* Request parameters for listActionVersions operation in ActionsApi.
|
|
550
459
|
* @export
|
|
551
|
-
* @interface
|
|
460
|
+
* @interface ActionsApiListActionVersionsRequest
|
|
552
461
|
*/
|
|
553
|
-
export interface
|
|
462
|
+
export interface ActionsApiListActionVersionsRequest {
|
|
554
463
|
/**
|
|
555
464
|
* Action code
|
|
556
465
|
* @type {string}
|
|
557
|
-
* @memberof
|
|
466
|
+
* @memberof ActionsApiListActionVersions
|
|
558
467
|
*/
|
|
559
468
|
readonly code: string;
|
|
560
469
|
/**
|
|
561
470
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
562
471
|
* @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
|
|
472
|
+
* @memberof ActionsApiListActionVersions
|
|
577
473
|
*/
|
|
578
474
|
readonly authorization?: string;
|
|
579
475
|
/**
|
|
580
476
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
581
477
|
* @type {number}
|
|
582
|
-
* @memberof
|
|
478
|
+
* @memberof ActionsApiListActionVersions
|
|
583
479
|
*/
|
|
584
480
|
readonly pageSize?: number;
|
|
585
481
|
/**
|
|
586
482
|
* 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
483
|
* @type {string}
|
|
588
|
-
* @memberof
|
|
484
|
+
* @memberof ActionsApiListActionVersions
|
|
589
485
|
*/
|
|
590
486
|
readonly pageToken?: string;
|
|
591
487
|
/**
|
|
592
|
-
* Filter the response by one or multiple fields.
|
|
488
|
+
* 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
489
|
* @type {string}
|
|
594
|
-
* @memberof
|
|
490
|
+
* @memberof ActionsApiListActionVersions
|
|
595
491
|
*/
|
|
596
492
|
readonly filter?: string;
|
|
597
493
|
/**
|
|
598
494
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
599
495
|
* @type {string}
|
|
600
|
-
* @memberof
|
|
496
|
+
* @memberof ActionsApiListActionVersions
|
|
601
497
|
*/
|
|
602
498
|
readonly search?: string;
|
|
603
499
|
/**
|
|
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,
|
|
500
|
+
* 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
501
|
* @type {string}
|
|
606
|
-
* @memberof
|
|
502
|
+
* @memberof ActionsApiListActionVersions
|
|
607
503
|
*/
|
|
608
504
|
readonly order?: string;
|
|
609
505
|
/**
|
|
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/>
|
|
506
|
+
* 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
507
|
* @type {string}
|
|
612
|
-
* @memberof
|
|
508
|
+
* @memberof ActionsApiListActionVersions
|
|
613
509
|
*/
|
|
614
510
|
readonly expand?: string;
|
|
615
511
|
/**
|
|
616
|
-
* Filters the response by one or multiple fields.
|
|
512
|
+
* 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
513
|
* @type {string}
|
|
618
|
-
* @memberof
|
|
514
|
+
* @memberof ActionsApiListActionVersions
|
|
619
515
|
*/
|
|
620
516
|
readonly filters?: string;
|
|
621
517
|
}
|
|
@@ -644,7 +540,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
644
540
|
*/
|
|
645
541
|
readonly pageToken?: string;
|
|
646
542
|
/**
|
|
647
|
-
* Filter the response by one or multiple fields.
|
|
543
|
+
* 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
544
|
* @type {string}
|
|
649
545
|
* @memberof ActionsApiListActions
|
|
650
546
|
*/
|
|
@@ -656,76 +552,76 @@ export interface ActionsApiListActionsRequest {
|
|
|
656
552
|
*/
|
|
657
553
|
readonly search?: string;
|
|
658
554
|
/**
|
|
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,
|
|
555
|
+
* 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
556
|
* @type {string}
|
|
661
557
|
* @memberof ActionsApiListActions
|
|
662
558
|
*/
|
|
663
559
|
readonly order?: string;
|
|
664
560
|
/**
|
|
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/>
|
|
561
|
+
* 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
562
|
* @type {string}
|
|
667
563
|
* @memberof ActionsApiListActions
|
|
668
564
|
*/
|
|
669
565
|
readonly expand?: string;
|
|
670
566
|
/**
|
|
671
|
-
* Filters the response by one or multiple fields.
|
|
567
|
+
* 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
568
|
* @type {string}
|
|
673
569
|
* @memberof ActionsApiListActions
|
|
674
570
|
*/
|
|
675
571
|
readonly filters?: string;
|
|
676
572
|
}
|
|
677
573
|
/**
|
|
678
|
-
* Request parameters for
|
|
574
|
+
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
679
575
|
* @export
|
|
680
|
-
* @interface
|
|
576
|
+
* @interface ActionsApiListAllActionVersionsRequest
|
|
681
577
|
*/
|
|
682
|
-
export interface
|
|
578
|
+
export interface ActionsApiListAllActionVersionsRequest {
|
|
683
579
|
/**
|
|
684
580
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
685
581
|
* @type {string}
|
|
686
|
-
* @memberof
|
|
582
|
+
* @memberof ActionsApiListAllActionVersions
|
|
687
583
|
*/
|
|
688
584
|
readonly authorization?: string;
|
|
689
585
|
/**
|
|
690
586
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
691
587
|
* @type {number}
|
|
692
|
-
* @memberof
|
|
588
|
+
* @memberof ActionsApiListAllActionVersions
|
|
693
589
|
*/
|
|
694
590
|
readonly pageSize?: number;
|
|
695
591
|
/**
|
|
696
592
|
* 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
593
|
* @type {string}
|
|
698
|
-
* @memberof
|
|
594
|
+
* @memberof ActionsApiListAllActionVersions
|
|
699
595
|
*/
|
|
700
596
|
readonly pageToken?: string;
|
|
701
597
|
/**
|
|
702
|
-
* Filter the response by one or multiple fields.
|
|
598
|
+
* 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
599
|
* @type {string}
|
|
704
|
-
* @memberof
|
|
600
|
+
* @memberof ActionsApiListAllActionVersions
|
|
705
601
|
*/
|
|
706
602
|
readonly filter?: string;
|
|
707
603
|
/**
|
|
708
604
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
709
605
|
* @type {string}
|
|
710
|
-
* @memberof
|
|
606
|
+
* @memberof ActionsApiListAllActionVersions
|
|
711
607
|
*/
|
|
712
608
|
readonly search?: string;
|
|
713
609
|
/**
|
|
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,
|
|
610
|
+
* 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
611
|
* @type {string}
|
|
716
|
-
* @memberof
|
|
612
|
+
* @memberof ActionsApiListAllActionVersions
|
|
717
613
|
*/
|
|
718
614
|
readonly order?: string;
|
|
719
615
|
/**
|
|
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/>
|
|
616
|
+
* 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
617
|
* @type {string}
|
|
722
|
-
* @memberof
|
|
618
|
+
* @memberof ActionsApiListAllActionVersions
|
|
723
619
|
*/
|
|
724
620
|
readonly expand?: string;
|
|
725
621
|
/**
|
|
726
|
-
* Filters the response by one or multiple fields.
|
|
622
|
+
* 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
623
|
* @type {string}
|
|
728
|
-
* @memberof
|
|
624
|
+
* @memberof ActionsApiListAllActionVersions
|
|
729
625
|
*/
|
|
730
626
|
readonly filters?: string;
|
|
731
627
|
}
|
|
@@ -754,31 +650,6 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
754
650
|
*/
|
|
755
651
|
readonly authorization?: string;
|
|
756
652
|
}
|
|
757
|
-
/**
|
|
758
|
-
* Request parameters for updateAction_5 operation in ActionsApi.
|
|
759
|
-
* @export
|
|
760
|
-
* @interface ActionsApiUpdateAction0Request
|
|
761
|
-
*/
|
|
762
|
-
export interface ActionsApiUpdateAction0Request {
|
|
763
|
-
/**
|
|
764
|
-
* Action code
|
|
765
|
-
* @type {string}
|
|
766
|
-
* @memberof ActionsApiUpdateAction0
|
|
767
|
-
*/
|
|
768
|
-
readonly code: string;
|
|
769
|
-
/**
|
|
770
|
-
*
|
|
771
|
-
* @type {UpdateActionRequestDto}
|
|
772
|
-
* @memberof ActionsApiUpdateAction0
|
|
773
|
-
*/
|
|
774
|
-
readonly updateActionRequestDto: UpdateActionRequestDto;
|
|
775
|
-
/**
|
|
776
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
777
|
-
* @type {string}
|
|
778
|
-
* @memberof ActionsApiUpdateAction0
|
|
779
|
-
*/
|
|
780
|
-
readonly authorization?: string;
|
|
781
|
-
}
|
|
782
653
|
/**
|
|
783
654
|
* ActionsApi - object-oriented interface
|
|
784
655
|
* @export
|
|
@@ -795,15 +666,6 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
795
666
|
* @memberof ActionsApi
|
|
796
667
|
*/
|
|
797
668
|
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
669
|
/**
|
|
808
670
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
809
671
|
* @summary Delete the action
|
|
@@ -814,14 +676,14 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
814
676
|
*/
|
|
815
677
|
deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
816
678
|
/**
|
|
817
|
-
* Deletes
|
|
818
|
-
* @summary Delete the action
|
|
819
|
-
* @param {
|
|
679
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
680
|
+
* @summary Delete the action version
|
|
681
|
+
* @param {ActionsApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
820
682
|
* @param {*} [options] Override http request option.
|
|
821
683
|
* @throws {RequiredError}
|
|
822
684
|
* @memberof ActionsApi
|
|
823
685
|
*/
|
|
824
|
-
|
|
686
|
+
deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
825
687
|
/**
|
|
826
688
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
827
689
|
* @summary Retrieve the action
|
|
@@ -832,32 +694,23 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
832
694
|
*/
|
|
833
695
|
getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
|
|
834
696
|
/**
|
|
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.
|
|
697
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
698
|
+
* @summary Retrieve the action version
|
|
699
|
+
* @param {ActionsApiGetActionVersionRequest} requestParameters Request parameters.
|
|
847
700
|
* @param {*} [options] Override http request option.
|
|
848
701
|
* @throws {RequiredError}
|
|
849
702
|
* @memberof ActionsApi
|
|
850
703
|
*/
|
|
851
|
-
|
|
704
|
+
getActionVersion(requestParameters: ActionsApiGetActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionVersionResponseClass, any, {}>>;
|
|
852
705
|
/**
|
|
853
|
-
* Lists
|
|
854
|
-
* @summary List
|
|
855
|
-
* @param {
|
|
706
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
707
|
+
* @summary List action versions
|
|
708
|
+
* @param {ActionsApiListActionVersionsRequest} requestParameters Request parameters.
|
|
856
709
|
* @param {*} [options] Override http request option.
|
|
857
710
|
* @throws {RequiredError}
|
|
858
711
|
* @memberof ActionsApi
|
|
859
712
|
*/
|
|
860
|
-
|
|
713
|
+
listActionVersions(requestParameters: ActionsApiListActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
861
714
|
/**
|
|
862
715
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
863
716
|
* @summary List actions
|
|
@@ -868,14 +721,14 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
868
721
|
*/
|
|
869
722
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
870
723
|
/**
|
|
871
|
-
* Lists all action
|
|
872
|
-
* @summary List
|
|
873
|
-
* @param {
|
|
724
|
+
* 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\"
|
|
725
|
+
* @summary List action versions
|
|
726
|
+
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
874
727
|
* @param {*} [options] Override http request option.
|
|
875
728
|
* @throws {RequiredError}
|
|
876
729
|
* @memberof ActionsApi
|
|
877
730
|
*/
|
|
878
|
-
|
|
731
|
+
listAllActionVersions(requestParameters?: ActionsApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
879
732
|
/**
|
|
880
733
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
881
734
|
* @summary Update the action
|
|
@@ -885,13 +738,4 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
885
738
|
* @memberof ActionsApi
|
|
886
739
|
*/
|
|
887
740
|
updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
888
|
-
/**
|
|
889
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
890
|
-
* @summary Update the action
|
|
891
|
-
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
892
|
-
* @param {*} [options] Override http request option.
|
|
893
|
-
* @throws {RequiredError}
|
|
894
|
-
* @memberof ActionsApi
|
|
895
|
-
*/
|
|
896
|
-
updateAction_5(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
897
741
|
}
|