@emilgroup/action-sdk-node 1.0.1-beta.22 → 1.0.1-beta.26

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