@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +259 -24
  4. package/api/email-tracking-api.ts +32 -24
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/msgraph-webhooks-api.ts +278 -0
  8. package/api/notification-templates-api.ts +56 -36
  9. package/api/notifications-api.ts +115 -4
  10. package/api.ts +2 -0
  11. package/dist/api/email-messages-api.d.ts +158 -24
  12. package/dist/api/email-messages-api.js +225 -22
  13. package/dist/api/email-tracking-api.d.ts +32 -24
  14. package/dist/api/email-tracking-api.js +30 -22
  15. package/dist/api/email-verifications-api.d.ts +16 -8
  16. package/dist/api/email-verifications-api.js +16 -8
  17. package/dist/api/layouts-api.d.ts +56 -36
  18. package/dist/api/layouts-api.js +52 -32
  19. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  20. package/dist/api/msgraph-webhooks-api.js +305 -0
  21. package/dist/api/notification-templates-api.d.ts +56 -36
  22. package/dist/api/notification-templates-api.js +52 -32
  23. package/dist/api/notifications-api.d.ts +65 -4
  24. package/dist/api/notifications-api.js +101 -4
  25. package/dist/api.d.ts +1 -0
  26. package/dist/api.js +1 -0
  27. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  28. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  29. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  30. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  31. package/dist/models/email-message-class.d.ts +49 -2
  32. package/dist/models/email-message-class.js +16 -2
  33. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  34. package/dist/models/grpc-send-email-request-dto.js +22 -0
  35. package/dist/models/index.d.ts +7 -0
  36. package/dist/models/index.js +7 -0
  37. package/dist/models/inline-attachment-dto.d.ts +36 -0
  38. package/dist/models/inline-attachment-dto.js +15 -0
  39. package/dist/models/send-email-request-dto.d.ts +131 -0
  40. package/dist/models/send-email-request-dto.js +22 -0
  41. package/dist/models/send-email-response-class.d.ts +24 -0
  42. package/dist/models/send-email-response-class.js +15 -0
  43. package/dist/models/send-notification-request-dto.d.ts +1 -0
  44. package/dist/models/send-notification-request-dto.js +2 -1
  45. package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
  46. package/dist/models/unassign-email-message-entity-response-class.js +15 -0
  47. package/models/assign-email-message-entity-body-dto.ts +52 -0
  48. package/models/assign-email-message-entity-response-class.ts +31 -0
  49. package/models/email-message-class.ts +53 -3
  50. package/models/grpc-send-email-request-dto.ts +144 -0
  51. package/models/index.ts +7 -0
  52. package/models/inline-attachment-dto.ts +42 -0
  53. package/models/send-email-request-dto.ts +138 -0
  54. package/models/send-email-response-class.ts +30 -0
  55. package/models/send-notification-request-dto.ts +2 -1
  56. package/models/unassign-email-message-entity-response-class.ts +31 -0
  57. package/package.json +1 -1
@@ -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.
@@ -141,7 +142,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
145
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @summary Delete the notification template
145
147
  * @param {number} id
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -188,7 +190,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
188
190
  });
189
191
  },
190
192
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
194
+ * @summary Retrieve the notification template
192
195
  * @param {number} id
193
196
  * @param {number} id2
194
197
  * @param {string} [authorization] Bearer Token
@@ -245,15 +248,16 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
245
248
  });
246
249
  },
247
250
  /**
248
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
251
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
252
+ * @summary List notification templates
249
253
  * @param {string} [authorization] Bearer Token
250
254
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
255
  * @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.
256
+ * @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
257
  * @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.
258
+ * @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>
259
+ * @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>
260
+ * @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
261
  * @param {*} [options] Override http request option.
258
262
  * @throws {RequiredError}
259
263
  */
@@ -316,7 +320,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
316
320
  });
317
321
  },
