@emilgroup/notification-sdk 0.8.1-beta.6 → 0.8.1-beta.60

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 (114) hide show
  1. package/.openapi-generator/FILES +23 -0
  2. package/README.md +2 -2
  3. package/api/email-mailboxes-api.ts +150 -0
  4. package/api/email-messages-api.ts +56 -36
  5. package/api/email-subscriptions-api.ts +781 -0
  6. package/api/email-tracking-api.ts +291 -48
  7. package/api/email-verifications-api.ts +24 -12
  8. package/api/layouts-api.ts +76 -46
  9. package/api/msgraph-webhooks-api.ts +278 -0
  10. package/api/notification-templates-api.ts +76 -46
  11. package/api/notifications-api.ts +121 -6
  12. package/api.ts +6 -0
  13. package/base.ts +174 -41
  14. package/common.ts +3 -2
  15. package/configuration.ts +20 -0
  16. package/dist/api/email-mailboxes-api.d.ts +87 -0
  17. package/dist/api/email-mailboxes-api.js +221 -0
  18. package/dist/api/email-messages-api.d.ts +44 -32
  19. package/dist/api/email-messages-api.js +62 -40
  20. package/dist/api/email-subscriptions-api.d.ts +432 -0
  21. package/dist/api/email-subscriptions-api.js +738 -0
  22. package/dist/api/email-tracking-api.d.ts +174 -44
  23. package/dist/api/email-tracking-api.js +261 -48
  24. package/dist/api/email-verifications-api.d.ts +18 -10
  25. package/dist/api/email-verifications-api.js +30 -16
  26. package/dist/api/health-api.d.ts +1 -1
  27. package/dist/api/layouts-api.d.ts +61 -41
  28. package/dist/api/layouts-api.js +81 -50
  29. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  30. package/dist/api/msgraph-webhooks-api.js +305 -0
  31. package/dist/api/notification-templates-api.d.ts +61 -41
  32. package/dist/api/notification-templates-api.js +81 -50
  33. package/dist/api/notifications-api.d.ts +66 -5
  34. package/dist/api/notifications-api.js +111 -8
  35. package/dist/api.d.ts +3 -0
  36. package/dist/api.js +3 -0
  37. package/dist/base.d.ts +24 -0
  38. package/dist/base.js +178 -59
  39. package/dist/common.d.ts +1 -1
  40. package/dist/common.js +1 -0
  41. package/dist/configuration.d.ts +17 -0
  42. package/dist/configuration.js +2 -0
  43. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  44. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  45. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  46. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  47. package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
  48. package/dist/models/catch-up-email-subscription-response-class.js +15 -0
  49. package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
  50. package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
  51. package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
  52. package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
  53. package/dist/models/email-mailbox-class.d.ts +47 -0
  54. package/dist/models/email-mailbox-class.js +20 -0
  55. package/dist/models/email-message-class.d.ts +73 -7
  56. package/dist/models/email-message-class.js +22 -3
  57. package/dist/models/email-message-summary-class.d.ts +98 -0
  58. package/dist/models/email-message-summary-class.js +33 -0
  59. package/dist/models/email-subscription-class.d.ts +110 -0
  60. package/dist/models/email-subscription-class.js +23 -0
  61. package/dist/models/email-thread-class.d.ts +37 -5
  62. package/dist/models/entity-ref-class.d.ts +37 -0
  63. package/dist/models/entity-ref-class.js +22 -0
  64. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  65. package/dist/models/get-email-subscription-response-class.js +15 -0
  66. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  67. package/dist/models/grpc-send-email-request-dto.js +22 -0
  68. package/dist/models/index.d.ts +20 -0
  69. package/dist/models/index.js +20 -0
  70. package/dist/models/inline-attachment-dto.d.ts +36 -0
  71. package/dist/models/inline-attachment-dto.js +15 -0
  72. package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
  73. package/dist/models/list-email-mailboxes-response-class.js +15 -0
  74. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  75. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  76. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  77. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  78. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  79. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  80. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  81. package/dist/models/renew-email-subscription-response-class.js +15 -0
  82. package/dist/models/send-email-request-dto.d.ts +131 -0
  83. package/dist/models/send-email-request-dto.js +22 -0
  84. package/dist/models/send-email-response-class.d.ts +24 -0
  85. package/dist/models/send-email-response-class.js +15 -0
  86. package/dist/models/send-notification-request-dto.d.ts +10 -1
  87. package/dist/models/send-notification-request-dto.js +2 -1
  88. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  89. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  90. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  91. package/models/assign-email-thread-entity-response-class.ts +31 -0
  92. package/models/catch-up-email-subscription-response-class.ts +30 -0
  93. package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
  94. package/models/catch-up-email-subscriptions-response-class.ts +36 -0
  95. package/models/email-mailbox-class.ts +56 -0
  96. package/models/email-message-class.ts +78 -8
  97. package/models/email-message-summary-class.ts +109 -0
  98. package/models/email-subscription-class.ts +119 -0
  99. package/models/email-thread-class.ts +37 -5
  100. package/models/entity-ref-class.ts +46 -0
  101. package/models/get-email-subscription-response-class.ts +31 -0
  102. package/models/grpc-send-email-request-dto.ts +144 -0
  103. package/models/index.ts +20 -0
  104. package/models/inline-attachment-dto.ts +42 -0
  105. package/models/list-email-mailboxes-response-class.ts +49 -0
  106. package/models/list-email-subscriptions-response-class.ts +49 -0
  107. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  108. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  109. package/models/renew-email-subscription-response-class.ts +31 -0
  110. package/models/send-email-request-dto.ts +138 -0
  111. package/models/send-email-response-class.ts +30 -0
  112. package/models/send-notification-request-dto.ts +9 -2
  113. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  114. package/package.json +2 -2
