@emilgroup/action-sdk 1.0.1-beta.22 → 1.1.1-beta.1

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