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

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 (33) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/actions-api.ts +681 -0
  4. package/api.ts +2 -0
  5. package/dist/api/actions-api.d.ts +384 -0
  6. package/dist/api/actions-api.js +640 -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/create-action-request-dto.d.ts +48 -0
  12. package/dist/models/create-action-request-dto.js +15 -0
  13. package/dist/models/create-action-response-class.d.ts +25 -0
  14. package/dist/models/create-action-response-class.js +15 -0
  15. package/dist/models/get-action-response-class.d.ts +25 -0
  16. package/dist/models/get-action-response-class.js +15 -0
  17. package/dist/models/index.d.ts +7 -0
  18. package/dist/models/index.js +7 -0
  19. package/dist/models/list-actions-response-class.d.ts +43 -0
  20. package/dist/models/list-actions-response-class.js +15 -0
  21. package/dist/models/update-action-request-dto.d.ts +54 -0
  22. package/dist/models/update-action-request-dto.js +15 -0
  23. package/dist/models/update-action-response-class.d.ts +25 -0
  24. package/dist/models/update-action-response-class.js +15 -0
  25. package/models/action-class.ts +90 -0
  26. package/models/create-action-request-dto.ts +54 -0
  27. package/models/create-action-response-class.ts +31 -0
  28. package/models/get-action-response-class.ts +31 -0
  29. package/models/index.ts +7 -0
  30. package/models/list-actions-response-class.ts +49 -0
  31. package/models/update-action-request-dto.ts +60 -0
  32. package/models/update-action-response-class.ts +31 -0
  33. package/package.json +1 -1
