@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.31

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 +8 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +259 -24
  4. package/api/email-tracking-api.ts +32 -24
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/msgraph-webhooks-api.ts +278 -0
  8. package/api/notification-templates-api.ts +56 -36
  9. package/api/notifications-api.ts +115 -4
  10. package/api.ts +2 -0
  11. package/dist/api/email-messages-api.d.ts +158 -24
  12. package/dist/api/email-messages-api.js +225 -22
  13. package/dist/api/email-tracking-api.d.ts +32 -24
  14. package/dist/api/email-tracking-api.js +30 -22
  15. package/dist/api/email-verifications-api.d.ts +16 -8
  16. package/dist/api/email-verifications-api.js +16 -8
  17. package/dist/api/layouts-api.d.ts +56 -36
  18. package/dist/api/layouts-api.js +52 -32
  19. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  20. package/dist/api/msgraph-webhooks-api.js +305 -0
  21. package/dist/api/notification-templates-api.d.ts +56 -36
  22. package/dist/api/notification-templates-api.js +52 -32
  23. package/dist/api/notifications-api.d.ts +65 -4
  24. package/dist/api/notifications-api.js +101 -4
  25. package/dist/api.d.ts +1 -0
  26. package/dist/api.js +1 -0
  27. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  28. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  29. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  30. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  31. package/dist/models/email-message-class.d.ts +49 -2
  32. package/dist/models/email-message-class.js +16 -2
  33. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  34. package/dist/models/grpc-send-email-request-dto.js +22 -0
  35. package/dist/models/index.d.ts +7 -0
  36. package/dist/models/index.js +7 -0
  37. package/dist/models/inline-attachment-dto.d.ts +36 -0
  38. package/dist/models/inline-attachment-dto.js +15 -0
  39. package/dist/models/send-email-request-dto.d.ts +131 -0
  40. package/dist/models/send-email-request-dto.js +22 -0
  41. package/dist/models/send-email-response-class.d.ts +24 -0
  42. package/dist/models/send-email-response-class.js +15 -0
  43. package/dist/models/send-notification-request-dto.d.ts +1 -0
  44. package/dist/models/send-notification-request-dto.js +2 -1
  45. package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
  46. package/dist/models/unassign-email-message-entity-response-class.js +15 -0
  47. package/models/assign-email-message-entity-body-dto.ts +52 -0
  48. package/models/assign-email-message-entity-response-class.ts +31 -0
  49. package/models/email-message-class.ts +53 -3
  50. package/models/grpc-send-email-request-dto.ts +144 -0
  51. package/models/index.ts +7 -0
  52. package/models/inline-attachment-dto.ts +42 -0
  53. package/models/send-email-request-dto.ts +138 -0
  54. package/models/send-email-response-class.ts +30 -0
  55. package/models/send-notification-request-dto.ts +2 -1
  56. package/models/unassign-email-message-entity-response-class.ts +31 -0
  57. package/package.json +1 -1
@@ -33,7 +33,8 @@ import { ListEmailThreadsResponseClass } from '../models';
33
33
  export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
36
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
37
+ * @summary Close the email thread
37
38
  * @param {string} code
38
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
40
  * @param {*} [options] Override http request option.
@@ -77,7 +78,8 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
77
78
  };
78
79
  },
