@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 NotificationTemplatesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
96
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
97
+ * @summary Create the notification template
97
98
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -102,7 +103,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
102
103
  createNotificationTemplate: function (createNotificationTemplateRequestDto, authorization, options) {
103
104
  if (options === void 0) { options = {}; }
104
105
  return __awaiter(_this, void 0, void 0, function () {
105
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
106
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
106
107
  return __generator(this, function (_a) {
107
108
  switch (_a.label) {
108
109
  case 0:
@@ -119,13 +120,16 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
119
120
  localVarQueryParameter = {};
120
121
  // authentication bearer required
121
122
  // http bearer authentication required
122
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
123
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
124
+ // Only Authorization falls back to the configured token; an empty value is never sent.
125
+ ];
123
126
  case 1:
124
127
  // authentication bearer required
125
128
  // http bearer authentication required
126
129
  _a.sent();
127
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
128
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
130
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
131
+ if (authorizationValue) {
132
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
129
133
  }
130
134
  localVarHeaderParameter['Content-Type'] = 'application/json';
131
135
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -141,7 +145,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
141
145
  });
142
146
  },
143
147
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
148
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
149
+ * @summary Delete the notification template
145
150
  * @param {number} id
146
151
  * @param {string} [authorization] Bearer Token
147
152
  * @param {*} [options] Override http request option.
@@ -150,7 +155,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
150
155
  deleteNotificationTemplate: function (id, authorization, options) {
151
156
  if (options === void 0) { options = {}; }
152
157
  return __awaiter(_this, void 0, void 0, function () {
153
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
158
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
154
159
  return __generator(this, function (_a) {
155
160
  switch (_a.label) {
156
161
  case 0:
@@ -168,13 +173,16 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
168
173
  localVarQueryParameter = {};
169
174
  // authentication bearer required
170
175
  // http bearer authentication required
171
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
176
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
177
+ // Only Authorization falls back to the configured token; an empty value is never sent.
178
+ ];
172
179
  case 1:
173
180
  // authentication bearer required
174
181
  // http bearer authentication required
175
182
  _a.sent();
176
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
177
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
183
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
184
+ if (authorizationValue) {
185
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
178
186
  }
179
187
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
180
188
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -188,7 +196,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
188
196
  });
189
197
  },
190
198
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
199
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
200
+ * @summary Retrieve the notification template
192
201
  * @param {number} id
193
202
  * @param {number} id2
194
203
  * @param {string} [authorization] Bearer Token
@@ -199,7 +208,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
199
208
  getNotificationTemplate: function (id, id2, authorization, expand, options) {
200
209
  if (options === void 0) { options = {}; }
201
210
  return __awaiter(_this, void 0, void 0, function () {
202
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
211
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
203
212
  return __generator(this, function (_a) {
204
213
  switch (_a.label) {
205
214
  case 0:
@@ -230,8 +239,9 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
230
239
  if (expand !== undefined) {
231
240
  localVarQueryParameter['expand'] = expand;
232
241
  }
233
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
234
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
242
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
243
+ if (authorizationValue) {
244
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
235
245
  }
236
246
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
237
247
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -245,22 +255,23 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
245
255
  });
246
256
  },
247
257
  /**
248
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
258
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
259
+ * @summary List notification templates
249
260
  * @param {string} [authorization] Bearer Token
250
261
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
262
  * @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.
252
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
263
+ * @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: name, slug</i>
253
264
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
254
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
255
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
256
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
265
+ * @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, name, createdAt</i>
266
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
267
+ * @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: name, slug</i>
257
268
  * @param {*} [options] Override http request option.
258
269
  * @throws {RequiredError}
259
270
  */
260
271
  listNotificationTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
261
272
  if (options === void 0) { options = {}; }
262
273
  return __awaiter(_this, void 0, void 0, function () {
263
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
274
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
264
275
  return __generator(this, function (_a) {
265
276
  switch (_a.label) {
266
277
  case 0:
@@ -301,8 +312,9 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
301
312
  if (filters !== undefined) {
302
313
  localVarQueryParameter['filters'] = filters;
303
314
  }
304
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
305
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
315
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
316
+ if (authorizationValue) {
317
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
306
318
  }
307
319
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
308
320
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -316,7 +328,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
316
328
  });
317
329
  },
318
330
  /**
319
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
331
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
332
+ * @summary Update the notification template
320
333
  * @param {number} id
321
334
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
322
335
  * @param {string} [authorization] Bearer Token
@@ -326,7 +339,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
326
339
  updateNotificationTemplate: function (id, updateNotificationTemplateRequestDto, authorization, options) {
327
340
  if (options === void 0) { options = {}; }
328
341
  return __awaiter(_this, void 0, void 0, function () {
329
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
342
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
330
343
  return __generator(this, function (_a) {
331
344
  switch (_a.label) {
332
345
  case 0:
@@ -346,13 +359,16 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
346
359
  localVarQueryParameter = {};
347
360
  // authentication bearer required
348
361
  // http bearer authentication required
349
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
362
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
363
+ // Only Authorization falls back to the configured token; an empty value is never sent.
364
+ ];
350
365
  case 1:
351
366
  // authentication bearer required
352
367
  // http bearer authentication required
353
368
  _a.sent();
354
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
355
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
369
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
370
+ if (authorizationValue) {
371
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
356
372
  }
357
373
  localVarHeaderParameter['Content-Type'] = 'application/json';
358
374
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -378,7 +394,8 @@ var NotificationTemplatesApiFp = function (configuration) {
378
394
  var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
379
395
  return {
380
396
  /**
381
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
397
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
398
+ * @summary Create the notification template
382
399
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
383
400
  * @param {string} [authorization] Bearer Token
384
401
  * @param {*} [options] Override http request option.
@@ -398,7 +415,8 @@ var NotificationTemplatesApiFp = function (configuration) {
398
415
  });
399
416
  },
400
417
  /**
401
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
418
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
419
+ * @summary Delete the notification template
402
420
  * @param {number} id
403
421
  * @param {string} [authorization] Bearer Token
404
422
  * @param {*} [options] Override http request option.
@@ -418,7 +436,8 @@ var NotificationTemplatesApiFp = function (configuration) {
418
436
  });
419
437
  },
420
438
  /**
421
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
439
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
440
+ * @summary Retrieve the notification template
422
441
  * @param {number} id
423
442
  * @param {number} id2
424
443
  * @param {string} [authorization] Bearer Token
@@ -440,15 +459,16 @@ var NotificationTemplatesApiFp = function (configuration) {
440
459
  });
441
460
  },
442
461
  /**
443
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
462
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
463
+ * @summary List notification templates
444
464
  * @param {string} [authorization] Bearer Token
445
465
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
466
  * @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.
447
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
467
+ * @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: name, slug</i>
448
468
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
449
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
450
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
451
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
469
+ * @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, name, createdAt</i>
470
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
471
+ * @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: name, slug</i>
452
472
  * @param {*} [options] Override http request option.
453
473
  * @throws {RequiredError}
454
474
  */
@@ -466,7 +486,8 @@ var NotificationTemplatesApiFp = function (configuration) {
466
486
  });
467
487
  },
468
488
  /**
469
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
489
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
490
+ * @summary Update the notification template
470
491
  * @param {number} id
471
492
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
472
493
  * @param {string} [authorization] Bearer Token
@@ -497,7 +518,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
497
518
  var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
498
519
  return {
499
520
  /**
500
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
521
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
522
+ * @summary Create the notification template
501
523
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
502
524
  * @param {string} [authorization] Bearer Token
503
525
  * @param {*} [options] Override http request option.
@@ -507,7 +529,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
507
529
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
508
530
  },
509
531
  /**
510
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
532
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
533
+ * @summary Delete the notification template
511
534
  * @param {number} id
512
535
  * @param {string} [authorization] Bearer Token
513
536
  * @param {*} [options] Override http request option.
@@ -517,7 +540,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
517
540
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
518
541
  },
519
542
  /**
520
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
543
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
544
+ * @summary Retrieve the notification template
521
545
  * @param {number} id
522
546
  * @param {number} id2
523
547
  * @param {string} [authorization] Bearer Token
@@ -529,15 +553,16 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
529
553
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
530
554
  },
531
555
  /**
532
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
556
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
557
+ * @summary List notification templates
533
558
  * @param {string} [authorization] Bearer Token
534
559
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
560
  * @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.
536
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
561
+ * @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: name, slug</i>
537
562
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
538
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
539
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
540
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
563
+ * @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, name, createdAt</i>
564
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
565
+ * @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: name, slug</i>
541
566
  * @param {*} [options] Override http request option.
542
567
  * @throws {RequiredError}
543
568
  */
@@ -545,7 +570,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
545
570
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
546
571
  },
547
572
  /**
548
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
573
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
574
+ * @summary Update the notification template
549
575
  * @param {number} id
550
576
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
551
577
  * @param {string} [authorization] Bearer Token
@@ -570,7 +596,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
570
596
  return _super !== null && _super.apply(this, arguments) || this;
571
597
  }
572
598
  /**
573
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
599
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
600
+ * @summary Create the notification template
574
601
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
575
602
  * @param {*} [options] Override http request option.
576
603
  * @throws {RequiredError}
@@ -581,7 +608,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
581
608
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
582
609
  };
583
610
  /**
584
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
611
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
612
+ * @summary Delete the notification template
585
613
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
586
614
  * @param {*} [options] Override http request option.
587
615
  * @throws {RequiredError}
@@ -592,7 +620,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
592
620
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
593
621
  };
594
622
  /**
595
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
623
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
624
+ * @summary Retrieve the notification template
596
625
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
597
626
  * @param {*} [options] Override http request option.
598
627
  * @throws {RequiredError}
@@ -603,7 +632,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
603
632
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).getNotificationTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
604
633
  };
605
634
  /**
606
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
635
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
636
+ * @summary List notification templates
607
637
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
608
638
  * @param {*} [options] Override http request option.
609
639
  * @throws {RequiredError}
@@ -615,7 +645,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
615
645
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).listNotificationTemplates(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); });
616
646
  };
617
647
  /**
618
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
648
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
649
+ * @summary Update the notification template
619
650
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
620
651
  * @param {*} [options] Override http request option.
621
652
  * @throws {RequiredError}
@@ -12,6 +12,8 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { SendEmailRequestDto } from '../models';
16
+ import { SendEmailResponseClass } from '../models';
15
17
  import { SendNotificationRequestDto } from '../models';
16
18
  import { SendNotificationResponseClass } from '../models';
17
19
  /**
@@ -20,7 +22,17 @@ import { SendNotificationResponseClass } from '../models';
20
22
  */
21
23
  export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
22
24
  /**
23
- * undefined **Required Permissions** none
25
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
26
+ * @summary Send an email without a template
27
+ * @param {SendEmailRequestDto} sendEmailRequestDto
28
+ * @param {string} [authorization] Bearer Token
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ sendEmail: (sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
+ /**
34
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
35
+ * @summary Send a notification
24
36
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
25
37
  * @param {string} [authorization] Bearer Token
26
38
  * @param {*} [options] Override http request option.
@@ -34,7 +46,17 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
34
46
  */
35
47
  export declare const NotificationsApiFp: (configuration?: Configuration) => {
36
48
  /**
37
- * undefined **Required Permissions** none
49
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
50
+ * @summary Send an email without a template
51
+ * @param {SendEmailRequestDto} sendEmailRequestDto
52
+ * @param {string} [authorization] Bearer Token
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendEmailResponseClass>>;
57
+ /**
58
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
59
+ * @summary Send a notification
38
60
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
39
61
  * @param {string} [authorization] Bearer Token
40
62
  * @param {*} [options] Override http request option.
@@ -48,7 +70,17 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
48
70
  */
49
71
  export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50
72
  /**
51
- * undefined **Required Permissions** none
73
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
74
+ * @summary Send an email without a template
75
+ * @param {SendEmailRequestDto} sendEmailRequestDto
76
+ * @param {string} [authorization] Bearer Token
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: any): AxiosPromise<SendEmailResponseClass>;
81
+ /**
82
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
83
+ * @summary Send a notification
52
84
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
53
85
  * @param {string} [authorization] Bearer Token
54
86
  * @param {*} [options] Override http request option.
@@ -56,6 +88,25 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
56
88
  */
57
89
  sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: any): AxiosPromise<SendNotificationResponseClass>;
58
90
  };
91
+ /**
92
+ * Request parameters for sendEmail operation in NotificationsApi.
93
+ * @export
94
+ * @interface NotificationsApiSendEmailRequest
95
+ */
96
+ export interface NotificationsApiSendEmailRequest {
97
+ /**
98
+ *
99
+ * @type {SendEmailRequestDto}
100
+ * @memberof NotificationsApiSendEmail
101
+ */
102
+ readonly sendEmailRequestDto: SendEmailRequestDto;
103
+ /**
104
+ * Bearer Token
105
+ * @type {string}
106
+ * @memberof NotificationsApiSendEmail
107
+ */
108
+ readonly authorization?: string;
109
+ }
59
110
  /**
60
111
  * Request parameters for sendNotification operation in NotificationsApi.
61
112
  * @export
@@ -83,11 +134,21 @@ export interface NotificationsApiSendNotificationRequest {
83
134
  */
84
135
  export declare class NotificationsApi extends BaseAPI {
85
136
  /**
86
- * undefined **Required Permissions** none
137
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
138
+ * @summary Send an email without a template
139
+ * @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ * @memberof NotificationsApi
143
+ */
144
+ sendEmail(requestParameters: NotificationsApiSendEmailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendEmailResponseClass, any, {}, any>>;
145
+ /**
146
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
147
+ * @summary Send a notification
87
148
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
88
149
  * @param {*} [options] Override http request option.
89
150
  * @throws {RequiredError}
90
151
  * @memberof NotificationsApi
91
152
  */
92
- sendNotification(requestParameters: NotificationsApiSendNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendNotificationResponseClass, any, {}>>;
153
+ sendNotification(requestParameters: NotificationsApiSendNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendNotificationResponseClass, any, {}, any>>;
93
154
  }