@emilgroup/notification-sdk 0.8.1-beta.3 → 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 +9 -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 +8 -1
  56. package/models/unassign-email-message-entity-response-class.ts +31 -0
  57. package/package.json +1 -1
@@ -93,7 +93,61 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
96
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
97
+ * @summary Assign an email message to an entity
98
+ * @param {string} code
99
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
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, assignEmailMessageEntityBodyDto, 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 'assignEmailMessageEntityBodyDto' is not null or undefined
114
+ (0, common_1.assertParamExists)('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto);
115
+ localVarPath = "/notificationservice/v1/email-messages/{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)(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration);
140
+ return [2 /*return*/, {
141
+ url: (0, common_1.toPathString)(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ }];
144
+ }
145
+ });
146
+ });
147
+ },
148
+ /**
149
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
150
+ * @summary Download the email message attachment
97
151
  * @param {string} code
98
152
  * @param {number} attachmentId
99
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -144,7 +198,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
144
198
  });
145
199
  },
146
200
  /**
147
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
201
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
202
+ * @summary Retrieve the email message
148
203
  * @param {string} code
149
204
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
205
  * @param {*} [options] Override http request option.
@@ -191,7 +246,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
191
246
  });
192
247
  },
193
248
  /**
194
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
249
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
250
+ * @summary List the email message attachments
195
251
  * @param {string} code
196
252
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
253
  * @param {*} [options] Override http request option.
@@ -238,16 +294,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
238
294
  });
239
295
  },
240
296
  /**
241
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
297
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
242
298
  * @summary List email messages
243
299
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
300
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
301
  * @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.
246
- * @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} [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>
247
303
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
248
304
  * @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>
249
305
  * @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>
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, 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>
251
307
  * @param {*} [options] Override http request option.
252
308
  * @throws {RequiredError}
253
309
  */
@@ -309,6 +365,54 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
309
365
  });
310
366
  });
311
367
  },
368
+ /**
369
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
370
+ * @summary Unassign an email message from its entity
371
+ * @param {string} code
372
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
373
+ * @param {*} [options] Override http request option.
374
+ * @throws {RequiredError}
375
+ */
376
+ unassignEntity: function (code, authorization, options) {
377
+ if (options === void 0) { options = {}; }
378
+ return __awaiter(_this, void 0, void 0, function () {
379
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
380
+ return __generator(this, function (_a) {
381
+ switch (_a.label) {
382
+ case 0:
383
+ // verify required parameter 'code' is not null or undefined
384
+ (0, common_1.assertParamExists)('unassignEntity', 'code', code);
385
+ localVarPath = "/notificationservice/v1/email-messages/{code}/entity"
386
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
387
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
388
+ if (configuration) {
389
+ baseOptions = configuration.baseOptions;
390
+ baseAccessToken = configuration.accessToken;
391
+ }
392
+ localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
393
+ localVarHeaderParameter = {};
394
+ localVarQueryParameter = {};
395
+ // authentication bearer required
396
+ // http bearer authentication required
397
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
398
+ case 1:
399
+ // authentication bearer required
400
+ // http bearer authentication required
401
+ _a.sent();
402
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
403
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
404
+ }
405
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
406
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
407
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
408
+ return [2 /*return*/, {
409
+ url: (0, common_1.toPathString)(localVarUrlObj),
410
+ options: localVarRequestOptions,
411
+ }];
412
+ }
413
+ });
414
+ });
415
+ },
312
416
  };
313
417
  };
314
418
  exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
