@emilgroup/action-sdk 1.1.1-beta.27 → 1.1.1-beta.7
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 -6
- package/README.md +2 -2
- package/api/actions-api.ts +397 -219
- package/api/executions-api.ts +12 -119
- package/dist/api/actions-api.d.ts +270 -178
- package/dist/api/actions-api.js +328 -153
- package/dist/api/executions-api.d.ts +12 -69
- package/dist/api/executions-api.js +9 -102
- 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/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
package/api/actions-api.ts
CHANGED
|
@@ -25,11 +25,11 @@ import { CreateActionRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateActionResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import {
|
|
28
|
+
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
30
|
-
import {
|
|
30
|
+
import { GetActionResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
32
|
-
import {
|
|
32
|
+
import { ListActionExecutionsResponseClass } from '../models';
|
|
33
33
|
// @ts-ignore
|
|
34
34
|
import { ListActionsResponseClass } from '../models';
|
|
35
35
|
// @ts-ignore
|
|
@@ -77,6 +77,53 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
77
77
|
|
|
78
78
|
|
|
79
79
|
|
|
80
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
|
+
|
|
82
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
83
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
85
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createActionRequestDto, localVarRequestOptions, configuration)
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
url: toPathString(localVarUrlObj),
|
|
89
|
+
options: localVarRequestOptions,
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
/**
|
|
93
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
94
|
+
* @summary Create the action
|
|
95
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
96
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
createAction_1: async (createActionRequestDto: CreateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
|
+
// verify required parameter 'createActionRequestDto' is not null or undefined
|
|
102
|
+
assertParamExists('createAction_1', 'createActionRequestDto', createActionRequestDto)
|
|
103
|
+
const localVarPath = `/actionservice/v1/actions`;
|
|
104
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
105
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106
|
+
let baseOptions;
|
|
107
|
+
let baseAccessToken;
|
|
108
|
+
if (configuration) {
|
|
109
|
+
baseOptions = configuration.baseOptions;
|
|
110
|
+
baseAccessToken = configuration.accessToken;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
114
|
+
const localVarHeaderParameter = {} as any;
|
|
115
|
+
const localVarQueryParameter = {} as any;
|
|
116
|
+
|
|
117
|
+
// authentication bearer required
|
|
118
|
+
// http bearer authentication required
|
|
119
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
120
|
+
|
|
121
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
122
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
80
127
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
128
|
|
|
82
129
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -135,18 +182,18 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
135
182
|
};
|
|
136
183
|
},
|
|
137
184
|
/**
|
|
138
|
-
* Deletes
|
|
139
|
-
* @summary Delete the action
|
|
140
|
-
* @param {string}
|
|
185
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
186
|
+
* @summary Delete the action
|
|
187
|
+
* @param {string} code Action code
|
|
141
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
189
|
* @param {*} [options] Override http request option.
|
|
143
190
|
* @throws {RequiredError}
|
|
144
191
|
*/
|
|
145
|
-
|
|
146
|
-
// verify required parameter '
|
|
147
|
-
assertParamExists('
|
|
148
|
-
const localVarPath = `/actionservice/v1/actions/
|
|
149
|
-
.replace(`{${"
|
|
192
|
+
deleteAction_2: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
193
|
+
// verify required parameter 'code' is not null or undefined
|
|
194
|
+
assertParamExists('deleteAction_2', 'code', code)
|
|
195
|
+
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
196
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
150
197
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151
198
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152
199
|
let baseOptions;
|
|
@@ -184,11 +231,10 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
184
231
|
* @summary Retrieve the action
|
|
185
232
|
* @param {string} code Action code
|
|
186
233
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
188
234
|
* @param {*} [options] Override http request option.
|
|
189
235
|
* @throws {RequiredError}
|
|
190
236
|
*/
|
|
191
|
-
getAction: async (code: string, authorization?: string,
|
|
237
|
+
getAction: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
192
238
|
// verify required parameter 'code' is not null or undefined
|
|
193
239
|
assertParamExists('getAction', 'code', code)
|
|
194
240
|
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
@@ -210,10 +256,6 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
210
256
|
// http bearer authentication required
|
|
211
257
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
212
258
|
|
|
213
|
-
if (expand !== undefined) {
|
|
214
|
-
localVarQueryParameter['expand'] = expand;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
259
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
218
260
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
219
261
|
}
|
|
@@ -230,19 +272,16 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
230
272
|
};
|
|
231
273
|
},
|
|
232
274
|
/**
|
|
233
|
-
*
|
|
234
|
-
* @summary Retrieve the
|
|
235
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
275
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
276
|
+
* @summary Retrieve the actionExecution
|
|
236
277
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
|
-
* @param {string} [
|
|
278
|
+
* @param {string} [executionCode] Action execution code
|
|
279
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
238
280
|
* @param {*} [options] Override http request option.
|
|
239
281
|
* @throws {RequiredError}
|
|
240
282
|
*/
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
assertParamExists('getActionVersion', 'versionCode', versionCode)
|
|
244
|
-
const localVarPath = `/actionservice/v1/actions/versions/{versionCode}`
|
|
245
|
-
.replace(`{${"versionCode"}}`, encodeURIComponent(String(versionCode)));
|
|
283
|
+
getActionExecutionStatus: async (authorization?: string, executionCode?: string, correlationId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
284
|
+
const localVarPath = `/actionservice/v1/actions/executions/status`;
|
|
246
285
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
247
286
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
248
287
|
let baseOptions;
|
|
@@ -260,8 +299,12 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
260
299
|
// http bearer authentication required
|
|
261
300
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
262
301
|
|
|
263
|
-
if (
|
|
264
|
-
localVarQueryParameter['
|
|
302
|
+
if (executionCode !== undefined) {
|
|
303
|
+
localVarQueryParameter['executionCode'] = executionCode;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
if (correlationId !== undefined) {
|
|
307
|
+
localVarQueryParameter['correlationId'] = correlationId;
|
|
265
308
|
}
|
|
266
309
|
|
|
267
310
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
@@ -280,25 +323,66 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
280
323
|
};
|
|
281
324
|
},
|
|
282
325
|
/**
|
|
283
|
-
*
|
|
284
|
-
* @summary
|
|
326
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
327
|
+
* @summary Retrieve the action
|
|
285
328
|
* @param {string} code Action code
|
|
286
329
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
*/
|
|
333
|
+
getAction_3: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
334
|
+
// verify required parameter 'code' is not null or undefined
|
|
335
|
+
assertParamExists('getAction_3', 'code', code)
|
|
336
|
+
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
337
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
338
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
339
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
340
|
+
let baseOptions;
|
|
341
|
+
let baseAccessToken;
|
|
342
|
+
if (configuration) {
|
|
343
|
+
baseOptions = configuration.baseOptions;
|
|
344
|
+
baseAccessToken = configuration.accessToken;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
348
|
+
const localVarHeaderParameter = {} as any;
|
|
349
|
+
const localVarQueryParameter = {} as any;
|
|
350
|
+
|
|
351
|
+
// authentication bearer required
|
|
352
|
+
// http bearer authentication required
|
|
353
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
354
|
+
|
|
355
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
356
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
362
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
363
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
364
|
+
|
|
365
|
+
return {
|
|
366
|
+
url: toPathString(localVarUrlObj),
|
|
367
|
+
options: localVarRequestOptions,
|
|
368
|
+
};
|
|
369
|
+
},
|
|
370
|
+
/**
|
|
371
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
372
|
+
* @summary List actionExecutions
|
|
373
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
287
374
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
288
375
|
* @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.
|
|
289
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
376
|
+
* @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>
|
|
290
377
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
291
|
-
* @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,
|
|
292
|
-
* @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/>
|
|
293
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
378
|
+
* @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>
|
|
379
|
+
* @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/>
|
|
380
|
+
* @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>
|
|
294
381
|
* @param {*} [options] Override http request option.
|
|
295
382
|
* @throws {RequiredError}
|
|
296
383
|
*/
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
assertParamExists('listActionVersions', 'code', code)
|
|
300
|
-
const localVarPath = `/actionservice/v1/actions/{code}/versions`
|
|
301
|
-
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
384
|
+
listActionExecutions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
385
|
+
const localVarPath = `/actionservice/v1/actions/executions`;
|
|
302
386
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
303
387
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
304
388
|
let baseOptions;
|
|
@@ -365,11 +449,11 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
365
449
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
366
450
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
367
451
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
368
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
452
|
+
* @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>
|
|
369
453
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
370
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code,
|
|
371
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
372
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
454
|
+
* @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>
|
|
455
|
+
* @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/>
|
|
456
|
+
* @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>
|
|
373
457
|
* @param {*} [options] Override http request option.
|
|
374
458
|
* @throws {RequiredError}
|
|
375
459
|
*/
|
|
@@ -436,21 +520,21 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
436
520
|
};
|
|
437
521
|
},
|
|
438
522
|
/**
|
|
439
|
-
* Lists all action
|
|
440
|
-
* @summary List
|
|
523
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
524
|
+
* @summary List actions
|
|
441
525
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
526
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
527
|
* @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.
|
|
444
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
528
|
+
* @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>
|
|
445
529
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
446
|
-
* @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,
|
|
447
|
-
* @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/>
|
|
448
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
530
|
+
* @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>
|
|
531
|
+
* @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/>
|
|
532
|
+
* @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>
|
|
449
533
|
* @param {*} [options] Override http request option.
|
|
450
534
|
* @throws {RequiredError}
|
|
451
535
|
*/
|
|
452
|
-
|
|
453
|
-
const localVarPath = `/actionservice/v1/actions
|
|
536
|
+
listActions_4: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
537
|
+
const localVarPath = `/actionservice/v1/actions`;
|
|
454
538
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
455
539
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
456
540
|
let baseOptions;
|
|
@@ -512,7 +596,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
512
596
|
};
|
|
513
597
|
},
|
|
514
598
|
/**
|
|
515
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
599
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
516
600
|
* @summary Update the action
|
|
517
601
|
* @param {string} code Action code
|
|
518
602
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -563,7 +647,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
563
647
|
};
|
|
564
648
|
},
|
|
565
649
|
/**
|
|
566
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
650
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
567
651
|
* @summary Update the action
|
|
568
652
|
* @param {string} code Action code
|
|
569
653
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -571,11 +655,11 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
571
655
|
* @param {*} [options] Override http request option.
|
|
572
656
|
* @throws {RequiredError}
|
|
573
657
|
*/
|
|
574
|
-
|
|
658
|
+
updateAction_5: async (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
575
659
|
// verify required parameter 'code' is not null or undefined
|
|
576
|
-
assertParamExists('
|
|
660
|
+
assertParamExists('updateAction_5', 'code', code)
|
|
577
661
|
// verify required parameter 'updateActionRequestDto' is not null or undefined
|
|
578
|
-
assertParamExists('
|
|
662
|
+
assertParamExists('updateAction_5', 'updateActionRequestDto', updateActionRequestDto)
|
|
579
663
|
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
580
664
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
581
665
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -635,6 +719,18 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
635
719
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createAction(createActionRequestDto, authorization, options);
|
|
636
720
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
637
721
|
},
|
|
722
|
+
/**
|
|
723
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
724
|
+
* @summary Create the action
|
|
725
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
726
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
727
|
+
* @param {*} [options] Override http request option.
|
|
728
|
+
* @throws {RequiredError}
|
|
729
|
+
*/
|
|
730
|
+
async createAction_1(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>> {
|
|
731
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createAction_1(createActionRequestDto, authorization, options);
|
|
732
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
733
|
+
},
|
|
638
734
|
/**
|
|
639
735
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
640
736
|
* @summary Delete the action
|
|
@@ -648,15 +744,15 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
648
744
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
649
745
|
},
|
|
650
746
|
/**
|
|
651
|
-
* Deletes
|
|
652
|
-
* @summary Delete the action
|
|
653
|
-
* @param {string}
|
|
747
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
748
|
+
* @summary Delete the action
|
|
749
|
+
* @param {string} code Action code
|
|
654
750
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
655
751
|
* @param {*} [options] Override http request option.
|
|
656
752
|
* @throws {RequiredError}
|
|
657
753
|
*/
|
|
658
|
-
async
|
|
659
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
754
|
+
async deleteAction_2(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
755
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAction_2(code, authorization, options);
|
|
660
756
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
661
757
|
},
|
|
662
758
|
/**
|
|
@@ -664,44 +760,54 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
664
760
|
* @summary Retrieve the action
|
|
665
761
|
* @param {string} code Action code
|
|
666
762
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
667
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
668
763
|
* @param {*} [options] Override http request option.
|
|
669
764
|
* @throws {RequiredError}
|
|
670
765
|
*/
|
|
671
|
-
async getAction(code: string, authorization?: string,
|
|
672
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization,
|
|
766
|
+
async getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
|
|
767
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
|
|
673
768
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
674
769
|
},
|
|
675
770
|
/**
|
|
676
|
-
*
|
|
677
|
-
* @summary Retrieve the
|
|
678
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
771
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
772
|
+
* @summary Retrieve the actionExecution
|
|
679
773
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
680
|
-
* @param {string} [
|
|
774
|
+
* @param {string} [executionCode] Action execution code
|
|
775
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
681
776
|
* @param {*} [options] Override http request option.
|
|
682
777
|
* @throws {RequiredError}
|
|
683
778
|
*/
|
|
684
|
-
async
|
|
685
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
779
|
+
async getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>> {
|
|
780
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getActionExecutionStatus(authorization, executionCode, correlationId, options);
|
|
686
781
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
687
782
|
},
|
|
688
783
|
/**
|
|
689
|
-
*
|
|
690
|
-
* @summary
|
|
784
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
785
|
+
* @summary Retrieve the action
|
|
691
786
|
* @param {string} code Action code
|
|
692
787
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
788
|
+
* @param {*} [options] Override http request option.
|
|
789
|
+
* @throws {RequiredError}
|
|
790
|
+
*/
|
|
791
|
+
async getAction_3(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
|
|
792
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction_3(code, authorization, options);
|
|
793
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
794
|
+
},
|
|
795
|
+
/**
|
|
796
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
797
|
+
* @summary List actionExecutions
|
|
798
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
693
799
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
694
800
|
* @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.
|
|
695
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
801
|
+
* @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>
|
|
696
802
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
697
|
-
* @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,
|
|
698
|
-
* @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/>
|
|
699
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
803
|
+
* @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>
|
|
804
|
+
* @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/>
|
|
805
|
+
* @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>
|
|
700
806
|
* @param {*} [options] Override http request option.
|
|
701
807
|
* @throws {RequiredError}
|
|
702
808
|
*/
|
|
703
|
-
async
|
|
704
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
809
|
+
async 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>> {
|
|
810
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
705
811
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
706
812
|
},
|
|
707
813
|
/**
|
|
@@ -710,11 +816,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
710
816
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
711
817
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
712
818
|
* @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.
|
|
713
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
819
|
+
* @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>
|
|
714
820
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
715
|
-
* @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,
|
|
716
|
-
* @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/>
|
|
717
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
821
|
+
* @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>
|
|
822
|
+
* @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/>
|
|
823
|
+
* @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>
|
|
718
824
|
* @param {*} [options] Override http request option.
|
|
719
825
|
* @throws {RequiredError}
|
|
720
826
|
*/
|
|
@@ -723,25 +829,25 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
723
829
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
724
830
|
},
|
|
725
831
|
/**
|
|
726
|
-
* Lists all action
|
|
727
|
-
* @summary List
|
|
832
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
833
|
+
* @summary List actions
|
|
728
834
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
729
835
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
730
836
|
* @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.
|
|
731
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
837
|
+
* @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>
|
|
732
838
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
733
|
-
* @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,
|
|
734
|
-
* @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/>
|
|
735
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
839
|
+
* @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>
|
|
840
|
+
* @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/>
|
|
841
|
+
* @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>
|
|
736
842
|
* @param {*} [options] Override http request option.
|
|
737
843
|
* @throws {RequiredError}
|
|
738
844
|
*/
|
|
739
|
-
async
|
|
740
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
845
|
+
async listActions_4(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>> {
|
|
846
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listActions_4(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
741
847
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
742
848
|
},
|
|
743
849
|
/**
|
|
744
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
850
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
745
851
|
* @summary Update the action
|
|
746
852
|
* @param {string} code Action code
|
|
747
853
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -754,7 +860,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
754
860
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
755
861
|
},
|
|
756
862
|
/**
|
|
757
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
863
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
758
864
|
* @summary Update the action
|
|
759
865
|
* @param {string} code Action code
|
|
760
866
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -762,8 +868,8 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
762
868
|
* @param {*} [options] Override http request option.
|
|
763
869
|
* @throws {RequiredError}
|
|
764
870
|
*/
|
|
765
|
-
async
|
|
766
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
871
|
+
async updateAction_5(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>> {
|
|
872
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAction_5(code, updateActionRequestDto, authorization, options);
|
|
767
873
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
768
874
|
},
|
|
769
875
|
}
|
|
@@ -787,6 +893,17 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
787
893
|
createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass> {
|
|
788
894
|
return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
789
895
|
},
|
|
896
|
+
/**
|
|
897
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
898
|
+
* @summary Create the action
|
|
899
|
+
* @param {CreateActionRequestDto} createActionRequestDto
|
|
900
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
createAction_1(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass> {
|
|
905
|
+
return localVarFp.createAction_1(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
906
|
+
},
|
|
790
907
|
/**
|
|
791
908
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
792
909
|
* @summary Delete the action
|
|
@@ -799,57 +916,66 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
799
916
|
return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
|
|
800
917
|
},
|
|
801
918
|
/**
|
|
802
|
-
* Deletes
|
|
803
|
-
* @summary Delete the action
|
|
804
|
-
* @param {string}
|
|
919
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
920
|
+
* @summary Delete the action
|
|
921
|
+
* @param {string} code Action code
|
|
805
922
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
806
923
|
* @param {*} [options] Override http request option.
|
|
807
924
|
* @throws {RequiredError}
|
|
808
925
|
*/
|
|
809
|
-
|
|
810
|
-
return localVarFp.
|
|
926
|
+
deleteAction_2(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
927
|
+
return localVarFp.deleteAction_2(code, authorization, options).then((request) => request(axios, basePath));
|
|
811
928
|
},
|
|
812
929
|
/**
|
|
813
930
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
814
931
|
* @summary Retrieve the action
|
|
815
932
|
* @param {string} code Action code
|
|
816
933
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
817
|
-
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
818
934
|
* @param {*} [options] Override http request option.
|
|
819
935
|
* @throws {RequiredError}
|
|
820
936
|
*/
|
|
821
|
-
getAction(code: string, authorization?: string,
|
|
822
|
-
return localVarFp.getAction(code, authorization,
|
|
937
|
+
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
|
|
938
|
+
return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
|
|
823
939
|
},
|
|
824
940
|
/**
|
|
825
|
-
*
|
|
826
|
-
* @summary Retrieve the
|
|
827
|
-
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
941
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
942
|
+
* @summary Retrieve the actionExecution
|
|
828
943
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
829
|
-
* @param {string} [
|
|
944
|
+
* @param {string} [executionCode] Action execution code
|
|
945
|
+
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
830
946
|
* @param {*} [options] Override http request option.
|
|
831
947
|
* @throws {RequiredError}
|
|
832
948
|
*/
|
|
833
|
-
|
|
834
|
-
return localVarFp.
|
|
949
|
+
getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass> {
|
|
950
|
+
return localVarFp.getActionExecutionStatus(authorization, executionCode, correlationId, options).then((request) => request(axios, basePath));
|
|
835
951
|
},
|
|
836
952
|
/**
|
|
837
|
-
*
|
|
838
|
-
* @summary
|
|
953
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
954
|
+
* @summary Retrieve the action
|
|
839
955
|
* @param {string} code Action code
|
|
840
956
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
getAction_3(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
|
|
961
|
+
return localVarFp.getAction_3(code, authorization, options).then((request) => request(axios, basePath));
|
|
962
|
+
},
|
|
963
|
+
/**
|
|
964
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
965
|
+
* @summary List actionExecutions
|
|
966
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
841
967
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
842
968
|
* @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.
|
|
843
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
969
|
+
* @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>
|
|
844
970
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
845
|
-
* @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,
|
|
846
|
-
* @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/>
|
|
847
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
971
|
+
* @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>
|
|
972
|
+
* @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/>
|
|
973
|
+
* @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>
|
|
848
974
|
* @param {*} [options] Override http request option.
|
|
849
975
|
* @throws {RequiredError}
|
|
850
976
|
*/
|
|
851
|
-
|
|
852
|
-
return localVarFp.
|
|
977
|
+
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass> {
|
|
978
|
+
return localVarFp.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
853
979
|
},
|
|
854
980
|
/**
|
|
855
981
|
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
@@ -857,11 +983,11 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
857
983
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
858
984
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
859
985
|
* @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.
|
|
860
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
986
|
+
* @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>
|
|
861
987
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
862
|
-
* @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,
|
|
863
|
-
* @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/>
|
|
864
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
988
|
+
* @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>
|
|
989
|
+
* @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/>
|
|
990
|
+
* @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>
|
|
865
991
|
* @param {*} [options] Override http request option.
|
|
866
992
|
* @throws {RequiredError}
|
|
867
993
|
*/
|
|
@@ -869,24 +995,24 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
869
995
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
870
996
|
},
|
|
871
997
|
/**
|
|
872
|
-
* Lists all action
|
|
873
|
-
* @summary List
|
|
998
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
999
|
+
* @summary List actions
|
|
874
1000
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
875
1001
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
876
1002
|
* @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.
|
|
877
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1003
|
+
* @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>
|
|
878
1004
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
879
|
-
* @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,
|
|
880
|
-
* @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/>
|
|
881
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1005
|
+
* @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>
|
|
1006
|
+
* @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/>
|
|
1007
|
+
* @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>
|
|
882
1008
|
* @param {*} [options] Override http request option.
|
|
883
1009
|
* @throws {RequiredError}
|
|
884
1010
|
*/
|
|
885
|
-
|
|
886
|
-
return localVarFp.
|
|
1011
|
+
listActions_4(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
|
|
1012
|
+
return localVarFp.listActions_4(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
887
1013
|
},
|
|
888
1014
|
/**
|
|
889
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1015
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
890
1016
|
* @summary Update the action
|
|
891
1017
|
* @param {string} code Action code
|
|
892
1018
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -898,7 +1024,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
898
1024
|
return localVarFp.updateAction(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
899
1025
|
},
|
|
900
1026
|
/**
|
|
901
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1027
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
902
1028
|
* @summary Update the action
|
|
903
1029
|
* @param {string} code Action code
|
|
904
1030
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -906,8 +1032,8 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
906
1032
|
* @param {*} [options] Override http request option.
|
|
907
1033
|
* @throws {RequiredError}
|
|
908
1034
|
*/
|
|
909
|
-
|
|
910
|
-
return localVarFp.
|
|
1035
|
+
updateAction_5(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass> {
|
|
1036
|
+
return localVarFp.updateAction_5(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
911
1037
|
},
|
|
912
1038
|
};
|
|
913
1039
|
};
|
|
@@ -933,6 +1059,27 @@ export interface ActionsApiCreateActionRequest {
|
|
|
933
1059
|
readonly authorization?: string
|
|
934
1060
|
}
|
|
935
1061
|
|
|
1062
|
+
/**
|
|
1063
|
+
* Request parameters for createAction_1 operation in ActionsApi.
|
|
1064
|
+
* @export
|
|
1065
|
+
* @interface ActionsApiCreateAction0Request
|
|
1066
|
+
*/
|
|
1067
|
+
export interface ActionsApiCreateAction0Request {
|
|
1068
|
+
/**
|
|
1069
|
+
*
|
|
1070
|
+
* @type {CreateActionRequestDto}
|
|
1071
|
+
* @memberof ActionsApiCreateAction0
|
|
1072
|
+
*/
|
|
1073
|
+
readonly createActionRequestDto: CreateActionRequestDto
|
|
1074
|
+
|
|
1075
|
+
/**
|
|
1076
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1077
|
+
* @type {string}
|
|
1078
|
+
* @memberof ActionsApiCreateAction0
|
|
1079
|
+
*/
|
|
1080
|
+
readonly authorization?: string
|
|
1081
|
+
}
|
|
1082
|
+
|
|
936
1083
|
/**
|
|
937
1084
|
* Request parameters for deleteAction operation in ActionsApi.
|
|
938
1085
|
* @export
|
|
@@ -955,22 +1102,22 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
955
1102
|
}
|
|
956
1103
|
|
|
957
1104
|
/**
|
|
958
|
-
* Request parameters for
|
|
1105
|
+
* Request parameters for deleteAction_2 operation in ActionsApi.
|
|
959
1106
|
* @export
|
|
960
|
-
* @interface
|
|
1107
|
+
* @interface ActionsApiDeleteAction0Request
|
|
961
1108
|
*/
|
|
962
|
-
export interface
|
|
1109
|
+
export interface ActionsApiDeleteAction0Request {
|
|
963
1110
|
/**
|
|
964
|
-
*
|
|
1111
|
+
* Action code
|
|
965
1112
|
* @type {string}
|
|
966
|
-
* @memberof
|
|
1113
|
+
* @memberof ActionsApiDeleteAction0
|
|
967
1114
|
*/
|
|
968
|
-
readonly
|
|
1115
|
+
readonly code: string
|
|
969
1116
|
|
|
970
1117
|
/**
|
|
971
1118
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
972
1119
|
* @type {string}
|
|
973
|
-
* @memberof
|
|
1120
|
+
* @memberof ActionsApiDeleteAction0
|
|
974
1121
|
*/
|
|
975
1122
|
readonly authorization?: string
|
|
976
1123
|
}
|
|
@@ -994,109 +1141,116 @@ export interface ActionsApiGetActionRequest {
|
|
|
994
1141
|
* @memberof ActionsApiGetAction
|
|
995
1142
|
*/
|
|
996
1143
|
readonly authorization?: string
|
|
997
|
-
|
|
998
|
-
/**
|
|
999
|
-
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
1000
|
-
* @type {string}
|
|
1001
|
-
* @memberof ActionsApiGetAction
|
|
1002
|
-
*/
|
|
1003
|
-
readonly expand?: string
|
|
1004
1144
|
}
|
|
1005
1145
|
|
|
1006
1146
|
/**
|
|
1007
|
-
* Request parameters for
|
|
1147
|
+
* Request parameters for getActionExecutionStatus operation in ActionsApi.
|
|
1008
1148
|
* @export
|
|
1009
|
-
* @interface
|
|
1149
|
+
* @interface ActionsApiGetActionExecutionStatusRequest
|
|
1010
1150
|
*/
|
|
1011
|
-
export interface
|
|
1151
|
+
export interface ActionsApiGetActionExecutionStatusRequest {
|
|
1012
1152
|
/**
|
|
1013
|
-
*
|
|
1153
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1014
1154
|
* @type {string}
|
|
1015
|
-
* @memberof
|
|
1155
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
1016
1156
|
*/
|
|
1017
|
-
readonly
|
|
1157
|
+
readonly authorization?: string
|
|
1018
1158
|
|
|
1019
1159
|
/**
|
|
1020
|
-
*
|
|
1160
|
+
* Action execution code
|
|
1021
1161
|
* @type {string}
|
|
1022
|
-
* @memberof
|
|
1162
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
1023
1163
|
*/
|
|
1024
|
-
readonly
|
|
1164
|
+
readonly executionCode?: string
|
|
1025
1165
|
|
|
1026
1166
|
/**
|
|
1027
|
-
*
|
|
1167
|
+
* Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
1028
1168
|
* @type {string}
|
|
1029
|
-
* @memberof
|
|
1169
|
+
* @memberof ActionsApiGetActionExecutionStatus
|
|
1030
1170
|
*/
|
|
1031
|
-
readonly
|
|
1171
|
+
readonly correlationId?: string
|
|
1032
1172
|
}
|
|
1033
1173
|
|
|
1034
1174
|
/**
|
|
1035
|
-
* Request parameters for
|
|
1175
|
+
* Request parameters for getAction_3 operation in ActionsApi.
|
|
1036
1176
|
* @export
|
|
1037
|
-
* @interface
|
|
1177
|
+
* @interface ActionsApiGetAction0Request
|
|
1038
1178
|
*/
|
|
1039
|
-
export interface
|
|
1179
|
+
export interface ActionsApiGetAction0Request {
|
|
1040
1180
|
/**
|
|
1041
1181
|
* Action code
|
|
1042
1182
|
* @type {string}
|
|
1043
|
-
* @memberof
|
|
1183
|
+
* @memberof ActionsApiGetAction0
|
|
1044
1184
|
*/
|
|
1045
1185
|
readonly code: string
|
|
1046
1186
|
|
|
1047
1187
|
/**
|
|
1048
1188
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1049
1189
|
* @type {string}
|
|
1050
|
-
* @memberof
|
|
1190
|
+
* @memberof ActionsApiGetAction0
|
|
1191
|
+
*/
|
|
1192
|
+
readonly authorization?: string
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* Request parameters for listActionExecutions operation in ActionsApi.
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface ActionsApiListActionExecutionsRequest
|
|
1199
|
+
*/
|
|
1200
|
+
export interface ActionsApiListActionExecutionsRequest {
|
|
1201
|
+
/**
|
|
1202
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof ActionsApiListActionExecutions
|
|
1051
1205
|
*/
|
|
1052
1206
|
readonly authorization?: string
|
|
1053
1207
|
|
|
1054
1208
|
/**
|
|
1055
1209
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1056
1210
|
* @type {number}
|
|
1057
|
-
* @memberof
|
|
1211
|
+
* @memberof ActionsApiListActionExecutions
|
|
1058
1212
|
*/
|
|
1059
1213
|
readonly pageSize?: number
|
|
1060
1214
|
|
|
1061
1215
|
/**
|
|
1062
1216
|
* 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.
|
|
1063
1217
|
* @type {string}
|
|
1064
|
-
* @memberof
|
|
1218
|
+
* @memberof ActionsApiListActionExecutions
|
|
1065
1219
|
*/
|
|
1066
1220
|
readonly pageToken?: string
|
|
1067
1221
|
|
|
1068
1222
|
/**
|
|
1069
|
-
* Filter the response by one or multiple fields.
|
|
1223
|
+
* 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>
|
|
1070
1224
|
* @type {string}
|
|
1071
|
-
* @memberof
|
|
1225
|
+
* @memberof ActionsApiListActionExecutions
|
|
1072
1226
|
*/
|
|
1073
1227
|
readonly filter?: string
|
|
1074
1228
|
|
|
1075
1229
|
/**
|
|
1076
1230
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1077
1231
|
* @type {string}
|
|
1078
|
-
* @memberof
|
|
1232
|
+
* @memberof ActionsApiListActionExecutions
|
|
1079
1233
|
*/
|
|
1080
1234
|
readonly search?: string
|
|
1081
1235
|
|
|
1082
1236
|
/**
|
|
1083
|
-
* 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,
|
|
1237
|
+
* 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>
|
|
1084
1238
|
* @type {string}
|
|
1085
|
-
* @memberof
|
|
1239
|
+
* @memberof ActionsApiListActionExecutions
|
|
1086
1240
|
*/
|
|
1087
1241
|
readonly order?: string
|
|
1088
1242
|
|
|
1089
1243
|
/**
|
|
1090
|
-
* 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/>
|
|
1244
|
+
* 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/>
|
|
1091
1245
|
* @type {string}
|
|
1092
|
-
* @memberof
|
|
1246
|
+
* @memberof ActionsApiListActionExecutions
|
|
1093
1247
|
*/
|
|
1094
1248
|
readonly expand?: string
|
|
1095
1249
|
|
|
1096
1250
|
/**
|
|
1097
|
-
* Filters the response by one or multiple fields.
|
|
1251
|
+
* 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>
|
|
1098
1252
|
* @type {string}
|
|
1099
|
-
* @memberof
|
|
1253
|
+
* @memberof ActionsApiListActionExecutions
|
|
1100
1254
|
*/
|
|
1101
1255
|
readonly filters?: string
|
|
1102
1256
|
}
|
|
@@ -1129,7 +1283,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
1129
1283
|
readonly pageToken?: string
|
|
1130
1284
|
|
|
1131
1285
|
/**
|
|
1132
|
-
* Filter the response by one or multiple fields.
|
|
1286
|
+
* 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>
|
|
1133
1287
|
* @type {string}
|
|
1134
1288
|
* @memberof ActionsApiListActions
|
|
1135
1289
|
*/
|
|
@@ -1143,21 +1297,21 @@ export interface ActionsApiListActionsRequest {
|
|
|
1143
1297
|
readonly search?: string
|
|
1144
1298
|
|
|
1145
1299
|
/**
|
|
1146
|
-
* 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,
|
|
1300
|
+
* 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>
|
|
1147
1301
|
* @type {string}
|
|
1148
1302
|
* @memberof ActionsApiListActions
|
|
1149
1303
|
*/
|
|
1150
1304
|
readonly order?: string
|
|
1151
1305
|
|
|
1152
1306
|
/**
|
|
1153
|
-
* 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/>
|
|
1307
|
+
* 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/>
|
|
1154
1308
|
* @type {string}
|
|
1155
1309
|
* @memberof ActionsApiListActions
|
|
1156
1310
|
*/
|
|
1157
1311
|
readonly expand?: string
|
|
1158
1312
|
|
|
1159
1313
|
/**
|
|
1160
|
-
* Filters the response by one or multiple fields.
|
|
1314
|
+
* 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>
|
|
1161
1315
|
* @type {string}
|
|
1162
1316
|
* @memberof ActionsApiListActions
|
|
1163
1317
|
*/
|
|
@@ -1165,64 +1319,64 @@ export interface ActionsApiListActionsRequest {
|
|
|
1165
1319
|
}
|
|
1166
1320
|
|
|
1167
1321
|
/**
|
|
1168
|
-
* Request parameters for
|
|
1322
|
+
* Request parameters for listActions_4 operation in ActionsApi.
|
|
1169
1323
|
* @export
|
|
1170
|
-
* @interface
|
|
1324
|
+
* @interface ActionsApiListActions0Request
|
|
1171
1325
|
*/
|
|
1172
|
-
export interface
|
|
1326
|
+
export interface ActionsApiListActions0Request {
|
|
1173
1327
|
/**
|
|
1174
1328
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1175
1329
|
* @type {string}
|
|
1176
|
-
* @memberof
|
|
1330
|
+
* @memberof ActionsApiListActions0
|
|
1177
1331
|
*/
|
|
1178
1332
|
readonly authorization?: string
|
|
1179
1333
|
|
|
1180
1334
|
/**
|
|
1181
1335
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1182
1336
|
* @type {number}
|
|
1183
|
-
* @memberof
|
|
1337
|
+
* @memberof ActionsApiListActions0
|
|
1184
1338
|
*/
|
|
1185
1339
|
readonly pageSize?: number
|
|
1186
1340
|
|
|
1187
1341
|
/**
|
|
1188
1342
|
* 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.
|
|
1189
1343
|
* @type {string}
|
|
1190
|
-
* @memberof
|
|
1344
|
+
* @memberof ActionsApiListActions0
|
|
1191
1345
|
*/
|
|
1192
1346
|
readonly pageToken?: string
|
|
1193
1347
|
|
|
1194
1348
|
/**
|
|
1195
|
-
* Filter the response by one or multiple fields.
|
|
1349
|
+
* 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>
|
|
1196
1350
|
* @type {string}
|
|
1197
|
-
* @memberof
|
|
1351
|
+
* @memberof ActionsApiListActions0
|
|
1198
1352
|
*/
|
|
1199
1353
|
readonly filter?: string
|
|
1200
1354
|
|
|
1201
1355
|
/**
|
|
1202
1356
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1203
1357
|
* @type {string}
|
|
1204
|
-
* @memberof
|
|
1358
|
+
* @memberof ActionsApiListActions0
|
|
1205
1359
|
*/
|
|
1206
1360
|
readonly search?: string
|
|
1207
1361
|
|
|
1208
1362
|
/**
|
|
1209
|
-
* 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,
|
|
1363
|
+
* 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>
|
|
1210
1364
|
* @type {string}
|
|
1211
|
-
* @memberof
|
|
1365
|
+
* @memberof ActionsApiListActions0
|
|
1212
1366
|
*/
|
|
1213
1367
|
readonly order?: string
|
|
1214
1368
|
|
|
1215
1369
|
/**
|
|
1216
|
-
* 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/>
|
|
1370
|
+
* 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/>
|
|
1217
1371
|
* @type {string}
|
|
1218
|
-
* @memberof
|
|
1372
|
+
* @memberof ActionsApiListActions0
|
|
1219
1373
|
*/
|
|
1220
1374
|
readonly expand?: string
|
|
1221
1375
|
|
|
1222
1376
|
/**
|
|
1223
|
-
* Filters the response by one or multiple fields.
|
|
1377
|
+
* 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>
|
|
1224
1378
|
* @type {string}
|
|
1225
|
-
* @memberof
|
|
1379
|
+
* @memberof ActionsApiListActions0
|
|
1226
1380
|
*/
|
|
1227
1381
|
readonly filters?: string
|
|
1228
1382
|
}
|
|
@@ -1256,7 +1410,7 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
1256
1410
|
}
|
|
1257
1411
|
|
|
1258
1412
|
/**
|
|
1259
|
-
* Request parameters for
|
|
1413
|
+
* Request parameters for updateAction_5 operation in ActionsApi.
|
|
1260
1414
|
* @export
|
|
1261
1415
|
* @interface ActionsApiUpdateAction0Request
|
|
1262
1416
|
*/
|
|
@@ -1302,6 +1456,18 @@ export class ActionsApi extends BaseAPI {
|
|
|
1302
1456
|
return ActionsApiFp(this.configuration).createAction(requestParameters.createActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1303
1457
|
}
|
|
1304
1458
|
|
|
1459
|
+
/**
|
|
1460
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
1461
|
+
* @summary Create the action
|
|
1462
|
+
* @param {ActionsApiCreateAction0Request} requestParameters Request parameters.
|
|
1463
|
+
* @param {*} [options] Override http request option.
|
|
1464
|
+
* @throws {RequiredError}
|
|
1465
|
+
* @memberof ActionsApi
|
|
1466
|
+
*/
|
|
1467
|
+
public createAction_1(requestParameters: ActionsApiCreateAction0Request, options?: AxiosRequestConfig) {
|
|
1468
|
+
return ActionsApiFp(this.configuration).createAction_1(requestParameters.createActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1469
|
+
}
|
|
1470
|
+
|
|
1305
1471
|
/**
|
|
1306
1472
|
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
1307
1473
|
* @summary Delete the action
|
|
@@ -1315,15 +1481,15 @@ export class ActionsApi extends BaseAPI {
|
|
|
1315
1481
|
}
|
|
1316
1482
|
|
|
1317
1483
|
/**
|
|
1318
|
-
* Deletes
|
|
1319
|
-
* @summary Delete the action
|
|
1320
|
-
* @param {
|
|
1484
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
1485
|
+
* @summary Delete the action
|
|
1486
|
+
* @param {ActionsApiDeleteAction0Request} requestParameters Request parameters.
|
|
1321
1487
|
* @param {*} [options] Override http request option.
|
|
1322
1488
|
* @throws {RequiredError}
|
|
1323
1489
|
* @memberof ActionsApi
|
|
1324
1490
|
*/
|
|
1325
|
-
public
|
|
1326
|
-
return ActionsApiFp(this.configuration).
|
|
1491
|
+
public deleteAction_2(requestParameters: ActionsApiDeleteAction0Request, options?: AxiosRequestConfig) {
|
|
1492
|
+
return ActionsApiFp(this.configuration).deleteAction_2(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1327
1493
|
}
|
|
1328
1494
|
|
|
1329
1495
|
/**
|
|
@@ -1335,31 +1501,43 @@ export class ActionsApi extends BaseAPI {
|
|
|
1335
1501
|
* @memberof ActionsApi
|
|
1336
1502
|
*/
|
|
1337
1503
|
public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
|
|
1338
|
-
return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization,
|
|
1504
|
+
return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1339
1505
|
}
|
|
1340
1506
|
|
|
1341
1507
|
/**
|
|
1342
|
-
*
|
|
1343
|
-
* @summary Retrieve the
|
|
1344
|
-
* @param {
|
|
1508
|
+
* Retrieves the latest action execution status by executionCode or correlationId **Required Permissions** \"action-management.actions.view\"
|
|
1509
|
+
* @summary Retrieve the actionExecution
|
|
1510
|
+
* @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
|
|
1345
1511
|
* @param {*} [options] Override http request option.
|
|
1346
1512
|
* @throws {RequiredError}
|
|
1347
1513
|
* @memberof ActionsApi
|
|
1348
1514
|
*/
|
|
1349
|
-
public
|
|
1350
|
-
return ActionsApiFp(this.configuration).
|
|
1515
|
+
public getActionExecutionStatus(requestParameters: ActionsApiGetActionExecutionStatusRequest = {}, options?: AxiosRequestConfig) {
|
|
1516
|
+
return ActionsApiFp(this.configuration).getActionExecutionStatus(requestParameters.authorization, requestParameters.executionCode, requestParameters.correlationId, options).then((request) => request(this.axios, this.basePath));
|
|
1351
1517
|
}
|
|
1352
1518
|
|
|
1353
1519
|
/**
|
|
1354
|
-
*
|
|
1355
|
-
* @summary
|
|
1356
|
-
* @param {
|
|
1520
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
1521
|
+
* @summary Retrieve the action
|
|
1522
|
+
* @param {ActionsApiGetAction0Request} requestParameters Request parameters.
|
|
1357
1523
|
* @param {*} [options] Override http request option.
|
|
1358
1524
|
* @throws {RequiredError}
|
|
1359
1525
|
* @memberof ActionsApi
|
|
1360
1526
|
*/
|
|
1361
|
-
public
|
|
1362
|
-
return ActionsApiFp(this.configuration).
|
|
1527
|
+
public getAction_3(requestParameters: ActionsApiGetAction0Request, options?: AxiosRequestConfig) {
|
|
1528
|
+
return ActionsApiFp(this.configuration).getAction_3(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
/**
|
|
1532
|
+
* Lists action executions (latest status per execution only) with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
1533
|
+
* @summary List actionExecutions
|
|
1534
|
+
* @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
* @memberof ActionsApi
|
|
1538
|
+
*/
|
|
1539
|
+
public listActionExecutions(requestParameters: ActionsApiListActionExecutionsRequest = {}, options?: AxiosRequestConfig) {
|
|
1540
|
+
return ActionsApiFp(this.configuration).listActionExecutions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1363
1541
|
}
|
|
1364
1542
|
|
|
1365
1543
|
/**
|
|
@@ -1375,19 +1553,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
1375
1553
|
}
|
|
1376
1554
|
|
|
1377
1555
|
/**
|
|
1378
|
-
* Lists all action
|
|
1379
|
-
* @summary List
|
|
1380
|
-
* @param {
|
|
1556
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
1557
|
+
* @summary List actions
|
|
1558
|
+
* @param {ActionsApiListActions0Request} requestParameters Request parameters.
|
|
1381
1559
|
* @param {*} [options] Override http request option.
|
|
1382
1560
|
* @throws {RequiredError}
|
|
1383
1561
|
* @memberof ActionsApi
|
|
1384
1562
|
*/
|
|
1385
|
-
public
|
|
1386
|
-
return ActionsApiFp(this.configuration).
|
|
1563
|
+
public listActions_4(requestParameters: ActionsApiListActions0Request = {}, options?: AxiosRequestConfig) {
|
|
1564
|
+
return ActionsApiFp(this.configuration).listActions_4(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1387
1565
|
}
|
|
1388
1566
|
|
|
1389
1567
|
/**
|
|
1390
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1568
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1391
1569
|
* @summary Update the action
|
|
1392
1570
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
1393
1571
|
* @param {*} [options] Override http request option.
|
|
@@ -1399,14 +1577,14 @@ export class ActionsApi extends BaseAPI {
|
|
|
1399
1577
|
}
|
|
1400
1578
|
|
|
1401
1579
|
/**
|
|
1402
|
-
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1580
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
1403
1581
|
* @summary Update the action
|
|
1404
1582
|
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
1405
1583
|
* @param {*} [options] Override http request option.
|
|
1406
1584
|
* @throws {RequiredError}
|
|
1407
1585
|
* @memberof ActionsApi
|
|
1408
1586
|
*/
|
|
1409
|
-
public
|
|
1410
|
-
return ActionsApiFp(this.configuration).
|
|
1587
|
+
public updateAction_5(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig) {
|
|
1588
|
+
return ActionsApiFp(this.configuration).updateAction_5(requestParameters.code, requestParameters.updateActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1411
1589
|
}
|
|
1412
1590
|
}
|