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

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 (62) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +36 -24
  4. package/api/email-tracking-api.ts +263 -32
  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 +36 -24
  12. package/dist/api/email-messages-api.js +34 -22
  13. package/dist/api/email-tracking-api.d.ts +162 -32
  14. package/dist/api/email-tracking-api.js +227 -28
  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-thread-entity-body-dto.d.ts +43 -0
  28. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  29. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  30. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  31. package/dist/models/email-message-class.d.ts +49 -7
  32. package/dist/models/email-message-class.js +16 -2
  33. package/dist/models/email-thread-class.d.ts +6 -5
  34. package/dist/models/entity-ref-class.d.ts +37 -0
  35. package/dist/models/entity-ref-class.js +22 -0
  36. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  37. package/dist/models/grpc-send-email-request-dto.js +22 -0
  38. package/dist/models/index.d.ts +8 -0
  39. package/dist/models/index.js +8 -0
  40. package/dist/models/inline-attachment-dto.d.ts +36 -0
  41. package/dist/models/inline-attachment-dto.js +15 -0
  42. package/dist/models/send-email-request-dto.d.ts +131 -0
  43. package/dist/models/send-email-request-dto.js +22 -0
  44. package/dist/models/send-email-response-class.d.ts +24 -0
  45. package/dist/models/send-email-response-class.js +15 -0
  46. package/dist/models/send-notification-request-dto.d.ts +10 -1
  47. package/dist/models/send-notification-request-dto.js +2 -1
  48. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  49. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  50. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  51. package/models/assign-email-thread-entity-response-class.ts +31 -0
  52. package/models/email-message-class.ts +53 -8
  53. package/models/email-thread-class.ts +6 -5
  54. package/models/entity-ref-class.ts +46 -0
  55. package/models/grpc-send-email-request-dto.ts +144 -0
  56. package/models/index.ts +8 -0
  57. package/models/inline-attachment-dto.ts +42 -0
  58. package/models/send-email-request-dto.ts +138 -0
  59. package/models/send-email-response-class.ts +30 -0
  60. package/models/send-notification-request-dto.ts +9 -2
  61. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  62. package/package.json +1 -1
@@ -93,7 +93,61 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
96
+ * Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
97
+ * @summary Assign an email thread to an entity
98
+ * @param {string} code
99
+ * @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
100
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ assignEntity: function (code, assignEmailThreadEntityBodyDto, authorization, options) {
105
+ if (options === void 0) { options = {}; }
106
+ return __awaiter(_this, void 0, void 0, function () {
107
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
108
+ return __generator(this, function (_a) {
109
+ switch (_a.label) {
110
+ case 0:
111
+ // verify required parameter 'code' is not null or undefined
112
+ (0, common_1.assertParamExists)('assignEntity', 'code', code);
113
+ // verify required parameter 'assignEmailThreadEntityBodyDto' is not null or undefined
114
+ (0, common_1.assertParamExists)('assignEntity', 'assignEmailThreadEntityBodyDto', assignEmailThreadEntityBodyDto);
115
+ localVarPath = "/notificationservice/v1/email-threads/{code}/entity"
116
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
117
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ baseAccessToken = configuration.accessToken;
121
+ }
122
+ localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
123
+ localVarHeaderParameter = {};
124
+ localVarQueryParameter = {};
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ case 1:
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ _a.sent();
132
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
134
+ }
135
+ localVarHeaderParameter['Content-Type'] = 'application/json';
136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
139
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(assignEmailThreadEntityBodyDto, localVarRequestOptions, configuration);
140
+ return [2 /*return*/, {
141
+ url: (0, common_1.toPathString)(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ }];
144
+ }
145
+ });
146
+ });
147
+ },
148
+ /**
149
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
150
+ * @summary Close the email thread
97
151
  * @param {string} code
98
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
153
  * @param {*} [options] Override http request option.
@@ -140,7 +194,8 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
140
194
  });
141
195
  },
142
196
  /**
143
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
197
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
198
+ * @summary Retrieve the email thread
144
199
  * @param {string} code
145
200
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
201
  * @param {*} [options] Override http request option.
@@ -187,12 +242,12 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
187
242
  });
188
243
  },
189
244
  /**
190
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
245
+ * 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\"
191
246
  * @summary List email messages
192
247
  * @param {string} code
193
248
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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>
249
+ * @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>
250
+ * @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>
196
251
  * @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>
197
252
  * @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>
198
253
  * @param {*} [options] Override http request option.
@@ -251,16 +306,16 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
251
306
  });
252
307
  },
253
308
  /**
254
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
309
+ * 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\"
255
310
  * @summary List email threads
256
311
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
257
312
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
258
313
  * @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.
259
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
314
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
260
315
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
261
316
  * @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
262
317
  * @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: messages<i>
263
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
318
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
264
319
  * @param {*} [options] Override http request option.
265
320
  * @throws {RequiredError}
266
321
  */
