@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.4

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 (57) hide show
  1. package/.openapi-generator/FILES +0 -8
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +24 -259
  4. package/api/email-tracking-api.ts +24 -32
  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 -2
  10. package/dist/api/email-messages-api.d.ts +24 -158
  11. package/dist/api/email-messages-api.js +22 -225
  12. package/dist/api/email-tracking-api.d.ts +24 -32
  13. package/dist/api/email-tracking-api.js +22 -30
  14. package/dist/api/email-verifications-api.d.ts +8 -16
  15. package/dist/api/email-verifications-api.js +8 -16
  16. package/dist/api/layouts-api.d.ts +36 -56
  17. package/dist/api/layouts-api.js +32 -52
  18. package/dist/api/notification-templates-api.d.ts +36 -56
  19. package/dist/api/notification-templates-api.js +32 -52
  20. package/dist/api/notifications-api.d.ts +4 -65
  21. package/dist/api/notifications-api.js +4 -101
  22. package/dist/api.d.ts +0 -1
  23. package/dist/api.js +0 -1
  24. package/dist/models/email-message-class.d.ts +2 -49
  25. package/dist/models/email-message-class.js +2 -16
  26. package/dist/models/index.d.ts +0 -7
  27. package/dist/models/index.js +0 -7
  28. package/dist/models/send-notification-request-dto.d.ts +0 -9
  29. package/dist/models/send-notification-request-dto.js +1 -2
  30. package/models/email-message-class.ts +3 -53
  31. package/models/index.ts +0 -7
  32. package/models/send-notification-request-dto.ts +1 -8
  33. package/package.json +1 -1
  34. package/api/msgraph-webhooks-api.ts +0 -278
  35. package/dist/api/msgraph-webhooks-api.d.ts +0 -168
  36. package/dist/api/msgraph-webhooks-api.js +0 -305
  37. package/dist/models/assign-email-message-entity-body-dto.d.ts +0 -43
  38. package/dist/models/assign-email-message-entity-body-dto.js +0 -22
  39. package/dist/models/assign-email-message-entity-response-class.d.ts +0 -25
  40. package/dist/models/assign-email-message-entity-response-class.js +0 -15
  41. package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
  42. package/dist/models/grpc-send-email-request-dto.js +0 -22
  43. package/dist/models/inline-attachment-dto.d.ts +0 -36
  44. package/dist/models/inline-attachment-dto.js +0 -15
  45. package/dist/models/send-email-request-dto.d.ts +0 -131
  46. package/dist/models/send-email-request-dto.js +0 -22
  47. package/dist/models/send-email-response-class.d.ts +0 -24
  48. package/dist/models/send-email-response-class.js +0 -15
  49. package/dist/models/unassign-email-message-entity-response-class.d.ts +0 -25
  50. package/dist/models/unassign-email-message-entity-response-class.js +0 -15
  51. package/models/assign-email-message-entity-body-dto.ts +0 -52
  52. package/models/assign-email-message-entity-response-class.ts +0 -31
  53. package/models/grpc-send-email-request-dto.ts +0 -144
  54. package/models/inline-attachment-dto.ts +0 -42
  55. package/models/send-email-request-dto.ts +0 -138
  56. package/models/send-email-response-class.ts +0 -30
  57. package/models/unassign-email-message-entity-response-class.ts +0 -31
@@ -93,8 +93,7 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
97
- * @summary Close the email thread
96
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
98
97
  * @param {string} code
99
98
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
100
99
  * @param {*} [options] Override http request option.
@@ -141,8 +140,7 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
141
140
  });
142
141
  },