@@ -320,7 +424,30 @@ var EmailMessagesApiFp = function (configuration) {
320
424
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
321
425
  return {
322
426
  /**
323
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
427
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
428
+ * @summary Assign an email message to an entity
429
+ * @param {string} code
430
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
431
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
432
+ * @param {*} [options] Override http request option.
433
+ * @throws {RequiredError}
434
+ */
435
+ assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
436
+ return __awaiter(this, void 0, void 0, function () {
437
+ var localVarAxiosArgs;
438
+ return __generator(this, function (_a) {
439
+ switch (_a.label) {
440
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options)];
441
+ case 1:
442
+ localVarAxiosArgs = _a.sent();
443
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
444
+ }
445
+ });
446
+ });
447
+ },
448
+ /**
449
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
450
+ * @summary Download the email message attachment
324
451
  * @param {string} code
325
452
  * @param {number} attachmentId
326
453
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -341,7 +468,8 @@ var EmailMessagesApiFp = function (configuration) {
341
468
  });
342
469
  },
343
470
  /**
344
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
471
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
472
+ * @summary Retrieve the email message
345
473
  * @param {string} code
346
474
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
347
475
  * @param {*} [options] Override http request option.
@@ -361,7 +489,8 @@ var EmailMessagesApiFp = function (configuration) {
361
489
  });
362
490
  },
363
491
  /**
364
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
492
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
493
+ * @summary List the email message attachments
365
494
  * @param {string} code
366
495
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
496
  * @param {*} [options] Override http request option.
@@ -381,16 +510,16 @@ var EmailMessagesApiFp = function (configuration) {
381
510
  });
382
511
  },
383
512
  /**
384
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
513
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
385
514
  * @summary List email messages
386
515
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
516
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
388
517
  * @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.
389
- * @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>
518
+ * @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>
390
519
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
391
520
  * @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>
392
521
  * @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>
393
- * @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>
522
+ * @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>
394
523
  * @param {*} [options] Override http request option.
395
524
  * @throws {RequiredError}
396
525
  */
@@ -407,6 +536,27 @@ var EmailMessagesApiFp = function (configuration) {
407
536
  });
408
537
  });
409
538
  },
539
+ /**
540
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
541
+ * @summary Unassign an email message from its entity
542
+ * @param {string} code
543
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ unassignEntity: function (code, authorization, options) {
548
+ return __awaiter(this, void 0, void 0, function () {
549
+ var localVarAxiosArgs;
550
+ return __generator(this, function (_a) {
551
+ switch (_a.label) {
552
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.unassignEntity(code, authorization, options)];
553
+ case 1:
554
+ localVarAxiosArgs = _a.sent();
555
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
556
+ }
557
+ });
558
+ });
559
+ },
410
560
  };
411
561
  };
412
562
  exports.EmailMessagesApiFp = EmailMessagesApiFp;
@@ -418,7 +568,20 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
418
568
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
419
569
  return {
420
570
  /**
421
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
571
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
572
+ * @summary Assign an email message to an entity
573
+ * @param {string} code
574
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
575
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
576
+ * @param {*} [options] Override http request option.
577
+ * @throws {RequiredError}
578
+ */
579
+ assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
580
+ return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
581
+ },
582
+ /**
583
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
584
+ * @summary Download the email message attachment
422
585
  * @param {string} code
423
586
  * @param {number} attachmentId
424
587
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -429,7 +592,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
429
592
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
430
593
  },
431
594
  /**
432
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
595
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
596
+ * @summary Retrieve the email message
433
597
  * @param {string} code
434
598
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
435
599
  * @param {*} [options] Override http request option.
@@ -439,7 +603,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
439
603
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
440
604
  },
441
605
  /**
442
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
606
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
607
+ * @summary List the email message attachments
443
608
  * @param {string} code
444
609
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
610
  * @param {*} [options] Override http request option.
@@ -449,22 +614,33 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
449
614
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
450
615
  },
451
616
  /**
452
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
617
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
453
618
  * @summary List email messages
454
619
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
620
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
456
621
  * @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.
457
- * @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>
622
+ * @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>
458
623
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
459
624
  * @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>
460
625
  * @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>
461
- * @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>
626
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
462
627
  * @param {*} [options] Override http request option.
463
628
  * @throws {RequiredError}
464
629
  */