@@ -322,6 +377,54 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
322
377
  });
323
378
  });
324
379
  },
380
+ /**
381
+ * Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
382
+ * @summary Unassign an email thread from its entity
383
+ * @param {string} code
384
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
385
+ * @param {*} [options] Override http request option.
386
+ * @throws {RequiredError}
387
+ */
388
+ unassignEntity: function (code, authorization, options) {
389
+ if (options === void 0) { options = {}; }
390
+ return __awaiter(_this, void 0, void 0, function () {
391
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
392
+ return __generator(this, function (_a) {
393
+ switch (_a.label) {
394
+ case 0:
395
+ // verify required parameter 'code' is not null or undefined
396
+ (0, common_1.assertParamExists)('unassignEntity', 'code', code);
397
+ localVarPath = "/notificationservice/v1/email-threads/{code}/entity"
398
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
399
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
400
+ if (configuration) {
401
+ baseOptions = configuration.baseOptions;
402
+ baseAccessToken = configuration.accessToken;
403
+ }
404
+ localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
405
+ localVarHeaderParameter = {};
406
+ localVarQueryParameter = {};
407
+ // authentication bearer required
408
+ // http bearer authentication required
409
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
410
+ case 1:
411
+ // authentication bearer required
412
+ // http bearer authentication required
413
+ _a.sent();
414
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
415
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
416
+ }
417
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
418
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
419
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
420
+ return [2 /*return*/, {
421
+ url: (0, common_1.toPathString)(localVarUrlObj),
422
+ options: localVarRequestOptions,
423
+ }];
424
+ }
425
+ });
426
+ });
427
+ },
325
428
  };
326
429
  };
327
430
  exports.EmailTrackingApiAxiosParamCreator = EmailTrackingApiAxiosParamCreator;