79
80
  /**
80
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
81
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
82
+ * @summary Retrieve the email thread
81
83
  * @param {string} code
82
84
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
85
  * @param {*} [options] Override http request option.
@@ -121,12 +123,12 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
121
123
  };
122
124
  },
123
125
  /**
124
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
126
+ * 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\"
125
127
  * @summary List email messages
126
128
  * @param {string} code
127
129
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
- * @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>
129
- * @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>
130
+ * @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>
131
+ * @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>
130
132
  * @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>
131
133
  * @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>
132
134
  * @param {*} [options] Override http request option.
@@ -186,7 +188,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
186
188
  };
187
189
  },
188
190
  /**
189
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
191
+ * 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\"
190
192
  * @summary List email threads
191
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
194
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -272,7 +274,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
272
274
  const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
273
275
  return {
274
276
  /**
275
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
277
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
278
+ * @summary Close the email thread
276
279
  * @param {string} code
277
280
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
278
281
  * @param {*} [options] Override http request option.
@@ -283,7 +286,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
283
286
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
284
287
  },
285
288
  /**
286
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
289
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
290
+ * @summary Retrieve the email thread
287
291
  * @param {string} code
288
292
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
293
  * @param {*} [options] Override http request option.
@@ -294,12 +298,12 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
294
298
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
295
299
  },
296
300
  /**
297
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
301
+ * 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\"
298
302
  * @summary List email messages
299
303
  * @param {string} code
300
304
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
301
- * @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>
302
- * @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>
305
+ * @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>
306
+ * @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>
303
307
  * @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>
304
308
  * @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>
305
309
  * @param {*} [options] Override http request option.
@@ -310,7 +314,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
310
314
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
311
315
  },
312
316
  /**
313
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
317
+ * 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\"
314
318
  * @summary List email threads
315
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
316
320
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -338,7 +342,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
338
342
  const localVarFp = EmailTrackingApiFp(configuration)
339
343
  return {
340
344
  /**
341
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
345
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
346
+ * @summary Close the email thread
342
347
  * @param {string} code
343
348
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
349
  * @param {*} [options] Override http request option.
@@ -348,7 +353,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
348
353
  return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
349
354
  },
350
355
  /**
351
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
356
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
357
+ * @summary Retrieve the email thread
352
358
  * @param {string} code
353
359
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
354
360
  * @param {*} [options] Override http request option.
@@ -358,12 +364,12 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
358
364
  return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
359
365
  },
360
366
  /**
361
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
367
+ * 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\"
362
368
  * @summary List email messages
363
369
  * @param {string} code
364
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
366
- * @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>
371
+ * @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>
372
+ * @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>
367
373
  * @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>
368
374
  * @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>
369
375
  * @param {*} [options] Override http request option.
@@ -373,7 +379,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
373
379
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
374
380
  },
375
381
  /**
376
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
382
+ * 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\"
377
383
  * @summary List email threads
378
384
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
379
385
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -455,14 +461,14 @@ export interface EmailTrackingApiListMessagesRequest {
455
461
  readonly authorization?: string
456
462
 
457
463
  /**
458
- * 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>
464
+ * 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>
459
465
  * @type {string}
460
466
  * @memberof EmailTrackingApiListMessages
461
467
  */
462
468
  readonly filter?: string
463
469
 
464
470
  /**
465
- * 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>
471
+ * 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>
466
472
  * @type {string}
467
473
  * @memberof EmailTrackingApiListMessages
468
474
  */
