@emilgroup/notification-sdk 0.8.1-beta.49 → 0.8.1-beta.5

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 (101) hide show
  1. package/.openapi-generator/FILES +0 -20
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +28 -40
  4. package/api/email-tracking-api.ts +40 -271
  5. package/api/email-verifications-api.ts +8 -16
  6. package/api/layouts-api.ts +36 -56
  7. package/api/notification-templates-api.ts +36 -56
  8. package/api/notifications-api.ts +4 -115
  9. package/api.ts +0 -6
  10. package/base.ts +15 -36
  11. package/configuration.ts +0 -11
  12. package/dist/api/email-messages-api.d.ts +28 -40
  13. package/dist/api/email-messages-api.js +25 -37
  14. package/dist/api/email-tracking-api.d.ts +40 -170
  15. package/dist/api/email-tracking-api.js +34 -233
  16. package/dist/api/email-verifications-api.d.ts +8 -16
  17. package/dist/api/email-verifications-api.js +8 -16
  18. package/dist/api/layouts-api.d.ts +36 -56
  19. package/dist/api/layouts-api.js +32 -52
  20. package/dist/api/notification-templates-api.d.ts +36 -56
  21. package/dist/api/notification-templates-api.js +32 -52
  22. package/dist/api/notifications-api.d.ts +4 -65
  23. package/dist/api/notifications-api.js +4 -101
  24. package/dist/api.d.ts +0 -3
  25. package/dist/api.js +0 -3
  26. package/dist/base.d.ts +0 -1
  27. package/dist/base.js +16 -36
  28. package/dist/configuration.d.ts +0 -9
  29. package/dist/configuration.js +0 -1
  30. package/dist/models/email-message-class.d.ts +7 -73
  31. package/dist/models/email-message-class.js +3 -22
  32. package/dist/models/email-thread-class.d.ts +5 -37
  33. package/dist/models/index.d.ts +0 -17
  34. package/dist/models/index.js +0 -17
  35. package/dist/models/send-notification-request-dto.d.ts +1 -10
  36. package/dist/models/send-notification-request-dto.js +1 -2
  37. package/models/email-message-class.ts +8 -78
  38. package/models/email-thread-class.ts +5 -37
  39. package/models/index.ts +0 -17
  40. package/models/send-notification-request-dto.ts +2 -9
  41. package/package.json +1 -1
  42. package/api/email-mailboxes-api.ts +0 -148
  43. package/api/email-subscriptions-api.ts +0 -559
  44. package/api/msgraph-webhooks-api.ts +0 -278
  45. package/dist/api/email-mailboxes-api.d.ts +0 -87
  46. package/dist/api/email-mailboxes-api.js +0 -218
  47. package/dist/api/email-subscriptions-api.d.ts +0 -319
  48. package/dist/api/email-subscriptions-api.js +0 -537
  49. package/dist/api/msgraph-webhooks-api.d.ts +0 -168
  50. package/dist/api/msgraph-webhooks-api.js +0 -305
  51. package/dist/models/assign-email-thread-entity-body-dto.d.ts +0 -43
  52. package/dist/models/assign-email-thread-entity-body-dto.js +0 -22
  53. package/dist/models/assign-email-thread-entity-response-class.d.ts +0 -25
  54. package/dist/models/assign-email-thread-entity-response-class.js +0 -15
  55. package/dist/models/email-mailbox-class.d.ts +0 -47
  56. package/dist/models/email-mailbox-class.js +0 -20
  57. package/dist/models/email-message-summary-class.d.ts +0 -98
  58. package/dist/models/email-message-summary-class.js +0 -33
  59. package/dist/models/email-subscription-class.d.ts +0 -104
  60. package/dist/models/email-subscription-class.js +0 -23
  61. package/dist/models/entity-ref-class.d.ts +0 -37
  62. package/dist/models/entity-ref-class.js +0 -22
  63. package/dist/models/get-email-subscription-response-class.d.ts +0 -25
  64. package/dist/models/get-email-subscription-response-class.js +0 -15
  65. package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
  66. package/dist/models/grpc-send-email-request-dto.js +0 -22
  67. package/dist/models/inline-attachment-dto.d.ts +0 -36
  68. package/dist/models/inline-attachment-dto.js +0 -15
  69. package/dist/models/list-email-mailboxes-response-class.d.ts +0 -43
  70. package/dist/models/list-email-mailboxes-response-class.js +0 -15
  71. package/dist/models/list-email-subscriptions-response-class.d.ts +0 -43
  72. package/dist/models/list-email-subscriptions-response-class.js +0 -15
  73. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +0 -24
  74. package/dist/models/reconcile-email-subscriptions-request-dto.js +0 -15
  75. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +0 -48
  76. package/dist/models/reconcile-email-subscriptions-response-class.js +0 -15
  77. package/dist/models/renew-email-subscription-response-class.d.ts +0 -25
  78. package/dist/models/renew-email-subscription-response-class.js +0 -15
  79. package/dist/models/send-email-request-dto.d.ts +0 -131
  80. package/dist/models/send-email-request-dto.js +0 -22
  81. package/dist/models/send-email-response-class.d.ts +0 -24
  82. package/dist/models/send-email-response-class.js +0 -15
  83. package/dist/models/unassign-email-thread-entity-response-class.d.ts +0 -25
  84. package/dist/models/unassign-email-thread-entity-response-class.js +0 -15
  85. package/models/assign-email-thread-entity-body-dto.ts +0 -52
  86. package/models/assign-email-thread-entity-response-class.ts +0 -31
  87. package/models/email-mailbox-class.ts +0 -56
  88. package/models/email-message-summary-class.ts +0 -109
  89. package/models/email-subscription-class.ts +0 -113
  90. package/models/entity-ref-class.ts +0 -46
  91. package/models/get-email-subscription-response-class.ts +0 -31
  92. package/models/grpc-send-email-request-dto.ts +0 -144
  93. package/models/inline-attachment-dto.ts +0 -42
  94. package/models/list-email-mailboxes-response-class.ts +0 -49
  95. package/models/list-email-subscriptions-response-class.ts +0 -49
  96. package/models/reconcile-email-subscriptions-request-dto.ts +0 -30
  97. package/models/reconcile-email-subscriptions-response-class.ts +0 -54
  98. package/models/renew-email-subscription-response-class.ts +0 -31
  99. package/models/send-email-request-dto.ts +0 -138
  100. package/models/send-email-response-class.ts +0 -30
  101. package/models/unassign-email-thread-entity-response-class.ts +0 -31