465
630
  listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
466
631
  return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
467
632
  },
633
+ /**
634
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
635
+ * @summary Unassign an email message from its entity
636
+ * @param {string} code
637
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
638
+ * @param {*} [options] Override http request option.
639
+ * @throws {RequiredError}
640
+ */
641
+ unassignEntity: function (code, authorization, options) {
642
+ return localVarFp.unassignEntity(code, authorization, options).then(function (request) { return request(axios, basePath); });
643
+ },
468
644
  };
469
645
  };
470
646
  exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
@@ -480,7 +656,20 @@ var EmailMessagesApi = /** @class */ (function (_super) {
480
656
  return _super !== null && _super.apply(this, arguments) || this;
481
657
  }
482
658
  /**
483
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
659
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
660
+ * @summary Assign an email message to an entity
661
+ * @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
662
+ * @param {*} [options] Override http request option.
663
+ * @throws {RequiredError}
664
+ * @memberof EmailMessagesApi
665
+ */
666
+ EmailMessagesApi.prototype.assignEntity = function (requestParameters, options) {
667
+ var _this = this;
668
+ return (0, exports.EmailMessagesApiFp)(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
669
+ };
670
+ /**
671
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
672
+ * @summary Download the email message attachment
484
673
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
485
674
  * @param {*} [options] Override http request option.
486
675
  * @throws {RequiredError}
@@ -491,7 +680,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
491
680
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
492
681
  };
493
682
  /**
494
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
683
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
684
+ * @summary Retrieve the email message
495
685
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
496
686
  * @param {*} [options] Override http request option.
497
687
  * @throws {RequiredError}
@@ -502,7 +692,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
502
692
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
503
693
  };
504
694
  /**
505
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
695
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
696
+ * @summary List the email message attachments
506
697
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
507
698
  * @param {*} [options] Override http request option.
508
699
  * @throws {RequiredError}
@@ -513,7 +704,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
513
704
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
705
  };
515
706
  /**
516
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
707
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
517
708
  * @summary List email messages
518
709
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
519
710
  * @param {*} [options] Override http request option.
@@ -525,6 +716,18 @@ var EmailMessagesApi = /** @class */ (function (_super) {
525
716
  if (requestParameters === void 0) { requestParameters = {}; }
526
717
  return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(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); });
527
718
  };
719
+ /**
720
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
721
+ * @summary Unassign an email message from its entity
722
+ * @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
723
+ * @param {*} [options] Override http request option.
724
+ * @throws {RequiredError}
725
+ * @memberof EmailMessagesApi
726
+ */
727
+ EmailMessagesApi.prototype.unassignEntity = function (requestParameters, options) {
728
+ var _this = this;
729
+ return (0, exports.EmailMessagesApiFp)(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
730
+ };
528
731
  return EmailMessagesApi;
529
732
  }(base_1.BaseAPI));
530
733
  exports.EmailMessagesApi = EmailMessagesApi;
@@ -21,7 +21,8 @@ import { ListEmailThreadsResponseClass } from '../models';
21
21
  */
22
22
  export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
23
23
  /**
24
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
24
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
25
+ * @summary Close the email thread
25
26
  * @param {string} code
26
27
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
27
28
  * @param {*} [options] Override http request option.
@@ -29,7 +30,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
29
30
  */
30
31
  closeThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
32
  /**
32
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
33
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
34
+ * @summary Retrieve the email thread
33
35
  * @param {string} code
34
36
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
37
  * @param {*} [options] Override http request option.
@@ -37,12 +39,12 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
37
39
  */
38
40
  getThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
41
  /**
40
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
42
+ * 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\"
41
43
  * @summary List email messages
42
44
  * @param {string} code
43
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
44
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
45
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
46
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
47
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
46
48
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
47
49
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
48
50
  * @param {*} [options] Override http request option.
@@ -50,7 +52,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
50
52
  */
51
53
  listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