143
142
  /**
144
- * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
145
- * @summary Retrieve the email thread
143
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
146
144
  * @param {string} code
147
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
148
146
  * @param {*} [options] Override http request option.
@@ -189,12 +187,12 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
189
187
  });
190
188
  },
191
189
  /**
192
- * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
190
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
193
191
  * @summary List email messages
194
192
  * @param {string} code
195
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
196
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
197
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
194
+ * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
198
196
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
199
197
  * @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: attachments<i>
200
198
  * @param {*} [options] Override http request option.
@@ -253,7 +251,7 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
253
251
  });
254
252
  },
255
253
  /**
256
- * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
254
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
257
255
  * @summary List email threads
258
256
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
259
257
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -335,8 +333,7 @@ var EmailTrackingApiFp = function (configuration) {
335
333
  var localVarAxiosParamCreator = (0, exports.EmailTrackingApiAxiosParamCreator)(configuration);
336
334
  return {
337
335
  /**
338
- * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
339
- * @summary Close the email thread
336
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
340
337
  * @param {string} code
341
338
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
342
339
  * @param {*} [options] Override http request option.
@@ -356,8 +353,7 @@ var EmailTrackingApiFp = function (configuration) {
356
353
  });
357
354
  },
358
355
  /**
359
- * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
360
- * @summary Retrieve the email thread
356
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
361
357
  * @param {string} code
362
358
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
359
  * @param {*} [options] Override http request option.
@@ -377,12 +373,12 @@ var EmailTrackingApiFp = function (configuration) {
377
373
  });
378
374
  },
379
375
  /**
380
- * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
376
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
381
377
  * @summary List email messages
382
378
  * @param {string} code
383
379
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
384
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
385
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
380
+ * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
381
+ * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
386
382
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
387
383
  * @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: attachments<i>
388
384
  * @param {*} [options] Override http request option.
@@ -402,7 +398,7 @@ var EmailTrackingApiFp = function (configuration) {
402
398
  });
403
399
  },
404
400
  /**
405
- * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
401
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
406
402
  * @summary List email threads
407
403
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
408
404
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -439,8 +435,7 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
439
435
  var localVarFp = (0, exports.EmailTrackingApiFp)(configuration);
440
436
  return {
441
437
  /**
442
- * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
443
- * @summary Close the email thread
438
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
444
439
  * @param {string} code
445
440
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
446
441
  * @param {*} [options] Override http request option.
@@ -450,8 +445,7 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
450
445
  return localVarFp.closeThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
451
446
  },
452
447
  /**
453
- * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
454
- * @summary Retrieve the email thread
448
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
455
449
  * @param {string} code
456
450
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
457
451
  * @param {*} [options] Override http request option.
@@ -461,12 +455,12 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
461
455
  return localVarFp.getThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
462
456
  },
463
457
  /**
464
- * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
458
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
465
459
  * @summary List email messages
466
460
  * @param {string} code
467
461
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
468
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
469
- * @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, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
462
+ * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
463
+ * @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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
470
464
  * @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, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
471
465
  * @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: attachments<i>
472
466
  * @param {*} [options] Override http request option.
@@ -476,7 +470,7 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
476
470
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
477
471
  },
478
472
  /**
479
- * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
473
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
480
474
  * @summary List email threads
481
475
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
482
476
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -507,8 +501,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
507
501
  return _super !== null && _super.apply(this, arguments) || this;
508
502
  }
509
503
  /**
510
- * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
511
- * @summary Close the email thread
504
+ * undefined **Required Permissions** \"notification-management.email-messages.update\"
512
505
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
513
506
  * @param {*} [options] Override http request option.
514
507
  * @throws {RequiredError}
@@ -519,8 +512,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
519
512
  return (0, exports.EmailTrackingApiFp)(this.configuration).closeThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
520
513
  };
521
514
  /**
522
- * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
523
- * @summary Retrieve the email thread
515
+ * undefined **Required Permissions** \"notification-management.email-messages.view\"
524
516
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
525
517
  * @param {*} [options] Override http request option.
526
518
  * @throws {RequiredError}
@@ -531,7 +523,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
531
523
  return (0, exports.EmailTrackingApiFp)(this.configuration).getThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
532
524
  };
533
525
  /**
534
- * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
526
+ * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
535
527
  * @summary List email messages
536
528
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
537
529
  * @param {*} [options] Override http request option.
@@ -543,7 +535,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
543
535
  return (0, exports.EmailTrackingApiFp)(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
544
536
  };
545
537
  /**
546
- * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
538
+ * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
547
539
  * @summary List email threads
548
540
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
549
541
  * @param {*} [options] Override http request option.
@@ -22,8 +22,7 @@ import { InitiateEmailVerificationResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
26
- * @summary Complete an email verification
25
+ * undefined **Required Permissions** none
27
26
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
28
27
  * @param {string} [authorization] Bearer Token
29
28
  * @param {*} [options] Override http request option.
@@ -31,8 +30,7 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
31
30
  */