@@ -35,8 +35,7 @@ import { InitiateEmailVerificationResponseClass } from '../models';
35
35
  export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
39
- * @summary Complete an email verification
38
+ * undefined **Required Permissions** none
40
39
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
41
40
  * @param {string} [authorization] Bearer Token
42
41
  * @param {*} [options] Override http request option.
@@ -82,8 +81,7 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
82
81
  };
83
82
  },
84
83
  /**
85
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
86
- * @summary Initiate an email verification
84
+ * undefined **Required Permissions** none
87
85
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
88
86
  * @param {string} [authorization] Bearer Token
89
87
  * @param {*} [options] Override http request option.
@@ -139,8 +137,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
139
137
  const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
140
138
  return {
141
139
  /**
142
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
143
- * @summary Complete an email verification
140
+ * undefined **Required Permissions** none
144
141
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
145
142
  * @param {string} [authorization] Bearer Token
146
143
  * @param {*} [options] Override http request option.
@@ -151,8 +148,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
151
148
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
152
149
  },
153
150
  /**
154
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
155
- * @summary Initiate an email verification
151
+ * undefined **Required Permissions** none
156
152
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
157
153
  * @param {string} [authorization] Bearer Token
158
154
  * @param {*} [options] Override http request option.
@@ -173,8 +169,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
173
169
  const localVarFp = EmailVerificationsApiFp(configuration)
174
170
  return {
175
171
  /**
176
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
177
- * @summary Complete an email verification
172
+ * undefined **Required Permissions** none
178
173
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
179
174
  * @param {string} [authorization] Bearer Token
180
175
  * @param {*} [options] Override http request option.
@@ -184,8 +179,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
184
179
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
185
180
  },
186
181
  /**
187
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
188
- * @summary Initiate an email verification
182
+ * undefined **Required Permissions** none
189
183
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
190
184
  * @param {string} [authorization] Bearer Token
191
185
  * @param {*} [options] Override http request option.
@@ -247,8 +241,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
247
241
  */
