@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,109 @@
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
+ export interface ConfigurationParameters {
17
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
18
+ username?: string;
19
+ password?: string;
20
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
21
+ basePath?: string;
22
+ baseOptions?: any;
23
+ formDataCtor?: new () => any;
24
+ }
25
+
26
+ export class Configuration {
27
+ /**
28
+ * parameter for apiKey security
29
+ * @param name security name
30
+ * @memberof Configuration
31
+ */
32
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
33
+ /**
34
+ * parameter for basic security
35
+ *
36
+ * @type {string}
37
+ * @memberof Configuration
38
+ */
39
+ username?: string;
40
+ /**
41
+ * parameter for basic security
42
+ *
43
+ * @type {string}
44
+ * @memberof Configuration
45
+ */
46
+ password?: string;
47
+ /**
48
+ * parameter for oauth2 security
49
+ * @param name security name
50
+ * @param scopes oauth2 scope
51
+ * @memberof Configuration
52
+ */
53
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * override base path
56
+ *
57
+ * @type {string}
58
+ * @memberof Configuration
59
+ */
60
+ basePath?: string;
61
+ /**
62
+ * base options for axios calls
63
+ *
64
+ * @type {any}
65
+ * @memberof Configuration
66
+ */
67
+ baseOptions?: any;
68
+ /**
69
+ * The FormData constructor that will be used to create multipart form data
70
+ * requests. You can inject this here so that execution environments that
71
+ * do not support the FormData class can still run the generated client.
72
+ *
73
+ * @type {new () => FormData}
74
+ */
75
+ formDataCtor?: new () => any;
76
+
77
+ /**
78
+ * parameter for automatically refreshing access token for oauth2 security
79
+ *
80
+ * @type {string}
81
+ * @memberof Configuration
82
+ */
83
+ refreshToken?: string;
84
+
85
+ constructor(param: ConfigurationParameters = {}) {
86
+ this.apiKey = param.apiKey;
87
+ this.username = param.username;
88
+ this.password = param.password;
89
+ this.accessToken = param.accessToken;
90
+ this.basePath = param.basePath;
91
+ this.baseOptions = param.baseOptions;
92
+ this.formDataCtor = param.formDataCtor;
93
+ }
94
+
95
+ /**
96
+ * Check if the given MIME is a JSON MIME.
97
+ * JSON MIME examples:
98
+ * application/json
99
+ * application/json; charset=UTF8
100
+ * APPLICATION/JSON
101
+ * application/vnd.company+json
102
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
103
+ * @return True if the given MIME is JSON, false otherwise.
104
+ */
105
+ public isJsonMime(mime: string): boolean {
106
+ const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
107
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
108
+ }
109
+ }
@@ -0,0 +1,364 @@
1
+ /**
2
+ * EMIL NotificationService
3
+ * The EMIL NotificationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateLayoutRequestDto } from '../models';
16
+ import { CreateLayoutResponseClass } from '../models';
17
+ import { GetLayoutResponseClass } from '../models';
18
+ import { ListLayoutsResponseClass } from '../models';
19
+ import { UpdateLayoutRequestDto } from '../models';
20
+ import { UpdateLayoutResponseClass } from '../models';
21
+ /**
22
+ * LayoutsApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ *
28
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
29
+ * @param {string} [authorization] Bearer Token
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ *
36
+ * @param {number} id
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ *
44
+ * @param {number} id
45
+ * @param {number} id2 Layout id
46
+ * @param {string} [authorization] Bearer Token
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getLayout: (id: number, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ *
53
+ * @param {string} [authorization] Bearer Token
54
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
55
+ * @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.
56
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
57
+ * @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.
58
+ * @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.
59
+ * @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.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ listLayouts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ /**
65
+ *
66
+ * @param {number} id
67
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
68
+ * @param {string} [authorization] Bearer Token
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ updateLayout: (id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
73
+ };
74
+ /**
75
+ * LayoutsApi - functional programming interface
76
+ * @export
77
+ */
78
+ export declare const LayoutsApiFp: (configuration?: Configuration) => {
79
+ /**
80
+ *
81
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
82
+ * @param {string} [authorization] Bearer Token
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ */
86
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
87
+ /**
88
+ *
89
+ * @param {number} id
90
+ * @param {string} [authorization] Bearer Token
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
95
+ /**
96
+ *
97
+ * @param {number} id
98
+ * @param {number} id2 Layout id
99
+ * @param {string} [authorization] Bearer Token
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
104
+ /**
105
+ *
106
+ * @param {string} [authorization] Bearer Token
107
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
108
+ * @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.
109
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
110
+ * @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.
111
+ * @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.
112
+ * @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.
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
117
+ /**
118
+ *
119
+ * @param {number} id
120
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
121
+ * @param {string} [authorization] Bearer Token
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLayoutResponseClass>>;
126
+ };
127
+ /**
128
+ * LayoutsApi - factory interface
129
+ * @export
130
+ */
131
+ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
132
+ /**
133
+ *
134
+ * @param {CreateLayoutRequestDto} createLayoutRequestDto
135
+ * @param {string} [authorization] Bearer Token
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
140
+ /**
141
+ *
142
+ * @param {number} id
143
+ * @param {string} [authorization] Bearer Token
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
148
+ /**
149
+ *
150
+ * @param {number} id
151
+ * @param {number} id2 Layout id
152
+ * @param {string} [authorization] Bearer Token
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
157
+ /**
158
+ *
159
+ * @param {string} [authorization] Bearer Token
160
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
161
+ * @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.
162
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
163
+ * @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.
164
+ * @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.
165
+ * @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.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListLayoutsResponseClass>;
170
+ /**
171
+ *
172
+ * @param {number} id
173
+ * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
174
+ * @param {string} [authorization] Bearer Token
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLayoutResponseClass>;
179
+ };
180
+ /**
181
+ * Request parameters for createLayout operation in LayoutsApi.
182
+ * @export
183
+ * @interface LayoutsApiCreateLayoutRequest
184
+ */
185
+ export interface LayoutsApiCreateLayoutRequest {
186
+ /**
187
+ *
188
+ * @type {CreateLayoutRequestDto}
189
+ * @memberof LayoutsApiCreateLayout
190
+ */
191
+ readonly createLayoutRequestDto: CreateLayoutRequestDto;
192
+ /**
193
+ * Bearer Token
194
+ * @type {string}
195
+ * @memberof LayoutsApiCreateLayout
196
+ */
197
+ readonly authorization?: string;
198
+ }
199
+ /**
200
+ * Request parameters for deleteLayout operation in LayoutsApi.
201
+ * @export
202
+ * @interface LayoutsApiDeleteLayoutRequest
203
+ */
204
+ export interface LayoutsApiDeleteLayoutRequest {
205
+ /**
206
+ *
207
+ * @type {number}
208
+ * @memberof LayoutsApiDeleteLayout
209
+ */
210
+ readonly id: number;
211
+ /**
212
+ * Bearer Token
213
+ * @type {string}
214
+ * @memberof LayoutsApiDeleteLayout
215
+ */
216
+ readonly authorization?: string;
217
+ }
218
+ /**
219
+ * Request parameters for getLayout operation in LayoutsApi.
220
+ * @export
221
+ * @interface LayoutsApiGetLayoutRequest
222
+ */
223
+ export interface LayoutsApiGetLayoutRequest {
224
+ /**
225
+ *
226
+ * @type {number}
227
+ * @memberof LayoutsApiGetLayout
228
+ */
229
+ readonly id: number;
230
+ /**
231
+ * Layout id
232
+ * @type {number}
233
+ * @memberof LayoutsApiGetLayout
234
+ */
235
+ readonly id2: number;
236
+ /**
237
+ * Bearer Token
238
+ * @type {string}
239
+ * @memberof LayoutsApiGetLayout
240
+ */
241
+ readonly authorization?: string;
242
+ }
243
+ /**
244
+ * Request parameters for listLayouts operation in LayoutsApi.
245
+ * @export
246
+ * @interface LayoutsApiListLayoutsRequest
247
+ */
248
+ export interface LayoutsApiListLayoutsRequest {
249
+ /**
250
+ * Bearer Token
251
+ * @type {string}
252
+ * @memberof LayoutsApiListLayouts
253
+ */
254
+ readonly authorization?: string;
255
+ /**
256
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
257
+ * @type {any}
258
+ * @memberof LayoutsApiListLayouts
259
+ */
260
+ readonly pageSize?: any;
261
+ /**
262
+ * 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.
263
+ * @type {any}
264
+ * @memberof LayoutsApiListLayouts
265
+ */
266
+ readonly pageToken?: any;
267
+ /**
268
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
269
+ * @type {any}
270
+ * @memberof LayoutsApiListLayouts
271
+ */
272
+ readonly filter?: any;
273
+ /**
274
+ * 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.
275
+ * @type {any}
276
+ * @memberof LayoutsApiListLayouts
277
+ */
278
+ readonly search?: any;
279
+ /**
280
+ * 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.
281
+ * @type {any}
282
+ * @memberof LayoutsApiListLayouts
283
+ */
284
+ readonly order?: any;
285
+ /**
286
+ * 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.
287
+ * @type {any}
288
+ * @memberof LayoutsApiListLayouts
289
+ */
290
+ readonly expand?: any;
291
+ }
292
+ /**
293
+ * Request parameters for updateLayout operation in LayoutsApi.
294
+ * @export
295
+ * @interface LayoutsApiUpdateLayoutRequest
296
+ */
297
+ export interface LayoutsApiUpdateLayoutRequest {
298
+ /**
299
+ *
300
+ * @type {number}
301
+ * @memberof LayoutsApiUpdateLayout
302
+ */
303
+ readonly id: number;
304
+ /**
305
+ *
306
+ * @type {UpdateLayoutRequestDto}
307
+ * @memberof LayoutsApiUpdateLayout
308
+ */
309
+ readonly updateLayoutRequestDto: UpdateLayoutRequestDto;
310
+ /**
311
+ * Bearer Token
312
+ * @type {string}
313
+ * @memberof LayoutsApiUpdateLayout
314
+ */
315
+ readonly authorization?: string;
316
+ }
317
+ /**
318
+ * LayoutsApi - object-oriented interface
319
+ * @export
320
+ * @class LayoutsApi
321
+ * @extends {BaseAPI}
322
+ */
323
+ export declare class LayoutsApi extends BaseAPI {
324
+ /**
325
+ *
326
+ * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ * @memberof LayoutsApi
330
+ */
331
+ createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
332
+ /**
333
+ *
334
+ * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
335
+ * @param {*} [options] Override http request option.
336
+ * @throws {RequiredError}
337
+ * @memberof LayoutsApi
338
+ */
339
+ deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
340
+ /**
341
+ *
342
+ * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ * @memberof LayoutsApi
346
+ */
347
+ getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
348
+ /**
349
+ *
350
+ * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
351
+ * @param {*} [options] Override http request option.
352
+ * @throws {RequiredError}
353
+ * @memberof LayoutsApi
354
+ */
355
+ listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
356
+ /**
357
+ *
358
+ * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
359
+ * @param {*} [options] Override http request option.
360
+ * @throws {RequiredError}
361
+ * @memberof LayoutsApi
362
+ */
363
+ updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLayoutResponseClass, any>>;
364
+ }