32
31
  completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
32
  /**
34
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
35
- * @summary Initiate an email verification
33
+ * undefined **Required Permissions** none
36
34
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
37
35
  * @param {string} [authorization] Bearer Token
38
36
  * @param {*} [options] Override http request option.
@@ -46,8 +44,7 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
46
44
  */
47
45
  export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
48
46
  /**
49
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
50
- * @summary Complete an email verification
47
+ * undefined **Required Permissions** none
51
48
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
52
49
  * @param {string} [authorization] Bearer Token
53
50
  * @param {*} [options] Override http request option.
@@ -55,8 +52,7 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
55
52
  */
56
53
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
57
54
  /**
58
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
59
- * @summary Initiate an email verification
55
+ * undefined **Required Permissions** none
60
56
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
61
57
  * @param {string} [authorization] Bearer Token
62
58
  * @param {*} [options] Override http request option.
@@ -70,8 +66,7 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
70
66
  */
71
67
  export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
72
68
  /**
73
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
74
- * @summary Complete an email verification
69
+ * undefined **Required Permissions** none
75
70
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
76
71
  * @param {string} [authorization] Bearer Token
77
72
  * @param {*} [options] Override http request option.
@@ -79,8 +74,7 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
79
74
  */
80
75
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
81
76
  /**
82
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
83
- * @summary Initiate an email verification
77
+ * undefined **Required Permissions** none
84
78
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
85
79
  * @param {string} [authorization] Bearer Token
86
80
  * @param {*} [options] Override http request option.
@@ -134,8 +128,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
134
128
  */
135
129
  export declare class EmailVerificationsApi extends BaseAPI {
136
130
  /**
137
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
138
- * @summary Complete an email verification
131
+ * undefined **Required Permissions** none
139
132
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
140
133
  * @param {*} [options] Override http request option.
141
134
  * @throws {RequiredError}
@@ -143,8 +136,7 @@ export declare class EmailVerificationsApi extends BaseAPI {
143
136
  */
144
137
  completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}>>;
145
138
  /**
146
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
147
- * @summary Initiate an email verification
139
+ * undefined **Required Permissions** none
148
140
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
149
141
  * @param {*} [options] Override http request option.
150
142
  * @throws {RequiredError}
@@ -93,8 +93,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
97
- * @summary Complete an email verification
96
+ * undefined **Required Permissions** none
98
97
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
99
98
  * @param {string} [authorization] Bearer Token
100
99
  * @param {*} [options] Override http request option.
@@ -142,8 +141,7 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
142
141
  });
143
142
  },
144
143
  /**
145
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
146
- * @summary Initiate an email verification
144
+ * undefined **Required Permissions** none
147
145
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
148
146
  * @param {string} [authorization] Bearer Token
149
147
  * @param {*} [options] Override http request option.
@@ -201,8 +199,7 @@ var EmailVerificationsApiFp = function (configuration) {
201
199
  var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
202
200
  return {
203
201
  /**
204
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
205
- * @summary Complete an email verification
202
+ * undefined **Required Permissions** none
206
203
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
207
204
  * @param {string} [authorization] Bearer Token
208
205
  * @param {*} [options] Override http request option.
@@ -222,8 +219,7 @@ var EmailVerificationsApiFp = function (configuration) {
222
219
  });
223
220
  },
224
221
  /**
225
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
226
- * @summary Initiate an email verification
222
+ * undefined **Required Permissions** none
227
223
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
228
224
  * @param {string} [authorization] Bearer Token
229
225
  * @param {*} [options] Override http request option.
@@ -253,8 +249,7 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
253
249
  var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
254
250
  return {
255
251
  /**
256
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
257
- * @summary Complete an email verification
252
+ * undefined **Required Permissions** none
258
253
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
259
254
  * @param {string} [authorization] Bearer Token
260
255
  * @param {*} [options] Override http request option.
@@ -264,8 +259,7 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
264
259
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
265
260
  },
266
261
  /**
267
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
268
- * @summary Initiate an email verification
262
+ * undefined **Required Permissions** none
269
263
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
270
264
  * @param {string} [authorization] Bearer Token
271
265
  * @param {*} [options] Override http request option.
@@ -289,8 +283,7 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
289
283
  return _super !== null && _super.apply(this, arguments) || this;
290
284
  }
291
285
  /**
292
- * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
293
- * @summary Complete an email verification
286
+ * undefined **Required Permissions** none
294
287
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
295
288
  * @param {*} [options] Override http request option.
296
289
  * @throws {RequiredError}
@@ -301,8 +294,7 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
301
294
  return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
302
295
  };
303
296
  /**
304
- * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
305
- * @summary Initiate an email verification
297
+ * undefined **Required Permissions** none
306
298
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
307
299
  * @param {*} [options] Override http request option.
308
300
  * @throws {RequiredError}
@@ -24,8 +24,7 @@ import { UpdateLayoutResponseClass } from '../models';
24
24
  */