248
242
  export class EmailVerificationsApi extends BaseAPI {
249
243
  /**
250
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
251
- * @summary Complete an email verification
244
+ * undefined **Required Permissions** none
252
245
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
253
246
  * @param {*} [options] Override http request option.
254
247
  * @throws {RequiredError}
@@ -259,8 +252,7 @@ export class EmailVerificationsApi extends BaseAPI {
259
252
  }
260
253
 
261
254
  /**
262
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
263
- * @summary Initiate an email verification
255
+ * undefined **Required Permissions** none
264
256
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
265
257
  * @param {*} [options] Override http request option.
266
258
  * @throws {RequiredError}
@@ -39,8 +39,7 @@ import { UpdateLayoutResponseClass } from '../models';
39
39
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
43
- * @summary Create the layout
42
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
44
43
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
45
44
  * @param {string} [authorization] Bearer Token
46
45
  * @param {*} [options] Override http request option.
@@ -86,8 +85,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
86
85
  };
87
86
  },
88
87
  /**
89
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
- * @summary Delete the layout
88
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
91
89
  * @param {number} id
92
90
  * @param {string} [authorization] Bearer Token
93
91
  * @param {*} [options] Override http request option.
@@ -131,8 +129,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
131
129
  };
132
130
  },
133
131
  /**
134
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
- * @summary Retrieve the layout
132
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
136
133
  * @param {number} id
137
134
  * @param {number} id2 Layout id
138
135
  * @param {string} [authorization] Bearer Token
@@ -183,16 +180,15 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
183
180
  };
184
181
  },
185
182
  /**
186
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
187
- * @summary List layouts
183
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
188
184
  * @param {string} [authorization] Bearer Token
189
185
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
186
  * @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.<br/> <br/> <i>Allowed values: id, name, slug</i>
187
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
188
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
194
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
195
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
189
+ * @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.
190
+ * @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.
191
+ * @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
192
  * @param {*} [options] Override http request option.
197
193
  * @throws {RequiredError}
198
194
  */
@@ -259,8 +255,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
259
255
  };
260
256
  },
261
257
  /**
262
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
263
- * @summary Update the layout
258
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
264
259
  * @param {number} id
265
260
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
266
261
  * @param {string} [authorization] Bearer Token
@@ -320,8 +315,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
320
315
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
321
316
  return {
322
317
  /**
323
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
324
- * @summary Create the layout
318
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
325
319
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
326
320
  * @param {string} [authorization] Bearer Token
327
321
  * @param {*} [options] Override http request option.
@@ -332,8 +326,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
332
326
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
333
327
  },
334
328
  /**
335
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
336
- * @summary Delete the layout
329
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
337
330
  * @param {number} id
338
331
  * @param {string} [authorization] Bearer Token
339
332
  * @param {*} [options] Override http request option.
@@ -344,8 +337,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
344
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
345
338
  },
346
339
  /**
347
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
348
- * @summary Retrieve the layout
340
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
349
341
  * @param {number} id
350
342
  * @param {number} id2 Layout id
351
343
  * @param {string} [authorization] Bearer Token
@@ -357,16 +349,15 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
357
349
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
350
  },
359
351
  /**
360
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
361
- * @summary List layouts
352
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
362
353
  * @param {string} [authorization] Bearer Token
363
354
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
355
  * @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.
365
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
356
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
366
357
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
367
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
368
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
369
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
358
+ * @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.
359
+ * @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.
360
+ * @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.
370
361
  * @param {*} [options] Override http request option.
371
362
  * @throws {RequiredError}
372
363
  */
@@ -375,8 +366,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
375
366
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
367
  },
