@emilgroup/action-sdk 1.1.1-beta.27 → 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 -7
- package/README.md +2 -2
- package/api/actions-api.ts +130 -559
- package/api.ts +0 -2
- package/dist/api/actions-api.d.ts +112 -358
- package/dist/api/actions-api.js +97 -427
- 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 -6
- package/dist/models/index.js +0 -6
- 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 -6
- 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/get-action-version-response-class.d.ts +0 -25
- package/dist/models/get-action-version-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/get-action-version-response-class.ts +0 -31
- 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,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';
|
|
17
18
|
import { GetActionResponseClass } from '../models';
|
|
18
|
-
import {
|
|
19
|
-
import { ListActionVersionsResponseClass } from '../models';
|
|
19
|
+
import { ListActionExecutionsResponseClass } from '../models';
|
|
20
20
|
import { ListActionsResponseClass } from '../models';
|
|
21
21
|
import { UpdateActionRequestDto } from '../models';
|
|
22
22
|
import { UpdateActionResponseClass } from '../models';
|
|
@@ -26,7 +26,7 @@ import { UpdateActionResponseClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* Creates a new action configuration
|
|
29
|
+
* Creates a new action configuration
|
|
30
30
|
* @summary Create the action
|
|
31
31
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35
35
|
*/
|
|
36
36
|
createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
* Deletes an action configuration by its code
|
|
38
|
+
* Deletes an action configuration by its code
|
|
39
39
|
* @summary Delete the action
|
|
40
40
|
* @param {string} code Action code
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -44,82 +44,56 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
44
44
|
*/
|
|
45
45
|
deleteAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
48
|
-
* @summary Delete the action version
|
|
49
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
50
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
-
* @param {*} [options] Override http request option.
|
|
52
|
-
* @throws {RequiredError}
|
|
53
|
-
*/
|
|
54
|
-
deleteActionVersion: (versionCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
-
/**
|
|
56
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
47
|
+
* Retrieves an action configuration by its code
|
|
57
48
|
* @summary Retrieve the action
|
|
58
49
|
* @param {string} code Action code
|
|
59
50
|
* @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)
|
|
61
51
|
* @param {*} [options] Override http request option.
|
|
62
52
|
* @throws {RequiredError}
|
|
63
53
|
*/
|
|
64
|
-
getAction: (code: string, authorization?: string,
|
|
54
|
+
getAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
55
|
/**
|
|
66
|
-
*
|
|
67
|
-
* @summary Retrieve the
|
|
68
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
56
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
57
|
+
* @summary Retrieve the actionExecution
|
|
69
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
|
-
* @param {string} [
|
|
59
|
+
* @param {string} [executionCode] Action execution code
|
|
60
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
71
61
|
* @param {*} [options] Override http request option.
|
|
72
62
|
* @throws {RequiredError}
|
|
73
63
|
*/
|
|
74
|
-
|
|
64
|
+
getActionExecutionStatus: (authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
65
|
/**
|
|
76
|
-
* Lists
|
|
77
|
-
* @summary List
|
|
78
|
-
* @param {string} code Action code
|
|
66
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
67
|
+
* @summary List actionExecutions
|
|
79
68
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
80
69
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
81
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.
|
|
82
|
-
* @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>
|
|
83
72
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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,
|
|
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/>
|
|
86
|
-
* @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>
|
|
87
76
|
* @param {*} [options] Override http request option.
|
|
88
77
|
* @throws {RequiredError}
|
|
89
78
|
*/
|
|
90
|
-
|
|
79
|
+
listActionExecutions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
91
80
|
/**
|
|
92
|
-
* Lists all action configurations with optional filters
|
|
81
|
+
* Lists all action configurations with optional filters
|
|
93
82
|
* @summary List actions
|
|
94
83
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
84
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
96
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.
|
|
97
|
-
* @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>
|
|
98
87
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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,
|
|
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/>
|
|
101
|
-
* @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>
|
|
102
91
|
* @param {*} [options] Override http request option.
|
|
103
92
|
* @throws {RequiredError}
|
|
104
93
|
*/
|
|
105
94
|
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
106
95
|
/**
|
|
107
|
-
*
|
|
108
|
-
* @summary List action versions
|
|
109
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
112
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
113
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
115
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
116
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
117
|
-
* @param {*} [options] Override http request option.
|
|
118
|
-
* @throws {RequiredError}
|
|
119
|
-
*/
|
|
120
|
-
listAllActionVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
121
|
-
/**
|
|
122
|
-
* 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)
|
|
123
97
|
* @summary Update the action
|
|
124
98
|
* @param {string} code Action code
|
|
125
99
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -128,16 +102,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
128
102
|
* @throws {RequiredError}
|
|
129
103
|
*/
|
|
130
104
|
updateAction: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
|
-
/**
|
|
132
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
133
|
-
* @summary Update the action
|
|
134
|
-
* @param {string} code Action code
|
|
135
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
136
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
|
-
* @param {*} [options] Override http request option.
|
|
138
|
-
* @throws {RequiredError}
|
|
139
|
-
*/
|
|
140
|
-
updateAction_1: (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
105
|
};
|
|
142
106
|
/**
|
|
143
107
|
* ActionsApi - functional programming interface
|
|
@@ -145,7 +109,7 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
145
109
|
*/
|
|
146
110
|
export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
147
111
|
/**
|
|
148
|
-
* Creates a new action configuration
|
|
112
|
+
* Creates a new action configuration
|
|
149
113
|
* @summary Create the action
|
|
150
114
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
151
115
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -154,7 +118,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
154
118
|
*/
|
|
155
119
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
|
|
156
120
|
/**
|
|
157
|
-
* Deletes an action configuration by its code
|
|
121
|
+
* Deletes an action configuration by its code
|
|
158
122
|
* @summary Delete the action
|
|
159
123
|
* @param {string} code Action code
|
|
160
124
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -163,82 +127,56 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
163
127
|
*/
|
|
164
128
|
deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
165
129
|
/**
|
|
166
|
-
*
|
|
167
|
-
* @summary Delete the action version
|
|
168
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
169
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
-
* @param {*} [options] Override http request option.
|
|
171
|
-
* @throws {RequiredError}
|
|
172
|
-
*/
|
|
173
|
-
deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
174
|
-
/**
|
|
175
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
130
|
+
* Retrieves an action configuration by its code
|
|
176
131
|
* @summary Retrieve the action
|
|
177
132
|
* @param {string} code Action code
|
|
178
133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
179
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
180
134
|
* @param {*} [options] Override http request option.
|
|
181
135
|
* @throws {RequiredError}
|
|
182
136
|
*/
|
|
183
|
-
getAction(code: string, authorization?: string,
|
|
137
|
+
getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
|
|
184
138
|
/**
|
|
185
|
-
*
|
|
186
|
-
* @summary Retrieve the
|
|
187
|
-
* @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
|
|
188
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @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)
|
|
190
144
|
* @param {*} [options] Override http request option.
|
|
191
145
|
* @throws {RequiredError}
|
|
192
146
|
*/
|
|
193
|
-
|
|
147
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>>;
|
|
194
148
|
/**
|
|
195
|
-
* Lists
|
|
196
|
-
* @summary List
|
|
197
|
-
* @param {string} code Action code
|
|
149
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
150
|
+
* @summary List actionExecutions
|
|
198
151
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
152
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
200
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.
|
|
201
|
-
* @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>
|
|
202
155
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
203
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
204
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
205
|
-
* @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>
|
|
206
159
|
* @param {*} [options] Override http request option.
|
|
207
160
|
* @throws {RequiredError}
|
|
208
161
|
*/
|
|
209
|
-
|
|
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>>;
|
|
210
163
|
/**
|
|
211
|
-
* Lists all action configurations with optional filters
|
|
164
|
+
* Lists all action configurations with optional filters
|
|
212
165
|
* @summary List actions
|
|
213
166
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
214
167
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
215
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.
|
|
216
|
-
* @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>
|
|
217
170
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
218
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code,
|
|
219
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
220
|
-
* @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>
|
|
221
174
|
* @param {*} [options] Override http request option.
|
|
222
175
|
* @throws {RequiredError}
|
|
223
176
|
*/
|
|
224
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>>;
|
|
225
178
|
/**
|
|
226
|
-
*
|
|
227
|
-
* @summary List action versions
|
|
228
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
230
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
231
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
232
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
233
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
234
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
235
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
236
|
-
* @param {*} [options] Override http request option.
|
|
237
|
-
* @throws {RequiredError}
|
|
238
|
-
*/
|
|
239
|
-
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionVersionsResponseClass>>;
|
|
240
|
-
/**
|
|
241
|
-
* 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)
|
|
242
180
|
* @summary Update the action
|
|
243
181
|
* @param {string} code Action code
|
|
244
182
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -247,16 +185,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
247
185
|
* @throws {RequiredError}
|
|
248
186
|
*/
|
|
249
187
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
250
|
-
/**
|
|
251
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
252
|
-
* @summary Update the action
|
|
253
|
-
* @param {string} code Action code
|
|
254
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
255
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
|
-
* @param {*} [options] Override http request option.
|
|
257
|
-
* @throws {RequiredError}
|
|
258
|
-
*/
|
|
259
|
-
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
|
|
260
188
|
};
|
|
261
189
|
/**
|
|
262
190
|
* ActionsApi - factory interface
|
|
@@ -264,7 +192,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
264
192
|
*/
|
|
265
193
|
export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
266
194
|
/**
|
|
267
|
-
* Creates a new action configuration
|
|
195
|
+
* Creates a new action configuration
|
|
268
196
|
* @summary Create the action
|
|
269
197
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
270
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -273,7 +201,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
273
201
|
*/
|
|
274
202
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
|
|
275
203
|
/**
|
|
276
|
-
* Deletes an action configuration by its code
|
|
204
|
+
* Deletes an action configuration by its code
|
|
277
205
|
* @summary Delete the action
|
|
278
206
|
* @param {string} code Action code
|
|
279
207
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -282,82 +210,56 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
282
210
|
*/
|
|
283
211
|
deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
284
212
|
/**
|
|
285
|
-
*
|
|
286
|
-
* @summary Delete the action version
|
|
287
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
288
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
289
|
-
* @param {*} [options] Override http request option.
|
|
290
|
-
* @throws {RequiredError}
|
|
291
|
-
*/
|
|
292
|
-
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
293
|
-
/**
|
|
294
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
213
|
+
* Retrieves an action configuration by its code
|
|
295
214
|
* @summary Retrieve the action
|
|
296
215
|
* @param {string} code Action code
|
|
297
216
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
299
217
|
* @param {*} [options] Override http request option.
|
|
300
218
|
* @throws {RequiredError}
|
|
301
219
|
*/
|
|
302
|
-
getAction(code: string, authorization?: string,
|
|
220
|
+
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
|
|
303
221
|
/**
|
|
304
|
-
*
|
|
305
|
-
* @summary Retrieve the
|
|
306
|
-
* @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
|
|
307
224
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @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)
|
|
309
227
|
* @param {*} [options] Override http request option.
|
|
310
228
|
* @throws {RequiredError}
|
|
311
229
|
*/
|
|
312
|
-
|
|
230
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass>;
|
|
313
231
|
/**
|
|
314
|
-
* Lists
|
|
315
|
-
* @summary List
|
|
316
|
-
* @param {string} code Action code
|
|
232
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
233
|
+
* @summary List actionExecutions
|
|
317
234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
235
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
319
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.
|
|
320
|
-
* @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>
|
|
321
238
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
322
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
323
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
324
|
-
* @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>
|
|
325
242
|
* @param {*} [options] Override http request option.
|
|
326
243
|
* @throws {RequiredError}
|
|
327
244
|
*/
|
|
328
|
-
|
|
245
|
+
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass>;
|
|
329
246
|
/**
|
|
330
|
-
* Lists all action configurations with optional filters
|
|
247
|
+
* Lists all action configurations with optional filters
|
|
331
248
|
* @summary List actions
|
|
332
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
333
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
334
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.
|
|
335
|
-
* @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>
|
|
336
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
337
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code,
|
|
338
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
339
|
-
* @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>
|
|
340
257
|
* @param {*} [options] Override http request option.
|
|
341
258
|
* @throws {RequiredError}
|
|
342
259
|
*/
|
|
343
260
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
344
261
|
/**
|
|
345
|
-
*
|
|
346
|
-
* @summary List action versions
|
|
347
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
349
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
350
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
351
|
-
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
352
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
353
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
354
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
355
|
-
* @param {*} [options] Override http request option.
|
|
356
|
-
* @throws {RequiredError}
|
|
357
|
-
*/
|
|
358
|
-
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass>;
|
|
359
|
-
/**
|
|
360
|
-
* 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)
|
|
361
263
|
* @summary Update the action
|
|
362
264
|
* @param {string} code Action code
|
|
363
265
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -366,16 +268,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
366
268
|
* @throws {RequiredError}
|
|
367
269
|
*/
|
|
368
270
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
369
|
-
/**
|
|
370
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
371
|
-
* @summary Update the action
|
|
372
|
-
* @param {string} code Action code
|
|
373
|
-
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
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
|
-
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
|
|
379
271
|
};
|
|
380
272
|
/**
|
|
381
273
|
* Request parameters for createAction operation in ActionsApi.
|
|
@@ -415,25 +307,6 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
415
307
|
*/
|
|
416
308
|
readonly authorization?: string;
|
|
417
309
|
}
|
|
418
|
-
/**
|
|
419
|
-
* Request parameters for deleteActionVersion operation in ActionsApi.
|
|
420
|
-
* @export
|
|
421
|
-
* @interface ActionsApiDeleteActionVersionRequest
|
|
422
|
-
*/
|
|
423
|
-
export interface ActionsApiDeleteActionVersionRequest {
|
|
424
|
-
/**
|
|
425
|
-
* Version code (e.g. acv_<nanoid>)
|
|
426
|
-
* @type {string}
|
|
427
|
-
* @memberof ActionsApiDeleteActionVersion
|
|
428
|
-
*/
|
|
429
|
-
readonly versionCode: string;
|
|
430
|
-
/**
|
|
431
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @type {string}
|
|
433
|
-
* @memberof ActionsApiDeleteActionVersion
|
|
434
|
-
*/
|
|
435
|
-
readonly authorization?: string;
|
|
436
|
-
}
|
|
437
310
|
/**
|
|
438
311
|
* Request parameters for getAction operation in ActionsApi.
|
|
439
312
|
* @export
|
|
@@ -452,96 +325,84 @@ export interface ActionsApiGetActionRequest {
|
|
|
452
325
|
* @memberof ActionsApiGetAction
|
|
453
326
|
*/
|
|
454
327
|
readonly authorization?: string;
|
|
455
|
-
/**
|
|
456
|
-
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
457
|
-
* @type {string}
|
|
458
|
-
* @memberof ActionsApiGetAction
|
|
459
|
-
*/
|
|
460
|
-
readonly expand?: string;
|
|
461
328
|
}
|
|
462
329
|
/**
|
|
463
|
-
* Request parameters for
|
|
330
|
+
* Request parameters for getActionExecutionStatus operation in ActionsApi.
|
|
464
331
|
* @export
|
|
465
|
-
* @interface
|
|
332
|
+
* @interface ActionsApiGetActionExecutionStatusRequest
|
|
466
333
|
*/
|
|
467
|
-
export interface
|
|
334
|
+
export interface ActionsApiGetActionExecutionStatusRequest {
|
|
468
335
|
/**
|
|
469
|
-
*
|
|
336
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
470
337
|
* @type {string}
|
|
471
|
-
* @memberof
|
|
338
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
472
339
|
*/
|
|
473
|
-
readonly
|
|
340
|
+
readonly authorization?: string;
|
|
474
341
|
/**
|
|
475
|
-
*
|
|
342
|
+
* Action execution code
|
|
476
343
|
* @type {string}
|
|
477
|
-
* @memberof
|
|
344
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
478
345
|
*/
|
|
479
|
-
readonly
|
|
346
|
+
readonly executionCode?: string;
|
|
480
347
|
/**
|
|
481
|
-
*
|
|
348
|
+
* Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
482
349
|
* @type {string}
|
|
483
|
-
* @memberof
|
|
350
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
484
351
|
*/
|
|
485
|
-
readonly
|
|
352
|
+
readonly correlationId?: string;
|
|
486
353
|
}
|
|
487
354
|
/**
|
|
488
|
-
* Request parameters for
|
|
355
|
+
* Request parameters for listActionExecutions operation in ActionsApi.
|
|
489
356
|
* @export
|
|
490
|
-
* @interface
|
|
357
|
+
* @interface ActionsApiListActionExecutionsRequest
|
|
491
358
|
*/
|
|
492
|
-
export interface
|
|
493
|
-
/**
|
|
494
|
-
* Action code
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof ActionsApiListActionVersions
|
|
497
|
-
*/
|
|
498
|
-
readonly code: string;
|
|
359
|
+
export interface ActionsApiListActionExecutionsRequest {
|
|
499
360
|
/**
|
|
500
361
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
501
362
|
* @type {string}
|
|
502
|
-
* @memberof
|
|
363
|
+
* @memberof ActionsApiListActionExecutions
|
|
503
364
|
*/
|
|
504
365
|
readonly authorization?: string;
|
|
505
366
|
/**
|
|
506
367
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
507
368
|
* @type {number}
|
|
508
|
-
* @memberof
|
|
369
|
+
* @memberof ActionsApiListActionExecutions
|
|
509
370
|
*/
|
|
510
371
|
readonly pageSize?: number;
|
|
511
372
|
/**
|
|
512
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.
|
|
513
374
|
* @type {string}
|
|
514
|
-
* @memberof
|
|
375
|
+
* @memberof ActionsApiListActionExecutions
|
|
515
376
|
*/
|
|
516
377
|
readonly pageToken?: string;
|
|
517
378
|
/**
|
|
518
|
-
* 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>
|
|
519
380
|
* @type {string}
|
|
520
|
-
* @memberof
|
|
381
|
+
* @memberof ActionsApiListActionExecutions
|
|
521
382
|
*/
|
|
522
383
|
readonly filter?: string;
|
|
523
384
|
/**
|
|
524
385
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
525
386
|
* @type {string}
|
|
526
|
-
* @memberof
|
|
387
|
+
* @memberof ActionsApiListActionExecutions
|
|
527
388
|
*/
|
|
528
389
|
readonly search?: string;
|
|
529
390
|
/**
|
|
530
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
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>
|
|
531
392
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
393
|
+
* @memberof ActionsApiListActionExecutions
|
|
533
394
|
*/
|
|
534
395
|
readonly order?: string;
|
|
535
396
|
/**
|
|
536
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
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/>
|
|
537
398
|
* @type {string}
|
|
538
|
-
* @memberof
|
|
399
|
+
* @memberof ActionsApiListActionExecutions
|
|
539
400
|
*/
|
|
540
401
|
readonly expand?: string;
|
|
541
402
|
/**
|
|
542
|
-
* 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>
|
|
543
404
|
* @type {string}
|
|
544
|
-
* @memberof
|
|
405
|
+
* @memberof ActionsApiListActionExecutions
|
|
545
406
|
*/
|
|
546
407
|
readonly filters?: string;
|
|
547
408
|
}
|
|
@@ -570,7 +431,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
570
431
|
*/
|
|
571
432
|
readonly pageToken?: string;
|
|
572
433
|
/**
|
|
573
|
-
* 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>
|
|
574
435
|
* @type {string}
|
|
575
436
|
* @memberof ActionsApiListActions
|
|
576
437
|
*/
|
|
@@ -582,79 +443,24 @@ export interface ActionsApiListActionsRequest {
|
|
|
582
443
|
*/
|
|
583
444
|
readonly search?: string;
|
|
584
445
|
/**
|
|
585
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code,
|
|
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>
|
|
586
447
|
* @type {string}
|
|
587
448
|
* @memberof ActionsApiListActions
|
|
588
449
|
*/
|
|
589
450
|
readonly order?: string;
|
|
590
451
|
/**
|
|
591
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
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/>
|
|
592
453
|
* @type {string}
|
|
593
454
|
* @memberof ActionsApiListActions
|
|
594
455
|
*/
|
|
595
456
|
readonly expand?: string;
|
|
596
457
|
/**
|
|
597
|
-
* 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>
|
|
598
459
|
* @type {string}
|
|
599
460
|
* @memberof ActionsApiListActions
|
|
600
461
|
*/
|
|
601
462
|
readonly filters?: string;
|
|
602
463
|
}
|
|
603
|
-
/**
|
|
604
|
-
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
605
|
-
* @export
|
|
606
|
-
* @interface ActionsApiListAllActionVersionsRequest
|
|
607
|
-
*/
|
|
608
|
-
export interface ActionsApiListAllActionVersionsRequest {
|
|
609
|
-
/**
|
|
610
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
611
|
-
* @type {string}
|
|
612
|
-
* @memberof ActionsApiListAllActionVersions
|
|
613
|
-
*/
|
|
614
|
-
readonly authorization?: string;
|
|
615
|
-
/**
|
|
616
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
617
|
-
* @type {number}
|
|
618
|
-
* @memberof ActionsApiListAllActionVersions
|
|
619
|
-
*/
|
|
620
|
-
readonly pageSize?: number;
|
|
621
|
-
/**
|
|
622
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
623
|
-
* @type {string}
|
|
624
|
-
* @memberof ActionsApiListAllActionVersions
|
|
625
|
-
*/
|
|
626
|
-
readonly pageToken?: string;
|
|
627
|
-
/**
|
|
628
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
629
|
-
* @type {string}
|
|
630
|
-
* @memberof ActionsApiListAllActionVersions
|
|
631
|
-
*/
|
|
632
|
-
readonly filter?: string;
|
|
633
|
-
/**
|
|
634
|
-
* To search the list by any field, pass search=xxx to fetch the result.
|
|
635
|
-
* @type {string}
|
|
636
|
-
* @memberof ActionsApiListAllActionVersions
|
|
637
|
-
*/
|
|
638
|
-
readonly search?: string;
|
|
639
|
-
/**
|
|
640
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
641
|
-
* @type {string}
|
|
642
|
-
* @memberof ActionsApiListAllActionVersions
|
|
643
|
-
*/
|
|
644
|
-
readonly order?: string;
|
|
645
|
-
/**
|
|
646
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: inputValidationSchema<i>
|
|
647
|
-
* @type {string}
|
|
648
|
-
* @memberof ActionsApiListAllActionVersions
|
|
649
|
-
*/
|
|
650
|
-
readonly expand?: string;
|
|
651
|
-
/**
|
|
652
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
653
|
-
* @type {string}
|
|
654
|
-
* @memberof ActionsApiListAllActionVersions
|
|
655
|
-
*/
|
|
656
|
-
readonly filters?: string;
|
|
657
|
-
}
|
|
658
464
|
/**
|
|
659
465
|
* Request parameters for updateAction operation in ActionsApi.
|
|
660
466
|
* @export
|
|
@@ -680,31 +486,6 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
680
486
|
*/
|
|
681
487
|
readonly authorization?: string;
|
|
682
488
|
}
|
|
683
|
-
/**
|
|
684
|
-
* Request parameters for updateAction_1 operation in ActionsApi.
|
|
685
|
-
* @export
|
|
686
|
-
* @interface ActionsApiUpdateAction0Request
|
|
687
|
-
*/
|
|
688
|
-
export interface ActionsApiUpdateAction0Request {
|
|
689
|
-
/**
|
|
690
|
-
* Action code
|
|
691
|
-
* @type {string}
|
|
692
|
-
* @memberof ActionsApiUpdateAction0
|
|
693
|
-
*/
|
|
694
|
-
readonly code: string;
|
|
695
|
-
/**
|
|
696
|
-
*
|
|
697
|
-
* @type {UpdateActionRequestDto}
|
|
698
|
-
* @memberof ActionsApiUpdateAction0
|
|
699
|
-
*/
|
|
700
|
-
readonly updateActionRequestDto: UpdateActionRequestDto;
|
|
701
|
-
/**
|
|
702
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
703
|
-
* @type {string}
|
|
704
|
-
* @memberof ActionsApiUpdateAction0
|
|
705
|
-
*/
|
|
706
|
-
readonly authorization?: string;
|
|
707
|
-
}
|
|
708
489
|
/**
|
|
709
490
|
* ActionsApi - object-oriented interface
|
|
710
491
|
* @export
|
|
@@ -713,7 +494,7 @@ export interface ActionsApiUpdateAction0Request {
|
|
|
713
494
|
*/
|
|
714
495
|
export declare class ActionsApi extends BaseAPI {
|
|
715
496
|
/**
|
|
716
|
-
* Creates a new action configuration
|
|
497
|
+
* Creates a new action configuration
|
|
717
498
|
* @summary Create the action
|
|
718
499
|
* @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
|
|
719
500
|
* @param {*} [options] Override http request option.
|
|
@@ -722,7 +503,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
722
503
|
*/
|
|
723
504
|
createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
|
|
724
505
|
/**
|
|
725
|
-
* Deletes an action configuration by its code
|
|
506
|
+
* Deletes an action configuration by its code
|
|
726
507
|
* @summary Delete the action
|
|
727
508
|
* @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
|
|
728
509
|
* @param {*} [options] Override http request option.
|
|
@@ -731,16 +512,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
731
512
|
*/
|
|
732
513
|
deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
733
514
|
/**
|
|
734
|
-
*
|
|
735
|
-
* @summary Delete the action version
|
|
736
|
-
* @param {ActionsApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
737
|
-
* @param {*} [options] Override http request option.
|
|
738
|
-
* @throws {RequiredError}
|
|
739
|
-
* @memberof ActionsApi
|
|
740
|
-
*/
|
|
741
|
-
deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
742
|
-
/**
|
|
743
|
-
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
515
|
+
* Retrieves an action configuration by its code
|
|
744
516
|
* @summary Retrieve the action
|
|
745
517
|
* @param {ActionsApiGetActionRequest} requestParameters Request parameters.
|
|
746
518
|
* @param {*} [options] Override http request option.
|
|
@@ -749,25 +521,25 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
749
521
|
*/
|
|
750
522
|
getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
|
|
751
523
|
/**
|
|
752
|
-
*
|
|
753
|
-
* @summary Retrieve the
|
|
754
|
-
* @param {
|
|
524
|
+
* Retrieves the latest action execution status by executionCode or correlationId
|
|
525
|
+
* @summary Retrieve the actionExecution
|
|
526
|
+
* @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
|
|
755
527
|
* @param {*} [options] Override http request option.
|
|
756
528
|
* @throws {RequiredError}
|
|
757
529
|
* @memberof ActionsApi
|
|
758
530
|
*/
|
|
759
|
-
|
|
531
|
+
getActionExecutionStatus(requestParameters?: ActionsApiGetActionExecutionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionExecutionStatusResponseClass, any, {}>>;
|
|
760
532
|
/**
|
|
761
|
-
* Lists
|
|
762
|
-
* @summary List
|
|
763
|
-
* @param {
|
|
533
|
+
* Lists action executions (latest status per execution only) with optional filters
|
|
534
|
+
* @summary List actionExecutions
|
|
535
|
+
* @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
|
|
764
536
|
* @param {*} [options] Override http request option.
|
|
765
537
|
* @throws {RequiredError}
|
|
766
538
|
* @memberof ActionsApi
|
|
767
539
|
*/
|
|
768
|
-
|
|
540
|
+
listActionExecutions(requestParameters?: ActionsApiListActionExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionExecutionsResponseClass, any, {}>>;
|
|
769
541
|
/**
|
|
770
|
-
* Lists all action configurations with optional filters
|
|
542
|
+
* Lists all action configurations with optional filters
|
|
771
543
|
* @summary List actions
|
|
772
544
|
* @param {ActionsApiListActionsRequest} requestParameters Request parameters.
|
|
773
545
|
* @param {*} [options] Override http request option.
|
|
@@ -776,16 +548,7 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
776
548
|
*/
|
|
777
549
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
778
550
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @summary List action versions
|
|
781
|
-
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
782
|
-
* @param {*} [options] Override http request option.
|
|
783
|
-
* @throws {RequiredError}
|
|
784
|
-
* @memberof ActionsApi
|
|
785
|
-
*/
|
|
786
|
-
listAllActionVersions(requestParameters?: ActionsApiListAllActionVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionVersionsResponseClass, any, {}>>;
|
|
787
|
-
/**
|
|
788
|
-
* 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)
|
|
789
552
|
* @summary Update the action
|
|
790
553
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
791
554
|
* @param {*} [options] Override http request option.
|
|
@@ -793,13 +556,4 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
793
556
|
* @memberof ActionsApi
|
|
794
557
|
*/
|
|
795
558
|
updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
796
|
-
/**
|
|
797
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
798
|
-
* @summary Update the action
|
|
799
|
-
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
800
|
-
* @param {*} [options] Override http request option.
|
|
801
|
-
* @throws {RequiredError}
|
|
802
|
-
* @memberof ActionsApi
|
|
803
|
-
*/
|
|
804
|
-
updateAction_1(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
|
|
805
559
|
}
|