@emilgroup/action-sdk 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 +677 -0
  4. package/api.ts +2 -0
  5. package/dist/api/actions-api.d.ts +384 -0
  6. package/dist/api/actions-api.js +636 -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,677 @@
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
+ /**
36
+ * ActionsApi - axios parameter creator
37
+ * @export
38
+ */
39
+ export const ActionsApiAxiosParamCreator = function (configuration?: Configuration) {
40
+ return {
41
+ /**
42
+ * Creates a new action configuration
43
+ * @summary Create the action
44
+ * @param {CreateActionRequestDto} createActionRequestDto
45
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ createAction: async (createActionRequestDto: CreateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ // verify required parameter 'createActionRequestDto' is not null or undefined
51
+ assertParamExists('createAction', 'createActionRequestDto', createActionRequestDto)
52
+ const localVarPath = `/actionservice/v1/actions`;
53
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
55
+ let baseOptions;
56
+ let baseAccessToken;
57
+ if (configuration) {
58
+ baseOptions = configuration.baseOptions;
59
+ baseAccessToken = configuration.accessToken;
60
+ }
61
+
62
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
63
+ const localVarHeaderParameter = {} as any;
64
+ const localVarQueryParameter = {} as any;
65
+
66
+ // authentication bearer required
67
+ // http bearer authentication required
68
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
+
70
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
71
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
72
+ }
73
+
74
+
75
+
76
+ localVarHeaderParameter['Content-Type'] = 'application/json';
77
+
78
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
80
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
81
+ localVarRequestOptions.data = serializeDataIfNeeded(createActionRequestDto, localVarRequestOptions, configuration)
82
+
83
+ return {
84
+ url: toPathString(localVarUrlObj),
85
+ options: localVarRequestOptions,
86
+ };
87
+ },
88
+ /**
89
+ * Deletes an action configuration by its code
90
+ * @summary Delete the action
91
+ * @param {string} code Action code
92
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ deleteAction: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'code' is not null or undefined
98
+ assertParamExists('deleteAction', 'code', code)
99
+ const localVarPath = `/actionservice/v1/actions/{code}`
100
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
101
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
102
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
103
+ let baseOptions;
104
+ let baseAccessToken;
105
+ if (configuration) {
106
+ baseOptions = configuration.baseOptions;
107
+ baseAccessToken = configuration.accessToken;
108
+ }
109
+
110
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
111
+ const localVarHeaderParameter = {} as any;
112
+ const localVarQueryParameter = {} as any;
113
+
114
+ // authentication bearer required
115
+ // http bearer authentication required
116
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
+
118
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
119
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
120
+ }
121
+
122
+
123
+
124
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
125
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
126
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
127
+
128
+ return {
129
+ url: toPathString(localVarUrlObj),
130
+ options: localVarRequestOptions,
131
+ };
132
+ },
133
+ /**
134
+ * Retrieves an action configuration by its code
135
+ * @summary Retrieve the action
136
+ * @param {string} code Action code
137
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ getAction: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
142
+ // verify required parameter 'code' is not null or undefined
143
+ assertParamExists('getAction', 'code', code)
144
+ const localVarPath = `/actionservice/v1/actions/{code}`
145
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
146
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
147
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
148
+ let baseOptions;
149
+ let baseAccessToken;
150
+ if (configuration) {
151
+ baseOptions = configuration.baseOptions;
152
+ baseAccessToken = configuration.accessToken;
153
+ }
154
+
155
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
156
+ const localVarHeaderParameter = {} as any;
157
+ const localVarQueryParameter = {} as any;
158
+
159
+ // authentication bearer required
160
+ // http bearer authentication required
161
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
162
+
163
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
164
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
165
+ }
166
+
167
+
168
+
169
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
170
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
171
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
172
+
173
+ return {
174
+ url: toPathString(localVarUrlObj),
175
+ options: localVarRequestOptions,
176
+ };
177
+ },
178
+ /**
179
+ * Lists all action configurations with optional filters
180
+ * @summary List actions
181
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
183
+ * @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.
184
+ * @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;
185
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
186
+ * @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;
187
+ * @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;
188
+ * @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;
189
+ * @param {*} [options] Override http request option.
190
+ * @throws {RequiredError}
191
+ */
192
+ listActions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
193
+ const localVarPath = `/actionservice/v1/actions`;
194
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
195
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
196
+ let baseOptions;
197
+ let baseAccessToken;
198
+ if (configuration) {
199
+ baseOptions = configuration.baseOptions;
200
+ baseAccessToken = configuration.accessToken;
201
+ }
202
+
203
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
204
+ const localVarHeaderParameter = {} as any;
205
+ const localVarQueryParameter = {} as any;
206
+
207
+ // authentication bearer required
208
+ // http bearer authentication required
209
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
210
+
211
+ if (pageSize !== undefined) {
212
+ localVarQueryParameter['pageSize'] = pageSize;
213
+ }
214
+
215
+ if (pageToken !== undefined) {
216
+ localVarQueryParameter['pageToken'] = pageToken;
217
+ }
218
+
219
+ if (filter !== undefined) {
220
+ localVarQueryParameter['filter'] = filter;
221
+ }
222
+
223
+ if (search !== undefined) {
224
+ localVarQueryParameter['search'] = search;
225
+ }
226
+
227
+ if (order !== undefined) {
228
+ localVarQueryParameter['order'] = order;
229
+ }
230
+
231
+ if (expand !== undefined) {
232
+ localVarQueryParameter['expand'] = expand;
233
+ }
234
+
235
+ if (filters !== undefined) {
236
+ localVarQueryParameter['filters'] = filters;
237
+ }
238
+
239
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
240
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
241
+ }
242
+
243
+
244
+
245
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
246
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
247
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
248
+
249
+ return {
250
+ url: toPathString(localVarUrlObj),
251
+ options: localVarRequestOptions,
252
+ };
253
+ },
254
+ /**
255
+ * Updates an existing action configuration (patch semantics)
256
+ * @summary Update the action
257
+ * @param {string} code Action code
258
+ * @param {UpdateActionRequestDto} updateActionRequestDto
259
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ */
263
+ updateAction: async (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
264
+ // verify required parameter 'code' is not null or undefined
265
+ assertParamExists('updateAction', 'code', code)
266
+ // verify required parameter 'updateActionRequestDto' is not null or undefined
267
+ assertParamExists('updateAction', 'updateActionRequestDto', updateActionRequestDto)
268
+ const localVarPath = `/actionservice/v1/actions/{code}`
269
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
270
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
271
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
272
+ let baseOptions;
273
+ let baseAccessToken;
274
+ if (configuration) {
275
+ baseOptions = configuration.baseOptions;
276
+ baseAccessToken = configuration.accessToken;
277
+ }
278
+
279
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
280
+ const localVarHeaderParameter = {} as any;
281
+ const localVarQueryParameter = {} as any;
282
+
283
+ // authentication bearer required
284
+ // http bearer authentication required
285
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
286
+
287
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
288
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
289
+ }
290
+
291
+
292
+
293
+ localVarHeaderParameter['Content-Type'] = 'application/json';
294
+
295
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
296
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
297
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
298
+ localVarRequestOptions.data = serializeDataIfNeeded(updateActionRequestDto, localVarRequestOptions, configuration)
299
+
300
+ return {
301
+ url: toPathString(localVarUrlObj),
302
+ options: localVarRequestOptions,
303
+ };
304
+ },
305
+ }
306
+ };
307
+
308
+ /**
309
+ * ActionsApi - functional programming interface
310
+ * @export
311
+ */
312
+ export const ActionsApiFp = function(configuration?: Configuration) {
313
+ const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration)
314
+ return {
315
+ /**
316
+ * Creates a new action configuration
317
+ * @summary Create the action
318
+ * @param {CreateActionRequestDto} createActionRequestDto
319
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ async createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>> {
324
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAction(createActionRequestDto, authorization, options);
325
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
326
+ },
327
+ /**
328
+ * Deletes an action configuration by its code
329
+ * @summary Delete the action
330
+ * @param {string} code Action code
331
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ async deleteAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
336
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAction(code, authorization, options);
337
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
+ },
339
+ /**
340
+ * Retrieves an action configuration by its code
341
+ * @summary Retrieve the action
342
+ * @param {string} code Action code
343
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ */
347
+ async getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
348
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
349
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
+ },
351
+ /**
352
+ * Lists all action configurations with optional filters
353
+ * @summary List actions
354
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
+ * @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.
357
+ * @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;
358
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
359
+ * @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;
360
+ * @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;
361
+ * @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;
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ 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>> {
366
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
367
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
368
+ },
369
+ /**
370
+ * Updates an existing action configuration (patch semantics)
371
+ * @summary Update the action
372
+ * @param {string} code Action code
373
+ * @param {UpdateActionRequestDto} updateActionRequestDto
374
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
375
+ * @param {*} [options] Override http request option.
376
+ * @throws {RequiredError}
377
+ */
378
+ async updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>> {
379
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAction(code, updateActionRequestDto, authorization, options);
380
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
381
+ },
382
+ }
383
+ };
384
+
385
+ /**
386
+ * ActionsApi - factory interface
387
+ * @export
388
+ */
389
+ export const ActionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
390
+ const localVarFp = ActionsApiFp(configuration)
391
+ return {
392
+ /**
393
+ * Creates a new action configuration
394
+ * @summary Create the action
395
+ * @param {CreateActionRequestDto} createActionRequestDto
396
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
397
+ * @param {*} [options] Override http request option.
398
+ * @throws {RequiredError}
399
+ */
400
+ createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass> {
401
+ return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
402
+ },
403
+ /**
404
+ * Deletes an action configuration by its code
405
+ * @summary Delete the action
406
+ * @param {string} code Action code
407
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
408
+ * @param {*} [options] Override http request option.
409
+ * @throws {RequiredError}
410
+ */
411
+ deleteAction(code: string, authorization?: string, options?: any): AxiosPromise<void> {
412
+ return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
413
+ },
414
+ /**
415
+ * Retrieves an action configuration by its code
416
+ * @summary Retrieve the action
417
+ * @param {string} code Action code
418
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
419
+ * @param {*} [options] Override http request option.
420
+ * @throws {RequiredError}
421
+ */
422
+ getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
423
+ return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
424
+ },
425
+ /**
426
+ * Lists all action configurations with optional filters
427
+ * @summary List actions
428
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
+ * @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.
431
+ * @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;
432
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
+ * @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;
434
+ * @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;
435
+ * @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;
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ */
439
+ listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
440
+ return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
441
+ },
442
+ /**
443
+ * Updates an existing action configuration (patch semantics)
444
+ * @summary Update the action
445
+ * @param {string} code Action code
446
+ * @param {UpdateActionRequestDto} updateActionRequestDto
447
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
448
+ * @param {*} [options] Override http request option.
449
+ * @throws {RequiredError}
450
+ */
451
+ updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass> {
452
+ return localVarFp.updateAction(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
453
+ },
454
+ };
455
+ };
456
+
457
+ /**
458
+ * Request parameters for createAction operation in ActionsApi.
459
+ * @export
460
+ * @interface ActionsApiCreateActionRequest
461
+ */
462
+ export interface ActionsApiCreateActionRequest {
463
+ /**
464
+ *
465
+ * @type {CreateActionRequestDto}
466
+ * @memberof ActionsApiCreateAction
467
+ */
468
+ readonly createActionRequestDto: CreateActionRequestDto
469
+
470
+ /**
471
+ * Bearer Token: provided by the login endpoint under the name accessToken.
472
+ * @type {string}
473
+ * @memberof ActionsApiCreateAction
474
+ */
475
+ readonly authorization?: string
476
+ }
477
+
478
+ /**
479
+ * Request parameters for deleteAction operation in ActionsApi.
480
+ * @export
481
+ * @interface ActionsApiDeleteActionRequest
482
+ */
483
+ export interface ActionsApiDeleteActionRequest {
484
+ /**
485
+ * Action code
486
+ * @type {string}
487
+ * @memberof ActionsApiDeleteAction
488
+ */
489
+ readonly code: string
490
+
491
+ /**
492
+ * Bearer Token: provided by the login endpoint under the name accessToken.
493
+ * @type {string}
494
+ * @memberof ActionsApiDeleteAction
495
+ */
496
+ readonly authorization?: string
497
+ }
498
+
499
+ /**
500
+ * Request parameters for getAction operation in ActionsApi.
501
+ * @export
502
+ * @interface ActionsApiGetActionRequest
503
+ */
504
+ export interface ActionsApiGetActionRequest {
505
+ /**
506
+ * Action code
507
+ * @type {string}
508
+ * @memberof ActionsApiGetAction
509
+ */
510
+ readonly code: string
511
+
512
+ /**
513
+ * Bearer Token: provided by the login endpoint under the name accessToken.
514
+ * @type {string}
515
+ * @memberof ActionsApiGetAction
516
+ */
517
+ readonly authorization?: string
518
+ }
519
+
520
+ /**
521
+ * Request parameters for listActions operation in ActionsApi.
522
+ * @export
523
+ * @interface ActionsApiListActionsRequest
524
+ */
525
+ export interface ActionsApiListActionsRequest {
526
+ /**
527
+ * Bearer Token: provided by the login endpoint under the name accessToken.
528
+ * @type {string}
529
+ * @memberof ActionsApiListActions
530
+ */
531
+ readonly authorization?: string
532
+
533
+ /**
534
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
+ * @type {number}
536
+ * @memberof ActionsApiListActions
537
+ */
538
+ readonly pageSize?: number
539
+
540
+ /**
541
+ * 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.
542
+ * @type {string}
543
+ * @memberof ActionsApiListActions
544
+ */
545
+ readonly pageToken?: string
546
+
547
+ /**
548
+ * 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;
549
+ * @type {string}
550
+ * @memberof ActionsApiListActions
551
+ */
552
+ readonly filter?: string
553
+
554
+ /**
555
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
556
+ * @type {string}
557
+ * @memberof ActionsApiListActions
558
+ */
559
+ readonly search?: string
560
+
561
+ /**
562
+ * 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;
563
+ * @type {string}
564
+ * @memberof ActionsApiListActions
565
+ */
566
+ readonly order?: string
567
+
568
+ /**
569
+ * 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;
570
+ * @type {string}
571
+ * @memberof ActionsApiListActions
572
+ */
573
+ readonly expand?: string
574
+
575
+ /**
576
+ * 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;
577
+ * @type {string}
578
+ * @memberof ActionsApiListActions
579
+ */
580
+ readonly filters?: string
581
+ }
582
+
583
+ /**
584
+ * Request parameters for updateAction operation in ActionsApi.
585
+ * @export
586
+ * @interface ActionsApiUpdateActionRequest
587
+ */
588
+ export interface ActionsApiUpdateActionRequest {
589
+ /**
590
+ * Action code
591
+ * @type {string}
592
+ * @memberof ActionsApiUpdateAction
593
+ */
594
+ readonly code: string
595
+
596
+ /**
597
+ *
598
+ * @type {UpdateActionRequestDto}
599
+ * @memberof ActionsApiUpdateAction
600
+ */
601
+ readonly updateActionRequestDto: UpdateActionRequestDto
602
+
603
+ /**
604
+ * Bearer Token: provided by the login endpoint under the name accessToken.
605
+ * @type {string}
606
+ * @memberof ActionsApiUpdateAction
607
+ */
608
+ readonly authorization?: string
609
+ }
610
+
611
+ /**
612
+ * ActionsApi - object-oriented interface
613
+ * @export
614
+ * @class ActionsApi
615
+ * @extends {BaseAPI}
616
+ */
617
+ export class ActionsApi extends BaseAPI {
618
+ /**
619
+ * Creates a new action configuration
620
+ * @summary Create the action
621
+ * @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
622
+ * @param {*} [options] Override http request option.
623
+ * @throws {RequiredError}
624
+ * @memberof ActionsApi
625
+ */
626
+ public createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig) {
627
+ return ActionsApiFp(this.configuration).createAction(requestParameters.createActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
628
+ }
629
+
630
+ /**
631
+ * Deletes an action configuration by its code
632
+ * @summary Delete the action
633
+ * @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
634
+ * @param {*} [options] Override http request option.
635
+ * @throws {RequiredError}
636
+ * @memberof ActionsApi
637
+ */
638
+ public deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig) {
639
+ return ActionsApiFp(this.configuration).deleteAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
640
+ }
641
+
642
+ /**
643
+ * Retrieves an action configuration by its code
644
+ * @summary Retrieve the action
645
+ * @param {ActionsApiGetActionRequest} requestParameters Request parameters.
646
+ * @param {*} [options] Override http request option.
647
+ * @throws {RequiredError}
648
+ * @memberof ActionsApi
649
+ */
650
+ public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
651
+ return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
652
+ }
653
+
654
+ /**
655
+ * Lists all action configurations with optional filters
656
+ * @summary List actions
657
+ * @param {ActionsApiListActionsRequest} requestParameters Request parameters.
658
+ * @param {*} [options] Override http request option.
659
+ * @throws {RequiredError}
660
+ * @memberof ActionsApi
661
+ */
662
+ public listActions(requestParameters: ActionsApiListActionsRequest = {}, options?: AxiosRequestConfig) {
663
+ 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));
664
+ }
665
+
666
+ /**
667
+ * Updates an existing action configuration (patch semantics)
668
+ * @summary Update the action
669
+ * @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
670
+ * @param {*} [options] Override http request option.
671
+ * @throws {RequiredError}
672
+ * @memberof ActionsApi
673
+ */
674
+ public updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig) {
675
+ return ActionsApiFp(this.configuration).updateAction(requestParameters.code, requestParameters.updateActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
676
+ }
677
+ }