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

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 (104) hide show
  1. package/.openapi-generator/FILES +23 -0
  2. package/README.md +2 -2
  3. package/api/email-mailboxes-api.ts +148 -0
  4. package/api/email-messages-api.ts +40 -28
  5. package/api/email-subscriptions-api.ts +769 -0
  6. package/api/email-tracking-api.ts +271 -40
  7. package/api/email-verifications-api.ts +16 -8
  8. package/api/layouts-api.ts +56 -36
  9. package/api/msgraph-webhooks-api.ts +278 -0
  10. package/api/notification-templates-api.ts +56 -36
  11. package/api/notifications-api.ts +115 -4
  12. package/api.ts +6 -0
  13. package/dist/api/email-mailboxes-api.d.ts +87 -0
  14. package/dist/api/email-mailboxes-api.js +218 -0
  15. package/dist/api/email-messages-api.d.ts +40 -28
  16. package/dist/api/email-messages-api.js +37 -25
  17. package/dist/api/email-subscriptions-api.d.ts +432 -0
  18. package/dist/api/email-subscriptions-api.js +722 -0
  19. package/dist/api/email-tracking-api.d.ts +170 -40
  20. package/dist/api/email-tracking-api.js +233 -34
  21. package/dist/api/email-verifications-api.d.ts +16 -8
  22. package/dist/api/email-verifications-api.js +16 -8
  23. package/dist/api/layouts-api.d.ts +56 -36
  24. package/dist/api/layouts-api.js +52 -32
  25. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  26. package/dist/api/msgraph-webhooks-api.js +305 -0
  27. package/dist/api/notification-templates-api.d.ts +56 -36
  28. package/dist/api/notification-templates-api.js +52 -32
  29. package/dist/api/notifications-api.d.ts +65 -4
  30. package/dist/api/notifications-api.js +101 -4
  31. package/dist/api.d.ts +3 -0
  32. package/dist/api.js +3 -0
  33. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  34. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  35. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  36. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  37. package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
  38. package/dist/models/catch-up-email-subscription-response-class.js +15 -0
  39. package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
  40. package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
  41. package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
  42. package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
  43. package/dist/models/email-mailbox-class.d.ts +47 -0
  44. package/dist/models/email-mailbox-class.js +20 -0
  45. package/dist/models/email-message-class.d.ts +73 -7
  46. package/dist/models/email-message-class.js +22 -3
  47. package/dist/models/email-message-summary-class.d.ts +98 -0
  48. package/dist/models/email-message-summary-class.js +33 -0
  49. package/dist/models/email-subscription-class.d.ts +110 -0
  50. package/dist/models/email-subscription-class.js +23 -0
  51. package/dist/models/email-thread-class.d.ts +37 -5
  52. package/dist/models/entity-ref-class.d.ts +37 -0
  53. package/dist/models/entity-ref-class.js +22 -0
  54. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  55. package/dist/models/get-email-subscription-response-class.js +15 -0
  56. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  57. package/dist/models/grpc-send-email-request-dto.js +22 -0
  58. package/dist/models/index.d.ts +20 -0
  59. package/dist/models/index.js +20 -0
  60. package/dist/models/inline-attachment-dto.d.ts +36 -0
  61. package/dist/models/inline-attachment-dto.js +15 -0
  62. package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
  63. package/dist/models/list-email-mailboxes-response-class.js +15 -0
  64. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  65. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  66. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  67. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  68. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  69. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  70. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  71. package/dist/models/renew-email-subscription-response-class.js +15 -0
  72. package/dist/models/send-email-request-dto.d.ts +131 -0
  73. package/dist/models/send-email-request-dto.js +22 -0
  74. package/dist/models/send-email-response-class.d.ts +24 -0
  75. package/dist/models/send-email-response-class.js +15 -0
  76. package/dist/models/send-notification-request-dto.d.ts +10 -1
  77. package/dist/models/send-notification-request-dto.js +2 -1
  78. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  79. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  80. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  81. package/models/assign-email-thread-entity-response-class.ts +31 -0
  82. package/models/catch-up-email-subscription-response-class.ts +30 -0
  83. package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
  84. package/models/catch-up-email-subscriptions-response-class.ts +36 -0
  85. package/models/email-mailbox-class.ts +56 -0
  86. package/models/email-message-class.ts +78 -8
  87. package/models/email-message-summary-class.ts +109 -0
  88. package/models/email-subscription-class.ts +119 -0
  89. package/models/email-thread-class.ts +37 -5
  90. package/models/entity-ref-class.ts +46 -0
  91. package/models/get-email-subscription-response-class.ts +31 -0
  92. package/models/grpc-send-email-request-dto.ts +144 -0
  93. package/models/index.ts +20 -0
  94. package/models/inline-attachment-dto.ts +42 -0
  95. package/models/list-email-mailboxes-response-class.ts +49 -0
  96. package/models/list-email-subscriptions-response-class.ts +49 -0
  97. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  98. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  99. package/models/renew-email-subscription-response-class.ts +31 -0
  100. package/models/send-email-request-dto.ts +138 -0
  101. package/models/send-email-response-class.ts +30 -0
  102. package/models/send-notification-request-dto.ts +9 -2
  103. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  104. package/package.json +1 -1
