@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
@@ -0,0 +1,131 @@
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 { InlineAttachmentDto } from './inline-attachment-dto';
13
+ import { S3DocumentDto } from './s3-document-dto';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface SendEmailRequestDto
18
+ */
19
+ export interface SendEmailRequestDto {
20
+ /**
21
+ * Subject of the email
22
+ * @type {string}
23
+ * @memberof SendEmailRequestDto
24
+ */
25
+ 'emailSubject': string;
26
+ /**
27
+ * HTML body of the email, sent as given. Required unless textBody is set.
28
+ * @type {string}
29
+ * @memberof SendEmailRequestDto
30
+ */
31
+ 'htmlBody'?: string;
32
+ /**
33
+ * Plain-text body of the email. Sent as the text alternative when htmlBody is also set. Required unless htmlBody is set.
34
+ * @type {string}
35
+ * @memberof SendEmailRequestDto
36
+ */
37
+ 'textBody'?: string;
38
+ /**
39
+ * Email address of the sender. Defaults to the sender configured in the tenant settings.
40
+ * @type {string}
41
+ * @memberof SendEmailRequestDto
42
+ */
43
+ 'emailSender'?: string;
44
+ /**
45
+ * Email addresses of the receivers
46
+ * @type {Array<string>}
47
+ * @memberof SendEmailRequestDto
48
+ */
49
+ 'emailTo': Array<string>;
50
+ /**
51
+ * Email addresses that receive a copy of the email
52
+ * @type {Array<string>}
53
+ * @memberof SendEmailRequestDto
54
+ */
55
+ 'emailCc'?: Array<string>;
56
+ /**
57
+ * Email addresses that receive a copy of the email without the other recipients knowing
58
+ * @type {Array<string>}
59
+ * @memberof SendEmailRequestDto
60
+ */
61
+ 'emailBcc'?: Array<string>;
62
+ /**
63
+ * Attachments that have already been uploaded to S3
64
+ * @type {Array<S3DocumentDto>}
65
+ * @memberof SendEmailRequestDto
66
+ */
67
+ 'attachments'?: Array<S3DocumentDto>;
68
+ /**
69
+ * Attachments sent with the request as base64 content. They are stored in S3 before the email is sent. Their decoded size may not exceed 10 MB in total.
70
+ * @type {Array<InlineAttachmentDto>}
71
+ * @memberof SendEmailRequestDto
72
+ */
73
+ 'inlineAttachments'?: Array<InlineAttachmentDto>;
74
+ /**
75
+ * Product slug used to look up a product-specific sender in the tenant settings, stored under productSlug_sender-email
76
+ * @type {string}
77
+ * @memberof SendEmailRequestDto
78
+ */
79
+ 'productSlug'?: string;
80
+ /**
81
+ * Entity type for email reply tracking
82
+ * @type {string}
83
+ * @memberof SendEmailRequestDto
84
+ */
85
+ 'entityType'?: SendEmailRequestDtoEntityTypeEnum;
86
+ /**
87
+ * Entity code for email reply tracking
88
+ * @type {string}
89
+ * @memberof SendEmailRequestDto
90
+ */
91
+ 'entityCode'?: string;
92
+ /**
93
+ * Reply-To address. Auto-generated when reply tracking is enabled.
94
+ * @type {string}
95
+ * @memberof SendEmailRequestDto
96
+ */
97
+ 'replyTo'?: string;
98
+ /**
99
+ * Custom Message-ID header. Auto-generated if not provided.
100
+ * @type {string}
101
+ * @memberof SendEmailRequestDto
102
+ */
103
+ 'customMessageId'?: string;
104
+ /**
105
+ * Message-ID of the email this is replying to (for threading)
106
+ * @type {string}
107
+ * @memberof SendEmailRequestDto
108
+ */
109
+ 'inReplyTo'?: string;
110
+ /**
111
+ * Message-IDs for email thread chain
112
+ * @type {Array<string>}
113
+ * @memberof SendEmailRequestDto
114
+ */
115
+ 'references'?: Array<string>;
116
+ /**
117
+ * Custom headers to set on the outgoing email
118
+ * @type {{ [key: string]: string; }}
119
+ * @memberof SendEmailRequestDto
120
+ */
121
+ 'customHeaders'?: {
122
+ [key: string]: string;
123
+ };
124
+ }
125
+ export declare const SendEmailRequestDtoEntityTypeEnum: {
126
+ readonly Claim: "Claim";
127
+ readonly Policy: "Policy";
128
+ readonly Lead: "Lead";
129
+ readonly Partner: "Partner";
130
+ };
131
+ export type SendEmailRequestDtoEntityTypeEnum = typeof SendEmailRequestDtoEntityTypeEnum[keyof typeof SendEmailRequestDtoEntityTypeEnum];
@@ -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.SendEmailRequestDtoEntityTypeEnum = void 0;
17
+ exports.SendEmailRequestDtoEntityTypeEnum = {
18
+ Claim: 'Claim',
19
+ Policy: 'Policy',
20
+ Lead: 'Lead',
21
+ Partner: 'Partner'
22
+ };
@@ -0,0 +1,24 @@
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 SendEmailResponseClass
16
+ */
17
+ export interface SendEmailResponseClass {
18
+ /**
19
+ * Notification request code
20
+ * @type {string}
21
+ * @memberof SendEmailResponseClass
22
+ */
23
+ 'code': string;
24
+ }
@@ -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 });
@@ -85,7 +85,7 @@ export interface SendNotificationRequestDto {
85
85
  */
86
86
  'entityCode'?: string;
87
87
  /**
88
- * Reply-To address for email reply tracking. Auto-generated when entityType and entityCode are provided.
88
+ * Reply-To address for email reply tracking. Auto-generated when reply tracking is enabled.
89
89
  * @type {string}
90
90
  * @memberof SendNotificationRequestDto
91
91
  */
@@ -108,10 +108,19 @@ export interface SendNotificationRequestDto {
108
108
  * @memberof SendNotificationRequestDto
109
109
  */
110
110
  'references': Array<string>;
111
+ /**
112
+ * Custom headers to set on the outgoing email
113
+ * @type {{ [key: string]: string; }}
114
+ * @memberof SendNotificationRequestDto
115
+ */
116
+ 'customHeaders': {
117
+ [key: string]: string;
118
+ };
111
119
  }
112
120
  export declare const SendNotificationRequestDtoEntityTypeEnum: {
113
121
  readonly Claim: "Claim";
114
122
  readonly Policy: "Policy";
115
123
  readonly Lead: "Lead";
124
+ readonly Partner: "Partner";
116
125
  };
117
126
  export type SendNotificationRequestDtoEntityTypeEnum = typeof SendNotificationRequestDtoEntityTypeEnum[keyof typeof SendNotificationRequestDtoEntityTypeEnum];
@@ -17,5 +17,6 @@ exports.SendNotificationRequestDtoEntityTypeEnum = void 0;
17
17
  exports.SendNotificationRequestDtoEntityTypeEnum = {
18
18
  Claim: 'Claim',
19
19
  Policy: 'Policy',
20
- Lead: 'Lead'
20
+ Lead: 'Lead',
21
+ Partner: 'Partner'
21
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 { EmailThreadClass } from './email-thread-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface UnassignEmailThreadEntityResponseClass
17
+ */
18
+ export interface UnassignEmailThreadEntityResponseClass {
19
+ /**
20
+ * The email thread response.
21
+ * @type {EmailThreadClass}
22
+ * @memberof UnassignEmailThreadEntityResponseClass
23
+ */
24
+ 'thread': EmailThreadClass;
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 });
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface AssignEmailThreadEntityBodyDto
21
+ */
22
+ export interface AssignEmailThreadEntityBodyDto {
23
+ /**
24
+ * Type of the entity the email thread belongs to
25
+ * @type {string}
26
+ * @memberof AssignEmailThreadEntityBodyDto
27
+ */
28
+ 'entityType': AssignEmailThreadEntityBodyDtoEntityTypeEnum;
29
+ /**
30
+ * Code of the entity. Required unless entityNumber is set; takes precedence over entityNumber.
31
+ * @type {string}
32
+ * @memberof AssignEmailThreadEntityBodyDto
33
+ */
34
+ 'entityCode'?: string;
35
+ /**
36
+ * Number of the entity, e.g. the policy number. Used only when entityCode is not set.
37
+ * @type {string}
38
+ * @memberof AssignEmailThreadEntityBodyDto
39
+ */
40
+ 'entityNumber'?: string;
41
+ }
42
+
43
+ export const AssignEmailThreadEntityBodyDtoEntityTypeEnum = {
44
+ Claim: 'Claim',
45
+ Policy: 'Policy',
46
+ Lead: 'Lead',
47
+ Partner: 'Partner'
48
+ } as const;
49
+
50
+ export type AssignEmailThreadEntityBodyDtoEntityTypeEnum = typeof AssignEmailThreadEntityBodyDtoEntityTypeEnum[keyof typeof AssignEmailThreadEntityBodyDtoEntityTypeEnum];
51
+
52
+
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { EmailThreadClass } from './email-thread-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface AssignEmailThreadEntityResponseClass
22
+ */
23
+ export interface AssignEmailThreadEntityResponseClass {
24
+ /**
25
+ * The email thread response.
26
+ * @type {EmailThreadClass}
27
+ * @memberof AssignEmailThreadEntityResponseClass
28
+ */
29
+ 'thread': EmailThreadClass;
30
+ }
31
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CatchUpEmailSubscriptionResponseClass
21
+ */
22
+ export interface CatchUpEmailSubscriptionResponseClass {
23
+ /**
24
+ * Whether a catch-up was queued. False when the subscription is being deleted.
25
+ * @type {boolean}
26
+ * @memberof CatchUpEmailSubscriptionResponseClass
27
+ */
28
+ 'queued': boolean;
29
+ }
30
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CatchUpEmailSubscriptionsRequestDto
21
+ */
22
+ export interface CatchUpEmailSubscriptionsRequestDto {
23
+ /**
24
+ * Catch up the email channel of this product. Omit it to catch up the tenant-wide email channel.
25
+ * @type {string}
26
+ * @memberof CatchUpEmailSubscriptionsRequestDto
27
+ */
28
+ 'productSlug'?: string;
29
+ }
30
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CatchUpEmailSubscriptionsResponseClass
21
+ */
22
+ export interface CatchUpEmailSubscriptionsResponseClass {
23
+ /**
24
+ * Subscriptions a catch-up was queued for
25
+ * @type {number}
26
+ * @memberof CatchUpEmailSubscriptionsResponseClass
27
+ */
28
+ 'queued': number;
29
+ /**
30
+ * Subscriptions skipped because they are being deleted or could not be queued
31
+ * @type {number}
32
+ * @memberof CatchUpEmailSubscriptionsResponseClass
33
+ */
34
+ 'skipped': number;
35
+ }
36
+
@@ -0,0 +1,56 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface EmailMailboxClass
21
+ */
22
+ export interface EmailMailboxClass {
23
+ /**
24
+ * Email address of the mailbox, lower-cased. Use it as the `mailbox` filter when listing email threads or messages.
25
+ * @type {string}
26
+ * @memberof EmailMailboxClass
27
+ */
28
+ 'address': string;
29
+ /**
30
+ * Transport the mailbox belongs to: a Microsoft 365 mailbox reached through Graph, or the sender address of an SES tenant
31
+ * @type {string}
32
+ * @memberof EmailMailboxClass
33
+ */
34
+ 'provider': EmailMailboxClassProviderEnum;
35
+ /**
36
+ * Number of threads in this mailbox whose latest message is inbound — the total of listing email threads with `mailbox` and `latestDirection==inbound`. Delivery reports (bounces) are not counted.
37
+ * @type {number}
38
+ * @memberof EmailMailboxClass
39
+ */
40
+ 'inboundCount': number;
41
+ /**
42
+ * Number of threads in this mailbox whose latest message is outbound — the total of listing email threads with `mailbox` and `latestDirection==outbound`
43
+ * @type {number}
44
+ * @memberof EmailMailboxClass
45
+ */
46
+ 'outboundCount': number;
47
+ }
48
+
49
+ export const EmailMailboxClassProviderEnum = {
50
+ Ses: 'ses',
51
+ Msgraph: 'msgraph'
52
+ } as const;
53
+
54
+ export type EmailMailboxClassProviderEnum = typeof EmailMailboxClassProviderEnum[keyof typeof EmailMailboxClassProviderEnum];
55
+
56
+
@@ -14,6 +14,7 @@
14
14
 
15
15
 
16
16
  import { EmailAttachmentClass } from './email-attachment-class';
17
+ import { EntityRefClass } from './entity-ref-class';
17
18
 
18
19
  /**
19
20
  *
@@ -34,11 +35,41 @@ export interface EmailMessageClass {
34
35
  */
35
36
  'code': string;
36
37
  /**
37
- * Thread code this message belongs to
38
+ * Thread code this message belongs to. Empty only while an inbound message is still being correlated.
38
39
  * @type {string}
39
40
  * @memberof EmailMessageClass
40
41
  */
41
42
  'threadCode': string;
43
+ /**
44
+ * Correlation state of an inbound message: pending, matched (thread and entity known) or unassigned (thread known, no entity yet)
45
+ * @type {string}
46
+ * @memberof EmailMessageClass
47
+ */
48
+ 'matchStatus': EmailMessageClassMatchStatusEnum;
49
+ /**
50
+ * What this row is: a message somebody wrote, or a delivery report (bounce) a mail server sent back about an outbound message
51
+ * @type {string}
52
+ * @memberof EmailMessageClass
53
+ */
54
+ 'kind': EmailMessageClassKindEnum;
55
+ /**
56
+ * Delivery report only: code of the outbound message the report is about
57
+ * @type {string}
58
+ * @memberof EmailMessageClass
59
+ */
60
+ 'reportedMessageCode'?: string;
61
+ /**
62
+ * Provider the message was sent or received through
63
+ * @type {string}
64
+ * @memberof EmailMessageClass
65
+ */
66
+ 'provider'?: EmailMessageClassProviderEnum;
67
+ /**
68
+ * Mailbox the message belongs to: the Microsoft 365 mailbox it was sent from or arrived in, or the sender address for SES. Empty for an inbound email that matched nothing yet.
69
+ * @type {string}
70
+ * @memberof EmailMessageClass
71
+ */
72
+ 'mailbox'?: string;
42
73
  /**
43
74
  * Direction of the email
44
75
  * @type {string}
@@ -82,7 +113,7 @@ export interface EmailMessageClass {
82
113
  */
83
114
  'bodyHtml'?: string;
84
115
  /**
85
- * Delivery status of the email
116
+ * Delivery status of the email. Outbound emails move through pending → sent, then bounced if a bounce arrives; failed marks a system-level send failure; inbound emails are always received.
86
117
  * @type {string}
87
118
  * @memberof EmailMessageClass
88
119
  */
@@ -136,19 +167,50 @@ export interface EmailMessageClass {
136
167
  */
137
168
  'attachments': Array<EmailAttachmentClass>;
138
169
  /**
139
- * Entity type this message is associated with
170
+ * Inbound only: how many attachments the email arrived with, images embedded in the body not counted. At most 10 attachments and 35 MB in total are kept, in order, stopping at the first that does not fit; when this is higher than the length of `attachments`, the rest are only in the original email.
171
+ * @type {number}
172
+ * @memberof EmailMessageClass
173
+ */
174
+ 'attachmentCount'?: number;
175
+ /**
176
+ * The entity the message\'s thread is linked to. Not set while the message is unassigned.
177
+ * @type {EntityRefClass}
178
+ * @memberof EmailMessageClass
179
+ */
180
+ 'entityRef'?: EntityRefClass;
181
+ /**
182
+ * Business number of the linked entity (policy, lead, claim or partner number)
140
183
  * @type {string}
141
184
  * @memberof EmailMessageClass
142
185
  */
143
- 'entityType': string;
186
+ 'entityNumber'?: string;
144
187
  /**
145
- * Entity code this message is associated with
188
+ * Latest workflow status of the email: the status of whichever workflow it triggered changed most recently. Counts EMAIL_RECEIVED workflows for an incoming email and EMAIL_BOUNCED workflows for an outgoing one. Not set when the email triggered no workflow.
146
189
  * @type {string}
147
190
  * @memberof EmailMessageClass
148
191
  */
149
- 'entityCode': string;
192
+ 'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
150
193
  }
151
194
 
195
+ export const EmailMessageClassMatchStatusEnum = {
196
+ Pending: 'pending',
197
+ Matched: 'matched',
198
+ Unassigned: 'unassigned'
199
+ } as const;
200
+
201
+ export type EmailMessageClassMatchStatusEnum = typeof EmailMessageClassMatchStatusEnum[keyof typeof EmailMessageClassMatchStatusEnum];
202
+ export const EmailMessageClassKindEnum = {
203
+ Message: 'message',
204
+ DeliveryReport: 'delivery_report'
205
+ } as const;
206
+
207
+ export type EmailMessageClassKindEnum = typeof EmailMessageClassKindEnum[keyof typeof EmailMessageClassKindEnum];
208
+ export const EmailMessageClassProviderEnum = {
209
+ Ses: 'ses',
210
+ Msgraph: 'msgraph'
211
+ } as const;
212
+
213
+ export type EmailMessageClassProviderEnum = typeof EmailMessageClassProviderEnum[keyof typeof EmailMessageClassProviderEnum];
152
214
  export const EmailMessageClassDirectionEnum = {
153
215
  Outbound: 'outbound',
154
216
  Inbound: 'inbound'
@@ -158,11 +220,19 @@ export type EmailMessageClassDirectionEnum = typeof EmailMessageClassDirectionEn
158
220
  export const EmailMessageClassDeliveryStatusEnum = {
159
221
  Pending: 'pending',
160
222
  Sent: 'sent',
161
- Delivered: 'delivered',
162
223
  Bounced: 'bounced',
163
- Failed: 'failed'
224
+ Failed: 'failed',
225
+ Received: 'received'
164
226
  } as const;
165
227
 
166
228
  export type EmailMessageClassDeliveryStatusEnum = typeof EmailMessageClassDeliveryStatusEnum[keyof typeof EmailMessageClassDeliveryStatusEnum];
229
+ export const EmailMessageClassWorkflowStatusEnum = {
230
+ InProgress: 'in_progress',
231
+ Done: 'done',
232
+ Failed: 'failed',
233
+ Cancelled: 'cancelled'
234
+ } as const;
235
+
236
+ export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
167
237
 
168
238