@emilgroup/notification-sdk-node 1.3.0 → 1.4.1-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 (43) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +2 -2
  3. package/api/default-api.ts +8 -4
  4. package/api/email-verifications-api.ts +8 -8
  5. package/api/layouts-api.ts +71 -71
  6. package/api/notification-templates-api.ts +71 -71
  7. package/api/notifications-api.ts +4 -4
  8. package/base.ts +55 -20
  9. package/common.ts +2 -2
  10. package/configuration.ts +9 -0
  11. package/dist/api/default-api.d.ts +8 -4
  12. package/dist/api/default-api.js +8 -4
  13. package/dist/api/email-verifications-api.d.ts +8 -8
  14. package/dist/api/email-verifications-api.js +8 -8
  15. package/dist/api/layouts-api.d.ts +64 -64
  16. package/dist/api/layouts-api.js +50 -50
  17. package/dist/api/notification-templates-api.d.ts +64 -64
  18. package/dist/api/notification-templates-api.js +50 -50
  19. package/dist/api/notifications-api.d.ts +4 -4
  20. package/dist/api/notifications-api.js +4 -4
  21. package/dist/base.d.ts +13 -5
  22. package/dist/base.js +64 -30
  23. package/dist/common.js +2 -2
  24. package/dist/configuration.d.ts +6 -0
  25. package/dist/configuration.js +8 -0
  26. package/dist/models/html-template-class.d.ts +0 -6
  27. package/dist/models/index.d.ts +1 -0
  28. package/dist/models/index.js +1 -0
  29. package/dist/models/initiate-email-verification-dto.d.ts +1 -1
  30. package/dist/models/inline-response200.d.ts +6 -6
  31. package/dist/models/inline-response503.d.ts +6 -6
  32. package/dist/models/s3-document-dto.d.ts +36 -0
  33. package/dist/models/s3-document-dto.js +15 -0
  34. package/dist/models/send-notification-request-dto.d.ts +3 -2
  35. package/models/html-template-class.ts +0 -6
  36. package/models/index.ts +1 -0
  37. package/models/initiate-email-verification-dto.ts +1 -1
  38. package/models/inline-response200.ts +6 -6
  39. package/models/inline-response503.ts +6 -6
  40. package/models/s3-document-dto.ts +42 -0
  41. package/models/send-notification-request-dto.ts +3 -2
  42. package/package.json +1 -1
  43. package/tsconfig.json +1 -0
@@ -35,6 +35,7 @@ models/layout-class.ts
35
35
  models/list-layouts-response-class.ts
36
36
  models/list-notification-templates-response-class.ts
37
37
  models/notification-template-class.ts
38
+ models/s3-document-dto.ts
38
39
  models/send-notification-request-dto.ts
39
40
  models/send-notification-response-class.ts
40
41
  models/update-html-template-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk-node@1.3.0 --save
20
+ npm install @emilgroup/notification-sdk-node@1.4.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk-node@1.3.0
24
+ yarn add @emilgroup/notification-sdk-node@1.4.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `LayoutApi`.
@@ -35,7 +35,8 @@ const FormData = require('form-data');
35
35
  export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- *
38
+ * Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
39
+ * @summary Health Check
39
40
  * @param {*} [options] Override http request option.
40
41
  * @throws {RequiredError}
41
42
  */