377
368
  /**
378
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
379
- * @summary Update the layout
369
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
380
370
  * @param {number} id
381
371
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
382
372
  * @param {string} [authorization] Bearer Token
@@ -398,8 +388,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
398
388
  const localVarFp = LayoutsApiFp(configuration)
399
389
  return {
400
390
  /**
401
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
402
- * @summary Create the layout
391
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
403
392
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
404
393
  * @param {string} [authorization] Bearer Token
405
394
  * @param {*} [options] Override http request option.
@@ -409,8 +398,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
409
398
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
410
399
  },
411
400
  /**
412
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
413
- * @summary Delete the layout
401
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
414
402
  * @param {number} id
415
403
  * @param {string} [authorization] Bearer Token
416
404
  * @param {*} [options] Override http request option.
@@ -420,8 +408,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
420
408
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
421
409
  },
422
410
  /**
423
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
424
- * @summary Retrieve the layout
411
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
425
412
  * @param {number} id
426
413
  * @param {number} id2 Layout id
427
414
  * @param {string} [authorization] Bearer Token
@@ -432,16 +419,15 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
432
419
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
433
420
  },
434
421
  /**
435
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
436
- * @summary List layouts
422
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
437
423
  * @param {string} [authorization] Bearer Token
438
424
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
425
  * @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.
440
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
426
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
441
427
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
442
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
443
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
444
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
428
+ * @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.
429
+ * @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.
430
+ * @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.
445
431
  * @param {*} [options] Override http request option.
446
432
  * @throws {RequiredError}
447
433
  */
@@ -449,8 +435,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
449
435
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
450
436
  },
451
437
  /**
452
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
453
- * @summary Update the layout
438
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
454
439
  * @param {number} id
455
440
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
456
441
  * @param {string} [authorization] Bearer Token
@@ -561,7 +546,7 @@ export interface LayoutsApiListLayoutsRequest {
561
546
  readonly pageToken?: string
562
547
 
563
548
  /**
564
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, name, slug</i>
549
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
565
550
  * @type {string}
566
551
  * @memberof LayoutsApiListLayouts
567
552
  */
@@ -575,21 +560,21 @@ export interface LayoutsApiListLayoutsRequest {
575
560
  readonly search?: string
576
561
 
577
562
  /**
578
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
563
+ * 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.
579
564
  * @type {string}
580
565
  * @memberof LayoutsApiListLayouts
581
566
  */
582
567
  readonly order?: string
583
568
 
584
569
  /**
585
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: headerTemplate, footerTemplate<i>
570
+ * 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.
586
571
  * @type {string}
587
572
  * @memberof LayoutsApiListLayouts
588
573
  */
589
574
  readonly expand?: string
590
575
 
591
576
  /**
592
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, name, slug</i>
577
+ * 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.
593
578
  * @type {string}
594
579
  * @memberof LayoutsApiListLayouts
595
580
  */
@@ -632,8 +617,7 @@ export interface LayoutsApiUpdateLayoutRequest {
632
617
  */
633
618
  export class LayoutsApi extends BaseAPI {
634
619
  /**
635
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
636
- * @summary Create the layout
620
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
637
621
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
638
622
  * @param {*} [options] Override http request option.
639
623
  * @throws {RequiredError}
@@ -644,8 +628,7 @@ export class LayoutsApi extends BaseAPI {
644
628
  }
645
629
 
646
630
  /**
647
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
648
- * @summary Delete the layout
631
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
649
632
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
650
633
  * @param {*} [options] Override http request option.
651
634
  * @throws {RequiredError}
@@ -656,8 +639,7 @@ export class LayoutsApi extends BaseAPI {
656
639
  }
657
640
 
658
641
  /**
659
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
660
- * @summary Retrieve the layout
642
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
661
643
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
662
644
  * @param {*} [options] Override http request option.
663
645
  * @throws {RequiredError}
@@ -668,8 +650,7 @@ export class LayoutsApi extends BaseAPI {
668
650
  }
669
651
 
670
652
  /**
671
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
672
- * @summary List layouts
653
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
673
654
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
674
655
  * @param {*} [options] Override http request option.
675
656
  * @throws {RequiredError}
@@ -680,8 +661,7 @@ export class LayoutsApi extends BaseAPI {
680
661
  }
681
662
 
682
663
  /**
683
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
684
- * @summary Update the layout
664
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
685
665
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
686
666
  * @param {*} [options] Override http request option.
687
667
  * @throws {RequiredError}