@@ -333,7 +436,30 @@ var EmailTrackingApiFp = function (configuration) {
333
436
  var localVarAxiosParamCreator = (0, exports.EmailTrackingApiAxiosParamCreator)(configuration);
334
437
  return {
335
438
  /**
336
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
439
+ * Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
440
+ * @summary Assign an email thread to an entity
441
+ * @param {string} code
442
+ * @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
443
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ */
447
+ assignEntity: function (code, assignEmailThreadEntityBodyDto, authorization, options) {
448
+ return __awaiter(this, void 0, void 0, function () {
449
+ var localVarAxiosArgs;
450
+ return __generator(this, function (_a) {
451
+ switch (_a.label) {
452
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.assignEntity(code, assignEmailThreadEntityBodyDto, authorization, options)];
453
+ case 1:
454
+ localVarAxiosArgs = _a.sent();
455
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
456
+ }
457
+ });
458
+ });
459
+ },
460
+ /**
461
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
462
+ * @summary Close the email thread
337
463
  * @param {string} code
338
464
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
339
465
  * @param {*} [options] Override http request option.
@@ -353,7 +479,8 @@ var EmailTrackingApiFp = function (configuration) {
353
479
  });
354
480
  },
355
481
  /**
356
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
482
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
483
+ * @summary Retrieve the email thread
357
484
  * @param {string} code
358
485
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
486
  * @param {*} [options] Override http request option.
@@ -373,12 +500,12 @@ var EmailTrackingApiFp = function (configuration) {
373
500
  });
374
501
  },
375
502
  /**
376
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
503
+ * 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\"
377
504
  * @summary List email messages
378
505
  * @param {string} code
379
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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>
507
+ * @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>
508
+ * @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>
382
509
  * @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>
383
510
  * @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>
384
511
  * @param {*} [options] Override http request option.
@@ -398,16 +525,16 @@ var EmailTrackingApiFp = function (configuration) {
398
525
  });
399
526
  },
400
527
  /**
401
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
528
+ * 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\"
402
529
  * @summary List email threads
403
530
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
404
531
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
405
532
  * @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.
406
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
533
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
407
534
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
408
535
  * @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
409
536
  * @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: messages<i>
410
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
537
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
411
538
  * @param {*} [options] Override http request option.
412
539
  * @throws {RequiredError}
413
540
  */
@@ -424,6 +551,27 @@ var EmailTrackingApiFp = function (configuration) {
424
551
  });
425
552
  });
426
553
  },
554
+ /**
555
+ * Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
556
+ * @summary Unassign an email thread from its entity
557
+ * @param {string} code
558
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
559
+ * @param {*} [options] Override http request option.
560
+ * @throws {RequiredError}
561
+ */
562
+ unassignEntity: function (code, authorization, options) {
563
+ return __awaiter(this, void 0, void 0, function () {
564
+ var localVarAxiosArgs;
565
+ return __generator(this, function (_a) {
566
+ switch (_a.label) {
567
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.unassignEntity(code, authorization, options)];
568
+ case 1:
569
+ localVarAxiosArgs = _a.sent();
570
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
571
+ }
572
+ });
573
+ });
574
+ },
427
575
  };
428
576
  };
429
577
  exports.EmailTrackingApiFp = EmailTrackingApiFp;
@@ -435,7 +583,20 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
435
583
  var localVarFp = (0, exports.EmailTrackingApiFp)(configuration);
436
584
  return {
437
585
  /**
438
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
586
+ * Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
587
+ * @summary Assign an email thread to an entity
588
+ * @param {string} code
589
+ * @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
590
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
591
+ * @param {*} [options] Override http request option.
592
+ * @throws {RequiredError}
593
+ */
594
+ assignEntity: function (code, assignEmailThreadEntityBodyDto, authorization, options) {
595
+ return localVarFp.assignEntity(code, assignEmailThreadEntityBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
596
+ },
597
+ /**
598
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
599
+ * @summary Close the email thread
439
600
  * @param {string} code
440
601
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
441
602
  * @param {*} [options] Override http request option.
@@ -445,7 +606,8 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
445
606
  return localVarFp.closeThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
446
607
  },
447
608
  /**
448
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
609
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
610
+ * @summary Retrieve the email thread
449
611
  * @param {string} code
450
612
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
451
613
  * @param {*} [options] Override http request option.
@@ -455,12 +617,12 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
455
617
  return localVarFp.getThread(code, authorization, options).then(function (request) { return request(axios, basePath); });
456
618
  },
457
619
  /**
458
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
620
+ * 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\"
459
621
  * @summary List email messages
460
622
  * @param {string} code
461
623
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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>
624
+ * @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>
625
+ * @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>
464
626
  * @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>
465
627
  * @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>
466
628
  * @param {*} [options] Override http request option.
@@ -470,22 +632,33 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
470
632
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
471
633
  },
472
634
  /**
473
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
635
+ * 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\"
474
636
  * @summary List email threads
475
637
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
476
638
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
477
639
  * @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.
478
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
640
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
479
641
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
480
642
  * @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
481
643
  * @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: messages<i>
482
- * @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
644
+ * @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
483
645
  * @param {*} [options] Override http request option.
484
646
  * @throws {RequiredError}
485
647
  */
486
648
  listThreads: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
487
649
  return localVarFp.listThreads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
488
650
  },
651
+ /**
652
+ * Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
653
+ * @summary Unassign an email thread from its entity
654
+ * @param {string} code
655
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
656
+ * @param {*} [options] Override http request option.
657
+ * @throws {RequiredError}
658
+ */
659
+ unassignEntity: function (code, authorization, options) {
660
+ return localVarFp.unassignEntity(code, authorization, options).then(function (request) { return request(axios, basePath); });
661
+ },
489
662
  };