@@ -39,7 +39,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
39
39
  export const NotificationTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
42
+ * 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\"
43
+ * @summary Create the notification template
43
44
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
44
45
  * @param {string} [authorization] Bearer Token
45
46
  * @param {*} [options] Override http request option.
@@ -85,7 +86,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
85
86
  };
86
87
  },
87
88
  /**
88
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
89
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
90
+ * @summary Delete the notification template
89
91
  * @param {number} id
90
92
  * @param {string} [authorization] Bearer Token
91
93
  * @param {*} [options] Override http request option.
@@ -129,7 +131,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
129
131
  };
130
132
  },
131
133
  /**
132
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
134
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
135
+ * @summary Retrieve the notification template
133
136
  * @param {number} id
134
137
  * @param {number} id2
135
138
  * @param {string} [authorization] Bearer Token
@@ -185,15 +188,16 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
185
188
  };
186
189
  },
187
190
  /**
188
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
191
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
192
+ * @summary List notification templates
189
193
  * @param {string} [authorization] Bearer Token
190
194
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
191
195
  * @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.
192
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
196
+ * @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>
193
197
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
194
- * @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.
195
- * @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.
196
- * @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.
198
+ * @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>
199
+ * @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>
200
+ * @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>
197
201
  * @param {*} [options] Override http request option.
198
202
  * @throws {RequiredError}
199
203
  */
@@ -260,7 +264,8 @@ export const NotificationTemplatesApiAxiosParamCreator = function (configuration
260
264
  };
261
265
  },
262
266
  /**
263
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
267
+ * 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\"
268
+ * @summary Update the notification template
264
269
  * @param {number} id
265
270
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
266
271
  * @param {string} [authorization] Bearer Token
@@ -320,7 +325,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
320
325
  const localVarAxiosParamCreator = NotificationTemplatesApiAxiosParamCreator(configuration)
321
326
  return {
322
327
  /**
323
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
328
+ * 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\"
329
+ * @summary Create the notification template
324
330
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
325
331
  * @param {string} [authorization] Bearer Token
326
332
  * @param {*} [options] Override http request option.
@@ -331,7 +337,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
331
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
332
338
  },
333
339
  /**
334
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
340
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
341
+ * @summary Delete the notification template
335
342
  * @param {number} id
336
343
  * @param {string} [authorization] Bearer Token
337
344
  * @param {*} [options] Override http request option.
@@ -342,7 +349,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
342
349
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
343
350
  },
344
351
  /**
345
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
352
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
353
+ * @summary Retrieve the notification template
346
354
  * @param {number} id
347
355
  * @param {number} id2
348
356
  * @param {string} [authorization] Bearer Token
@@ -355,15 +363,16 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
355
363
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
356
364
  },
357
365
  /**
358
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
366
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
367
+ * @summary List notification templates
359
368
  * @param {string} [authorization] Bearer Token
360
369
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
361
370
  * @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.
362
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
371
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: name, slug</i>
363
372
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
364
- * @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.
365
- * @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.
366
- * @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.
373
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, name, createdAt</i>
374
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
375
+ * @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>
367
376
  * @param {*} [options] Override http request option.
368
377
  * @throws {RequiredError}
369
378
  */
@@ -372,7 +381,8 @@ export const NotificationTemplatesApiFp = function(configuration?: Configuration
372
381
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
373
382
  },