318
322
  /**
319
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
323
+ * 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\"
324
+ * @summary Update the notification template
320
325
  * @param {number} id
321
326
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
322
327
  * @param {string} [authorization] Bearer Token
@@ -378,7 +383,8 @@ var NotificationTemplatesApiFp = function (configuration) {
378
383
  var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
379
384
  return {
380
385
  /**
381
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
386
+ * 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\"
387
+ * @summary Create the notification template
382
388
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
383
389
  * @param {string} [authorization] Bearer Token
384
390
  * @param {*} [options] Override http request option.
@@ -398,7 +404,8 @@ var NotificationTemplatesApiFp = function (configuration) {
398
404
  });
399
405
  },
400
406
  /**
401
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
407
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
408
+ * @summary Delete the notification template
402
409
  * @param {number} id
403
410
  * @param {string} [authorization] Bearer Token
404
411
  * @param {*} [options] Override http request option.
@@ -418,7 +425,8 @@ var NotificationTemplatesApiFp = function (configuration) {
418
425
  });
419
426
  },
420
427
  /**
421
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
428
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
429
+ * @summary Retrieve the notification template
422
430
  * @param {number} id
423
431
  * @param {number} id2
424
432
  * @param {string} [authorization] Bearer Token
@@ -440,15 +448,16 @@ var NotificationTemplatesApiFp = function (configuration) {
440
448
  });
441
449
  },
442
450
  /**
443
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
451
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
452
+ * @summary List notification templates
444
453
  * @param {string} [authorization] Bearer Token
445
454
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
455
  * @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.
456
+ * @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
457
  * @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.
458
+ * @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>
459
+ * @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>
460
+ * @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
461
  * @param {*} [options] Override http request option.
453
462
  * @throws {RequiredError}
454
463
  */
@@ -466,7 +475,8 @@ var NotificationTemplatesApiFp = function (configuration) {
466
475
  });
467
476
  },
468
477
  /**
469
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
478
+ * 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\"
479
+ * @summary Update the notification template
470
480
  * @param {number} id
471
481
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
472
482
  * @param {string} [authorization] Bearer Token
@@ -497,7 +507,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
497
507
  var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
498
508
  return {
499
509
  /**
500
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
510
+ * 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\"
511
+ * @summary Create the notification template
501
512
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
502
513
  * @param {string} [authorization] Bearer Token
503
514
  * @param {*} [options] Override http request option.
@@ -507,7 +518,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
507
518
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
508
519
  },
509
520
  /**
510
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
521
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
522
+ * @summary Delete the notification template
511
523
  * @param {number} id
512
524
  * @param {string} [authorization] Bearer Token
513
525
  * @param {*} [options] Override http request option.
@@ -517,7 +529,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
517
529
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
518
530
  },
519
531
  /**
520
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
532
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
533
+ * @summary Retrieve the notification template
521
534
  * @param {number} id
522
535
  * @param {number} id2
523
536
  * @param {string} [authorization] Bearer Token
@@ -529,15 +542,16 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
529
542
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
530
543
  },
531
544
  /**
532
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
545
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
546
+ * @summary List notification templates
533
547
  * @param {string} [authorization] Bearer Token
534
548
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
549
  * @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.
550
+ * @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
551
  * @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.
552
+ * @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>
553
+ * @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>
554
+ * @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
555
  * @param {*} [options] Override http request option.
542
556
  * @throws {RequiredError}
543
557
  */
@@ -545,7 +559,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
545
559
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
546
560
  },