25
25
  export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
28
- * @summary Create the layout
27
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
29
28
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
30
29
  * @param {string} [authorization] Bearer Token
31
30
  * @param {*} [options] Override http request option.
@@ -33,8 +32,7 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
33
32
  */
34
33
  createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
34
  /**
36
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
37
- * @summary Delete the layout
35
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
38
36
  * @param {number} id
39
37
  * @param {string} [authorization] Bearer Token
40
38
  * @param {*} [options] Override http request option.
@@ -42,8 +40,7 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
42
40
  */
43
41
  deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
42
  /**
45
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
46
- * @summary Retrieve the layout
43
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
47
44
  * @param {number} id
48
45
  * @param {number} id2 Layout id
49
46
  * @param {string} [authorization] Bearer Token
@@ -52,23 +49,21 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
52
49
  */
53
50
  getLayout: (id: number, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
51
  /**
55
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
56
- * @summary List layouts
52
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
57
53
  * @param {string} [authorization] Bearer Token
58
54
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
55
  * @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.
60
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
56
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
61
57
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
62
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
63
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
64
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
58
+ * @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.
59
+ * @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.
60
+ * @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.
65
61
  * @param {*} [options] Override http request option.
66
62
  * @throws {RequiredError}
67
63
  */
68
64
  listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
65
  /**
70
- * 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\"
71
- * @summary Update the layout
66
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
72
67
  * @param {number} id
73
68
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
74
69
  * @param {string} [authorization] Bearer Token
@@ -83,8 +78,7 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
83
78
  */
84
79
  export declare const LayoutsApiFp: (configuration?: Configuration) => {
85
80
  /**
86
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
87
- * @summary Create the layout
81
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
88
82
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
89
83
  * @param {string} [authorization] Bearer Token
90
84
  * @param {*} [options] Override http request option.
@@ -92,8 +86,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
92
86
  */
93
87
  createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
94
88
  /**
95
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
96
- * @summary Delete the layout
89
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
97
90
  * @param {number} id
98
91
  * @param {string} [authorization] Bearer Token
99
92
  * @param {*} [options] Override http request option.
@@ -101,8 +94,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
101
94
  */
102
95
  deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
103
96
  /**
104
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
105
- * @summary Retrieve the layout
97
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
106
98
  * @param {number} id
107
99
  * @param {number} id2 Layout id
108
100
  * @param {string} [authorization] Bearer Token
@@ -111,23 +103,21 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
111
103
  */
112
104
  getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
113
105
  /**
114
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
115
- * @summary List layouts
106
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
116
107
  * @param {string} [authorization] Bearer Token
117
108
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
118
109
  * @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.
119
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
110
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
120
111
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
121
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
122
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
123
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
112
+ * @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.
113
+ * @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.
114
+ * @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.
124
115
  * @param {*} [options] Override http request option.
125
116
  * @throws {RequiredError}
126
117
  */
127
118
  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>>;
128
119
  /**
129
- * 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\"
130
- * @summary Update the layout
120
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
131
121
  * @param {number} id
132
122
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
133
123
  * @param {string} [authorization] Bearer Token
@@ -142,8 +132,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
142
132
  */
143
133
  export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
144
134
  /**
145
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
146
- * @summary Create the layout
135
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
147
136
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
148
137
  * @param {string} [authorization] Bearer Token
149
138
  * @param {*} [options] Override http request option.
@@ -151,8 +140,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
151
140
  */
152
141
  createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
153
142
  /**
154
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
155
- * @summary Delete the layout
143
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
156
144
  * @param {number} id
157
145
  * @param {string} [authorization] Bearer Token
158
146
  * @param {*} [options] Override http request option.
@@ -160,8 +148,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
160
148
  */
161
149
  deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
162
150
  /**
163
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
164
- * @summary Retrieve the layout
151
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
165
152
  * @param {number} id
166
153
  * @param {number} id2 Layout id
167
154
  * @param {string} [authorization] Bearer Token
@@ -170,23 +157,21 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
170
157
  */
171
158
  getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
172
159
  /**
173
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
174
- * @summary List layouts
160
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
175
161
  * @param {string} [authorization] Bearer Token
176
162
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
163
  * @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.
178
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
164
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
179
165
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
180
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
181
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
182
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
166
+ * @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.
167
+ * @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.
168
+ * @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.
183
169
  * @param {*} [options] Override http request option.
184
170
  * @throws {RequiredError}
185
171
  */
186
172
  listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
187
173
  /**
188
- * 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\"
189
- * @summary Update the layout
174
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
190
175
  * @param {number} id
191
176
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
192
177
  * @param {string} [authorization] Bearer Token
@@ -283,7 +268,7 @@ export interface LayoutsApiListLayoutsRequest {
283
268
  */
284
269
  readonly pageToken?: string;
285
270
  /**
286
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
271
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
287
272
  * @type {string}
288
273
  * @memberof LayoutsApiListLayouts
289
274
  */
@@ -295,19 +280,19 @@ export interface LayoutsApiListLayoutsRequest {
295
280
  */
296
281
  readonly search?: string;
297
282
  /**
298
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
283
+ * 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.
299
284
  * @type {string}
300
285
  * @memberof LayoutsApiListLayouts
301
286
  */
302
287
  readonly order?: string;
303
288
  /**
304
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
289
+ * 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.
305
290
  * @type {string}
306
291
  * @memberof LayoutsApiListLayouts
307
292
  */
308
293
  readonly expand?: string;
309
294
  /**
310
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
295
+ * 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.
311
296
  * @type {string}
312
297
  * @memberof LayoutsApiListLayouts
313
298
  */
@@ -346,8 +331,7 @@ export interface LayoutsApiUpdateLayoutRequest {
346
331
  */
347
332
  export declare class LayoutsApi extends BaseAPI {
348
333
  /**
349
- * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
350
- * @summary Create the layout
334
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
351
335
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
352
336
  * @param {*} [options] Override http request option.
353
337
  * @throws {RequiredError}
@@ -355,8 +339,7 @@ export declare class LayoutsApi extends BaseAPI {
355
339
  */
356
340
  createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any, {}>>;
357
341
  /**
358
- * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
359
- * @summary Delete the layout
342
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
360
343
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
361
344
  * @param {*} [options] Override http request option.
362
345
  * @throws {RequiredError}
@@ -364,8 +347,7 @@ export declare class LayoutsApi extends BaseAPI {
364
347
  */
365
348
  deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
366
349
  /**
367
- * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
368
- * @summary Retrieve the layout
350
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
369
351
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
370
352
  * @param {*} [options] Override http request option.
371
353
  * @throws {RequiredError}
@@ -373,8 +355,7 @@ export declare class LayoutsApi extends BaseAPI {
373
355
  */
374
356
  getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any, {}>>;
375
357
  /**
376
- * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
377
- * @summary List layouts
358
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
378
359
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
379
360
  * @param {*} [options] Override http request option.
380
361
  * @throws {RequiredError}
@@ -382,8 +363,7 @@ export declare class LayoutsApi extends BaseAPI {
382
363
  */
383
364
  listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any, {}>>;
384
365
  /**
385
- * 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\"
386
- * @summary Update the layout
366
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
387
367
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
388
368
  * @param {*} [options] Override http request option.
389
369
  * @throws {RequiredError}