54
  /**
53
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
55
+ * 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\"
54
56
  * @summary List email threads
55
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -71,7 +73,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
71
73
  */
72
74
  export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
73
75
  /**
74
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
76
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
77
+ * @summary Close the email thread
75
78
  * @param {string} code
76
79
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
77
80
  * @param {*} [options] Override http request option.
@@ -79,7 +82,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
79
82
  */
80
83
  closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
81
84
  /**
82
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
85
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
86
+ * @summary Retrieve the email thread
83
87
  * @param {string} code
84
88
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
89
  * @param {*} [options] Override http request option.
@@ -87,12 +91,12 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
87
91
  */
88
92
  getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
89
93
  /**
90
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
94
+ * 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\"
91
95
  * @summary List email messages
92
96
  * @param {string} code
93
97
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
94
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
95
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
98
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
99
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
96
100
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
97
101
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
98
102
  * @param {*} [options] Override http request option.
@@ -100,7 +104,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
100
104
  */
101
105
  listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
102
106
  /**
103
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
107
+ * 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\"
104
108
  * @summary List email threads
105
109
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
110
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -121,7 +125,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
121
125
  */
122
126
  export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
123
127
  /**
124
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
128
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
129
+ * @summary Close the email thread
125
130
  * @param {string} code
126
131
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
132
  * @param {*} [options] Override http request option.
@@ -129,7 +134,8 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
129
134
  */
130
135
  closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
131
136
  /**
132
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
137
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
138
+ * @summary Retrieve the email thread
133
139
  * @param {string} code
134
140
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
141
  * @param {*} [options] Override http request option.
@@ -137,12 +143,12 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
137
143
  */
138
144
  getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
139
145
  /**
140
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
146
+ * 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\"
141
147
  * @summary List email messages
142
148
  * @param {string} code
143
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
145
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
150
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
151
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
146
152
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
147
153
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
148
154
  * @param {*} [options] Override http request option.
@@ -150,7 +156,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
150
156
  */
151
157
  listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
152
158
  /**
153
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
159
+ * 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\"
154
160
  * @summary List email threads
155
161
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
162
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -222,13 +228,13 @@ export interface EmailTrackingApiListMessagesRequest {
222
228
  */
223
229
  readonly authorization?: string;
224
230
  /**
225
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
231
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
226
232
  * @type {string}
227
233
  * @memberof EmailTrackingApiListMessages
228
234
  */
229
235
  readonly filter?: string;
230
236
  /**
231
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
237
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
232
238
  * @type {string}
233
239
  * @memberof EmailTrackingApiListMessages
234
240
  */
@@ -309,7 +315,8 @@ export interface EmailTrackingApiListThreadsRequest {
309
315
  */
310
316
  export declare class EmailTrackingApi extends BaseAPI {
311
317
  /**
312
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
318
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
319
+ * @summary Close the email thread
313
320
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
314
321
  * @param {*} [options] Override http request option.
315
322
  * @throws {RequiredError}
@@ -317,7 +324,8 @@ export declare class EmailTrackingApi extends BaseAPI {
317
324
  */
318
325
  closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
319
326
  /**
320
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
327
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
328
+ * @summary Retrieve the email thread
321
329
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
322
330
  * @param {*} [options] Override http request option.
323
331
  * @throws {RequiredError}
@@ -325,7 +333,7 @@ export declare class EmailTrackingApi extends BaseAPI {
325
333
  */
326
334
  getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
327
335
  /**
328
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
336
+ * 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\"
329
337
  * @summary List email messages
330
338
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
331
339
  * @param {*} [options] Override http request option.
@@ -334,7 +342,7 @@ export declare class EmailTrackingApi extends BaseAPI {
334
342
  */
335
343
  listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
336
344
  /**
337
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
345
+ * 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\"
338
346
  * @summary List email threads
339
347
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
340
348
  * @param {*} [options] Override http request option.