@@ -93,7 +93,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
96
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
97
+ * @summary Download the email message attachment
97
98
  * @param {string} code
98
99
  * @param {number} attachmentId
99
100
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -103,7 +104,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
103
104
  downloadAttachment: function (code, attachmentId, authorization, options) {
104
105
  if (options === void 0) { options = {}; }
105
106
  return __awaiter(_this, void 0, void 0, function () {
106
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
107
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
107
108
  return __generator(this, function (_a) {
108
109
  switch (_a.label) {
109
110
  case 0:
@@ -124,13 +125,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
124
125
  localVarQueryParameter = {};
125
126
  // authentication bearer required
126
127
  // http bearer authentication required
127
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
129
+ // Only Authorization falls back to the configured token; an empty value is never sent.
130
+ ];
128
131
  case 1:
129
132
  // authentication bearer required
130
133
  // http bearer authentication required
131
134
  _a.sent();
132
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
135
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
136
+ if (authorizationValue) {
137
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
134
138
  }
135
139
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
136
140
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -144,7 +148,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
144
148
  });
145
149
  },
146
150
  /**
147
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
151
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
152
+ * @summary Retrieve the email message
148
153
  * @param {string} code
149
154
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
155
  * @param {*} [options] Override http request option.
@@ -153,7 +158,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
153
158
  getMessage: function (code, authorization, options) {
154
159
  if (options === void 0) { options = {}; }
155
160
  return __awaiter(_this, void 0, void 0, function () {
156
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
161
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
157
162
  return __generator(this, function (_a) {
158
163
  switch (_a.label) {
159
164
  case 0:
@@ -171,13 +176,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
171
176
  localVarQueryParameter = {};
172
177
  // authentication bearer required
173
178
  // http bearer authentication required
174
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
179
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
180
+ // Only Authorization falls back to the configured token; an empty value is never sent.
181
+ ];
175
182
  case 1:
176
183
  // authentication bearer required
177
184
  // http bearer authentication required
178
185
  _a.sent();
179
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
180
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
186
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
187
+ if (authorizationValue) {
188
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
181
189
  }
182
190
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
183
191
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -191,7 +199,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
191
199
  });
192
200
  },
193
201
  /**
194
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
202
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
203
+ * @summary List the email message attachments
195
204
  * @param {string} code
196
205
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
206
  * @param {*} [options] Override http request option.
@@ -200,7 +209,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
200
209
  listAttachments: function (code, authorization, options) {
201
210
  if (options === void 0) { options = {}; }
202
211
  return __awaiter(_this, void 0, void 0, function () {
203
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
212
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
204
213
  return __generator(this, function (_a) {
205
214
  switch (_a.label) {
206
215
  case 0:
@@ -218,13 +227,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
218
227
  localVarQueryParameter = {};
219
228
  // authentication bearer required
220
229
  // http bearer authentication required
221
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
230
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
231
+ // Only Authorization falls back to the configured token; an empty value is never sent.
232
+ ];
222
233
  case 1:
223
234
  // authentication bearer required
224
235
  // http bearer authentication required
225
236
  _a.sent();
226
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
227
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
237
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
238
+ if (authorizationValue) {
239
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
228
240
  }
229
241
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
230
242
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -238,23 +250,23 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
238
250
  });
239
251
  },
240
252
  /**
241
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
253
+ * 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
254
  * @summary List email messages
243
255
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
256
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
257
  * @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>
258
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
247
259
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
248
- * @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>
260
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
249
261
  * @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>
262
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
251
263
  * @param {*} [options] Override http request option.
252
264
  * @throws {RequiredError}
253
265
  */
254
266
  listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
255
267
  if (options === void 0) { options = {}; }
256
268
  return __awaiter(_this, void 0, void 0, function () {
257
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
269
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
258
270
  return __generator(this, function (_a) {
259
271
  switch (_a.label) {
260
272
  case 0:
@@ -295,8 +307,9 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
295
307
  if (filters !== undefined) {
296
308
  localVarQueryParameter['filters'] = filters;
297
309
  }
298
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
299
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
310
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
311
+ if (authorizationValue) {
312
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
300
313
  }
301
314
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
302
315
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -320,7 +333,8 @@ var EmailMessagesApiFp = function (configuration) {
320
333
  var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
321
334
  return {
322
335
  /**
323
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
336
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
337
+ * @summary Download the email message attachment
324
338
  * @param {string} code
325
339
  * @param {number} attachmentId
326
340
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -341,7 +355,8 @@ var EmailMessagesApiFp = function (configuration) {
341
355
  });
342
356
  },
343
357
  /**
344
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
358
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
359
+ * @summary Retrieve the email message
345
360
  * @param {string} code
346
361
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
347
362
  * @param {*} [options] Override http request option.
@@ -361,7 +376,8 @@ var EmailMessagesApiFp = function (configuration) {
361
376
  });
362
377
  },
363
378
  /**
364
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
379
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
380
+ * @summary List the email message attachments
365
381
  * @param {string} code
366
382
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
383
  * @param {*} [options] Override http request option.
@@ -381,16 +397,16 @@ var EmailMessagesApiFp = function (configuration) {
381
397
  });
382
398
  },
383
399
  /**
384
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
400
+ * 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
401
  * @summary List email messages
386
402
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
403
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
388
404
  * @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>
405
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
390
406
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
391
- * @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>
407
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
392
408
  * @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>
409
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
394
410
  * @param {*} [options] Override http request option.
395
411
  * @throws {RequiredError}
396
412
  */
@@ -418,7 +434,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
418
434
  var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
419
435
  return {
420
436
  /**
421
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
437
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
438
+ * @summary Download the email message attachment
422
439
  * @param {string} code
423
440
  * @param {number} attachmentId
424
441
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -429,7 +446,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
429
446
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
430
447
  },
431
448
  /**
432
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
449
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
450
+ * @summary Retrieve the email message
433
451
  * @param {string} code
434
452
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
435
453
  * @param {*} [options] Override http request option.
@@ -439,7 +457,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
439
457
  return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
440
458
  },
441
459
  /**
442
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
460
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
461
+ * @summary List the email message attachments
443
462
  * @param {string} code
444
463
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
464
  * @param {*} [options] Override http request option.
@@ -449,16 +468,16 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
449
468
  return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
450
469
  },
451
470
  /**
452
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
471
+ * 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
472
  * @summary List email messages
454
473
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
474
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
456
475
  * @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>
476
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
458
477
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
459
- * @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>
478
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
460
479
  * @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>
480
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
462
481
  * @param {*} [options] Override http request option.
463
482
  * @throws {RequiredError}
464
483
  */
@@ -480,7 +499,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
480
499
  return _super !== null && _super.apply(this, arguments) || this;
481
500
  }
482
501
  /**
483
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
502
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
503
+ * @summary Download the email message attachment
484
504
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
485
505
  * @param {*} [options] Override http request option.
486
506
  * @throws {RequiredError}
@@ -491,7 +511,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
491
511
  return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
492
512
  };
493
513
  /**
494
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
514
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
515
+ * @summary Retrieve the email message
495
516
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
496
517
  * @param {*} [options] Override http request option.
497
518
  * @throws {RequiredError}
@@ -502,7 +523,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
502
523
  return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
503
524
  };
504
525
  /**
505
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
526
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
527
+ * @summary List the email message attachments
506
528
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
507
529
  * @param {*} [options] Override http request option.
508
530
  * @throws {RequiredError}
@@ -513,7 +535,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
513
535
  return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
536
  };
515
537
  /**
516
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
538
+ * 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
539
  * @summary List email messages
518
540
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
519
541
  * @param {*} [options] Override http request option.