547
561
  /**
548
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
562
+ * 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\"
563
+ * @summary Update the notification template
549
564
  * @param {number} id
550
565
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
551
566
  * @param {string} [authorization] Bearer Token
@@ -570,7 +585,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
570
585
  return _super !== null && _super.apply(this, arguments) || this;
571
586
  }
572
587
  /**
573
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
588
+ * 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\"
589
+ * @summary Create the notification template
574
590
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
575
591
  * @param {*} [options] Override http request option.
576
592
  * @throws {RequiredError}
@@ -581,7 +597,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
581
597
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
582
598
  };
583
599
  /**
584
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
600
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
601
+ * @summary Delete the notification template
585
602
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
586
603
  * @param {*} [options] Override http request option.
587
604
  * @throws {RequiredError}
@@ -592,7 +609,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
592
609
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
593
610
  };
594
611
  /**
595
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
612
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
613
+ * @summary Retrieve the notification template
596
614
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
597
615
  * @param {*} [options] Override http request option.
598
616
  * @throws {RequiredError}
@@ -603,7 +621,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
603
621
  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
622
  };
605
623
  /**
606
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
624
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
625
+ * @summary List notification templates
607
626
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
608
627
  * @param {*} [options] Override http request option.
609
628
  * @throws {RequiredError}
@@ -615,7 +634,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
615
634
  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
635
  };
617
636
  /**
618
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
637
+ * 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\"
638
+ * @summary Update the notification template
619
639
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
620
640
  * @param {*} [options] Override http request option.
621
641
  * @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,7 +134,17 @@ 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, {}>>;
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}
@@ -93,7 +93,57 @@ var NotificationsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** none
96
+ * 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
97
+ * @summary Send an email without a template
98
+ * @param {SendEmailRequestDto} sendEmailRequestDto
99
+ * @param {string} [authorization] Bearer Token
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ sendEmail: function (sendEmailRequestDto, authorization, options) {
104
+ if (options === void 0) { options = {}; }
105
+ return __awaiter(_this, void 0, void 0, function () {
106
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
107
+ return __generator(this, function (_a) {
108
+ switch (_a.label) {
109
+ case 0:
110
+ // verify required parameter 'sendEmailRequestDto' is not null or undefined
111
+ (0, common_1.assertParamExists)('sendEmail', 'sendEmailRequestDto', sendEmailRequestDto);
112
+ localVarPath = "/notificationservice/v1/notifications/emails";
113
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ baseAccessToken = configuration.accessToken;
117
+ }
118
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
119
+ localVarHeaderParameter = {};
120
+ localVarQueryParameter = {};
121
+ // authentication bearer required
122
+ // http bearer authentication required
123
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
124
+ case 1:
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ _a.sent();
128
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
129
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
130
+ }
131
+ localVarHeaderParameter['Content-Type'] = 'application/json';
132
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
133
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
134
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
135
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(sendEmailRequestDto, localVarRequestOptions, configuration);
136
+ return [2 /*return*/, {
137
+ url: (0, common_1.toPathString)(localVarUrlObj),
138
+ options: localVarRequestOptions,
139
+ }];
140
+ }
141
+ });
142
+ });
143
+ },
144
+ /**
145
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
146
+ * @summary Send a notification
97
147
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
98
148
  * @param {string} [authorization] Bearer Token
99
149
  * @param {*} [options] Override http request option.
@@ -151,7 +201,29 @@ var NotificationsApiFp = function (configuration) {
151
201
  var localVarAxiosParamCreator = (0, exports.NotificationsApiAxiosParamCreator)(configuration);
152
202
  return {
153
203
  /**
154
- * undefined **Required Permissions** none
204
+ * 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
205
+ * @summary Send an email without a template
206
+ * @param {SendEmailRequestDto} sendEmailRequestDto
207
+ * @param {string} [authorization] Bearer Token
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ */
211
+ sendEmail: function (sendEmailRequestDto, authorization, options) {
212
+ return __awaiter(this, void 0, void 0, function () {
213
+ var localVarAxiosArgs;
214
+ return __generator(this, function (_a) {
215
+ switch (_a.label) {
216
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.sendEmail(sendEmailRequestDto, authorization, options)];
217
+ case 1:
218
+ localVarAxiosArgs = _a.sent();
219
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
220
+ }
221
+ });
222
+ });
223
+ },
224
+ /**
225
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
226
+ * @summary Send a notification
155
227
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
156
228
  * @param {string} [authorization] Bearer Token
157
229
  * @param {*} [options] Override http request option.
@@ -181,7 +253,19 @@ var NotificationsApiFactory = function (configuration, basePath, axios) {
181
253
  var localVarFp = (0, exports.NotificationsApiFp)(configuration);
182
254
  return {
183
255
  /**
184
- * undefined **Required Permissions** none
256
+ * 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
257
+ * @summary Send an email without a template
258
+ * @param {SendEmailRequestDto} sendEmailRequestDto
259
+ * @param {string} [authorization] Bearer Token
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ */
263
+ sendEmail: function (sendEmailRequestDto, authorization, options) {
264
+ return localVarFp.sendEmail(sendEmailRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
265
+ },
266
+ /**
267
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
268
+ * @summary Send a notification
185
269
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
186
270
  * @param {string} [authorization] Bearer Token
187
271
  * @param {*} [options] Override http request option.
@@ -205,7 +289,20 @@ var NotificationsApi = /** @class */ (function (_super) {
205
289
  return _super !== null && _super.apply(this, arguments) || this;
206
290
  }
207
291
  /**
208
- * undefined **Required Permissions** none
292
+ * 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
293
+ * @summary Send an email without a template
294
+ * @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ * @memberof NotificationsApi
298
+ */
299
+ NotificationsApi.prototype.sendEmail = function (requestParameters, options) {
300
+ var _this = this;
301
+ return (0, exports.NotificationsApiFp)(this.configuration).sendEmail(requestParameters.sendEmailRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
302
+ };
303
+ /**
304
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
305
+ * @summary Send a notification
209
306
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
210
307
  * @param {*} [options] Override http request option.
211
308
  * @throws {RequiredError}
package/dist/api.d.ts CHANGED
@@ -14,5 +14,6 @@ export * from './api/email-tracking-api';
14
14
  export * from './api/email-verifications-api';
15
15
  export * from './api/health-api';
16
16
  export * from './api/layouts-api';
17
+ export * from './api/msgraph-webhooks-api';
17
18
  export * from './api/notification-templates-api';
18
19
  export * from './api/notifications-api';
package/dist/api.js CHANGED
@@ -32,5 +32,6 @@ __exportStar(require("./api/email-tracking-api"), exports);
32
32
  __exportStar(require("./api/email-verifications-api"), exports);
33
33
  __exportStar(require("./api/health-api"), exports);
34
34
  __exportStar(require("./api/layouts-api"), exports);
35
+ __exportStar(require("./api/msgraph-webhooks-api"), exports);
35
36
  __exportStar(require("./api/notification-templates-api"), exports);
36
37
  __exportStar(require("./api/notifications-api"), exports);
@@ -0,0 +1,43 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface AssignEmailMessageEntityBodyDto
16
+ */
17
+ export interface AssignEmailMessageEntityBodyDto {
18
+ /**
19
+ * Type of the entity the email message belongs to
20
+ * @type {string}
21
+ * @memberof AssignEmailMessageEntityBodyDto
22
+ */
23
+ 'entityType': AssignEmailMessageEntityBodyDtoEntityTypeEnum;
24
+ /**
25
+ * Code of the entity. Required unless entityNumber is set; takes precedence over entityNumber.
26
+ * @type {string}
27
+ * @memberof AssignEmailMessageEntityBodyDto
28
+ */
29
+ 'entityCode'?: string;
30
+ /**
31
+ * Number of the entity, e.g. the policy number. Used only when entityCode is not set.
32
+ * @type {string}
33
+ * @memberof AssignEmailMessageEntityBodyDto
34
+ */
35
+ 'entityNumber'?: string;
36
+ }
37
+ export declare const AssignEmailMessageEntityBodyDtoEntityTypeEnum: {
38
+ readonly Claim: "Claim";
39
+ readonly Policy: "Policy";
40
+ readonly Lead: "Lead";
41
+ readonly Partner: "Partner";
42
+ };
43
+ export type AssignEmailMessageEntityBodyDtoEntityTypeEnum = typeof AssignEmailMessageEntityBodyDtoEntityTypeEnum[keyof typeof AssignEmailMessageEntityBodyDtoEntityTypeEnum];
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL NotificationService
6
+ * The EMIL NotificationService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AssignEmailMessageEntityBodyDtoEntityTypeEnum = void 0;
17
+ exports.AssignEmailMessageEntityBodyDtoEntityTypeEnum = {
18
+ Claim: 'Claim',
19
+ Policy: 'Policy',
20
+ Lead: 'Lead',
21
+ Partner: 'Partner'
22
+ };
@@ -0,0 +1,25 @@
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 { EmailMessageClass } from './email-message-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AssignEmailMessageEntityResponseClass
17
+ */
18
+ export interface AssignEmailMessageEntityResponseClass {
19
+ /**
20
+ * The email message response.
21
+ * @type {EmailMessageClass}
22
+ * @memberof AssignEmailMessageEntityResponseClass
23
+ */
24
+ 'message': EmailMessageClass;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL NotificationService
6
+ * The EMIL NotificationService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });