@emilgroup/action-sdk 1.1.1-beta.24 → 1.1.1-beta.6
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 +0 -10
- package/README.md +2 -2
- package/api/actions-api.ts +125 -811
- package/api.ts +0 -2
- package/dist/api/actions-api.d.ts +110 -496
- package/dist/api/actions-api.js +96 -633
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/action-class.d.ts +20 -9
- package/dist/models/action-execution-class.d.ts +0 -36
- package/dist/models/create-action-request-dto.d.ts +5 -47
- package/dist/models/create-action-request-dto.js +0 -6
- package/dist/models/index.d.ts +0 -9
- package/dist/models/index.js +0 -9
- package/dist/models/update-action-request-dto.d.ts +5 -41
- package/dist/models/update-action-request-dto.js +0 -6
- package/models/action-class.ts +20 -9
- package/models/action-execution-class.ts +0 -36
- package/models/create-action-request-dto.ts +5 -50
- package/models/index.ts +0 -9
- package/models/update-action-request-dto.ts +5 -44
- package/package.json +1 -1
- package/api/executions-api.ts +0 -471
- package/dist/api/executions-api.d.ts +0 -272
- package/dist/api/executions-api.js +0 -452
- package/dist/models/action-ref-class.d.ts +0 -36
- package/dist/models/action-ref-class.js +0 -15
- package/dist/models/action-version-class.d.ts +0 -127
- package/dist/models/action-version-class.js +0 -21
- package/dist/models/export-actions-as-yaml-response-class.d.ts +0 -24
- package/dist/models/export-actions-as-yaml-response-class.js +0 -15
- package/dist/models/get-action-version-response-class.d.ts +0 -25
- package/dist/models/get-action-version-response-class.js +0 -15
- package/dist/models/import-actions-from-yaml-request-dto.d.ts +0 -36
- package/dist/models/import-actions-from-yaml-request-dto.js +0 -15
- package/dist/models/import-actions-from-yaml-response-class.d.ts +0 -37
- package/dist/models/import-actions-from-yaml-response-class.js +0 -15
- package/dist/models/list-action-versions-response-class.d.ts +0 -43
- package/dist/models/list-action-versions-response-class.js +0 -15
- package/dist/models/trigger-action-request-dto.d.ts +0 -62
- package/dist/models/trigger-action-request-dto.js +0 -15
- package/dist/models/trigger-action-response-class.d.ts +0 -25
- package/dist/models/trigger-action-response-class.js +0 -15
- package/models/action-ref-class.ts +0 -42
- package/models/action-version-class.ts +0 -136
- package/models/export-actions-as-yaml-response-class.ts +0 -30
- package/models/get-action-version-response-class.ts +0 -31
- package/models/import-actions-from-yaml-request-dto.ts +0 -42
- package/models/import-actions-from-yaml-response-class.ts +0 -43
- package/models/list-action-versions-response-class.ts +0 -49
- package/models/trigger-action-request-dto.ts +0 -66
- package/models/trigger-action-response-class.ts +0 -31
|
@@ -14,12 +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 {
|
|
17
|
+
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
18
18
|
import { GetActionResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import { ImportActionsFromYamlRequestDto } from '../models';
|
|
21
|
-
import { ImportActionsFromYamlResponseClass } from '../models';
|
|
22
|
-
import { ListActionVersionsResponseClass } from '../models';
|
|
19
|
+
import { ListActionExecutionsResponseClass } from '../models';
|
|
23
20
|
import { ListActionsResponseClass } from '../models';
|
|
24
21
|
import { UpdateActionRequestDto } from '../models';
|
|
25
22
|
import { UpdateActionResponseClass } from '../models';
|
|
@@ -29,7 +26,7 @@ import { UpdateActionResponseClass } from '../models';
|
|
|
29
26
|
*/
|
|
30
27
|
export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
28
|
/**
|
|
32
|
-
* Creates a new action configuration
|
|
29
|
+
* Creates a new action configuration
|
|
33
30
|
* @summary Create the action
|
|
34
31
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
35
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -38,7 +35,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
38
35
|
*/
|
|
39
36
|
createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
37
|
/**
|
|
41
|
-
* Deletes an action configuration by its code
|
|
38
|
+
* Deletes an action configuration by its code
|
|
42
39
|
* @summary Delete the action
|
|
43
40
|
* @param {string} code Action code
|
|
44
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -47,103 +44,56 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
47
44
|
*/
|
|
48
45
|
deleteAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
46
|
/**
|
|
50
|
-
*
|
|
51
|
-
* @summary Delete the action version
|
|
52
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
53
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
54
|
-
* @param {*} [options] Override http request option.
|
|
55
|
-
* @throws {RequiredError}
|
|
56
|
-
*/
|
|
57
|
-
deleteActionVersion: (versionCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
-
/**
|
|
59
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
60
|
-
* @summary Retrieve the entity-actions-yaml
|
|
61
|
-
* @param {string} productSlug Product slug
|
|
62
|
-
* @param {number} productVersionId Product version ID
|
|
63
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
65
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
66
|
-
* @param {*} [options] Override http request option.
|
|
67
|
-
* @throws {RequiredError}
|
|
68
|
-
*/
|
|
69
|
-
exportActionsAsYaml: (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
-
/**
|
|
71
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
47
|
+
* Retrieves an action configuration by its code
|
|
72
48
|
* @summary Retrieve the action
|
|
73
49
|
* @param {string} code Action code
|
|
74
50
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
76
|
-
* @param {*} [options] Override http request option.
|
|
77
|
-
* @throws {RequiredError}
|
|
78
|
-
*/
|
|
79
|
-
getAction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
-
/**
|
|
81
|
-
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
82
|
-
* @summary Retrieve the action version
|
|
83
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
84
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
|
-
* @param {string} [expand]
|
|
86
51
|
* @param {*} [options] Override http request option.
|
|
87
52
|
* @throws {RequiredError}
|
|
88
53
|
*/
|
|
89
|
-
|
|
54
|
+
getAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
55
|
/**
|
|
91
|
-
*
|
|
92
|
-
* @summary
|
|
93
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
56
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
57
|
+
* @summary Retrieve the actionExecution
|
|
94
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
|
+
* @param {string} [executionCode] Action execution code
|
|
60
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
95
61
|
* @param {*} [options] Override http request option.
|
|
96
62
|
* @throws {RequiredError}
|
|
97
63
|
*/
|
|
98
|
-
|
|
64
|
+
getActionExecutionStatus: (authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
99
65
|
/**
|
|
100
|
-
* Lists
|
|
101
|
-
* @summary List
|
|
102
|
-
* @param {string} code Action code
|
|
66
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
67
|
+
* @summary List actionExecutions
|
|
103
68
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
69
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
105
70
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
106
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
71
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
107
72
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
108
|
-
* @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,
|
|
109
|
-
* @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/>
|
|
110
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
73
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
74
|
+
* @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/>
|
|
75
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
111
76
|
* @param {*} [options] Override http request option.
|
|
112
77
|
* @throws {RequiredError}
|
|
113
78
|
*/
|
|
114
|
-
|
|
79
|
+
listActionExecutions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
80
|
/**
|
|
116
|
-
* Lists all action configurations with optional filters
|
|
81
|
+
* Lists all action configurations with optional filters
|
|
117
82
|
* @summary List actions
|
|
118
83
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
119
84
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
120
85
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
121
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
86
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
122
87
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
123
|
-
* @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,
|
|
124
|
-
* @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/>
|
|
125
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
88
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
89
|
+
* @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/>
|
|
90
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
126
91
|
* @param {*} [options] Override http request option.
|
|
127
92
|
* @throws {RequiredError}
|
|
128
93
|
*/
|
|
129
94
|
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
130
95
|
/**
|
|
131
|
-
*
|
|
132
|
-
* @summary List action versions
|
|
133
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
135
|
-
* @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.
|
|
136
|
-
* @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>
|
|
137
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
138
|
-
* @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>
|
|
139
|
-
* @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>
|
|
140
|
-
* @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>
|
|
141
|
-
* @param {*} [options] Override http request option.
|
|
142
|
-
* @throws {RequiredError}
|
|
143
|
-
*/
|
|
144
|
-
listAllActionVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
145
|
-
/**
|
|
146
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
96
|
+
* Updates an existing action configuration (patch semantics)
|
|
147
97
|
* @summary Update the action
|
|
148
98
|
* @param {string} code Action code
|
|
149
99
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -152,16 +102,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
152
102
|
* @throws {RequiredError}
|
|
153
103
|
*/
|
|
154
104
|
updateAction: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
155
|
-
/**
|
|
156
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
157
|
-
* @summary Update the action
|
|
158
|
-
* @param {string} code Action code
|
|
159
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
160
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
|
-
* @param {*} [options] Override http request option.
|
|
162
|
-
* @throws {RequiredError}
|
|
163
|
-
*/
|
|
164
|
-
updateAction_1: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
165
105
|
};
|
|
166
106
|
/**
|
|
167
107
|
* ActionsApi - functional programming interface
|
|
@@ -169,7 +109,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
169
109
|
*/
|
|
170
110
|
export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
171
111
|
/**
|
|
172
|
-
* Creates a new action configuration
|
|
112
|
+
* Creates a new action configuration
|
|
173
113
|
* @summary Create the action
|
|
174
114
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
175
115
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -178,7 +118,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
178
118
|
*/
|
|
179
119
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
|
|
180
120
|
/**
|
|
181
|
-
* Deletes an action configuration by its code
|
|
121
|
+
* Deletes an action configuration by its code
|
|
182
122
|
* @summary Delete the action
|
|
183
123
|
* @param {string} code Action code
|
|
184
124
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -187,103 +127,56 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
187
127
|
*/
|
|
188
128
|
deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
189
129
|
/**
|
|
190
|
-
*
|
|
191
|
-
* @summary Delete the action version
|
|
192
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
193
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
-
* @param {*} [options] Override http request option.
|
|
195
|
-
* @throws {RequiredError}
|
|
196
|
-
*/
|
|
197
|
-
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
198
|
-
/**
|
|
199
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
200
|
-
* @summary Retrieve the entity-actions-yaml
|
|
201
|
-
* @param {string} productSlug Product slug
|
|
202
|
-
* @param {number} productVersionId Product version ID
|
|
203
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
204
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
205
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
206
|
-
* @param {*} [options] Override http request option.
|
|
207
|
-
* @throws {RequiredError}
|
|
208
|
-
*/
|
|
209
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>>;
|
|
210
|
-
/**
|
|
211
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
130
|
+
* Retrieves an action configuration by its code
|
|
212
131
|
* @summary Retrieve the action
|
|
213
132
|
* @param {string} code Action code
|
|
214
133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
216
134
|
* @param {*} [options] Override http request option.
|
|
217
135
|
* @throws {RequiredError}
|
|
218
136
|
*/
|
|
219
|
-
getAction(code: string, authorization?: string,
|
|
137
|
+
getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
220
138
|
/**
|
|
221
|
-
*
|
|
222
|
-
* @summary Retrieve the
|
|
223
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
139
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
140
|
+
* @summary Retrieve the actionExecution
|
|
224
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
225
|
-
* @param {string} [
|
|
142
|
+
* @param {string} [executionCode] Action execution code
|
|
143
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
226
144
|
* @param {*} [options] Override http request option.
|
|
227
145
|
* @throws {RequiredError}
|
|
228
146
|
*/
|
|
229
|
-
|
|
147
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>>;
|
|
230
148
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @summary
|
|
233
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
234
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
-
* @param {*} [options] Override http request option.
|
|
236
|
-
* @throws {RequiredError}
|
|
237
|
-
*/
|
|
238
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>>;
|
|
239
|
-
/**
|
|
240
|
-
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
241
|
-
* @summary List action versions
|
|
242
|
-
* @param {string} code Action code
|
|
149
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
150
|
+
* @summary List actionExecutions
|
|
243
151
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
152
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
153
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
154
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
247
155
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
|
-
* @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,
|
|
249
|
-
* @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/>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
156
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
157
|
+
* @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/>
|
|
158
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
251
159
|
* @param {*} [options] Override http request option.
|
|
252
160
|
* @throws {RequiredError}
|
|
253
161
|
*/
|
|
254
|
-
|
|
162
|
+
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>>;
|
|
255
163
|
/**
|
|
256
|
-
* Lists all action configurations with optional filters
|
|
164
|
+
* Lists all action configurations with optional filters
|
|
257
165
|
* @summary List actions
|
|
258
166
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
259
167
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
260
168
|
* @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.
|
|
261
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
169
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
262
170
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
263
|
-
* @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,
|
|
264
|
-
* @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/>
|
|
265
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
171
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
172
|
+
* @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/>
|
|
173
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
266
174
|
* @param {*} [options] Override http request option.
|
|
267
175
|
* @throws {RequiredError}
|
|
268
176
|
*/
|
|
269
177
|
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>>;
|
|
270
178
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @summary List action versions
|
|
273
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
274
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
-
* @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.
|
|
276
|
-
* @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>
|
|
277
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
278
|
-
* @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>
|
|
279
|
-
* @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>
|
|
280
|
-
* @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>
|
|
281
|
-
* @param {*} [options] Override http request option.
|
|
282
|
-
* @throws {RequiredError}
|
|
283
|
-
*/
|
|
284
|
-
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>>;
|
|
285
|
-
/**
|
|
286
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
179
|
+
* Updates an existing action configuration (patch semantics)
|
|
287
180
|
* @summary Update the action
|
|
288
181
|
* @param {string} code Action code
|
|
289
182
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -292,16 +185,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
292
185
|
* @throws {RequiredError}
|
|
293
186
|
*/
|
|
294
187
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
295
|
-
/**
|
|
296
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
297
|
-
* @summary Update the action
|
|
298
|
-
* @param {string} code Action code
|
|
299
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
300
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
301
|
-
* @param {*} [options] Override http request option.
|
|
302
|
-
* @throws {RequiredError}
|
|
303
|
-
*/
|
|
304
|
-
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
305
188
|
};
|
|
306
189
|
/**
|
|
307
190
|
* ActionsApi - factory interface
|
|
@@ -309,7 +192,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
309
192
|
*/
|
|
310
193
|
export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
311
194
|
/**
|
|
312
|
-
* Creates a new action configuration
|
|
195
|
+
* Creates a new action configuration
|
|
313
196
|
* @summary Create the action
|
|
314
197
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
315
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -318,7 +201,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
318
201
|
*/
|
|
319
202
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
|
|
320
203
|
/**
|
|
321
|
-
* Deletes an action configuration by its code
|
|
204
|
+
* Deletes an action configuration by its code
|
|
322
205
|
* @summary Delete the action
|
|
323
206
|
* @param {string} code Action code
|
|
324
207
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -327,103 +210,56 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
327
210
|
*/
|
|
328
211
|
deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
329
212
|
/**
|
|
330
|
-
*
|
|
331
|
-
* @summary Delete the action version
|
|
332
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
333
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
334
|
-
* @param {*} [options] Override http request option.
|
|
335
|
-
* @throws {RequiredError}
|
|
336
|
-
*/
|
|
337
|
-
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
338
|
-
/**
|
|
339
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
340
|
-
* @summary Retrieve the entity-actions-yaml
|
|
341
|
-
* @param {string} productSlug Product slug
|
|
342
|
-
* @param {number} productVersionId Product version ID
|
|
343
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
344
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
345
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
346
|
-
* @param {*} [options] Override http request option.
|
|
347
|
-
* @throws {RequiredError}
|
|
348
|
-
*/
|
|
349
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass>;
|
|
350
|
-
/**
|
|
351
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
213
|
+
* Retrieves an action configuration by its code
|
|
352
214
|
* @summary Retrieve the action
|
|
353
215
|
* @param {string} code Action code
|
|
354
216
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
355
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
356
217
|
* @param {*} [options] Override http request option.
|
|
357
218
|
* @throws {RequiredError}
|
|
358
219
|
*/
|
|
359
|
-
getAction(code: string, authorization?: string,
|
|
220
|
+
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
360
221
|
/**
|
|
361
|
-
*
|
|
362
|
-
* @summary Retrieve the
|
|
363
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
222
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
223
|
+
* @summary Retrieve the actionExecution
|
|
364
224
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
|
-
* @param {string} [
|
|
225
|
+
* @param {string} [executionCode] Action execution code
|
|
226
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
366
227
|
* @param {*} [options] Override http request option.
|
|
367
228
|
* @throws {RequiredError}
|
|
368
229
|
*/
|
|
369
|
-
|
|
230
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass>;
|
|
370
231
|
/**
|
|
371
|
-
*
|
|
372
|
-
* @summary
|
|
373
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
374
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
375
|
-
* @param {*} [options] Override http request option.
|
|
376
|
-
* @throws {RequiredError}
|
|
377
|
-
*/
|
|
378
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass>;
|
|
379
|
-
/**
|
|
380
|
-
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
381
|
-
* @summary List action versions
|
|
382
|
-
* @param {string} code Action code
|
|
232
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
233
|
+
* @summary List actionExecutions
|
|
383
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
384
235
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
385
236
|
* @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.
|
|
386
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
237
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
387
238
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
388
|
-
* @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,
|
|
389
|
-
* @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/>
|
|
390
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
239
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
240
|
+
* @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/>
|
|
241
|
+
* @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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
391
242
|
* @param {*} [options] Override http request option.
|
|
392
243
|
* @throws {RequiredError}
|
|
393
244
|
*/
|
|
394
|
-
|
|
245
|
+
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass>;
|
|
395
246
|
/**
|
|
396
|
-
* Lists all action configurations with optional filters
|
|
247
|
+
* Lists all action configurations with optional filters
|
|
397
248
|
* @summary List actions
|
|
398
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
400
251
|
* @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.
|
|
401
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
402
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
403
|
-
* @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,
|
|
404
|
-
* @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/>
|
|
405
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
255
|
+
* @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/>
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
406
257
|
* @param {*} [options] Override http request option.
|
|
407
258
|
* @throws {RequiredError}
|
|
408
259
|
*/
|
|
409
260
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
410
261
|
/**
|
|
411
|
-
*
|
|
412
|
-
* @summary List action versions
|
|
413
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
414
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
415
|
-
* @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.
|
|
416
|
-
* @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>
|
|
417
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
418
|
-
* @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>
|
|
419
|
-
* @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>
|
|
420
|
-
* @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>
|
|
421
|
-
* @param {*} [options] Override http request option.
|
|
422
|
-
* @throws {RequiredError}
|
|
423
|
-
*/
|
|
424
|
-
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
425
|
-
/**
|
|
426
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
262
|
+
* Updates an existing action configuration (patch semantics)
|
|
427
263
|
* @summary Update the action
|
|
428
264
|
* @param {string} code Action code
|
|
429
265
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -432,16 +268,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
432
268
|
* @throws {RequiredError}
|
|
433
269
|
*/
|
|
434
270
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
435
|
-
/**
|
|
436
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
437
|
-
* @summary Update the action
|
|
438
|
-
* @param {string} code Action code
|
|
439
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
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
|
-
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
445
271
|
};
|
|
446
272
|
/**
|
|
447
273
|
* Request parameters for createAction operation in ActionsApi.
|
|
@@ -481,62 +307,6 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
481
307
|
*/
|
|
482
308
|
readonly authorization?: string;
|
|
483
309
|
}
|
|
484
|
-
/**
|
|
485
|
-
* Request parameters for deleteActionVersion operation in ActionsApi.
|
|
486
|
-
* @export
|
|
487
|
-
* @interface ActionsApiDeleteActionVersionRequest
|
|
488
|
-
*/
|
|
489
|
-
export interface ActionsApiDeleteActionVersionRequest {
|
|
490
|
-
/**
|
|
491
|
-
* Version code (e.g. acv_<nanoid>)
|
|
492
|
-
* @type {string}
|
|
493
|
-
* @memberof ActionsApiDeleteActionVersion
|
|
494
|
-
*/
|
|
495
|
-
readonly versionCode: string;
|
|
496
|
-
/**
|
|
497
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
498
|
-
* @type {string}
|
|
499
|
-
* @memberof ActionsApiDeleteActionVersion
|
|
500
|
-
*/
|
|
501
|
-
readonly authorization?: string;
|
|
502
|
-
}
|
|
503
|
-
/**
|
|
504
|
-
* Request parameters for exportActionsAsYaml operation in ActionsApi.
|
|
505
|
-
* @export
|
|
506
|
-
* @interface ActionsApiExportActionsAsYamlRequest
|
|
507
|
-
*/
|
|
508
|
-
export interface ActionsApiExportActionsAsYamlRequest {
|
|
509
|
-
/**
|
|
510
|
-
* Product slug
|
|
511
|
-
* @type {string}
|
|
512
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
513
|
-
*/
|
|
514
|
-
readonly productSlug: string;
|
|
515
|
-
/**
|
|
516
|
-
* Product version ID
|
|
517
|
-
* @type {number}
|
|
518
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
519
|
-
*/
|
|
520
|
-
readonly productVersionId: number;
|
|
521
|
-
/**
|
|
522
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
523
|
-
* @type {string}
|
|
524
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
525
|
-
*/
|
|
526
|
-
readonly authorization?: string;
|
|
527
|
-
/**
|
|
528
|
-
* Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
529
|
-
* @type {Array<string>}
|
|
530
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
531
|
-
*/
|
|
532
|
-
readonly actionSlugs?: Array<string>;
|
|
533
|
-
/**
|
|
534
|
-
* Include draft (disabled) actions
|
|
535
|
-
* @type {boolean}
|
|
536
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
537
|
-
*/
|
|
538
|
-
readonly includeDisabled?: boolean;
|
|
539
|
-
}
|
|
540
310
|
/**
|
|
541
311
|
* Request parameters for getAction operation in ActionsApi.
|
|
542
312
|
* @export
|
|
@@ -555,115 +325,84 @@ export interface ActionsApiGetActionRequest {
|
|
|
555
325
|
* @memberof ActionsApiGetAction
|
|
556
326
|
*/
|
|
557
327
|
readonly authorization?: string;
|
|
558
|
-
/**
|
|
559
|
-
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
560
|
-
* @type {string}
|
|
561
|
-
* @memberof ActionsApiGetAction
|
|
562
|
-
*/
|
|
563
|
-
readonly expand?: string;
|
|
564
328
|
}
|
|
565
329
|
/**
|
|
566
|
-
* Request parameters for
|
|
330
|
+
* Request parameters for getActionExecutionStatus operation in ActionsApi.
|
|
567
331
|
* @export
|
|
568
|
-
* @interface
|
|
332
|
+
* @interface ActionsApiGetActionExecutionStatusRequest
|
|
569
333
|
*/
|
|
570
|
-
export interface
|
|
571
|
-
/**
|
|
572
|
-
* Version code (e.g. acv_<nanoid>)
|
|
573
|
-
* @type {string}
|
|
574
|
-
* @memberof ActionsApiGetActionVersion
|
|
575
|
-
*/
|
|
576
|
-
readonly versionCode: string;
|
|
334
|
+
export interface ActionsApiGetActionExecutionStatusRequest {
|
|
577
335
|
/**
|
|
578
336
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
579
337
|
* @type {string}
|
|
580
|
-
* @memberof
|
|
338
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
581
339
|
*/
|
|
582
340
|
readonly authorization?: string;
|
|
583
341
|
/**
|
|
584
|
-
*
|
|
342
|
+
* Action execution code
|
|
585
343
|
* @type {string}
|
|
586
|
-
* @memberof
|
|
344
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
587
345
|
*/
|
|
588
|
-
readonly
|
|
589
|
-
}
|
|
590
|
-
/**
|
|
591
|
-
* Request parameters for importActionsFromYaml operation in ActionsApi.
|
|
592
|
-
* @export
|
|
593
|
-
* @interface ActionsApiImportActionsFromYamlRequest
|
|
594
|
-
*/
|
|
595
|
-
export interface ActionsApiImportActionsFromYamlRequest {
|
|
346
|
+
readonly executionCode?: string;
|
|
596
347
|
/**
|
|
597
|
-
*
|
|
598
|
-
* @type {ImportActionsFromYamlRequestDto}
|
|
599
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
600
|
-
*/
|
|
601
|
-
readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto;
|
|
602
|
-
/**
|
|
603
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
+
* Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
604
349
|
* @type {string}
|
|
605
|
-
* @memberof
|
|
350
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
606
351
|
*/
|
|
607
|
-
readonly
|
|
352
|
+
readonly correlationId?: string;
|
|
608
353
|
}
|
|
609
354
|
/**
|
|
610
|
-
* Request parameters for
|
|
355
|
+
* Request parameters for listActionExecutions operation in ActionsApi.
|
|
611
356
|
* @export
|
|
612
|
-
* @interface
|
|
357
|
+
* @interface ActionsApiListActionExecutionsRequest
|
|
613
358
|
*/
|
|
614
|
-
export interface
|
|
615
|
-
/**
|
|
616
|
-
* Action code
|
|
617
|
-
* @type {string}
|
|
618
|
-
* @memberof ActionsApiListActionVersions
|
|
619
|
-
*/
|
|
620
|
-
readonly code: string;
|
|
359
|
+
export interface ActionsApiListActionExecutionsRequest {
|
|
621
360
|
/**
|
|
622
361
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
362
|
* @type {string}
|
|
624
|
-
* @memberof
|
|
363
|
+
* @memberof ActionsApiListActionExecutions
|
|
625
364
|
*/
|
|
626
365
|
readonly authorization?: string;
|
|
627
366
|
/**
|
|
628
367
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
629
368
|
* @type {number}
|
|
630
|
-
* @memberof
|
|
369
|
+
* @memberof ActionsApiListActionExecutions
|
|
631
370
|
*/
|
|
632
371
|
readonly pageSize?: number;
|
|
633
372
|
/**
|
|
634
373
|
* 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.
|
|
635
374
|
* @type {string}
|
|
636
|
-
* @memberof
|
|
375
|
+
* @memberof ActionsApiListActionExecutions
|
|
637
376
|
*/
|
|
638
377
|
readonly pageToken?: string;
|
|
639
378
|
/**
|
|
640
|
-
* Filter the response by one or multiple fields.
|
|
379
|
+
* 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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
641
380
|
* @type {string}
|
|
642
|
-
* @memberof
|
|
381
|
+
* @memberof ActionsApiListActionExecutions
|
|
643
382
|
*/
|
|
644
383
|
readonly filter?: string;
|
|
645
384
|
/**
|
|
646
385
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
647
386
|
* @type {string}
|
|
648
|
-
* @memberof
|
|
387
|
+
* @memberof ActionsApiListActionExecutions
|
|
649
388
|
*/
|
|
650
389
|
readonly search?: string;
|
|
651
390
|
/**
|
|
652
|
-
* 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,
|
|
391
|
+
* 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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
653
392
|
* @type {string}
|
|
654
|
-
* @memberof
|
|
393
|
+
* @memberof ActionsApiListActionExecutions
|
|
655
394
|
*/
|
|
656
395
|
readonly order?: string;
|
|
657
396
|
/**
|
|
658
|
-
* 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/>
|
|
397
|
+
* 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/>
|
|
659
398
|
* @type {string}
|
|
660
|
-
* @memberof
|
|
399
|
+
* @memberof ActionsApiListActionExecutions
|
|
661
400
|
*/
|
|
662
401
|
readonly expand?: string;
|
|
663
402
|
/**
|
|
664
|
-
* Filters the response by one or multiple fields.
|
|
403
|
+
* 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, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
665
404
|
* @type {string}
|
|
666
|
-
* @memberof
|
|
405
|
+
* @memberof ActionsApiListActionExecutions
|
|
667
406
|
*/
|
|
668
407
|
readonly filters?: string;
|
|
669
408
|
}
|
|
@@ -692,7 +431,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
692
431
|
*/
|
|
693
432
|
readonly pageToken?: string;
|
|
694
433
|
/**
|
|
695
|
-
* Filter the response by one or multiple fields.
|
|
434
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
696
435
|
* @type {string}
|
|
697
436
|
* @memberof ActionsApiListActions
|
|
698
437
|
*/
|
|
@@ -704,79 +443,24 @@ export interface ActionsApiListActionsRequest {
|
|
|
704
443
|
*/
|
|
705
444
|
readonly search?: string;
|
|
706
445
|
/**
|
|
707
|
-
* 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,
|
|
446
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt</i>
|
|
708
447
|
* @type {string}
|
|
709
448
|
* @memberof ActionsApiListActions
|
|
710
449
|
*/
|
|
711
450
|
readonly order?: string;
|
|
712
451
|
/**
|
|
713
|
-
* 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/>
|
|
452
|
+
* 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/>
|
|
714
453
|
* @type {string}
|
|
715
454
|
* @memberof ActionsApiListActions
|
|
716
455
|
*/
|
|
717
456
|
readonly expand?: string;
|
|
718
457
|
/**
|
|
719
|
-
* Filters the response by one or multiple fields.
|
|
458
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
720
459
|
* @type {string}
|
|
721
460
|
* @memberof ActionsApiListActions
|
|
722
461
|
*/
|
|
723
462
|
readonly filters?: string;
|
|
724
463
|
}
|
|
725
|
-
/**
|
|
726
|
-
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
727
|
-
* @export
|
|
728
|
-
* @interface ActionsApiListAllActionVersionsRequest
|
|
729
|
-
*/
|
|
730
|
-
export interface ActionsApiListAllActionVersionsRequest {
|
|
731
|
-
/**
|
|
732
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
733
|
-
* @type {string}
|
|
734
|
-
* @memberof ActionsApiListAllActionVersions
|
|
735
|
-
*/
|
|
736
|
-
readonly authorization?: string;
|
|
737
|
-
/**
|
|
738
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
739
|
-
* @type {number}
|
|
740
|
-
* @memberof ActionsApiListAllActionVersions
|
|
741
|
-
*/
|
|
742
|
-
readonly pageSize?: number;
|
|
743
|
-
/**
|
|
744
|
-
* 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.
|
|
745
|
-
* @type {string}
|
|
746
|
-
* @memberof ActionsApiListAllActionVersions
|
|
747
|
-
*/
|
|
748
|
-
readonly pageToken?: string;
|
|
749
|
-
/**
|
|
750
|
-
* 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>
|
|
751
|
-
* @type {string}
|
|
752
|
-
* @memberof ActionsApiListAllActionVersions
|
|
753
|
-
*/
|
|
754
|
-
readonly filter?: string;
|
|
755
|
-
/**
|
|
756
|
-
* To search the list by any field, pass search=xxx to fetch the result.
|
|
757
|
-
* @type {string}
|
|
758
|
-
* @memberof ActionsApiListAllActionVersions
|
|
759
|
-
*/
|
|
760
|
-
readonly search?: string;
|
|
761
|
-
/**
|
|
762
|
-
* 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>
|
|
763
|
-
* @type {string}
|
|
764
|
-
* @memberof ActionsApiListAllActionVersions
|
|
765
|
-
*/
|
|
766
|
-
readonly order?: string;
|
|
767
|
-
/**
|
|
768
|
-
* 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>
|
|
769
|
-
* @type {string}
|
|
770
|
-
* @memberof ActionsApiListAllActionVersions
|
|
771
|
-
*/
|
|
772
|
-
readonly expand?: string;
|
|
773
|
-
/**
|
|
774
|
-
* 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>
|
|
775
|
-
* @type {string}
|
|
776
|
-
* @memberof ActionsApiListAllActionVersions
|
|
777
|
-
*/
|
|
778
|
-
readonly filters?: string;
|
|
779
|
-
}
|
|
780
464
|
/**
|
|
781
465
|
* Request parameters for updateAction operation in ActionsApi.
|
|
782
466
|
* @export
|
|
@@ -802,31 +486,6 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
802
486
|
*/
|
|
803
487
|
readonly authorization?: string;
|
|
804
488
|
}
|
|
805
|
-
/**
|
|
806
|
-
* Request parameters for updateAction_1 operation in ActionsApi.
|
|
807
|
-
* @export
|
|
808
|
-
* @interface ActionsApiUpdateAction0Request
|
|
809
|
-
*/
|
|
810
|
-
export interface ActionsApiUpdateAction0Request {
|
|
811
|
-
/**
|
|
812
|
-
* Action code
|
|
813
|
-
* @type {string}
|
|
814
|
-
* @memberof ActionsApiUpdateAction0
|
|
815
|
-
*/
|
|
816
|
-
readonly code: string;
|
|
817
|
-
/**
|
|
818
|
-
*
|
|
819
|
-
* @type {UpdateActionRequestDto}
|
|
820
|
-
* @memberof ActionsApiUpdateAction0
|
|
821
|
-
*/
|
|
822
|
-
readonly updateActionRequestDto: UpdateActionRequestDto;
|
|
823
|
-
/**
|
|
824
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
825
|
-
* @type {string}
|
|
826
|
-
* @memberof ActionsApiUpdateAction0
|
|
827
|
-
*/
|
|
828
|
-
readonly authorization?: string;
|
|
829
|
-
}
|
|
830
489
|
/**
|
|
831
490
|
* ActionsApi - object-oriented interface
|
|
832
491
|
* @export
|
|
@@ -835,7 +494,7 @@ export interface ActionsApiUpdateAction0Request {
|
|
|
835
494
|
*/
|
|
836
495
|
export declare class ActionsApi extends BaseAPI {
|
|
837
496
|
/**
|
|
838
|
-
* Creates a new action configuration
|
|
497
|
+
* Creates a new action configuration
|
|
839
498
|
* @summary Create the action
|
|
840
499
|
* @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
|
|
841
500
|
* @param {*} [options] Override http request option.
|
|
@@ -844,7 +503,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
844
503
|
*/
|
|
845
504
|
createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
|
|
846
505
|
/**
|
|
847
|
-
* Deletes an action configuration by its code
|
|
506
|
+
* Deletes an action configuration by its code
|
|
848
507
|
* @summary Delete the action
|
|
849
508
|
* @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
|
|
850
509
|
* @param {*} [options] Override http request option.
|
|
@@ -853,25 +512,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
853
512
|
*/
|
|
854
513
|
deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
855
514
|
/**
|
|
856
|
-
*
|
|
857
|
-
* @summary Delete the action version
|
|
858
|
-
* @param {ActionsApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
859
|
-
* @param {*} [options] Override http request option.
|
|
860
|
-
* @throws {RequiredError}
|
|
861
|
-
* @memberof ActionsApi
|
|
862
|
-
*/
|
|
863
|
-
deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
864
|
-
/**
|
|
865
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
866
|
-
* @summary Retrieve the entity-actions-yaml
|
|
867
|
-
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
868
|
-
* @param {*} [options] Override http request option.
|
|
869
|
-
* @throws {RequiredError}
|
|
870
|
-
* @memberof ActionsApi
|
|
871
|
-
*/
|
|
872
|
-
exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportActionsAsYamlResponseClass, any, {}>>;
|
|
873
|
-
/**
|
|
874
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
515
|
+
* Retrieves an action configuration by its code
|
|
875
516
|
* @summary Retrieve the action
|
|
876
517
|
* @param {ActionsApiGetActionRequest} requestParameters Request parameters.
|
|
877
518
|
* @param {*} [options] Override http request option.
|
|
@@ -880,34 +521,25 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
880
521
|
*/
|
|
881
522
|
getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
|
|
882
523
|
/**
|
|
883
|
-
*
|
|
884
|
-
* @summary Retrieve the
|
|
885
|
-
* @param {
|
|
524
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
525
|
+
* @summary Retrieve the actionExecution
|
|
526
|
+
* @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
|
|
886
527
|
* @param {*} [options] Override http request option.
|
|
887
528
|
* @throws {RequiredError}
|
|
888
529
|
* @memberof ActionsApi
|
|
889
530
|
*/
|
|
890
|
-
|
|
531
|
+
getActionExecutionStatus(requestParameters?: ActionsApiGetActionExecutionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionExecutionStatusResponseClass, any, {}>>;
|
|
891
532
|
/**
|
|
892
|
-
*
|
|
893
|
-
* @summary
|
|
894
|
-
* @param {
|
|
533
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
534
|
+
* @summary List actionExecutions
|
|
535
|
+
* @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
|
|
895
536
|
* @param {*} [options] Override http request option.
|
|
896
537
|
* @throws {RequiredError}
|
|
897
538
|
* @memberof ActionsApi
|
|
898
539
|
*/
|
|
899
|
-
|
|
540
|
+
listActionExecutions(requestParameters?: ActionsApiListActionExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionExecutionsResponseClass, any, {}>>;
|
|
900
541
|
/**
|
|
901
|
-
* Lists all
|
|
902
|
-
* @summary List action versions
|
|
903
|
-
* @param {ActionsApiListActionVersionsRequest} requestParameters Request parameters.
|
|
904
|
-
* @param {*} [options] Override http request option.
|
|
905
|
-
* @throws {RequiredError}
|
|
906
|
-
* @memberof ActionsApi
|
|
907
|
-
*/
|
|
908
|
-
listActionVersions(requestParameters: ActionsApiListActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
909
|
-
/**
|
|
910
|
-
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
542
|
+
* Lists all action configurations with optional filters
|
|
911
543
|
* @summary List actions
|
|
912
544
|
* @param {ActionsApiListActionsRequest} requestParameters Request parameters.
|
|
913
545
|
* @param {*} [options] Override http request option.
|
|
@@ -916,16 +548,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
916
548
|
*/
|
|
917
549
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
918
550
|
/**
|
|
919
|
-
*
|
|
920
|
-
* @summary List action versions
|
|
921
|
-
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
922
|
-
* @param {*} [options] Override http request option.
|
|
923
|
-
* @throws {RequiredError}
|
|
924
|
-
* @memberof ActionsApi
|
|
925
|
-
*/
|
|
926
|
-
listAllActionVersions(requestParameters?: ActionsApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
927
|
-
/**
|
|
928
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
551
|
+
* Updates an existing action configuration (patch semantics)
|
|
929
552
|
* @summary Update the action
|
|
930
553
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
931
554
|
* @param {*} [options] Override http request option.
|
|
@@ -933,13 +556,4 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
933
556
|
* @memberof ActionsApi
|
|
934
557
|
*/
|
|
935
558
|
updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
936
|
-
/**
|
|
937
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
938
|
-
* @summary Update the action
|
|
939
|
-
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
940
|
-
* @param {*} [options] Override http request option.
|
|
941
|
-
* @throws {RequiredError}
|
|
942
|
-
* @memberof ActionsApi
|
|
943
|
-
*/
|
|
944
|
-
updateAction_1(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
945
559
|
}
|