490
663
  };
491
664
  exports.EmailTrackingApiFactory = EmailTrackingApiFactory;
@@ -501,7 +674,20 @@ var EmailTrackingApi = /** @class */ (function (_super) {
501
674
  return _super !== null && _super.apply(this, arguments) || this;
502
675
  }
503
676
  /**
504
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
677
+ * Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
678
+ * @summary Assign an email thread to an entity
679
+ * @param {EmailTrackingApiAssignEntityRequest} requestParameters Request parameters.
680
+ * @param {*} [options] Override http request option.
681
+ * @throws {RequiredError}
682
+ * @memberof EmailTrackingApi
683
+ */
684
+ EmailTrackingApi.prototype.assignEntity = function (requestParameters, options) {
685
+ var _this = this;
686
+ return (0, exports.EmailTrackingApiFp)(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailThreadEntityBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
687
+ };
688
+ /**
689
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
690
+ * @summary Close the email thread
505
691
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
506
692
  * @param {*} [options] Override http request option.
507
693
  * @throws {RequiredError}
@@ -512,7 +698,8 @@ var EmailTrackingApi = /** @class */ (function (_super) {
512
698
  return (0, exports.EmailTrackingApiFp)(this.configuration).closeThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
513
699
  };
514
700
  /**
515
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
701
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
702
+ * @summary Retrieve the email thread
516
703
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
517
704
  * @param {*} [options] Override http request option.
518
705
  * @throws {RequiredError}
@@ -523,7 +710,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
523
710
  return (0, exports.EmailTrackingApiFp)(this.configuration).getThread(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
524
711
  };
525
712
  /**
526
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
713
+ * 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\"
527
714
  * @summary List email messages
528
715
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
529
716
  * @param {*} [options] Override http request option.
@@ -535,7 +722,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
535
722
  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); });
536
723
  };
537
724
  /**
538
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
725
+ * 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\"
539
726
  * @summary List email threads
540
727
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
541
728
  * @param {*} [options] Override http request option.
@@ -547,6 +734,18 @@ var EmailTrackingApi = /** @class */ (function (_super) {
547
734
  if (requestParameters === void 0) { requestParameters = {}; }
548
735
  return (0, exports.EmailTrackingApiFp)(this.configuration).listThreads(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
549
736
  };
737
+ /**
738
+ * Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
739
+ * @summary Unassign an email thread from its entity
740
+ * @param {EmailTrackingApiUnassignEntityRequest} requestParameters Request parameters.
741
+ * @param {*} [options] Override http request option.
742
+ * @throws {RequiredError}
743
+ * @memberof EmailTrackingApi
744
+ */
745
+ EmailTrackingApi.prototype.unassignEntity = function (requestParameters, options) {
746
+ var _this = this;
747
+ return (0, exports.EmailTrackingApiFp)(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
748
+ };
550
749
  return EmailTrackingApi;
551
750
  }(base_1.BaseAPI));
552
751
  exports.EmailTrackingApi = EmailTrackingApi;
@@ -22,7 +22,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * undefined **Required Permissions** none
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
26
27
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
27
28
  * @param {string} [authorization] Bearer Token
28
29
  * @param {*} [options] Override http request option.
@@ -30,7 +31,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
30
31
  */
31
32
  completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
33
  /**
33
- * undefined **Required Permissions** none
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
34
36
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
35
37
  * @param {string} [authorization] Bearer Token
36
38
  * @param {*} [options] Override http request option.
@@ -44,7 +46,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
44
46
  */
45
47
  export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
46
48
  /**
47
- * undefined **Required Permissions** none
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
48
51
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
49
52
  * @param {string} [authorization] Bearer Token
50
53
  * @param {*} [options] Override http request option.
@@ -52,7 +55,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
52
55
  */
53
56
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
54
57
  /**
55
- * undefined **Required Permissions** none
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
56
60
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
57
61
  * @param {string} [authorization] Bearer Token
58
62
  * @param {*} [options] Override http request option.
@@ -66,7 +70,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
66
70
  */
67
71
  export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
68
72
  /**
69
- * undefined **Required Permissions** none
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
70
75
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
71
76
  * @param {string} [authorization] Bearer Token
72
77
  * @param {*} [options] Override http request option.
@@ -74,7 +79,8 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
74
79
  */
75
80
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
76
81
  /**
77
- * undefined **Required Permissions** none
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
78
84
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
79
85
  * @param {string} [authorization] Bearer Token
80
86
  * @param {*} [options] Override http request option.
@@ -128,7 +134,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
128
134
  */
129
135
  export declare class EmailVerificationsApi extends BaseAPI {
130
136
  /**
131
- * undefined **Required Permissions** none
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
132
139
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
133
140
  * @param {*} [options] Override http request option.
134
141
  * @throws {RequiredError}
@@ -136,7 +143,8 @@ export declare class EmailVerificationsApi extends BaseAPI {
136
143
  */
137
144
  completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}>>;
138
145
  /**
139
- * undefined **Required Permissions** none
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
140
148
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
141
149
  * @param {*} [options] Override http request option.
142
150
  * @throws {RequiredError}
@@ -93,7 +93,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** none
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
97
98
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** none
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
145
147
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -199,7 +201,8 @@ var EmailVerificationsApiFp = function (configuration) {
199
201
  var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
200
202
  return {
201
203
  /**
202
- * undefined **Required Permissions** none
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
203
206
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
204
207
  * @param {string} [authorization] Bearer Token
205
208
  * @param {*} [options] Override http request option.
@@ -219,7 +222,8 @@ var EmailVerificationsApiFp = function (configuration) {
219
222
  });
220
223
  },
221
224
  /**
222
- * undefined **Required Permissions** none
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
223
227
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
224
228
  * @param {string} [authorization] Bearer Token
225
229
  * @param {*} [options] Override http request option.
@@ -249,7 +253,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
249
253
  var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
250
254
  return {
251
255
  /**
252
- * undefined **Required Permissions** none
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
253
258
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
254
259
  * @param {string} [authorization] Bearer Token
255
260
  * @param {*} [options] Override http request option.
@@ -259,7 +264,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
259
264
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
260
265
  },
261
266
  /**
262
- * undefined **Required Permissions** none
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
263
269
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
264
270
  * @param {string} [authorization] Bearer Token
265
271
  * @param {*} [options] Override http request option.
@@ -283,7 +289,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
283
289
  return _super !== null && _super.apply(this, arguments) || this;
284
290
  }
285
291
  /**
286
- * undefined **Required Permissions** none
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
287
294
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
288
295
  * @param {*} [options] Override http request option.
289
296
  * @throws {RequiredError}
@@ -294,7 +301,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
294
301
  return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
295
302
  };
296
303
  /**
297
- * undefined **Required Permissions** none
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
298
306
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
299
307
  * @param {*} [options] Override http request option.
300
308
  * @throws {RequiredError}