@emilgroup/notification-sdk-node 1.0.0-beta.0

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 (100) hide show
  1. package/.openapi-generator/FILES +38 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +68 -0
  5. package/api/layouts-api.ts +663 -0
  6. package/api/notification-templates-api.ts +677 -0
  7. package/api/notifications-api.ts +165 -0
  8. package/api.ts +35 -0
  9. package/base.ts +284 -0
  10. package/common.ts +199 -0
  11. package/configuration.ts +109 -0
  12. package/dist/api/layouts-api.d.ts +364 -0
  13. package/dist/api/layouts-api.js +622 -0
  14. package/dist/api/notification-templates-api.d.ts +373 -0
  15. package/dist/api/notification-templates-api.js +628 -0
  16. package/dist/api/notifications-api.d.ts +93 -0
  17. package/dist/api/notifications-api.js +224 -0
  18. package/dist/api.d.ts +14 -0
  19. package/dist/api.js +32 -0
  20. package/dist/base.d.ts +77 -0
  21. package/dist/base.js +393 -0
  22. package/dist/common.d.ts +92 -0
  23. package/dist/common.js +277 -0
  24. package/dist/configuration.d.ts +90 -0
  25. package/dist/configuration.js +44 -0
  26. package/dist/index.d.ts +15 -0
  27. package/dist/index.js +36 -0
  28. package/dist/models/create-layout-request-dto.d.ts +48 -0
  29. package/dist/models/create-layout-request-dto.js +15 -0
  30. package/dist/models/create-layout-response-class.d.ts +25 -0
  31. package/dist/models/create-layout-response-class.js +15 -0
  32. package/dist/models/create-notification-template-request-dto.d.ts +66 -0
  33. package/dist/models/create-notification-template-request-dto.js +15 -0
  34. package/dist/models/create-notification-template-response-class.d.ts +25 -0
  35. package/dist/models/create-notification-template-response-class.js +15 -0
  36. package/dist/models/delete-layout-request-dto.d.ts +24 -0
  37. package/dist/models/delete-layout-request-dto.js +15 -0
  38. package/dist/models/delete-notification-template-request-dto.d.ts +24 -0
  39. package/dist/models/delete-notification-template-request-dto.js +15 -0
  40. package/dist/models/get-layout-request-dto.d.ts +24 -0
  41. package/dist/models/get-layout-request-dto.js +15 -0
  42. package/dist/models/get-layout-response-class.d.ts +25 -0
  43. package/dist/models/get-layout-response-class.js +15 -0
  44. package/dist/models/get-notification-template-request-dto.d.ts +30 -0
  45. package/dist/models/get-notification-template-request-dto.js +15 -0
  46. package/dist/models/get-notification-template-response-class.d.ts +25 -0
  47. package/dist/models/get-notification-template-response-class.js +15 -0
  48. package/dist/models/html-template-class.d.ts +60 -0
  49. package/dist/models/html-template-class.js +15 -0
  50. package/dist/models/index.d.ts +22 -0
  51. package/dist/models/index.js +38 -0
  52. package/dist/models/layout-class.d.ts +73 -0
  53. package/dist/models/layout-class.js +15 -0
  54. package/dist/models/list-layouts-response-class.d.ts +30 -0
  55. package/dist/models/list-layouts-response-class.js +15 -0
  56. package/dist/models/list-notification-templates-response-class.d.ts +30 -0
  57. package/dist/models/list-notification-templates-response-class.js +15 -0
  58. package/dist/models/notification-template-class.d.ts +98 -0
  59. package/dist/models/notification-template-class.js +15 -0
  60. package/dist/models/send-notification-request-dto.d.ts +66 -0
  61. package/dist/models/send-notification-request-dto.js +15 -0
  62. package/dist/models/send-notification-response-class.d.ts +24 -0
  63. package/dist/models/send-notification-response-class.js +15 -0
  64. package/dist/models/update-html-template-request-dto.d.ts +42 -0
  65. package/dist/models/update-html-template-request-dto.js +21 -0
  66. package/dist/models/update-layout-request-dto.d.ts +55 -0
  67. package/dist/models/update-layout-request-dto.js +15 -0
  68. package/dist/models/update-layout-response-class.d.ts +25 -0
  69. package/dist/models/update-layout-response-class.js +15 -0
  70. package/dist/models/update-notification-template-request-dto.d.ts +73 -0
  71. package/dist/models/update-notification-template-request-dto.js +15 -0
  72. package/dist/models/update-notification-template-response-class.d.ts +25 -0
  73. package/dist/models/update-notification-template-response-class.js +15 -0
  74. package/git_push.sh +57 -0
  75. package/index.ts +19 -0
  76. package/models/create-layout-request-dto.ts +54 -0
  77. package/models/create-layout-response-class.ts +31 -0
  78. package/models/create-notification-template-request-dto.ts +72 -0
  79. package/models/create-notification-template-response-class.ts +31 -0
  80. package/models/delete-layout-request-dto.ts +30 -0
  81. package/models/delete-notification-template-request-dto.ts +30 -0
  82. package/models/get-layout-request-dto.ts +30 -0
  83. package/models/get-layout-response-class.ts +31 -0
  84. package/models/get-notification-template-request-dto.ts +36 -0
  85. package/models/get-notification-template-response-class.ts +31 -0
  86. package/models/html-template-class.ts +66 -0
  87. package/models/index.ts +22 -0
  88. package/models/layout-class.ts +79 -0
  89. package/models/list-layouts-response-class.ts +36 -0
  90. package/models/list-notification-templates-response-class.ts +36 -0
  91. package/models/notification-template-class.ts +104 -0
  92. package/models/send-notification-request-dto.ts +72 -0
  93. package/models/send-notification-response-class.ts +30 -0
  94. package/models/update-html-template-request-dto.ts +51 -0
  95. package/models/update-layout-request-dto.ts +61 -0
  96. package/models/update-layout-response-class.ts +31 -0
  97. package/models/update-notification-template-request-dto.ts +79 -0
  98. package/models/update-notification-template-response-class.ts +31 -0
  99. package/package.json +29 -0
  100. package/tsconfig.json +22 -0