@@ -0,0 +1,681 @@
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 { GetActionResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListActionsResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { UpdateActionRequestDto } from '../models';
33
+ // @ts-ignore
34
+ import { UpdateActionResponseClass } from '../models';
35
+ // URLSearchParams not necessarily used
36
+ // @ts-ignore
37
+ import { URL, URLSearchParams } from 'url';
38
+ const FormData = require('form-data');
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
+ * Lists all action configurations with optional filters
184
+ * @summary List actions
185
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
187
+ * @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.
188
+ * @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;
189
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
190
+ * @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;
191
+ * @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;
192
+ * @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;
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ */
196
+ listActions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
+ const localVarPath = `/actionservice/v1/actions`;
198
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
199
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
200
+ let baseOptions;
201
+ let baseAccessToken;
202
+ if (configuration) {
203
+ baseOptions = configuration.baseOptions;
204
+ baseAccessToken = configuration.accessToken;
205
+ }
206
+
207
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
208
+ const localVarHeaderParameter = {} as any;
209
+ const localVarQueryParameter = {} as any;
210
+
211
+ // authentication bearer required
212
+ // http bearer authentication required
213
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
214
+
215
+ if (pageSize !== undefined) {
216
+ localVarQueryParameter['pageSize'] = pageSize;
217
+ }
218
+
219
+ if (pageToken !== undefined) {
220
+ localVarQueryParameter['pageToken'] = pageToken;
221
+ }
222
+
223
+ if (filter !== undefined) {
224
+ localVarQueryParameter['filter'] = filter;
225
+ }
226
+
227
+ if (search !== undefined) {
228
+ localVarQueryParameter['search'] = search;
229
+ }
230
+
231
+ if (order !== undefined) {
232
+ localVarQueryParameter['order'] = order;
233
+ }
234
+
235
+ if (expand !== undefined) {
236
+ localVarQueryParameter['expand'] = expand;
237
+ }
238
+
239
+ if (filters !== undefined) {
240
+ localVarQueryParameter['filters'] = filters;
241
+ }
242
+
243
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
244
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
245
+ }
246
+
247
+
248
+
249
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
250
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
251
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
252
+
253
+ return {
254
+ url: toPathString(localVarUrlObj),
255
+ options: localVarRequestOptions,
256
+ };
257
+ },
258
+ /**
259
+ * Updates an existing action configuration (patch semantics)
260
+ * @summary Update the action
261
+ * @param {string} code Action code
262
+ * @param {UpdateActionRequestDto} updateActionRequestDto
263
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ updateAction: async (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
268
+ // verify required parameter 'code' is not null or undefined
269
+ assertParamExists('updateAction', 'code', code)
270
+ // verify required parameter 'updateActionRequestDto' is not null or undefined
271
+ assertParamExists('updateAction', 'updateActionRequestDto', updateActionRequestDto)
272
+ const localVarPath = `/actionservice/v1/actions/{code}`
273
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
274
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
275
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
276
+ let baseOptions;
277
+ let baseAccessToken;
278
+ if (configuration) {
279
+ baseOptions = configuration.baseOptions;
280
+ baseAccessToken = configuration.accessToken;
281
+ }
282
+
283
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
284
+ const localVarHeaderParameter = {} as any;
285
+ const localVarQueryParameter = {} as any;
286
+
287
+ // authentication bearer required
288
+ // http bearer authentication required
289
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
290
+
291
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
292
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
293
+ }
294
+
295
+
296
+
297
+ localVarHeaderParameter['Content-Type'] = 'application/json';
298
+
299
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
300
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
301
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
302
+ localVarRequestOptions.data = serializeDataIfNeeded(updateActionRequestDto, localVarRequestOptions, configuration)
303
+
304
+ return {
305
+ url: toPathString(localVarUrlObj),
306
+ options: localVarRequestOptions,
307
+ };
308
+ },
309
+ }
310
+ };
311
+
312
+ /**
313
+ * ActionsApi - functional programming interface
314
+ * @export
315
+ */
316
+ export const ActionsApiFp = function(configuration?: Configuration) {
317
+ const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration)
318
+ return {
319
+ /**
320
+ * Creates a new action configuration
321
+ * @summary Create the action
322
+ * @param {CreateActionRequestDto} createActionRequestDto
323
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
324
+ * @param {*} [options] Override http request option.
325
+ * @throws {RequiredError}
326
+ */
327
+ async createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>> {
328
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAction(createActionRequestDto, authorization, options);
329
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
330
+ },
331
+ /**
332
+ * Deletes an action configuration by its code
333
+ * @summary Delete the action
334
+ * @param {string} code Action code
335
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
+ * @param {*} [options] Override http request option.
337
+ * @throws {RequiredError}
338
+ */
339
+ async deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
340
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAction(code, authorization, options);
341
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
342
+ },
343
+ /**
344
+ * Retrieves an action configuration by its code
345
+ * @summary Retrieve the action
346
+ * @param {string} code Action code
347
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
348
+ * @param {*} [options] Override http request option.
349
+ * @throws {RequiredError}
350
+ */
351
+ async getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
352
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
353
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
+ },
355
+ /**
356
+ * Lists all action configurations with optional filters
357
+ * @summary List actions
358
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
360
+ * @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.
361
+ * @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;
362
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
363
+ * @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;
364
+ * @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;
365
+ * @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;
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ */
369
+ 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>> {
370
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
371
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
372
+ },
373
+ /**
374
+ * Updates an existing action configuration (patch semantics)
375
+ * @summary Update the action
376
+ * @param {string} code Action code
377
+ * @param {UpdateActionRequestDto} updateActionRequestDto
378
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
379
+ * @param {*} [options] Override http request option.
380
+ * @throws {RequiredError}
381
+ */
382
+ async updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>> {
383
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAction(code, updateActionRequestDto, authorization, options);
384
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
385
+ },
386
+ }
387
+ };
388
+
389
+ /**
390
+ * ActionsApi - factory interface
391
+ * @export
392
+ */
393
+ export const ActionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
394
+ const localVarFp = ActionsApiFp(configuration)
395
+ return {
396
+ /**
397
+ * Creates a new action configuration
398
+ * @summary Create the action
399
+ * @param {CreateActionRequestDto} createActionRequestDto
400
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
401
+ * @param {*} [options] Override http request option.
402
+ * @throws {RequiredError}
403
+ */
404
+ createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass> {
405
+ return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
406
+ },
407
+ /**
408
+ * Deletes an action configuration by its code
409
+ * @summary Delete the action
410
+ * @param {string} code Action code
411
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
412
+ * @param {*} [options] Override http request option.
413
+ * @throws {RequiredError}
414
+ */
415
+ deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void> {
416
+ return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
417
+ },
418
+ /**
419
+ * Retrieves an action configuration by its code
420
+ * @summary Retrieve the action
421
+ * @param {string} code Action code
422
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
423
+ * @param {*} [options] Override http request option.
424
+ * @throws {RequiredError}
425
+ */
426
+ getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
427
+ return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
428
+ },
429
+ /**
430
+ * Lists all action configurations with optional filters
431
+ * @summary List actions
432
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
+ * @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.
435
+ * @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;
436
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
437
+ * @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;
438
+ * @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;
439
+ * @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;
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
444
+ return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
445
+ },
446
+ /**
447
+ * Updates an existing action configuration (patch semantics)
448
+ * @summary Update the action
449
+ * @param {string} code Action code
450
+ * @param {UpdateActionRequestDto} updateActionRequestDto
451
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
452
+ * @param {*} [options] Override http request option.
453
+ * @throws {RequiredError}
454
+ */
455
+ updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass> {
456
+ return localVarFp.updateAction(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
457
+ },
458
+ };
459
+ };
460
+
461
+ /**
462
+ * Request parameters for createAction operation in ActionsApi.
463
+ * @export
464
+ * @interface ActionsApiCreateActionRequest
465
+ */
466
+ export interface ActionsApiCreateActionRequest {
467
+ /**
468
+ *
469
+ * @type {CreateActionRequestDto}
470
+ * @memberof ActionsApiCreateAction
471
+ */
472
+ readonly createActionRequestDto: CreateActionRequestDto
473
+
474
+ /**
475
+ * Bearer Token: provided by the login endpoint under the name accessToken.
476
+ * @type {string}
477
+ * @memberof ActionsApiCreateAction
478
+ */
479
+ readonly authorization?: string
480
+ }
481
+
482
+ /**
483
+ * Request parameters for deleteAction operation in ActionsApi.
484
+ * @export
485
+ * @interface ActionsApiDeleteActionRequest
486
+ */
487
+ export interface ActionsApiDeleteActionRequest {
488
+ /**
489
+ * Action code
490
+ * @type {string}
491
+ * @memberof ActionsApiDeleteAction
492
+ */
493
+ readonly code: string
494
+
495
+ /**
496
+ * Bearer Token: provided by the login endpoint under the name accessToken.
497
+ * @type {string}
498
+ * @memberof ActionsApiDeleteAction
499
+ */
500
+ readonly authorization?: string
501
+ }
502
+
503
+ /**
504
+ * Request parameters for getAction operation in ActionsApi.
505
+ * @export
506
+ * @interface ActionsApiGetActionRequest
507
+ */
508
+ export interface ActionsApiGetActionRequest {
509
+ /**
510
+ * Action code
511
+ * @type {string}
512
+ * @memberof ActionsApiGetAction
513
+ */
514
+ readonly code: string
515
+
516
+ /**
517
+ * Bearer Token: provided by the login endpoint under the name accessToken.
518
+ * @type {string}
519
+ * @memberof ActionsApiGetAction
520
+ */
521
+ readonly authorization?: string
522
+ }
523
+
524
+ /**
525
+ * Request parameters for listActions operation in ActionsApi.
526
+ * @export
527
+ * @interface ActionsApiListActionsRequest
528
+ */
529
+ export interface ActionsApiListActionsRequest {
530
+ /**
531
+ * Bearer Token: provided by the login endpoint under the name accessToken.
532
+ * @type {string}
533
+ * @memberof ActionsApiListActions
534
+ */
535
+ readonly authorization?: string
536
+
537
+ /**
538
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
+ * @type {number}
540
+ * @memberof ActionsApiListActions
541
+ */
542
+ readonly pageSize?: number
543
+
544
+ /**
545
+ * 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.
546
+ * @type {string}
547
+ * @memberof ActionsApiListActions
548
+ */
549
+ readonly pageToken?: string
550
+
551
+ /**
552
+ * 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;
553
+ * @type {string}
554
+ * @memberof ActionsApiListActions
555
+ */
556
+ readonly filter?: string
557
+
558
+ /**
559
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
560
+ * @type {string}
561
+ * @memberof ActionsApiListActions
562
+ */
563
+ readonly search?: string
564
+
565
+ /**
566
+ * 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;
567
+ * @type {string}
568
+ * @memberof ActionsApiListActions
569
+ */
570
+ readonly order?: string
571
+
572
+ /**
573
+ * 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;
574
+ * @type {string}
575
+ * @memberof ActionsApiListActions
576
+ */
577
+ readonly expand?: string
578
+
579
+ /**
580
+ * 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;
581
+ * @type {string}
582
+ * @memberof ActionsApiListActions
583
+ */
584
+ readonly filters?: string
585
+ }
586
+
587
+ /**
588
+ * Request parameters for updateAction operation in ActionsApi.
589
+ * @export
590
+ * @interface ActionsApiUpdateActionRequest
591
+ */
592
+ export interface ActionsApiUpdateActionRequest {
593
+ /**
594
+ * Action code
595
+ * @type {string}
596
+ * @memberof ActionsApiUpdateAction
597
+ */
598
+ readonly code: string
599
+
600
+ /**
601
+ *
602
+ * @type {UpdateActionRequestDto}
603
+ * @memberof ActionsApiUpdateAction
604
+ */
605
+ readonly updateActionRequestDto: UpdateActionRequestDto
606
+
607
+ /**
608
+ * Bearer Token: provided by the login endpoint under the name accessToken.
609
+ * @type {string}
610
+ * @memberof ActionsApiUpdateAction
611
+ */
612
+ readonly authorization?: string
613
+ }
614
+
615
+ /**
616
+ * ActionsApi - object-oriented interface
617
+ * @export
618
+ * @class ActionsApi
619
+ * @extends {BaseAPI}
620
+ */
621
+ export class ActionsApi extends BaseAPI {
622
+ /**
623
+ * Creates a new action configuration
624
+ * @summary Create the action
625
+ * @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
626
+ * @param {*} [options] Override http request option.
627
+ * @throws {RequiredError}
628
+ * @memberof ActionsApi
629
+ */
630
+ public createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig) {
631
+ return ActionsApiFp(this.configuration).createAction(requestParameters.createActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
632
+ }
633
+
634
+ /**
635
+ * Deletes an action configuration by its code
636
+ * @summary Delete the action
637
+ * @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
638
+ * @param {*} [options] Override http request option.
639
+ * @throws {RequiredError}
640
+ * @memberof ActionsApi
641
+ */
642
+ public deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig) {
643
+ return ActionsApiFp(this.configuration).deleteAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
644
+ }
645
+
646
+ /**
647
+ * Retrieves an action configuration by its code
648
+ * @summary Retrieve the action
649
+ * @param {ActionsApiGetActionRequest} requestParameters Request parameters.
650
+ * @param {*} [options] Override http request option.
651
+ * @throws {RequiredError}
652
+ * @memberof ActionsApi
653
+ */
654
+ public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
655
+ return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
656
+ }
657
+
658
+ /**
659
+ * Lists all action configurations with optional filters
660
+ * @summary List actions
661
+ * @param {ActionsApiListActionsRequest} requestParameters Request parameters.
662
+ * @param {*} [options] Override http request option.
663
+ * @throws {RequiredError}
664
+ * @memberof ActionsApi
665
+ */
666
+ public listActions(requestParameters: ActionsApiListActionsRequest = {}, options?: AxiosRequestConfig) {
667
+ 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));
668
+ }
669
+
670
+ /**
671
+ * Updates an existing action configuration (patch semantics)
672
+ * @summary Update the action
673
+ * @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
674
+ * @param {*} [options] Override http request option.
675
+ * @throws {RequiredError}
676
+ * @memberof ActionsApi
677
+ */
678
+ public updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig) {
679
+ return ActionsApiFp(this.configuration).updateAction(requestParameters.code, requestParameters.updateActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
680
+ }
681
+ }