@@ -554,7 +560,8 @@ export interface EmailTrackingApiListThreadsRequest {
554
560
  */
555
561
  export class EmailTrackingApi extends BaseAPI {
556
562
  /**
557
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
563
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
564
+ * @summary Close the email thread
558
565
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
559
566
  * @param {*} [options] Override http request option.
560
567
  * @throws {RequiredError}
@@ -565,7 +572,8 @@ export class EmailTrackingApi extends BaseAPI {
565
572
  }
566
573
 
567
574
  /**
568
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
575
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
576
+ * @summary Retrieve the email thread
569
577
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
570
578
  * @param {*} [options] Override http request option.
571
579
  * @throws {RequiredError}
@@ -576,7 +584,7 @@ export class EmailTrackingApi extends BaseAPI {
576
584
  }
577
585
 
578
586
  /**
579
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
587
+ * 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\"
580
588
  * @summary List email messages
581
589
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
582
590
  * @param {*} [options] Override http request option.
@@ -588,7 +596,7 @@ export class EmailTrackingApi extends BaseAPI {
588
596
  }
589
597
 
590
598
  /**
591
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
599
+ * 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\"
592
600
  * @summary List email threads
593
601
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
594
602
  * @param {*} [options] Override http request option.
@@ -35,7 +35,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
35
35
  export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** none
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
39
40
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
40
41
  * @param {string} [authorization] Bearer Token
41
42
  * @param {*} [options] Override http request option.
@@ -81,7 +82,8 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
81
82
  };
82
83
  },
83
84
  /**
84
- * undefined **Required Permissions** none
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
85
87
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
86
88
  * @param {string} [authorization] Bearer Token
87
89
  * @param {*} [options] Override http request option.
@@ -137,7 +139,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
137
139
  const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
138
140
  return {
139
141
  /**
140
- * undefined **Required Permissions** none
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
141
144
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
142
145
  * @param {string} [authorization] Bearer Token
143
146
  * @param {*} [options] Override http request option.
@@ -148,7 +151,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
148
151
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
149
152
  },
150
153
  /**
151
- * undefined **Required Permissions** none
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
152
156
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
153
157
  * @param {string} [authorization] Bearer Token
154
158
  * @param {*} [options] Override http request option.
@@ -169,7 +173,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
169
173
  const localVarFp = EmailVerificationsApiFp(configuration)
170
174
  return {
171
175
  /**
172
- * undefined **Required Permissions** none
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
173
178
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
174
179
  * @param {string} [authorization] Bearer Token
175
180
  * @param {*} [options] Override http request option.
@@ -179,7 +184,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
179
184
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
180
185
  },
181
186
  /**
182
- * undefined **Required Permissions** none
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
183
189
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
184
190
  * @param {string} [authorization] Bearer Token
185
191
  * @param {*} [options] Override http request option.
@@ -241,7 +247,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
241
247
  */
242
248
  export class EmailVerificationsApi extends BaseAPI {
243
249
  /**
244
- * undefined **Required Permissions** none
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
245
252
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
246
253
  * @param {*} [options] Override http request option.
247
254
  * @throws {RequiredError}
@@ -252,7 +259,8 @@ export class EmailVerificationsApi extends BaseAPI {
252
259
  }
253
260
 
254
261
  /**
255
- * undefined **Required Permissions** none
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
256
264
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
257
265
  * @param {*} [options] Override http request option.
258
266
  * @throws {RequiredError}
@@ -39,7 +39,8 @@ import { UpdateLayoutResponseClass } from '../models';
39
39
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
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
43
44
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
44
45
  * @param {string} [authorization] Bearer Token
45
46
  * @param {*} [options] Override http request option.
@@ -85,7 +86,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
85
86
  };
86
87
  },
87
88
  /**
88
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
89
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
+ * @summary Delete the layout
89
91
  * @param {number} id
90
92
  * @param {string} [authorization] Bearer Token
91
93
  * @param {*} [options] Override http request option.
@@ -129,7 +131,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
129
131
  };
130
132
  },
131
133
  /**
132
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
134
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
+ * @summary Retrieve the layout
133
136
  * @param {number} id
134
137
  * @param {number} id2 Layout id
135
138
  * @param {string} [authorization] Bearer Token
@@ -180,15 +183,16 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
180
183
  };
181
184
  },
182
185
  /**
183
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
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
184
188
  * @param {string} [authorization] Bearer Token
185
189
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
186
190
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
187
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
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>
188
192
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
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>
192
196
  * @param {*} [options] Override http request option.
193
197
  * @throws {RequiredError}
194
198
  */
@@ -255,7 +259,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
255
259
  };
256
260
  },
257
261
  /**
258
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
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
259
264
  * @param {number} id
260
265
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
261
266
  * @param {string} [authorization] Bearer Token
@@ -315,7 +320,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
315
320
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
316
321
  return {
317
322
  /**
318
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
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
319
325
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
320
326
  * @param {string} [authorization] Bearer Token
321
327
  * @param {*} [options] Override http request option.
@@ -326,7 +332,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
326
332
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
327
333
  },
328
334
  /**
329
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
335
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
336
+ * @summary Delete the layout
330
337
  * @param {number} id
331
338
  * @param {string} [authorization] Bearer Token
332
339
  * @param {*} [options] Override http request option.
@@ -337,7 +344,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
337
344
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
345
  },
339
346
  /**
340
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
347
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
348
+ * @summary Retrieve the layout
341
349
  * @param {number} id
342
350
  * @param {number} id2 Layout id
343
351
  * @param {string} [authorization] Bearer Token
@@ -349,15 +357,16 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
349
357
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
358
  },
351
359
  /**
352
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
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
353
362
  * @param {string} [authorization] Bearer Token
354
363
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
355
364
  * @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.
356
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
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>
357
366
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
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>
361
370
  * @param {*} [options] Override http request option.
362
371
  * @throws {RequiredError}
363
372
  */
@@ -366,7 +375,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
366
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
367
376
  },