@@ -0,0 +1,663 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
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 { CreateLayoutRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateLayoutResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetLayoutResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListLayoutsResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { UpdateLayoutRequestDto } from '../models';
33
+ // @ts-ignore
34
+ import { UpdateLayoutResponseClass } from '../models';
35
+ // URLSearchParams not necessarily used
36
+ // @ts-ignore
37
+ import { URL, URLSearchParams } from 'url';
38
+ const FormData = require('form-data');
39
+ /**
40
+ * LayoutsApi - axios parameter creator
41
+ * @export
42
+ */
43
+ export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
44
+ return {
45
+ /**
46
+ *
47
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
48
+ * @param {string} [authorization] Bearer Token
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ createLayout: async (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
53
+ // verify required parameter 'createLayoutRequestDto' is not null or undefined
54
+ assertParamExists('createLayout', 'createLayoutRequestDto', createLayoutRequestDto)
55
+ const localVarPath = `/notificationservice/v1/layouts`;
56
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
57
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
58
+ let baseOptions;
59
+ let baseAccessToken;
60
+ if (configuration) {
61
+ baseOptions = configuration.baseOptions;
62
+ baseAccessToken = configuration.accessToken;
63
+ }
64
+
65
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
66
+ const localVarHeaderParameter = {} as any;
67
+ const localVarQueryParameter = {} as any;
68
+
69
+ // authentication bearer required
70
+ // http bearer authentication required
71
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
72
+
73
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
74
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
75
+ }
76
+
77
+
78
+
79
+ localVarHeaderParameter['Content-Type'] = 'application/json';
80
+
81
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
82
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
83
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
84
+ localVarRequestOptions.data = serializeDataIfNeeded(createLayoutRequestDto, localVarRequestOptions, configuration)
85
+
86
+ return {
87
+ url: toPathString(localVarUrlObj),
88
+ options: localVarRequestOptions,
89
+ };
90
+ },
91
+ /**
92
+ *
93
+ * @param {number} id
94
+ * @param {string} [authorization] Bearer Token
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ deleteLayout: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
99
+ // verify required parameter 'id' is not null or undefined
100
+ assertParamExists('deleteLayout', 'id', id)
101
+ const localVarPath = `/notificationservice/v1/layouts/{id}`
102
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
103
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
104
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
105
+ let baseOptions;
106
+ let baseAccessToken;
107
+ if (configuration) {
108
+ baseOptions = configuration.baseOptions;
109
+ baseAccessToken = configuration.accessToken;
110
+ }
111
+
112
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
113
+ const localVarHeaderParameter = {} as any;
114
+ const localVarQueryParameter = {} as any;
115
+
116
+ // authentication bearer required
117
+ // http bearer authentication required
118
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
119
+
120
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
121
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
122
+ }
123
+
124
+
125
+
126
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
127
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
128
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
129
+
130
+ return {
131
+ url: toPathString(localVarUrlObj),
132
+ options: localVarRequestOptions,
133
+ };
134
+ },
135
+ /**
136
+ *
137
+ * @param {number} id
138
+ * @param {number} id2 Layout id
139
+ * @param {string} [authorization] Bearer Token
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ */
143
+ getLayout: async (id: number, id2: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
144
+ // verify required parameter 'id' is not null or undefined
145
+ assertParamExists('getLayout', 'id', id)
146
+ // verify required parameter 'id2' is not null or undefined
147
+ assertParamExists('getLayout', 'id2', id2)
148
+ const localVarPath = `/notificationservice/v1/layouts/{id}`
149
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
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 (id2 !== undefined) {
168
+ localVarQueryParameter['id'] = id2;
169
+ }
170
+
171
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
172
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
173
+ }
174
+
175
+
176
+
177
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
178
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
179
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
180
+
181
+ return {
182
+ url: toPathString(localVarUrlObj),
183
+ options: localVarRequestOptions,
184
+ };
185
+ },
186
+ /**
187
+ *
188
+ * @param {string} [authorization] Bearer Token
189
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
190
+ * @param {any} [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.
191
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
193
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
194
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ listLayouts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ const localVarPath = `/notificationservice/v1/layouts`;
200
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
201
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
202
+ let baseOptions;
203
+ let baseAccessToken;
204
+ if (configuration) {
205
+ baseOptions = configuration.baseOptions;
206
+ baseAccessToken = configuration.accessToken;
207
+ }
208
+
209
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
210
+ const localVarHeaderParameter = {} as any;
211
+ const localVarQueryParameter = {} as any;
212
+
213
+ // authentication bearer required
214
+ // http bearer authentication required
215
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
216
+
217
+ if (pageSize !== undefined) {
218
+ localVarQueryParameter['pageSize'] = pageSize;
219
+ }
220
+
221
+ if (pageToken !== undefined) {
222
+ localVarQueryParameter['pageToken'] = pageToken;
223
+ }
224
+
225
+ if (filter !== undefined) {
226
+ localVarQueryParameter['filter'] = filter;
227
+ }
228
+
229
+ if (search !== undefined) {
230
+ localVarQueryParameter['search'] = search;
231
+ }
232
+
233
+ if (order !== undefined) {
234
+ localVarQueryParameter['order'] = order;
235
+ }
236
+
237
+ if (expand !== undefined) {
238
+ localVarQueryParameter['expand'] = expand;
239
+ }
240
+
241
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
242
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
243
+ }
244
+
245
+
246
+
247
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
248
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
249
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
250
+
251
+ return {
252
+ url: toPathString(localVarUrlObj),
253
+ options: localVarRequestOptions,
254
+ };
255
+ },
256
+ /**
257
+ *
258
+ * @param {number} id
259
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
260
+ * @param {string} [authorization] Bearer Token
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ */
264
+ updateLayout: async (id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
265
+ // verify required parameter 'id' is not null or undefined
266
+ assertParamExists('updateLayout', 'id', id)
267
+ // verify required parameter 'updateLayoutRequestDto' is not null or undefined
268
+ assertParamExists('updateLayout', 'updateLayoutRequestDto', updateLayoutRequestDto)
269
+ const localVarPath = `/notificationservice/v1/layouts/{id}`
270
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
271
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
272
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
273
+ let baseOptions;
274
+ let baseAccessToken;
275
+ if (configuration) {
276
+ baseOptions = configuration.baseOptions;
277
+ baseAccessToken = configuration.accessToken;
278
+ }
279
+
280
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
281
+ const localVarHeaderParameter = {} as any;
282
+ const localVarQueryParameter = {} as any;
283
+
284
+ // authentication bearer required
285
+ // http bearer authentication required
286
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
287
+
288
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
289
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
290
+ }
291
+
292
+
293
+
294
+ localVarHeaderParameter['Content-Type'] = 'application/json';
295
+
296
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
297
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
298
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
299
+ localVarRequestOptions.data = serializeDataIfNeeded(updateLayoutRequestDto, localVarRequestOptions, configuration)
300
+
301
+ return {
302
+ url: toPathString(localVarUrlObj),
303
+ options: localVarRequestOptions,
304
+ };
305
+ },
306
+ }
307
+ };
308
+
309
+ /**
310
+ * LayoutsApi - functional programming interface
311
+ * @export
312
+ */
313
+ export const LayoutsApiFp = function(configuration?: Configuration) {
314
+ const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
315
+ return {
316
+ /**
317
+ *
318
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
319
+ * @param {string} [authorization] Bearer Token
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ async createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>> {
324
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createLayout(createLayoutRequestDto, authorization, options);
325
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
326
+ },
327
+ /**
328
+ *
329
+ * @param {number} id
330
+ * @param {string} [authorization] Bearer Token
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ async deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
335
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLayout(id, authorization, options);
336
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
337
+ },
338
+ /**
339
+ *
340
+ * @param {number} id
341
+ * @param {number} id2 Layout id
342
+ * @param {string} [authorization] Bearer Token
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ */
346
+ async getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>> {
347
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getLayout(id, id2, authorization, options);
348
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
349
+ },
350
+ /**
351
+ *
352
+ * @param {string} [authorization] Bearer Token
353
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
354
+ * @param {any} [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.
355
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
356
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
357
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
358
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
359
+ * @param {*} [options] Override http request option.
360
+ * @throws {RequiredError}
361
+ */
362
+ async listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>> {
363
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options);
364
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
365
+ },
366
+ /**
367
+ *
368
+ * @param {number} id
369
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
370
+ * @param {string} [authorization] Bearer Token
371
+ * @param {*} [options] Override http request option.
372
+ * @throws {RequiredError}
373
+ */
374
+ async updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLayoutResponseClass>> {
375
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateLayout(id, updateLayoutRequestDto, authorization, options);
376
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
377
+ },
378
+ }
379
+ };
380
+
381
+ /**
382
+ * LayoutsApi - factory interface
383
+ * @export
384
+ */
385
+ export const LayoutsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
386
+ const localVarFp = LayoutsApiFp(configuration)
387
+ return {
388
+ /**
389
+ *
390
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
391
+ * @param {string} [authorization] Bearer Token
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass> {
396
+ return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
397
+ },
398
+ /**
399
+ *
400
+ * @param {number} id
401
+ * @param {string} [authorization] Bearer Token
402
+ * @param {*} [options] Override http request option.
403
+ * @throws {RequiredError}
404
+ */
405
+ deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object> {
406
+ return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
407
+ },
408
+ /**
409
+ *
410
+ * @param {number} id
411
+ * @param {number} id2 Layout id
412
+ * @param {string} [authorization] Bearer Token
413
+ * @param {*} [options] Override http request option.
414
+ * @throws {RequiredError}
415
+ */
416
+ getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass> {
417
+ return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
418
+ },
419
+ /**
420
+ *
421
+ * @param {string} [authorization] Bearer Token
422
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
423
+ * @param {any} [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.
424
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
425
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
426
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
427
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ */
431
+ listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListLayoutsResponseClass> {
432
+ return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
433
+ },
434
+ /**
435
+ *
436
+ * @param {number} id
437
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
438
+ * @param {string} [authorization] Bearer Token
439
+ * @param {*} [options] Override http request option.
440
+ * @throws {RequiredError}
441
+ */
442
+ updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLayoutResponseClass> {
443
+ return localVarFp.updateLayout(id, updateLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
444
+ },
445
+ };
446
+ };
447
+
448
+ /**
449
+ * Request parameters for createLayout operation in LayoutsApi.
450
+ * @export
451
+ * @interface LayoutsApiCreateLayoutRequest
452
+ */
453
+ export interface LayoutsApiCreateLayoutRequest {
454
+ /**
455
+ *
456
+ * @type {CreateLayoutRequestDto}
457
+ * @memberof LayoutsApiCreateLayout
458
+ */
459
+ readonly createLayoutRequestDto: CreateLayoutRequestDto
460
+
461
+ /**
462
+ * Bearer Token
463
+ * @type {string}
464
+ * @memberof LayoutsApiCreateLayout
465
+ */
466
+ readonly authorization?: string
467
+ }
468
+
469
+ /**
470
+ * Request parameters for deleteLayout operation in LayoutsApi.
471
+ * @export
472
+ * @interface LayoutsApiDeleteLayoutRequest
473
+ */
474
+ export interface LayoutsApiDeleteLayoutRequest {
475
+ /**
476
+ *
477
+ * @type {number}
478
+ * @memberof LayoutsApiDeleteLayout
479
+ */
480
+ readonly id: number
481
+
482
+ /**
483
+ * Bearer Token
484
+ * @type {string}
485
+ * @memberof LayoutsApiDeleteLayout
486
+ */
487
+ readonly authorization?: string
488
+ }
489
+
490
+ /**
491
+ * Request parameters for getLayout operation in LayoutsApi.
492
+ * @export
493
+ * @interface LayoutsApiGetLayoutRequest
494
+ */
495
+ export interface LayoutsApiGetLayoutRequest {
496
+ /**
497
+ *
498
+ * @type {number}
499
+ * @memberof LayoutsApiGetLayout
500
+ */
501
+ readonly id: number
502
+
503
+ /**
504
+ * Layout id
505
+ * @type {number}
506
+ * @memberof LayoutsApiGetLayout
507
+ */
508
+ readonly id2: number
509
+
510
+ /**
511
+ * Bearer Token
512
+ * @type {string}
513
+ * @memberof LayoutsApiGetLayout
514
+ */
515
+ readonly authorization?: string
516
+ }
517
+
518
+ /**
519
+ * Request parameters for listLayouts operation in LayoutsApi.
520
+ * @export
521
+ * @interface LayoutsApiListLayoutsRequest
522
+ */
523
+ export interface LayoutsApiListLayoutsRequest {
524
+ /**
525
+ * Bearer Token
526
+ * @type {string}
527
+ * @memberof LayoutsApiListLayouts
528
+ */
529
+ readonly authorization?: string
530
+
531
+ /**
532
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
533
+ * @type {any}
534
+ * @memberof LayoutsApiListLayouts
535
+ */
536
+ readonly pageSize?: any
537
+
538
+ /**
539
+ * 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.
540
+ * @type {any}
541
+ * @memberof LayoutsApiListLayouts
542
+ */
543
+ readonly pageToken?: any
544
+
545
+ /**
546
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
547
+ * @type {any}
548
+ * @memberof LayoutsApiListLayouts
549
+ */
550
+ readonly filter?: any
551
+
552
+ /**
553
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
554
+ * @type {any}
555
+ * @memberof LayoutsApiListLayouts
556
+ */
557
+ readonly search?: any
558
+
559
+ /**
560
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
561
+ * @type {any}
562
+ * @memberof LayoutsApiListLayouts
563
+ */
564
+ readonly order?: any
565
+
566
+ /**
567
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
568
+ * @type {any}
569
+ * @memberof LayoutsApiListLayouts
570
+ */
571
+ readonly expand?: any
572
+ }
573
+
574
+ /**
575
+ * Request parameters for updateLayout operation in LayoutsApi.
576
+ * @export
577
+ * @interface LayoutsApiUpdateLayoutRequest
578
+ */
579
+ export interface LayoutsApiUpdateLayoutRequest {
580
+ /**
581
+ *
582
+ * @type {number}
583
+ * @memberof LayoutsApiUpdateLayout
584
+ */
585
+ readonly id: number
586
+
587
+ /**
588
+ *
589
+ * @type {UpdateLayoutRequestDto}
590
+ * @memberof LayoutsApiUpdateLayout
591
+ */
592
+ readonly updateLayoutRequestDto: UpdateLayoutRequestDto
593
+
594
+ /**
595
+ * Bearer Token
596
+ * @type {string}
597
+ * @memberof LayoutsApiUpdateLayout
598
+ */
599
+ readonly authorization?: string
600
+ }
601
+
602
+ /**
603
+ * LayoutsApi - object-oriented interface
604
+ * @export
605
+ * @class LayoutsApi
606
+ * @extends {BaseAPI}
607
+ */
608
+ export class LayoutsApi extends BaseAPI {
609
+ /**
610
+ *
611
+ * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
612
+ * @param {*} [options] Override http request option.
613
+ * @throws {RequiredError}
614
+ * @memberof LayoutsApi
615
+ */
616
+ public createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig) {
617
+ return LayoutsApiFp(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
618
+ }
619
+
620
+ /**
621
+ *
622
+ * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
623
+ * @param {*} [options] Override http request option.
624
+ * @throws {RequiredError}
625
+ * @memberof LayoutsApi
626
+ */
627
+ public deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig) {
628
+ return LayoutsApiFp(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
629
+ }
630
+
631
+ /**
632
+ *
633
+ * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
634
+ * @param {*} [options] Override http request option.
635
+ * @throws {RequiredError}
636
+ * @memberof LayoutsApi
637
+ */
638
+ public getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig) {
639
+ return LayoutsApiFp(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
640
+ }
641
+
642
+ /**
643
+ *
644
+ * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
645
+ * @param {*} [options] Override http request option.
646
+ * @throws {RequiredError}
647
+ * @memberof LayoutsApi
648
+ */
649
+ public listLayouts(requestParameters: LayoutsApiListLayoutsRequest = {}, options?: AxiosRequestConfig) {
650
+ return LayoutsApiFp(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
651
+ }
652
+
653
+ /**
654
+ *
655
+ * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
656
+ * @param {*} [options] Override http request option.
657
+ * @throws {RequiredError}
658
+ * @memberof LayoutsApi
659
+ */
660
+ public updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig) {
661
+ return LayoutsApiFp(this.configuration).updateLayout(requestParameters.id, requestParameters.updateLayoutRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
662
+ }
663
+ }