374
383
  /**
375
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
384
+ * 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\"
385
+ * @summary Update the notification template
376
386
  * @param {number} id
377
387
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
378
388
  * @param {string} [authorization] Bearer Token
@@ -394,7 +404,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
394
404
  const localVarFp = NotificationTemplatesApiFp(configuration)
395
405
  return {
396
406
  /**
397
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
407
+ * 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\"
408
+ * @summary Create the notification template
398
409
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
399
410
  * @param {string} [authorization] Bearer Token
400
411
  * @param {*} [options] Override http request option.
@@ -404,7 +415,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
404
415
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
405
416
  },
406
417
  /**
407
- * 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
408
420
  * @param {number} id
409
421
  * @param {string} [authorization] Bearer Token
410
422
  * @param {*} [options] Override http request option.
@@ -414,7 +426,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
414
426
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then((request) => request(axios, basePath));
415
427
  },
416
428
  /**
417
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
429
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
430
+ * @summary Retrieve the notification template
418
431
  * @param {number} id
419
432
  * @param {number} id2
420
433
  * @param {string} [authorization] Bearer Token
@@ -426,15 +439,16 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
426
439
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
427
440
  },
428
441
  /**
429
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
442
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
443
+ * @summary List notification templates
430
444
  * @param {string} [authorization] Bearer Token
431
445
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
432
446
  * @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.
433
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
447
+ * @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>
434
448
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
435
- * @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.
436
- * @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.
437
- * @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.
449
+ * @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>
450
+ * @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>
451
+ * @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>
438
452
  * @param {*} [options] Override http request option.
439
453
  * @throws {RequiredError}
440
454
  */
@@ -442,7 +456,8 @@ export const NotificationTemplatesApiFactory = function (configuration?: Configu
442
456
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
443
457
  },
444
458
  /**
445
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
459
+ * 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\"
460
+ * @summary Update the notification template
446
461
  * @param {number} id
447
462
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
448
463
  * @param {string} [authorization] Bearer Token
@@ -560,7 +575,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
560
575
  readonly pageToken?: string
561
576
 
562
577
  /**
563
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
578
+ * 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>
564
579
  * @type {string}
565
580
  * @memberof NotificationTemplatesApiListNotificationTemplates
566
581
  */
@@ -574,21 +589,21 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
574
589
  readonly search?: string
575
590
 
576
591
  /**
577
- * 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.
592
+ * 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>
578
593
  * @type {string}
579
594
  * @memberof NotificationTemplatesApiListNotificationTemplates
580
595
  */
581
596
  readonly order?: string
582
597
 
583
598
  /**
584
- * 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.
599
+ * 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>
585
600
  * @type {string}
586
601
  * @memberof NotificationTemplatesApiListNotificationTemplates
587
602
  */
588
603
  readonly expand?: string
589
604
 
590
605
  /**
591
- * 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.
606
+ * 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>
592
607
  * @type {string}
593
608
  * @memberof NotificationTemplatesApiListNotificationTemplates
594
609
  */
@@ -631,7 +646,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
631
646
  */
