@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.32
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 +8 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +259 -24
- package/api/email-tracking-api.ts +32 -24
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +2 -0
- package/dist/api/email-messages-api.d.ts +158 -24
- package/dist/api/email-messages-api.js +225 -22
- package/dist/api/email-tracking-api.d.ts +32 -24
- package/dist/api/email-tracking-api.js +30 -22
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- package/dist/api/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- package/dist/api/notification-templates-api.d.ts +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-message-entity-body-dto.js +22 -0
- package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-message-entity-response-class.js +15 -0
- package/dist/models/email-message-class.d.ts +49 -2
- package/dist/models/email-message-class.js +16 -2
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +1 -0
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-message-entity-response-class.js +15 -0
- package/models/assign-email-message-entity-body-dto.ts +52 -0
- package/models/assign-email-message-entity-response-class.ts +31 -0
- package/models/email-message-class.ts +53 -3
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +7 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/models/send-notification-request-dto.ts +2 -1
- package/models/unassign-email-message-entity-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -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 AssignEmailMessageEntityBodyDto
|
|
21
|
+
*/
|
|
22
|
+
export interface AssignEmailMessageEntityBodyDto {
|
|
23
|
+
/**
|
|
24
|
+
* Type of the entity the email message belongs to
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof AssignEmailMessageEntityBodyDto
|
|
27
|
+
*/
|
|
28
|
+
'entityType': AssignEmailMessageEntityBodyDtoEntityTypeEnum;
|
|
29
|
+
/**
|
|
30
|
+
* Code of the entity. Required unless entityNumber is set; takes precedence over entityNumber.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof AssignEmailMessageEntityBodyDto
|
|
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 AssignEmailMessageEntityBodyDto
|
|
39
|
+
*/
|
|
40
|
+
'entityNumber'?: string;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export const AssignEmailMessageEntityBodyDtoEntityTypeEnum = {
|
|
44
|
+
Claim: 'Claim',
|
|
45
|
+
Policy: 'Policy',
|
|
46
|
+
Lead: 'Lead',
|
|
47
|
+
Partner: 'Partner'
|
|
48
|
+
} as const;
|
|
49
|
+
|
|
50
|
+
export type AssignEmailMessageEntityBodyDtoEntityTypeEnum = typeof AssignEmailMessageEntityBodyDtoEntityTypeEnum[keyof typeof AssignEmailMessageEntityBodyDtoEntityTypeEnum];
|
|
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 { EmailMessageClass } from './email-message-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface AssignEmailMessageEntityResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface AssignEmailMessageEntityResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The email message response.
|
|
26
|
+
* @type {EmailMessageClass}
|
|
27
|
+
* @memberof AssignEmailMessageEntityResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'message': EmailMessageClass;
|
|
30
|
+
}
|
|
31
|
+
|
|
@@ -34,11 +34,35 @@ export interface EmailMessageClass {
|
|
|
34
34
|
*/
|
|
35
35
|
'code': string;
|
|
36
36
|
/**
|
|
37
|
-
* Thread code this message belongs to
|
|
37
|
+
* Thread code this message belongs to. Empty only while an inbound message is still being correlated.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof EmailMessageClass
|
|
40
40
|
*/
|
|
41
41
|
'threadCode': string;
|
|
42
|
+
/**
|
|
43
|
+
* Correlation state of an inbound message: pending, matched (thread and entity known) or unassigned (thread known, no entity yet)
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof EmailMessageClass
|
|
46
|
+
*/
|
|
47
|
+
'matchStatus': EmailMessageClassMatchStatusEnum;
|
|
48
|
+
/**
|
|
49
|
+
* What this row is: a message somebody wrote, or a delivery report (bounce) a mail server sent back about an outbound message
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof EmailMessageClass
|
|
52
|
+
*/
|
|
53
|
+
'kind': EmailMessageClassKindEnum;
|
|
54
|
+
/**
|
|
55
|
+
* Delivery report only: code of the outbound message the report is about
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof EmailMessageClass
|
|
58
|
+
*/
|
|
59
|
+
'reportedMessageCode'?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Provider that received an inbound message
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof EmailMessageClass
|
|
64
|
+
*/
|
|
65
|
+
'provider'?: EmailMessageClassProviderEnum;
|
|
42
66
|
/**
|
|
43
67
|
* Direction of the email
|
|
44
68
|
* @type {string}
|
|
@@ -82,7 +106,7 @@ export interface EmailMessageClass {
|
|
|
82
106
|
*/
|
|
83
107
|
'bodyHtml'?: string;
|
|
84
108
|
/**
|
|
85
|
-
* Delivery status of the email
|
|
109
|
+
* Delivery status of the email. Outbound emails move through pending → sent → delivered (or bounced/failed); inbound emails are always received.
|
|
86
110
|
* @type {string}
|
|
87
111
|
* @memberof EmailMessageClass
|
|
88
112
|
*/
|
|
@@ -147,8 +171,33 @@ export interface EmailMessageClass {
|
|
|
147
171
|
* @memberof EmailMessageClass
|
|
148
172
|
*/
|
|
149
173
|
'entityCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* Business number of the linked entity (policy, lead, claim or partner number)
|
|
176
|
+
* @type {string}
|
|
177
|
+
* @memberof EmailMessageClass
|
|
178
|
+
*/
|
|
179
|
+
'entityNumber'?: string;
|
|
150
180
|
}
|
|
151
181
|
|
|
182
|
+
export const EmailMessageClassMatchStatusEnum = {
|
|
183
|
+
Pending: 'pending',
|
|
184
|
+
Matched: 'matched',
|
|
185
|
+
Unassigned: 'unassigned'
|
|
186
|
+
} as const;
|
|
187
|
+
|
|
188
|
+
export type EmailMessageClassMatchStatusEnum = typeof EmailMessageClassMatchStatusEnum[keyof typeof EmailMessageClassMatchStatusEnum];
|
|
189
|
+
export const EmailMessageClassKindEnum = {
|
|
190
|
+
Message: 'message',
|
|
191
|
+
DeliveryReport: 'delivery_report'
|
|
192
|
+
} as const;
|
|
193
|
+
|
|
194
|
+
export type EmailMessageClassKindEnum = typeof EmailMessageClassKindEnum[keyof typeof EmailMessageClassKindEnum];
|
|
195
|
+
export const EmailMessageClassProviderEnum = {
|
|
196
|
+
Ses: 'ses',
|
|
197
|
+
Msgraph: 'msgraph'
|
|
198
|
+
} as const;
|
|
199
|
+
|
|
200
|
+
export type EmailMessageClassProviderEnum = typeof EmailMessageClassProviderEnum[keyof typeof EmailMessageClassProviderEnum];
|
|
152
201
|
export const EmailMessageClassDirectionEnum = {
|
|
153
202
|
Outbound: 'outbound',
|
|
154
203
|
Inbound: 'inbound'
|
|
@@ -160,7 +209,8 @@ export const EmailMessageClassDeliveryStatusEnum = {
|
|
|
160
209
|
Sent: 'sent',
|
|
161
210
|
Delivered: 'delivered',
|
|
162
211
|
Bounced: 'bounced',
|
|
163
|
-
Failed: 'failed'
|
|
212
|
+
Failed: 'failed',
|
|
213
|
+
Received: 'received'
|
|
164
214
|
} as const;
|
|
165
215
|
|
|
166
216
|
export type EmailMessageClassDeliveryStatusEnum = typeof EmailMessageClassDeliveryStatusEnum[keyof typeof EmailMessageClassDeliveryStatusEnum];
|
|
@@ -0,0 +1,144 @@
|
|
|
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 { InlineAttachmentDto } from './inline-attachment-dto';
|
|
17
|
+
import { S3DocumentDto } from './s3-document-dto';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
* @interface GrpcSendEmailRequestDto
|
|
23
|
+
*/
|
|
24
|
+
export interface GrpcSendEmailRequestDto {
|
|
25
|
+
/**
|
|
26
|
+
* Subject of the email
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof GrpcSendEmailRequestDto
|
|
29
|
+
*/
|
|
30
|
+
'emailSubject': string;
|
|
31
|
+
/**
|
|
32
|
+
* HTML body of the email, sent as given. Required unless textBody is set.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof GrpcSendEmailRequestDto
|
|
35
|
+
*/
|
|
36
|
+
'htmlBody'?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Plain-text body of the email. Sent as the text alternative when htmlBody is also set. Required unless htmlBody is set.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof GrpcSendEmailRequestDto
|
|
41
|
+
*/
|
|
42
|
+
'textBody'?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Email address of the sender. Defaults to the sender configured in the tenant settings.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof GrpcSendEmailRequestDto
|
|
47
|
+
*/
|
|
48
|
+
'emailSender'?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Email addresses of the receivers
|
|
51
|
+
* @type {Array<string>}
|
|
52
|
+
* @memberof GrpcSendEmailRequestDto
|
|
53
|
+
*/
|
|
54
|
+
'emailTo': Array<string>;
|
|
55
|
+
/**
|
|
56
|
+
* Email addresses that receive a copy of the email
|
|
57
|
+
* @type {Array<string>}
|
|
58
|
+
* @memberof GrpcSendEmailRequestDto
|
|
59
|
+
*/
|
|
60
|
+
'emailCc'?: Array<string>;
|
|
61
|
+
/**
|
|
62
|
+
* Email addresses that receive a copy of the email without the other recipients knowing
|
|
63
|
+
* @type {Array<string>}
|
|
64
|
+
* @memberof GrpcSendEmailRequestDto
|
|
65
|
+
*/
|
|
66
|
+
'emailBcc'?: Array<string>;
|
|
67
|
+
/**
|
|
68
|
+
* Attachments that have already been uploaded to S3
|
|
69
|
+
* @type {Array<S3DocumentDto>}
|
|
70
|
+
* @memberof GrpcSendEmailRequestDto
|
|
71
|
+
*/
|
|
72
|
+
'attachments'?: Array<S3DocumentDto>;
|
|
73
|
+
/**
|
|
74
|
+
* 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.
|
|
75
|
+
* @type {Array<InlineAttachmentDto>}
|
|
76
|
+
* @memberof GrpcSendEmailRequestDto
|
|
77
|
+
*/
|
|
78
|
+
'inlineAttachments'?: Array<InlineAttachmentDto>;
|
|
79
|
+
/**
|
|
80
|
+
* Product slug used to look up a product-specific sender in the tenant settings, stored under productSlug_sender-email
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof GrpcSendEmailRequestDto
|
|
83
|
+
*/
|
|
84
|
+
'productSlug'?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Entity type for email reply tracking
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof GrpcSendEmailRequestDto
|
|
89
|
+
*/
|
|
90
|
+
'entityType'?: GrpcSendEmailRequestDtoEntityTypeEnum;
|
|
91
|
+
/**
|
|
92
|
+
* Entity code for email reply tracking
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof GrpcSendEmailRequestDto
|
|
95
|
+
*/
|
|
96
|
+
'entityCode'?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Reply-To address. Auto-generated when entityType and entityCode are provided and reply tracking is enabled.
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof GrpcSendEmailRequestDto
|
|
101
|
+
*/
|
|
102
|
+
'replyTo'?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Custom Message-ID header. Auto-generated if not provided.
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof GrpcSendEmailRequestDto
|
|
107
|
+
*/
|
|
108
|
+
'customMessageId'?: string;
|
|
109
|
+
/**
|
|
110
|
+
* Message-ID of the email this is replying to (for threading)
|
|
111
|
+
* @type {string}
|
|
112
|
+
* @memberof GrpcSendEmailRequestDto
|
|
113
|
+
*/
|
|
114
|
+
'inReplyTo'?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Message-IDs for email thread chain
|
|
117
|
+
* @type {Array<string>}
|
|
118
|
+
* @memberof GrpcSendEmailRequestDto
|
|
119
|
+
*/
|
|
120
|
+
'references'?: Array<string>;
|
|
121
|
+
/**
|
|
122
|
+
* Custom headers to set on the outgoing email
|
|
123
|
+
* @type {{ [key: string]: string; }}
|
|
124
|
+
* @memberof GrpcSendEmailRequestDto
|
|
125
|
+
*/
|
|
126
|
+
'customHeaders'?: { [key: string]: string; };
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @type {object}
|
|
130
|
+
* @memberof GrpcSendEmailRequestDto
|
|
131
|
+
*/
|
|
132
|
+
'entityRef'?: object;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export const GrpcSendEmailRequestDtoEntityTypeEnum = {
|
|
136
|
+
Claim: 'Claim',
|
|
137
|
+
Policy: 'Policy',
|
|
138
|
+
Lead: 'Lead',
|
|
139
|
+
Partner: 'Partner'
|
|
140
|
+
} as const;
|
|
141
|
+
|
|
142
|
+
export type GrpcSendEmailRequestDtoEntityTypeEnum = typeof GrpcSendEmailRequestDtoEntityTypeEnum[keyof typeof GrpcSendEmailRequestDtoEntityTypeEnum];
|
|
143
|
+
|
|
144
|
+
|
package/models/index.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
export * from './assign-email-message-entity-body-dto';
|
|
2
|
+
export * from './assign-email-message-entity-response-class';
|
|
1
3
|
export * from './complete-email-verification-dto';
|
|
2
4
|
export * from './complete-email-verification-response-class';
|
|
3
5
|
export * from './create-layout-request-dto';
|
|
@@ -16,9 +18,11 @@ export * from './get-layout-request-dto';
|
|
|
16
18
|
export * from './get-layout-response-class';
|
|
17
19
|
export * from './get-notification-template-request-dto';
|
|
18
20
|
export * from './get-notification-template-response-class';
|
|
21
|
+
export * from './grpc-send-email-request-dto';
|
|
19
22
|
export * from './html-template-class';
|
|
20
23
|
export * from './initiate-email-verification-dto';
|
|
21
24
|
export * from './initiate-email-verification-response-class';
|
|
25
|
+
export * from './inline-attachment-dto';
|
|
22
26
|
export * from './inline-response200';
|
|
23
27
|
export * from './inline-response503';
|
|
24
28
|
export * from './layout-class';
|
|
@@ -29,8 +33,11 @@ export * from './list-layouts-response-class';
|
|
|
29
33
|
export * from './list-notification-templates-response-class';
|
|
30
34
|
export * from './notification-template-class';
|
|
31
35
|
export * from './s3-document-dto';
|
|
36
|
+
export * from './send-email-request-dto';
|
|
37
|
+
export * from './send-email-response-class';
|
|
32
38
|
export * from './send-notification-request-dto';
|
|
33
39
|
export * from './send-notification-response-class';
|
|
40
|
+
export * from './unassign-email-message-entity-response-class';
|
|
34
41
|
export * from './update-html-template-request-dto';
|
|
35
42
|
export * from './update-layout-request-dto';
|
|
36
43
|
export * from './update-layout-response-class';
|
|
@@ -0,0 +1,42 @@
|
|
|
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 InlineAttachmentDto
|
|
21
|
+
*/
|
|
22
|
+
export interface InlineAttachmentDto {
|
|
23
|
+
/**
|
|
24
|
+
* File name shown to the recipient
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof InlineAttachmentDto
|
|
27
|
+
*/
|
|
28
|
+
'filename': string;
|
|
29
|
+
/**
|
|
30
|
+
* Base64-encoded file content
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof InlineAttachmentDto
|
|
33
|
+
*/
|
|
34
|
+
'contentBase64': string;
|
|
35
|
+
/**
|
|
36
|
+
* MIME type of the file
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof InlineAttachmentDto
|
|
39
|
+
*/
|
|
40
|
+
'contentType'?: string;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -0,0 +1,138 @@
|
|
|
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 { InlineAttachmentDto } from './inline-attachment-dto';
|
|
17
|
+
import { S3DocumentDto } from './s3-document-dto';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
* @interface SendEmailRequestDto
|
|
23
|
+
*/
|
|
24
|
+
export interface SendEmailRequestDto {
|
|
25
|
+
/**
|
|
26
|
+
* Subject of the email
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof SendEmailRequestDto
|
|
29
|
+
*/
|
|
30
|
+
'emailSubject': string;
|
|
31
|
+
/**
|
|
32
|
+
* HTML body of the email, sent as given. Required unless textBody is set.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SendEmailRequestDto
|
|
35
|
+
*/
|
|
36
|
+
'htmlBody'?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Plain-text body of the email. Sent as the text alternative when htmlBody is also set. Required unless htmlBody is set.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SendEmailRequestDto
|
|
41
|
+
*/
|
|
42
|
+
'textBody'?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Email address of the sender. Defaults to the sender configured in the tenant settings.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof SendEmailRequestDto
|
|
47
|
+
*/
|
|
48
|
+
'emailSender'?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Email addresses of the receivers
|
|
51
|
+
* @type {Array<string>}
|
|
52
|
+
* @memberof SendEmailRequestDto
|
|
53
|
+
*/
|
|
54
|
+
'emailTo': Array<string>;
|
|
55
|
+
/**
|
|
56
|
+
* Email addresses that receive a copy of the email
|
|
57
|
+
* @type {Array<string>}
|
|
58
|
+
* @memberof SendEmailRequestDto
|
|
59
|
+
*/
|
|
60
|
+
'emailCc'?: Array<string>;
|
|
61
|
+
/**
|
|
62
|
+
* Email addresses that receive a copy of the email without the other recipients knowing
|
|
63
|
+
* @type {Array<string>}
|
|
64
|
+
* @memberof SendEmailRequestDto
|
|
65
|
+
*/
|
|
66
|
+
'emailBcc'?: Array<string>;
|
|
67
|
+
/**
|
|
68
|
+
* Attachments that have already been uploaded to S3
|
|
69
|
+
* @type {Array<S3DocumentDto>}
|
|
70
|
+
* @memberof SendEmailRequestDto
|
|
71
|
+
*/
|
|
72
|
+
'attachments'?: Array<S3DocumentDto>;
|
|
73
|
+
/**
|
|
74
|
+
* 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.
|
|
75
|
+
* @type {Array<InlineAttachmentDto>}
|
|
76
|
+
* @memberof SendEmailRequestDto
|
|
77
|
+
*/
|
|
78
|
+
'inlineAttachments'?: Array<InlineAttachmentDto>;
|
|
79
|
+
/**
|
|
80
|
+
* Product slug used to look up a product-specific sender in the tenant settings, stored under productSlug_sender-email
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof SendEmailRequestDto
|
|
83
|
+
*/
|
|
84
|
+
'productSlug'?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Entity type for email reply tracking
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof SendEmailRequestDto
|
|
89
|
+
*/
|
|
90
|
+
'entityType'?: SendEmailRequestDtoEntityTypeEnum;
|
|
91
|
+
/**
|
|
92
|
+
* Entity code for email reply tracking
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof SendEmailRequestDto
|
|
95
|
+
*/
|
|
96
|
+
'entityCode'?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Reply-To address. Auto-generated when entityType and entityCode are provided and reply tracking is enabled.
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof SendEmailRequestDto
|
|
101
|
+
*/
|
|
102
|
+
'replyTo'?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Custom Message-ID header. Auto-generated if not provided.
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof SendEmailRequestDto
|
|
107
|
+
*/
|
|
108
|
+
'customMessageId'?: string;
|
|
109
|
+
/**
|
|
110
|
+
* Message-ID of the email this is replying to (for threading)
|
|
111
|
+
* @type {string}
|
|
112
|
+
* @memberof SendEmailRequestDto
|
|
113
|
+
*/
|
|
114
|
+
'inReplyTo'?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Message-IDs for email thread chain
|
|
117
|
+
* @type {Array<string>}
|
|
118
|
+
* @memberof SendEmailRequestDto
|
|
119
|
+
*/
|
|
120
|
+
'references'?: Array<string>;
|
|
121
|
+
/**
|
|
122
|
+
* Custom headers to set on the outgoing email
|
|
123
|
+
* @type {{ [key: string]: string; }}
|
|
124
|
+
* @memberof SendEmailRequestDto
|
|
125
|
+
*/
|
|
126
|
+
'customHeaders'?: { [key: string]: string; };
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export const SendEmailRequestDtoEntityTypeEnum = {
|
|
130
|
+
Claim: 'Claim',
|
|
131
|
+
Policy: 'Policy',
|
|
132
|
+
Lead: 'Lead',
|
|
133
|
+
Partner: 'Partner'
|
|
134
|
+
} as const;
|
|
135
|
+
|
|
136
|
+
export type SendEmailRequestDtoEntityTypeEnum = typeof SendEmailRequestDtoEntityTypeEnum[keyof typeof SendEmailRequestDtoEntityTypeEnum];
|
|
137
|
+
|
|
138
|
+
|
|
@@ -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 SendEmailResponseClass
|
|
21
|
+
*/
|
|
22
|
+
export interface SendEmailResponseClass {
|
|
23
|
+
/**
|
|
24
|
+
* Notification request code
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof SendEmailResponseClass
|
|
27
|
+
*/
|
|
28
|
+
'code': string;
|
|
29
|
+
}
|
|
30
|
+
|
|
@@ -122,7 +122,8 @@ export interface SendNotificationRequestDto {
|
|
|
122
122
|
export const SendNotificationRequestDtoEntityTypeEnum = {
|
|
123
123
|
Claim: 'Claim',
|
|
124
124
|
Policy: 'Policy',
|
|
125
|
-
Lead: 'Lead'
|
|
125
|
+
Lead: 'Lead',
|
|
126
|
+
Partner: 'Partner'
|
|
126
127
|
} as const;
|
|
127
128
|
|
|
128
129
|
export type SendNotificationRequestDtoEntityTypeEnum = typeof SendNotificationRequestDtoEntityTypeEnum[keyof typeof SendNotificationRequestDtoEntityTypeEnum];
|
|
@@ -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 { EmailMessageClass } from './email-message-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface UnassignEmailMessageEntityResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface UnassignEmailMessageEntityResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The email message response.
|
|
26
|
+
* @type {EmailMessageClass}
|
|
27
|
+
* @memberof UnassignEmailMessageEntityResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'message': EmailMessageClass;
|
|
30
|
+
}
|
|
31
|
+
|