368
377
  /**
369
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
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
370
380
  * @param {number} id
371
381
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
372
382
  * @param {string} [authorization] Bearer Token
@@ -388,7 +398,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
388
398
  const localVarFp = LayoutsApiFp(configuration)
389
399
  return {
390
400
  /**
391
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
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
392
403
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
393
404
  * @param {string} [authorization] Bearer Token
394
405
  * @param {*} [options] Override http request option.
@@ -398,7 +409,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
398
409
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
399
410
  },
400
411
  /**
401
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
412
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
413
+ * @summary Delete the layout
402
414
  * @param {number} id
403
415
  * @param {string} [authorization] Bearer Token
404
416
  * @param {*} [options] Override http request option.
@@ -408,7 +420,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
408
420
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
409
421
  },
410
422
  /**
411
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
423
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
424
+ * @summary Retrieve the layout
412
425
  * @param {number} id
413
426
  * @param {number} id2 Layout id
414
427
  * @param {string} [authorization] Bearer Token
@@ -419,15 +432,16 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
419
432
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
420
433
  },
421
434
  /**
422
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
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
423
437
  * @param {string} [authorization] Bearer Token
424
438
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
425
439
  * @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.
426
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
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>
427
441
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
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.
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>
431
445
  * @param {*} [options] Override http request option.
432
446
  * @throws {RequiredError}
433
447
  */
@@ -435,7 +449,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
435
449
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
436
450
  },
437
451
  /**
438
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
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
439
454
  * @param {number} id
440
455
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
441
456
  * @param {string} [authorization] Bearer Token
@@ -546,7 +561,7 @@ export interface LayoutsApiListLayoutsRequest {
546
561
  readonly pageToken?: string
547
562
 
548
563
  /**
549
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
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>
550
565
  * @type {string}
551
566
  * @memberof LayoutsApiListLayouts
552
567
  */
@@ -560,21 +575,21 @@ export interface LayoutsApiListLayoutsRequest {
560
575
  readonly search?: string
561
576
 
562
577
  /**
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.
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>
564
579
  * @type {string}
565
580
  * @memberof LayoutsApiListLayouts
566
581
  */
567
582
  readonly order?: string
568
583
 
569
584
  /**
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.
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>
571
586
  * @type {string}
572
587
  * @memberof LayoutsApiListLayouts
573
588
  */
574
589
  readonly expand?: string
575
590
 
576
591
  /**
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.
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>
578
593
  * @type {string}
579
594
  * @memberof LayoutsApiListLayouts
580
595
  */
@@ -617,7 +632,8 @@ export interface LayoutsApiUpdateLayoutRequest {
617
632
  */
618
633
  export class LayoutsApi extends BaseAPI {
619
634
  /**
620
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
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
621
637
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
622
638
  * @param {*} [options] Override http request option.
623
639
  * @throws {RequiredError}
@@ -628,7 +644,8 @@ export class LayoutsApi extends BaseAPI {
628
644
  }
629
645
 
630
646
  /**
631
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
647
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
648
+ * @summary Delete the layout
632
649
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
633
650
  * @param {*} [options] Override http request option.
634
651
  * @throws {RequiredError}
@@ -639,7 +656,8 @@ export class LayoutsApi extends BaseAPI {
639
656
  }
640
657
 
641
658
  /**
642
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
659
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
660
+ * @summary Retrieve the layout
643
661
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
644
662
  * @param {*} [options] Override http request option.
645
663
  * @throws {RequiredError}
@@ -650,7 +668,8 @@ export class LayoutsApi extends BaseAPI {
650
668
  }
651
669
 
652
670
  /**
653
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
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
654
673
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
655
674
  * @param {*} [options] Override http request option.
656
675
  * @throws {RequiredError}
@@ -661,7 +680,8 @@ export class LayoutsApi extends BaseAPI {
661
680
  }
662
681
 
663
682
  /**
664
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
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
665
685
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
666
686
  * @param {*} [options] Override http request option.
667
687
  * @throws {RequiredError}