@@ -76,7 +77,8 @@ export const DefaultApiFp = function(configuration?: Configuration) {
76
77
  const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
77
78
  return {
78
79
  /**
79
- *
80
+ * Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
81
+ * @summary Health Check
80
82
  * @param {*} [options] Override http request option.
81
83
  * @throws {RequiredError}
82
84
  */
@@ -95,7 +97,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
95
97
  const localVarFp = DefaultApiFp(configuration)
96
98
  return {
97
99
  /**
98
- *
100
+ * Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
101
+ * @summary Health Check
99
102
  * @param {*} [options] Override http request option.
100
103
  * @throws {RequiredError}
101
104
  */
@@ -113,7 +116,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
113
116
  */
114
117
  export class DefaultApi extends BaseAPI {
115
118
  /**
116
- *
119
+ * Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
120
+ * @summary Health Check
117
121
  * @param {*} [options] Override http request option.
118
122
  * @throws {RequiredError}
119
123
  * @memberof DefaultApi
@@ -39,7 +39,7 @@ const FormData = require('form-data');
39
39
  export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- *
42
+ * undefined **Required Permissions** none
43
43
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
44
44
  * @param {string} [authorization] Bearer Token
45
45
  * @param {*} [options] Override http request option.
@@ -85,7 +85,7 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
85
85
  };
86
86
  },
87
87
  /**
88
- *
88
+ * undefined **Required Permissions** none
89
89
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
90
90
  * @param {string} [authorization] Bearer Token
91
91
  * @param {*} [options] Override http request option.
@@ -141,7 +141,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
141
141
  const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
142
142
  return {
143
143
  /**
144
- *
144
+ * undefined **Required Permissions** none
145
145
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
146
146
  * @param {string} [authorization] Bearer Token
147
147
  * @param {*} [options] Override http request option.
@@ -152,7 +152,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
152
152
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
153
153
  },
154
154
  /**
155
- *
155
+ * undefined **Required Permissions** none
156
156
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
157
157
  * @param {string} [authorization] Bearer Token
158
158
  * @param {*} [options] Override http request option.
@@ -173,7 +173,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
173
173
  const localVarFp = EmailVerificationsApiFp(configuration)
174
174
  return {
175
175
  /**
176
- *
176
+ * undefined **Required Permissions** none
177
177
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
178
178
  * @param {string} [authorization] Bearer Token
179
179
  * @param {*} [options] Override http request option.
@@ -183,7 +183,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
183
183
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
184
184
  },
185
185
  /**
186
- *
186
+ * undefined **Required Permissions** none
187
187
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
188
188
  * @param {string} [authorization] Bearer Token
189
189
  * @param {*} [options] Override http request option.
@@ -245,7 +245,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
245
245
  */
246
246
  export class EmailVerificationsApi extends BaseAPI {
247
247
  /**
248
- *
248
+ * undefined **Required Permissions** none
249
249
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
250
250
  * @param {*} [options] Override http request option.
251
251
  * @throws {RequiredError}
@@ -256,7 +256,7 @@ export class EmailVerificationsApi extends BaseAPI {
256
256
  }
257
257
 
258
258
  /**
259
- *
259
+ * undefined **Required Permissions** none
260
260
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
@@ -43,7 +43,7 @@ const FormData = require('form-data');
43
43
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- *
46
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
47
47
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
48
48
  * @param {string} [authorization] Bearer Token
49
49
  * @param {*} [options] Override http request option.
@@ -89,7 +89,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
89
89
  };
90
90
  },
91
91
  /**
92
- *
92
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
93
93
  * @param {number} id
94
94
  * @param {string} [authorization] Bearer Token
95
95
  * @param {*} [options] Override http request option.
@@ -133,7 +133,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
133
133
  };
134
134
  },
135
135
  /**
136
- *
136
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
137
137
  * @param {number} id
138
138
  * @param {number} id2 Layout id
139
139
  * @param {string} [authorization] Bearer Token
@@ -184,19 +184,19 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
184
184
  };
185
185
  },
186
186
  /**
187
- *
187
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
188
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=1, your subsequent call can include pageToken=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} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
193
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
194
- * @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.
195
- * @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.
189
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
+ * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
191
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
+ * @param {string} [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 {string} [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 {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
199
- listLayouts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, filters?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listLayouts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
200
  const localVarPath = `/notificationservice/v1/layouts`;
201
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -227,10 +227,6 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
227
227
  localVarQueryParameter['filter'] = filter;
228
228
  }
229
229
 
230
- if (filters !== undefined) {
231
- localVarQueryParameter['filters'] = filters;
232
- }
233
-
234
230
  if (search !== undefined) {
235
231
  localVarQueryParameter['search'] = search;
236
232
  }
@@ -243,6 +239,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
243
239
  localVarQueryParameter['expand'] = expand;
244
240
  }
245
241
 
242
+ if (filters !== undefined) {
243
+ localVarQueryParameter['filters'] = filters;
244
+ }
245
+
246
246
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
247
247
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
248
248
  }
@@ -259,7 +259,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
259
259
  };
260
260
  },
261
261
  /**
262
- *
262
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
263
263
  * @param {number} id
264
264
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
265
265
  * @param {string} [authorization] Bearer Token
@@ -319,7 +319,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
319
319
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
320
320
  return {
321
321
  /**
322
- *
322
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
323
323
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
324
324
  * @param {string} [authorization] Bearer Token
325
325
  * @param {*} [options] Override http request option.
@@ -330,7 +330,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
330
330
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
331
331
  },
332
332
  /**
333
- *
333
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
334
334
  * @param {number} id
335
335
  * @param {string} [authorization] Bearer Token
336
336
  * @param {*} [options] Override http request option.
@@ -341,7 +341,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
341
341
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
342
342
  },
343
343
  /**
344
- *
344
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
345
345
  * @param {number} id
346
346
  * @param {number} id2 Layout id
347
347
  * @param {string} [authorization] Bearer Token
@@ -353,24 +353,24 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
353
353
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
354
  },
355
355
  /**
356
- *
356
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
357
357
  * @param {string} [authorization] Bearer Token
358
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
359
- * @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.
360
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
361
- * @param {any} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
362
- * @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.
363
- * @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.
364
- * @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.
358
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
359
+ * @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.
360
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
361
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
362
+ * @param {string} [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.
363
+ * @param {string} [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.
364
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
365
365
  * @param {*} [options] Override http request option.
366
366
  * @throws {RequiredError}
367
367
  */
368
- async listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, filters?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>> {
369
- const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, filters, search, order, expand, options);
368
+ async listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>> {
369
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
370
370
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
371
371
  },
372
372
  /**
373
- *
373
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
374
374
  * @param {number} id
375
375
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
376
376
  * @param {string} [authorization] Bearer Token
@@ -392,7 +392,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
392
392
  const localVarFp = LayoutsApiFp(configuration)
393
393
  return {
394
394
  /**
395
- *
395
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
396
396
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
397
397
  * @param {string} [authorization] Bearer Token
398
398
  * @param {*} [options] Override http request option.
@@ -402,7 +402,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
402
402
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
403
403
  },
404
404
  /**
405
- *
405
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
406
406
  * @param {number} id
407
407
  * @param {string} [authorization] Bearer Token
408
408
  * @param {*} [options] Override http request option.
@@ -412,7 +412,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
412
412
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
413
413
  },
414
414
  /**
415
- *
415
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
416
416
  * @param {number} id
417
417
  * @param {number} id2 Layout id
418
418
  * @param {string} [authorization] Bearer Token
@@ -423,23 +423,23 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
423
423
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
424
424
  },
425
425
  /**
426
- *
426
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
427
427
  * @param {string} [authorization] Bearer Token
428
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
429
- * @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.
430
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
431
- * @param {any} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
432
- * @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.
433
- * @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.
434
- * @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 {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
429
+ * @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.
430
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
431
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
432
+ * @param {string} [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.
433
+ * @param {string} [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.
434
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
435
435
  * @param {*} [options] Override http request option.
436
436
  * @throws {RequiredError}
437
437
  */
438
- listLayouts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, filters?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListLayoutsResponseClass> {
439
- return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
438
+ listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass> {
439
+ return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
440
440
  },
441
441
  /**
442
- *
442
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
443
443
  * @param {number} id
444
444
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
445
445
  * @param {string} [authorization] Bearer Token
@@ -536,53 +536,53 @@ export interface LayoutsApiListLayoutsRequest {
536
536
  readonly authorization?: string
537
537
 
538
538
  /**
539
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
540
- * @type {any}
539
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
540
+ * @type {number}
541
541
  * @memberof LayoutsApiListLayouts
542
542
  */
543
- readonly pageSize?: any
543
+ readonly pageSize?: number
544
544
 
545
545
  /**
546
- * 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.
547
- * @type {any}
546
+ * 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.
547
+ * @type {string}
548
548
  * @memberof LayoutsApiListLayouts
549
549
  */
550
- readonly pageToken?: any
550
+ readonly pageToken?: string
551
551
 
552
552
  /**
553
553
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
554
- * @type {any}
554
+ * @type {string}
555
555
  * @memberof LayoutsApiListLayouts
556
556
  */
557
- readonly filter?: any
557
+ readonly filter?: string
558
558
 
559
559
  /**
560
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
561
- * @type {any}
560
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
561
+ * @type {string}
562
562
  * @memberof LayoutsApiListLayouts
563
563
  */
564
- readonly filters?: any
564
+ readonly search?: string
565
565
 
566
566
  /**
567
- * 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.
568
- * @type {any}
567
+ * 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.
568
+ * @type {string}
569
569
  * @memberof LayoutsApiListLayouts
570
570
  */
571
- readonly search?: any
571
+ readonly order?: string
572
572
 
573
573
  /**
574
- * 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.
575
- * @type {any}
574
+ * 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.
575
+ * @type {string}
576
576
  * @memberof LayoutsApiListLayouts
577
577
  */
578
- readonly order?: any
578
+ readonly expand?: string
579
579
 
580
580
  /**
581
- * 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.
582
- * @type {any}
581
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
582
+ * @type {string}
583
583
  * @memberof LayoutsApiListLayouts
584
584
  */
585
- readonly expand?: any
585
+ readonly filters?: string
586
586
  }
587
587
 
588
588
  /**
@@ -621,7 +621,7 @@ export interface LayoutsApiUpdateLayoutRequest {
621
621
  */
622
622
  export class LayoutsApi extends BaseAPI {
623
623
  /**
624
- *
624
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
625
625
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
626
626
  * @param {*} [options] Override http request option.
627
627
  * @throws {RequiredError}
@@ -632,7 +632,7 @@ export class LayoutsApi extends BaseAPI {
632
632
  }
633
633
 
634
634
  /**
635
- *
635
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
636
636
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
637
637
  * @param {*} [options] Override http request option.
638
638
  * @throws {RequiredError}
@@ -643,7 +643,7 @@ export class LayoutsApi extends BaseAPI {
643
643
  }
644
644
 
645
645
  /**
646
- *
646
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
647
647
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
648
648
  * @param {*} [options] Override http request option.
649
649
  * @throws {RequiredError}
@@ -654,18 +654,18 @@ export class LayoutsApi extends BaseAPI {
654
654
  }
655
655
 
656
656
  /**
657
- *
657
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
658
658
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
659
659
  * @param {*} [options] Override http request option.
660
660
  * @throws {RequiredError}
661
661
  * @memberof LayoutsApi
662
662
  */
663
663
  public listLayouts(requestParameters: LayoutsApiListLayoutsRequest = {}, options?: AxiosRequestConfig) {
664
- return LayoutsApiFp(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
664
+ return LayoutsApiFp(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
665
665
  }
666
666
 
667
667
  /**
668
- *
668
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
669
669
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
670
670
  * @param {*} [options] Override http request option.
671
671
  * @throws {RequiredError}