@emilgroup/notification-sdk 0.8.1-beta.41 → 0.8.1-beta.43
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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +148 -0
- package/api/email-messages-api.ts +12 -12
- package/api/email-tracking-api.ts +28 -28
- package/api.ts +2 -0
- package/base.ts +36 -15
- package/configuration.ts +11 -0
- package/dist/api/email-mailboxes-api.d.ts +87 -0
- package/dist/api/email-mailboxes-api.js +218 -0
- package/dist/api/email-messages-api.d.ts +12 -12
- package/dist/api/email-messages-api.js +9 -9
- package/dist/api/email-tracking-api.d.ts +28 -28
- package/dist/api/email-tracking-api.js +22 -22
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +1 -0
- package/dist/base.js +36 -16
- package/dist/configuration.d.ts +9 -0
- package/dist/configuration.js +1 -0
- package/dist/models/email-mailbox-class.d.ts +47 -0
- package/dist/models/email-mailbox-class.js +20 -0
- package/dist/models/email-message-class.d.ts +21 -3
- package/dist/models/email-message-class.js +7 -2
- package/dist/models/email-message-summary-class.d.ts +98 -0
- package/dist/models/email-message-summary-class.js +33 -0
- package/dist/models/email-thread-class.d.ts +31 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
- package/dist/models/list-email-mailboxes-response-class.js +15 -0
- package/models/email-mailbox-class.ts +56 -0
- package/models/email-message-class.ts +22 -3
- package/models/email-message-summary-class.ts +109 -0
- package/models/email-thread-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/list-email-mailboxes-response-class.ts +49 -0
- package/package.json +1 -1
|
@@ -54,11 +54,17 @@ export interface EmailMessageClass {
|
|
|
54
54
|
*/
|
|
55
55
|
'reportedMessageCode'?: string;
|
|
56
56
|
/**
|
|
57
|
-
* Provider
|
|
57
|
+
* Provider the message was sent or received through
|
|
58
58
|
* @type {string}
|
|
59
59
|
* @memberof EmailMessageClass
|
|
60
60
|
*/
|
|
61
61
|
'provider'?: EmailMessageClassProviderEnum;
|
|
62
|
+
/**
|
|
63
|
+
* 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.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof EmailMessageClass
|
|
66
|
+
*/
|
|
67
|
+
'mailbox'?: string;
|
|
62
68
|
/**
|
|
63
69
|
* Direction of the email
|
|
64
70
|
* @type {string}
|
|
@@ -102,7 +108,7 @@ export interface EmailMessageClass {
|
|
|
102
108
|
*/
|
|
103
109
|
'bodyHtml'?: string;
|
|
104
110
|
/**
|
|
105
|
-
* Delivery status of the email. Outbound emails move through pending → sent
|
|
111
|
+
* 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.
|
|
106
112
|
* @type {string}
|
|
107
113
|
* @memberof EmailMessageClass
|
|
108
114
|
*/
|
|
@@ -173,6 +179,12 @@ export interface EmailMessageClass {
|
|
|
173
179
|
* @memberof EmailMessageClass
|
|
174
180
|
*/
|
|
175
181
|
'entityNumber'?: string;
|
|
182
|
+
/**
|
|
183
|
+
* 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.
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof EmailMessageClass
|
|
186
|
+
*/
|
|
187
|
+
'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
|
|
176
188
|
}
|
|
177
189
|
export declare const EmailMessageClassMatchStatusEnum: {
|
|
178
190
|
readonly Pending: "pending";
|
|
@@ -198,9 +210,15 @@ export type EmailMessageClassDirectionEnum = typeof EmailMessageClassDirectionEn
|
|
|
198
210
|
export declare const EmailMessageClassDeliveryStatusEnum: {
|
|
199
211
|
readonly Pending: "pending";
|
|
200
212
|
readonly Sent: "sent";
|
|
201
|
-
readonly Delivered: "delivered";
|
|
202
213
|
readonly Bounced: "bounced";
|
|
203
214
|
readonly Failed: "failed";
|
|
204
215
|
readonly Received: "received";
|
|
205
216
|
};
|
|
206
217
|
export type EmailMessageClassDeliveryStatusEnum = typeof EmailMessageClassDeliveryStatusEnum[keyof typeof EmailMessageClassDeliveryStatusEnum];
|
|
218
|
+
export declare const EmailMessageClassWorkflowStatusEnum: {
|
|
219
|
+
readonly InProgress: "in_progress";
|
|
220
|
+
readonly Done: "done";
|
|
221
|
+
readonly Failed: "failed";
|
|
222
|
+
readonly Cancelled: "cancelled";
|
|
223
|
+
};
|
|
224
|
+
export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
|
|
16
|
+
exports.EmailMessageClassWorkflowStatusEnum = exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
|
|
17
17
|
exports.EmailMessageClassMatchStatusEnum = {
|
|
18
18
|
Pending: 'pending',
|
|
19
19
|
Matched: 'matched',
|
|
@@ -34,8 +34,13 @@ exports.EmailMessageClassDirectionEnum = {
|
|
|
34
34
|
exports.EmailMessageClassDeliveryStatusEnum = {
|
|
35
35
|
Pending: 'pending',
|
|
36
36
|
Sent: 'sent',
|
|
37
|
-
Delivered: 'delivered',
|
|
38
37
|
Bounced: 'bounced',
|
|
39
38
|
Failed: 'failed',
|
|
40
39
|
Received: 'received'
|
|
41
40
|
};
|
|
41
|
+
exports.EmailMessageClassWorkflowStatusEnum = {
|
|
42
|
+
InProgress: 'in_progress',
|
|
43
|
+
Done: 'done',
|
|
44
|
+
Failed: 'failed',
|
|
45
|
+
Cancelled: 'cancelled'
|
|
46
|
+
};
|
|
@@ -0,0 +1,98 @@
|
|
|
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 EmailMessageSummaryClass
|
|
16
|
+
*/
|
|
17
|
+
export interface EmailMessageSummaryClass {
|
|
18
|
+
/**
|
|
19
|
+
* Unique identifier code for the email message. Use it to fetch the full message.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof EmailMessageSummaryClass
|
|
22
|
+
*/
|
|
23
|
+
'code': string;
|
|
24
|
+
/**
|
|
25
|
+
* Whether the message was received or sent
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof EmailMessageSummaryClass
|
|
28
|
+
*/
|
|
29
|
+
'direction': EmailMessageSummaryClassDirectionEnum;
|
|
30
|
+
/**
|
|
31
|
+
* Sender email address
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof EmailMessageSummaryClass
|
|
34
|
+
*/
|
|
35
|
+
'fromAddress': string;
|
|
36
|
+
/**
|
|
37
|
+
* Recipient email addresses, comma-separated
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof EmailMessageSummaryClass
|
|
40
|
+
*/
|
|
41
|
+
'toAddresses': string;
|
|
42
|
+
/**
|
|
43
|
+
* Email subject
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof EmailMessageSummaryClass
|
|
46
|
+
*/
|
|
47
|
+
'subject'?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Delivery status of the message
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof EmailMessageSummaryClass
|
|
52
|
+
*/
|
|
53
|
+
'deliveryStatus': EmailMessageSummaryClassDeliveryStatusEnum;
|
|
54
|
+
/**
|
|
55
|
+
* Timestamp when the email was sent
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof EmailMessageSummaryClass
|
|
58
|
+
*/
|
|
59
|
+
'sentAt'?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Timestamp when the email was received
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof EmailMessageSummaryClass
|
|
64
|
+
*/
|
|
65
|
+
'receivedAt'?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Created at timestamp
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof EmailMessageSummaryClass
|
|
70
|
+
*/
|
|
71
|
+
'createdAt': string;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof EmailMessageSummaryClass
|
|
76
|
+
*/
|
|
77
|
+
'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
|
|
78
|
+
}
|
|
79
|
+
export declare const EmailMessageSummaryClassDirectionEnum: {
|
|
80
|
+
readonly Outbound: "outbound";
|
|
81
|
+
readonly Inbound: "inbound";
|
|
82
|
+
};
|
|
83
|
+
export type EmailMessageSummaryClassDirectionEnum = typeof EmailMessageSummaryClassDirectionEnum[keyof typeof EmailMessageSummaryClassDirectionEnum];
|
|
84
|
+
export declare const EmailMessageSummaryClassDeliveryStatusEnum: {
|
|
85
|
+
readonly Pending: "pending";
|
|
86
|
+
readonly Sent: "sent";
|
|
87
|
+
readonly Bounced: "bounced";
|
|
88
|
+
readonly Failed: "failed";
|
|
89
|
+
readonly Received: "received";
|
|
90
|
+
};
|
|
91
|
+
export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
|
|
92
|
+
export declare const EmailMessageSummaryClassWorkflowStatusEnum: {
|
|
93
|
+
readonly InProgress: "in_progress";
|
|
94
|
+
readonly Done: "done";
|
|
95
|
+
readonly Failed: "failed";
|
|
96
|
+
readonly Cancelled: "cancelled";
|
|
97
|
+
};
|
|
98
|
+
export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
|
|
@@ -0,0 +1,33 @@
|
|
|
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.EmailMessageSummaryClassWorkflowStatusEnum = exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
|
|
17
|
+
exports.EmailMessageSummaryClassDirectionEnum = {
|
|
18
|
+
Outbound: 'outbound',
|
|
19
|
+
Inbound: 'inbound'
|
|
20
|
+
};
|
|
21
|
+
exports.EmailMessageSummaryClassDeliveryStatusEnum = {
|
|
22
|
+
Pending: 'pending',
|
|
23
|
+
Sent: 'sent',
|
|
24
|
+
Bounced: 'bounced',
|
|
25
|
+
Failed: 'failed',
|
|
26
|
+
Received: 'received'
|
|
27
|
+
};
|
|
28
|
+
exports.EmailMessageSummaryClassWorkflowStatusEnum = {
|
|
29
|
+
InProgress: 'in_progress',
|
|
30
|
+
Done: 'done',
|
|
31
|
+
Failed: 'failed',
|
|
32
|
+
Cancelled: 'cancelled'
|
|
33
|
+
};
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { EmailMessageSummaryClass } from './email-message-summary-class';
|
|
12
13
|
import { EntityRefClass } from './entity-ref-class';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
@@ -52,6 +53,12 @@ export interface EmailThreadClass {
|
|
|
52
53
|
* @memberof EmailThreadClass
|
|
53
54
|
*/
|
|
54
55
|
'status': EmailThreadClassStatusEnum;
|
|
56
|
+
/**
|
|
57
|
+
* Mailbox the thread belongs to: the Microsoft 365 mailbox the conversation lives in, or the sender address for SES. Empty for a thread opened by an inbound email that matched nothing.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof EmailThreadClass
|
|
60
|
+
*/
|
|
61
|
+
'mailbox'?: string;
|
|
55
62
|
/**
|
|
56
63
|
* User who created this thread
|
|
57
64
|
* @type {string}
|
|
@@ -76,6 +83,30 @@ export interface EmailThreadClass {
|
|
|
76
83
|
* @memberof EmailThreadClass
|
|
77
84
|
*/
|
|
78
85
|
'updatedAt': string;
|
|
86
|
+
/**
|
|
87
|
+
* Number of messages in the thread. Delivery reports (bounces) are not counted.
|
|
88
|
+
* @type {number}
|
|
89
|
+
* @memberof EmailThreadClass
|
|
90
|
+
*/
|
|
91
|
+
'messageCount': number;
|
|
92
|
+
/**
|
|
93
|
+
* When the newest message of the thread was received, or sent for an outbound message
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof EmailThreadClass
|
|
96
|
+
*/
|
|
97
|
+
'lastMessageAt'?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Newest message of the thread, the one a thread row in a list shows. Set when listing threads.
|
|
100
|
+
* @type {EmailMessageSummaryClass}
|
|
101
|
+
* @memberof EmailThreadClass
|
|
102
|
+
*/
|
|
103
|
+
'latestMessage'?: EmailMessageSummaryClass;
|
|
104
|
+
/**
|
|
105
|
+
* Every message of the thread, newest first. Only filled when listing with expand=messages; bodies are fetched per message.
|
|
106
|
+
* @type {Array<EmailMessageSummaryClass>}
|
|
107
|
+
* @memberof EmailThreadClass
|
|
108
|
+
*/
|
|
109
|
+
'messages': Array<EmailMessageSummaryClass>;
|
|
79
110
|
}
|
|
80
111
|
export declare const EmailThreadClassStatusEnum: {
|
|
81
112
|
readonly Open: "open";
|
package/dist/models/index.d.ts
CHANGED
|
@@ -10,7 +10,9 @@ export * from './delete-layout-request-dto';
|
|
|
10
10
|
export * from './delete-notification-template-request-dto';
|
|
11
11
|
export * from './download-attachment-response-class';
|
|
12
12
|
export * from './email-attachment-class';
|
|
13
|
+
export * from './email-mailbox-class';
|
|
13
14
|
export * from './email-message-class';
|
|
15
|
+
export * from './email-message-summary-class';
|
|
14
16
|
export * from './email-subscription-class';
|
|
15
17
|
export * from './email-thread-class';
|
|
16
18
|
export * from './entity-ref-class';
|
|
@@ -30,6 +32,7 @@ export * from './inline-response200';
|
|
|
30
32
|
export * from './inline-response503';
|
|
31
33
|
export * from './layout-class';
|
|
32
34
|
export * from './list-email-attachments-response-class';
|
|
35
|
+
export * from './list-email-mailboxes-response-class';
|
|
33
36
|
export * from './list-email-messages-response-class';
|
|
34
37
|
export * from './list-email-subscriptions-response-class';
|
|
35
38
|
export * from './list-email-threads-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -26,7 +26,9 @@ __exportStar(require("./delete-layout-request-dto"), exports);
|
|
|
26
26
|
__exportStar(require("./delete-notification-template-request-dto"), exports);
|
|
27
27
|
__exportStar(require("./download-attachment-response-class"), exports);
|
|
28
28
|
__exportStar(require("./email-attachment-class"), exports);
|
|
29
|
+
__exportStar(require("./email-mailbox-class"), exports);
|
|
29
30
|
__exportStar(require("./email-message-class"), exports);
|
|
31
|
+
__exportStar(require("./email-message-summary-class"), exports);
|
|
30
32
|
__exportStar(require("./email-subscription-class"), exports);
|
|
31
33
|
__exportStar(require("./email-thread-class"), exports);
|
|
32
34
|
__exportStar(require("./entity-ref-class"), exports);
|
|
@@ -46,6 +48,7 @@ __exportStar(require("./inline-response200"), exports);
|
|
|
46
48
|
__exportStar(require("./inline-response503"), exports);
|
|
47
49
|
__exportStar(require("./layout-class"), exports);
|
|
48
50
|
__exportStar(require("./list-email-attachments-response-class"), exports);
|
|
51
|
+
__exportStar(require("./list-email-mailboxes-response-class"), exports);
|
|
49
52
|
__exportStar(require("./list-email-messages-response-class"), exports);
|
|
50
53
|
__exportStar(require("./list-email-subscriptions-response-class"), exports);
|
|
51
54
|
__exportStar(require("./list-email-threads-response-class"), 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
|
+
import { EmailMailboxClass } from './email-mailbox-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListEmailMailboxesResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ListEmailMailboxesResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* Next page token.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ListEmailMailboxesResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'nextPageToken': string;
|
|
25
|
+
/**
|
|
26
|
+
* Total amount of items.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof ListEmailMailboxesResponseClass
|
|
29
|
+
*/
|
|
30
|
+
'totalItems': number;
|
|
31
|
+
/**
|
|
32
|
+
* Items per page.
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof ListEmailMailboxesResponseClass
|
|
35
|
+
*/
|
|
36
|
+
'itemsPerPage': number;
|
|
37
|
+
/**
|
|
38
|
+
* Mailboxes of the tenant, sorted by address
|
|
39
|
+
* @type {Array<EmailMailboxClass>}
|
|
40
|
+
* @memberof ListEmailMailboxesResponseClass
|
|
41
|
+
*/
|
|
42
|
+
'items': Array<EmailMailboxClass>;
|
|
43
|
+
}
|
|
@@ -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,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 inbound messages in this mailbox. Delivery reports (bounces) are not counted.
|
|
37
|
+
* @type {number}
|
|
38
|
+
* @memberof EmailMailboxClass
|
|
39
|
+
*/
|
|
40
|
+
'inboundCount': number;
|
|
41
|
+
/**
|
|
42
|
+
* Number of outbound messages sent from this mailbox
|
|
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
|
+
|
|
@@ -59,11 +59,17 @@ export interface EmailMessageClass {
|
|
|
59
59
|
*/
|
|
60
60
|
'reportedMessageCode'?: string;
|
|
61
61
|
/**
|
|
62
|
-
* Provider
|
|
62
|
+
* Provider the message was sent or received through
|
|
63
63
|
* @type {string}
|
|
64
64
|
* @memberof EmailMessageClass
|
|
65
65
|
*/
|
|
66
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;
|
|
67
73
|
/**
|
|
68
74
|
* Direction of the email
|
|
69
75
|
* @type {string}
|
|
@@ -107,7 +113,7 @@ export interface EmailMessageClass {
|
|
|
107
113
|
*/
|
|
108
114
|
'bodyHtml'?: string;
|
|
109
115
|
/**
|
|
110
|
-
* Delivery status of the email. Outbound emails move through pending → sent
|
|
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.
|
|
111
117
|
* @type {string}
|
|
112
118
|
* @memberof EmailMessageClass
|
|
113
119
|
*/
|
|
@@ -178,6 +184,12 @@ export interface EmailMessageClass {
|
|
|
178
184
|
* @memberof EmailMessageClass
|
|
179
185
|
*/
|
|
180
186
|
'entityNumber'?: string;
|
|
187
|
+
/**
|
|
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.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof EmailMessageClass
|
|
191
|
+
*/
|
|
192
|
+
'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
|
|
181
193
|
}
|
|
182
194
|
|
|
183
195
|
export const EmailMessageClassMatchStatusEnum = {
|
|
@@ -208,12 +220,19 @@ export type EmailMessageClassDirectionEnum = typeof EmailMessageClassDirectionEn
|
|
|
208
220
|
export const EmailMessageClassDeliveryStatusEnum = {
|
|
209
221
|
Pending: 'pending',
|
|
210
222
|
Sent: 'sent',
|
|
211
|
-
Delivered: 'delivered',
|
|
212
223
|
Bounced: 'bounced',
|
|
213
224
|
Failed: 'failed',
|
|
214
225
|
Received: 'received'
|
|
215
226
|
} as const;
|
|
216
227
|
|
|
217
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];
|
|
218
237
|
|
|
219
238
|
|
|
@@ -0,0 +1,109 @@
|
|
|
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 EmailMessageSummaryClass
|
|
21
|
+
*/
|
|
22
|
+
export interface EmailMessageSummaryClass {
|
|
23
|
+
/**
|
|
24
|
+
* Unique identifier code for the email message. Use it to fetch the full message.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof EmailMessageSummaryClass
|
|
27
|
+
*/
|
|
28
|
+
'code': string;
|
|
29
|
+
/**
|
|
30
|
+
* Whether the message was received or sent
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof EmailMessageSummaryClass
|
|
33
|
+
*/
|
|
34
|
+
'direction': EmailMessageSummaryClassDirectionEnum;
|
|
35
|
+
/**
|
|
36
|
+
* Sender email address
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof EmailMessageSummaryClass
|
|
39
|
+
*/
|
|
40
|
+
'fromAddress': string;
|
|
41
|
+
/**
|
|
42
|
+
* Recipient email addresses, comma-separated
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof EmailMessageSummaryClass
|
|
45
|
+
*/
|
|
46
|
+
'toAddresses': string;
|
|
47
|
+
/**
|
|
48
|
+
* Email subject
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof EmailMessageSummaryClass
|
|
51
|
+
*/
|
|
52
|
+
'subject'?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Delivery status of the message
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof EmailMessageSummaryClass
|
|
57
|
+
*/
|
|
58
|
+
'deliveryStatus': EmailMessageSummaryClassDeliveryStatusEnum;
|
|
59
|
+
/**
|
|
60
|
+
* Timestamp when the email was sent
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof EmailMessageSummaryClass
|
|
63
|
+
*/
|
|
64
|
+
'sentAt'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Timestamp when the email was received
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof EmailMessageSummaryClass
|
|
69
|
+
*/
|
|
70
|
+
'receivedAt'?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Created at timestamp
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof EmailMessageSummaryClass
|
|
75
|
+
*/
|
|
76
|
+
'createdAt': string;
|
|
77
|
+
/**
|
|
78
|
+
* 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.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof EmailMessageSummaryClass
|
|
81
|
+
*/
|
|
82
|
+
'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export const EmailMessageSummaryClassDirectionEnum = {
|
|
86
|
+
Outbound: 'outbound',
|
|
87
|
+
Inbound: 'inbound'
|
|
88
|
+
} as const;
|
|
89
|
+
|
|
90
|
+
export type EmailMessageSummaryClassDirectionEnum = typeof EmailMessageSummaryClassDirectionEnum[keyof typeof EmailMessageSummaryClassDirectionEnum];
|
|
91
|
+
export const EmailMessageSummaryClassDeliveryStatusEnum = {
|
|
92
|
+
Pending: 'pending',
|
|
93
|
+
Sent: 'sent',
|
|
94
|
+
Bounced: 'bounced',
|
|
95
|
+
Failed: 'failed',
|
|
96
|
+
Received: 'received'
|
|
97
|
+
} as const;
|
|
98
|
+
|
|
99
|
+
export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
|
|
100
|
+
export const EmailMessageSummaryClassWorkflowStatusEnum = {
|
|
101
|
+
InProgress: 'in_progress',
|
|
102
|
+
Done: 'done',
|
|
103
|
+
Failed: 'failed',
|
|
104
|
+
Cancelled: 'cancelled'
|
|
105
|
+
} as const;
|
|
106
|
+
|
|
107
|
+
export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
|
|
108
|
+
|
|
109
|
+
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
|
|
16
|
+
import { EmailMessageSummaryClass } from './email-message-summary-class';
|
|
16
17
|
import { EntityRefClass } from './entity-ref-class';
|
|
17
18
|
|
|
18
19
|
/**
|
|
@@ -57,6 +58,12 @@ export interface EmailThreadClass {
|
|
|
57
58
|
* @memberof EmailThreadClass
|
|
58
59
|
*/
|
|
59
60
|
'status': EmailThreadClassStatusEnum;
|
|
61
|
+
/**
|
|
62
|
+
* Mailbox the thread belongs to: the Microsoft 365 mailbox the conversation lives in, or the sender address for SES. Empty for a thread opened by an inbound email that matched nothing.
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof EmailThreadClass
|
|
65
|
+
*/
|
|
66
|
+
'mailbox'?: string;
|
|
60
67
|
/**
|
|
61
68
|
* User who created this thread
|
|
62
69
|
* @type {string}
|
|
@@ -81,6 +88,30 @@ export interface EmailThreadClass {
|
|
|
81
88
|
* @memberof EmailThreadClass
|
|
82
89
|
*/
|
|
83
90
|
'updatedAt': string;
|
|
91
|
+
/**
|
|
92
|
+
* Number of messages in the thread. Delivery reports (bounces) are not counted.
|
|
93
|
+
* @type {number}
|
|
94
|
+
* @memberof EmailThreadClass
|
|
95
|
+
*/
|
|
96
|
+
'messageCount': number;
|
|
97
|
+
/**
|
|
98
|
+
* When the newest message of the thread was received, or sent for an outbound message
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof EmailThreadClass
|
|
101
|
+
*/
|
|
102
|
+
'lastMessageAt'?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Newest message of the thread, the one a thread row in a list shows. Set when listing threads.
|
|
105
|
+
* @type {EmailMessageSummaryClass}
|
|
106
|
+
* @memberof EmailThreadClass
|
|
107
|
+
*/
|
|
108
|
+
'latestMessage'?: EmailMessageSummaryClass;
|
|
109
|
+
/**
|
|
110
|
+
* Every message of the thread, newest first. Only filled when listing with expand=messages; bodies are fetched per message.
|
|
111
|
+
* @type {Array<EmailMessageSummaryClass>}
|
|
112
|
+
* @memberof EmailThreadClass
|
|
113
|
+
*/
|
|
114
|
+
'messages': Array<EmailMessageSummaryClass>;
|
|
84
115
|
}
|
|
85
116
|
|
|
86
117
|
export const EmailThreadClassStatusEnum = {
|
package/models/index.ts
CHANGED
|
@@ -10,7 +10,9 @@ export * from './delete-layout-request-dto';
|
|
|
10
10
|
export * from './delete-notification-template-request-dto';
|
|
11
11
|
export * from './download-attachment-response-class';
|
|
12
12
|
export * from './email-attachment-class';
|
|
13
|
+
export * from './email-mailbox-class';
|
|
13
14
|
export * from './email-message-class';
|
|
15
|
+
export * from './email-message-summary-class';
|
|
14
16
|
export * from './email-subscription-class';
|
|
15
17
|
export * from './email-thread-class';
|
|
16
18
|
export * from './entity-ref-class';
|
|
@@ -30,6 +32,7 @@ export * from './inline-response200';
|
|
|
30
32
|
export * from './inline-response503';
|
|
31
33
|
export * from './layout-class';
|
|
32
34
|
export * from './list-email-attachments-response-class';
|
|
35
|
+
export * from './list-email-mailboxes-response-class';
|
|
33
36
|
export * from './list-email-messages-response-class';
|
|
34
37
|
export * from './list-email-subscriptions-response-class';
|
|
35
38
|
export * from './list-email-threads-response-class';
|