632
647
  export class NotificationTemplatesApi extends BaseAPI {
633
648
  /**
634
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
649
+ * 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\"
650
+ * @summary Create the notification template
635
651
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
636
652
  * @param {*} [options] Override http request option.
637
653
  * @throws {RequiredError}
@@ -642,7 +658,8 @@ export class NotificationTemplatesApi extends BaseAPI {
642
658
  }
643
659
 
644
660
  /**
645
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
661
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
662
+ * @summary Delete the notification template
646
663
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
647
664
  * @param {*} [options] Override http request option.
648
665
  * @throws {RequiredError}
@@ -653,7 +670,8 @@ export class NotificationTemplatesApi extends BaseAPI {
653
670
  }
654
671
 
655
672
  /**
656
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
673
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
674
+ * @summary Retrieve the notification template
657
675
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
658
676
  * @param {*} [options] Override http request option.
659
677
  * @throws {RequiredError}
@@ -664,7 +682,8 @@ export class NotificationTemplatesApi extends BaseAPI {
664
682
  }
665
683
 
666
684
  /**
667
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
685
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
686
+ * @summary List notification templates
668
687
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
669
688
  * @param {*} [options] Override http request option.
670
689
  * @throws {RequiredError}
@@ -675,7 +694,8 @@ export class NotificationTemplatesApi extends BaseAPI {
675
694
  }
676
695
 
677
696
  /**
678
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
697
+ * 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\"
698
+ * @summary Update the notification template
679
699
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
680
700
  * @param {*} [options] Override http request option.
681
701
  * @throws {RequiredError}
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { SendEmailRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { SendEmailResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { SendNotificationRequestDto } from '../models';
25
29
  // @ts-ignore
26
30
  import { SendNotificationResponseClass } from '../models';
@@ -31,7 +35,55 @@ import { SendNotificationResponseClass } from '../models';
31
35
  export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
36
  return {
33
37
  /**
34
- * undefined **Required Permissions** none
38
+ * 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
39
+ * @summary Send an email without a template
40
+ * @param {SendEmailRequestDto} sendEmailRequestDto
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ sendEmail: async (sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ // verify required parameter 'sendEmailRequestDto' is not null or undefined
47
+ assertParamExists('sendEmail', 'sendEmailRequestDto', sendEmailRequestDto)
48
+ const localVarPath = `/notificationservice/v1/notifications/emails`;
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ let baseAccessToken;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ baseAccessToken = configuration.accessToken;
56
+ }
57
+
58
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
59
+ const localVarHeaderParameter = {} as any;
60
+ const localVarQueryParameter = {} as any;
61
+
62
+ // authentication bearer required
63
+ // http bearer authentication required
64
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
+
66
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
68
+ }
69
+
70
+
71
+
72
+ localVarHeaderParameter['Content-Type'] = 'application/json';
73
+
74
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
+ localVarRequestOptions.data = serializeDataIfNeeded(sendEmailRequestDto, localVarRequestOptions, configuration)
78
+
79
+ return {
80
+ url: toPathString(localVarUrlObj),
81
+ options: localVarRequestOptions,
82
+ };
83
+ },
84
+ /**
85
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
86
+ * @summary Send a notification
35
87
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
36
88
  * @param {string} [authorization] Bearer Token
37
89
  * @param {*} [options] Override http request option.
@@ -87,7 +139,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
87
139
  const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
88
140
  return {
89
141
  /**
90
- * undefined **Required Permissions** none
142
+ * 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
143
+ * @summary Send an email without a template
144
+ * @param {SendEmailRequestDto} sendEmailRequestDto
145
+ * @param {string} [authorization] Bearer Token
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ async sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendEmailResponseClass>> {
150
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sendEmail(sendEmailRequestDto, authorization, options);
151
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
152
+ },
153
+ /**
154
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
155
+ * @summary Send a notification
91
156
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
92
157
  * @param {string} [authorization] Bearer Token
93
158
  * @param {*} [options] Override http request option.
@@ -108,7 +173,19 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
108
173
  const localVarFp = NotificationsApiFp(configuration)
109
174
  return {
110
175
  /**
111
- * undefined **Required Permissions** none
176
+ * 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
177
+ * @summary Send an email without a template
178
+ * @param {SendEmailRequestDto} sendEmailRequestDto
179
+ * @param {string} [authorization] Bearer Token
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: any): AxiosPromise<SendEmailResponseClass> {
184
+ return localVarFp.sendEmail(sendEmailRequestDto, authorization, options).then((request) => request(axios, basePath));
185
+ },
186
+ /**
187
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
188
+ * @summary Send a notification
112
189
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
113
190
  * @param {string} [authorization] Bearer Token
114
191
  * @param {*} [options] Override http request option.
@@ -120,6 +197,27 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
120
197
  };
121
198
  };
122
199
 
200
+ /**
201
+ * Request parameters for sendEmail operation in NotificationsApi.
202
+ * @export
203
+ * @interface NotificationsApiSendEmailRequest
204
+ */
205
+ export interface NotificationsApiSendEmailRequest {
206
+ /**
207
+ *
208
+ * @type {SendEmailRequestDto}
209
+ * @memberof NotificationsApiSendEmail
210
+ */
211
+ readonly sendEmailRequestDto: SendEmailRequestDto
212
+
213
+ /**
214
+ * Bearer Token
215
+ * @type {string}
216
+ * @memberof NotificationsApiSendEmail
217
+ */
218
+ readonly authorization?: string
219
+ }
220
+
123
221
  /**
124
222
  * Request parameters for sendNotification operation in NotificationsApi.
125
223
  * @export
@@ -149,7 +247,20 @@ export interface NotificationsApiSendNotificationRequest {
149
247
  */
150
248
  export class NotificationsApi extends BaseAPI {
151
249
  /**
152
- * undefined **Required Permissions** none
250
+ * 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
251
+ * @summary Send an email without a template
252
+ * @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ * @memberof NotificationsApi
256
+ */
257
+ public sendEmail(requestParameters: NotificationsApiSendEmailRequest, options?: AxiosRequestConfig) {
258
+ return NotificationsApiFp(this.configuration).sendEmail(requestParameters.sendEmailRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
259
+ }
260
+
261
+ /**
262
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
263
+ * @summary Send a notification
153
264
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
154
265
  * @param {*} [options] Override http request option.
155
266
  * @throws {RequiredError}
package/api.ts CHANGED
@@ -20,20 +20,26 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
+ import { EmailMailboxesApi } from './api';
23
24
  import { EmailMessagesApi } from './api';
25
+ import { EmailSubscriptionsApi } from './api';
24
26
  import { EmailTrackingApi } from './api';
25
27
  import { EmailVerificationsApi } from './api';
26
28
  import { HealthApi } from './api';
27
29
  import { LayoutsApi } from './api';
30
+ import { MSGraphWebhooksApi } from './api';
28
31
  import { NotificationTemplatesApi } from './api';
29
32
  import { NotificationsApi } from './api';
30
33
 
31
34
 
35
+ export * from './api/email-mailboxes-api';
32
36
  export * from './api/email-messages-api';
37
+ export * from './api/email-subscriptions-api';
33
38
  export * from './api/email-tracking-api';
34
39
  export * from './api/email-verifications-api';
35
40
  export * from './api/health-api';
36
41
  export * from './api/layouts-api';
42
+ export * from './api/msgraph-webhooks-api';
37
43
  export * from './api/notification-templates-api';
38
44
  export * from './api/notifications-api';
39
45
 
@@ -0,0 +1,87 @@
1
+ /**
2
+ * EMIL NotificationService
3
+ * The EMIL NotificationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { ListEmailMailboxesResponseClass } from '../models';
16
+ /**
17
+ * EmailMailboxesApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const EmailMailboxesApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
23
+ * @summary List the email mailboxes
24
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
25
+ * @param {*} [options] Override http request option.
26
+ * @throws {RequiredError}
27
+ */
28
+ listEmailMailboxes: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
29
+ };
30
+ /**
31
+ * EmailMailboxesApi - functional programming interface
32
+ * @export
33
+ */
34
+ export declare const EmailMailboxesApiFp: (configuration?: Configuration) => {
35
+ /**
36
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
37
+ * @summary List the email mailboxes
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ listEmailMailboxes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMailboxesResponseClass>>;
43
+ };
44
+ /**
45
+ * EmailMailboxesApi - factory interface
46
+ * @export
47
+ */
48
+ export declare const EmailMailboxesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
49
+ /**
50
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
51
+ * @summary List the email mailboxes
52
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ listEmailMailboxes(authorization?: string, options?: any): AxiosPromise<ListEmailMailboxesResponseClass>;
57
+ };
58
+ /**
59
+ * Request parameters for listEmailMailboxes operation in EmailMailboxesApi.
60
+ * @export
61
+ * @interface EmailMailboxesApiListEmailMailboxesRequest
62
+ */
63
+ export interface EmailMailboxesApiListEmailMailboxesRequest {
64
+ /**
65
+ * Bearer Token: provided by the login endpoint under the name accessToken.
66
+ * @type {string}
67
+ * @memberof EmailMailboxesApiListEmailMailboxes
68
+ */
69
+ readonly authorization?: string;
70
+ }
71
+ /**
72
+ * EmailMailboxesApi - object-oriented interface
73
+ * @export
74
+ * @class EmailMailboxesApi
75
+ * @extends {BaseAPI}
76
+ */
77
+ export declare class EmailMailboxesApi extends BaseAPI {
78
+ /**
79
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
80
+ * @summary List the email mailboxes
81
+ * @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ * @memberof EmailMailboxesApi
85
+ */
86
+ listEmailMailboxes(requestParameters?: EmailMailboxesApiListEmailMailboxesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMailboxesResponseClass, any, {}>>;
87
+ }