@epilot/message-client 1.7.0 → 1.7.1
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/dist/openapi.d.ts +75 -50
- package/dist/openapi.json +29 -9
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -23,14 +23,17 @@ declare namespace Components {
|
|
|
23
23
|
*/
|
|
24
24
|
address: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* Type of the email, Internal (360 Agents), Partners, External users(Customers)
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER";
|
|
30
|
+
/**
|
|
31
|
+
* Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
28
32
|
*
|
|
29
33
|
*/
|
|
30
34
|
send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
|
|
31
35
|
/**
|
|
32
|
-
* Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR
|
|
33
|
-
* JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
|
|
36
|
+
* Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
|
|
34
37
|
*
|
|
35
38
|
*/
|
|
36
39
|
send_error?: {
|
|
@@ -115,14 +118,12 @@ declare namespace Components {
|
|
|
115
118
|
*/
|
|
116
119
|
cid?: string;
|
|
117
120
|
/**
|
|
118
|
-
* If true then this attachment should not be offered for download (at least not in the main attachments list)
|
|
119
|
-
* The usecase is CID embedded image (aka inline image).
|
|
121
|
+
* If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image).
|
|
120
122
|
*
|
|
121
123
|
*/
|
|
122
124
|
inline?: boolean;
|
|
123
125
|
/**
|
|
124
|
-
* If true then this attachment is sent via link. The link have to be inserted to email body by API caller
|
|
125
|
-
* In this case, service doesn't process this attachment.
|
|
126
|
+
* If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment.
|
|
126
127
|
*
|
|
127
128
|
*/
|
|
128
129
|
send_as_link?: boolean;
|
|
@@ -174,9 +175,7 @@ declare namespace Components {
|
|
|
174
175
|
bcc?: Address[];
|
|
175
176
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
176
177
|
/**
|
|
177
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
178
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
179
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
178
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
180
179
|
*
|
|
181
180
|
* example:
|
|
182
181
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -198,8 +197,7 @@ declare namespace Components {
|
|
|
198
197
|
*/
|
|
199
198
|
org_read_message?: string[];
|
|
200
199
|
/**
|
|
201
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
202
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
200
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
203
201
|
*
|
|
204
202
|
*/
|
|
205
203
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -207,13 +205,17 @@ declare namespace Components {
|
|
|
207
205
|
* Message type
|
|
208
206
|
*/
|
|
209
207
|
type?: "SENT" | "RECEIVED";
|
|
208
|
+
/**
|
|
209
|
+
* Template ID used for sending message.
|
|
210
|
+
* example:
|
|
211
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
212
|
+
*/
|
|
213
|
+
template_id?: string;
|
|
210
214
|
}
|
|
211
215
|
export interface MessageRequestParams {
|
|
212
216
|
[name: string]: any;
|
|
213
217
|
/**
|
|
214
|
-
* Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...)
|
|
215
|
-
* Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\
|
|
216
|
-
* `thread` or `parent_id` must be provided either.
|
|
218
|
+
* Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.
|
|
217
219
|
*
|
|
218
220
|
* example:
|
|
219
221
|
* {
|
|
@@ -236,8 +238,7 @@ declare namespace Components {
|
|
|
236
238
|
assigned_to?: string[];
|
|
237
239
|
};
|
|
238
240
|
/**
|
|
239
|
-
* Entity ID of parent message which this message replies to or forwards from
|
|
240
|
-
* If both `parent_id` and `thread` are provided, `thread` is discarded.
|
|
241
|
+
* Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.
|
|
241
242
|
*
|
|
242
243
|
* example:
|
|
243
244
|
* 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
|
|
@@ -276,6 +277,12 @@ declare namespace Components {
|
|
|
276
277
|
*/
|
|
277
278
|
bcc?: Address[];
|
|
278
279
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
280
|
+
/**
|
|
281
|
+
* Template ID used for sending message.
|
|
282
|
+
* example:
|
|
283
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
284
|
+
*/
|
|
285
|
+
template_id?: string;
|
|
279
286
|
}
|
|
280
287
|
export interface MessageV2 {
|
|
281
288
|
/**
|
|
@@ -367,9 +374,7 @@ declare namespace Components {
|
|
|
367
374
|
bcc?: Address[];
|
|
368
375
|
file?: /* Message attachments */ AttachmentsRelation;
|
|
369
376
|
/**
|
|
370
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
371
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
372
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
377
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
373
378
|
*
|
|
374
379
|
* example:
|
|
375
380
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -391,8 +396,7 @@ declare namespace Components {
|
|
|
391
396
|
*/
|
|
392
397
|
org_read_message?: string[];
|
|
393
398
|
/**
|
|
394
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
395
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
399
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
396
400
|
*
|
|
397
401
|
*/
|
|
398
402
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -400,6 +404,12 @@ declare namespace Components {
|
|
|
400
404
|
* Message type
|
|
401
405
|
*/
|
|
402
406
|
type?: "SENT" | "RECEIVED";
|
|
407
|
+
/**
|
|
408
|
+
* Template ID used for sending message.
|
|
409
|
+
* example:
|
|
410
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
411
|
+
*/
|
|
412
|
+
template_id?: string;
|
|
403
413
|
/**
|
|
404
414
|
* If true then html is not provided and must be downloaded using the html_download_url
|
|
405
415
|
*/
|
|
@@ -610,9 +620,7 @@ declare namespace Paths {
|
|
|
610
620
|
bcc?: Components.Schemas.Address[];
|
|
611
621
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
612
622
|
/**
|
|
613
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
614
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
615
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
623
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
616
624
|
*
|
|
617
625
|
* example:
|
|
618
626
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -634,8 +642,7 @@ declare namespace Paths {
|
|
|
634
642
|
*/
|
|
635
643
|
org_read_message?: string[];
|
|
636
644
|
/**
|
|
637
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
638
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
645
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
639
646
|
*
|
|
640
647
|
*/
|
|
641
648
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -643,6 +650,12 @@ declare namespace Paths {
|
|
|
643
650
|
* Message type
|
|
644
651
|
*/
|
|
645
652
|
type?: "SENT" | "RECEIVED";
|
|
653
|
+
/**
|
|
654
|
+
* Template ID used for sending message.
|
|
655
|
+
* example:
|
|
656
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
657
|
+
*/
|
|
658
|
+
template_id?: string;
|
|
646
659
|
}
|
|
647
660
|
export interface $403 {
|
|
648
661
|
}
|
|
@@ -782,9 +795,7 @@ declare namespace Paths {
|
|
|
782
795
|
bcc?: Components.Schemas.Address[];
|
|
783
796
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
784
797
|
/**
|
|
785
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
786
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
787
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
798
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
788
799
|
*
|
|
789
800
|
* example:
|
|
790
801
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -806,8 +817,7 @@ declare namespace Paths {
|
|
|
806
817
|
*/
|
|
807
818
|
org_read_message?: string[];
|
|
808
819
|
/**
|
|
809
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
810
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
820
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
811
821
|
*
|
|
812
822
|
*/
|
|
813
823
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -815,6 +825,12 @@ declare namespace Paths {
|
|
|
815
825
|
* Message type
|
|
816
826
|
*/
|
|
817
827
|
type?: "SENT" | "RECEIVED";
|
|
828
|
+
/**
|
|
829
|
+
* Template ID used for sending message.
|
|
830
|
+
* example:
|
|
831
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
832
|
+
*/
|
|
833
|
+
template_id?: string;
|
|
818
834
|
}
|
|
819
835
|
export interface $302 {
|
|
820
836
|
}
|
|
@@ -928,9 +944,7 @@ declare namespace Paths {
|
|
|
928
944
|
bcc?: Components.Schemas.Address[];
|
|
929
945
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
930
946
|
/**
|
|
931
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
932
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
933
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
947
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
934
948
|
*
|
|
935
949
|
* example:
|
|
936
950
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -952,8 +966,7 @@ declare namespace Paths {
|
|
|
952
966
|
*/
|
|
953
967
|
org_read_message?: string[];
|
|
954
968
|
/**
|
|
955
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
956
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
969
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
957
970
|
*
|
|
958
971
|
*/
|
|
959
972
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -961,6 +974,12 @@ declare namespace Paths {
|
|
|
961
974
|
* Message type
|
|
962
975
|
*/
|
|
963
976
|
type?: "SENT" | "RECEIVED";
|
|
977
|
+
/**
|
|
978
|
+
* Template ID used for sending message.
|
|
979
|
+
* example:
|
|
980
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
981
|
+
*/
|
|
982
|
+
template_id?: string;
|
|
964
983
|
/**
|
|
965
984
|
* If true then html is not provided and must be downloaded using the html_download_url
|
|
966
985
|
*/
|
|
@@ -1209,9 +1228,7 @@ declare namespace Paths {
|
|
|
1209
1228
|
bcc?: Components.Schemas.Address[];
|
|
1210
1229
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
1211
1230
|
/**
|
|
1212
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
1213
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
1214
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
1231
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
1215
1232
|
*
|
|
1216
1233
|
* example:
|
|
1217
1234
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -1233,8 +1250,7 @@ declare namespace Paths {
|
|
|
1233
1250
|
*/
|
|
1234
1251
|
org_read_message?: string[];
|
|
1235
1252
|
/**
|
|
1236
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
1237
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
1253
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
1238
1254
|
*
|
|
1239
1255
|
*/
|
|
1240
1256
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -1242,6 +1258,12 @@ declare namespace Paths {
|
|
|
1242
1258
|
* Message type
|
|
1243
1259
|
*/
|
|
1244
1260
|
type?: "SENT" | "RECEIVED";
|
|
1261
|
+
/**
|
|
1262
|
+
* Template ID used for sending message.
|
|
1263
|
+
* example:
|
|
1264
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
1265
|
+
*/
|
|
1266
|
+
template_id?: string;
|
|
1245
1267
|
}
|
|
1246
1268
|
export interface $403 {
|
|
1247
1269
|
}
|
|
@@ -1409,9 +1431,7 @@ declare namespace Paths {
|
|
|
1409
1431
|
bcc?: Components.Schemas.Address[];
|
|
1410
1432
|
file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
|
|
1411
1433
|
/**
|
|
1412
|
-
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
1413
|
-
* The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
|
|
1414
|
-
* The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
1434
|
+
* References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
|
|
1415
1435
|
*
|
|
1416
1436
|
* example:
|
|
1417
1437
|
* <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
|
|
@@ -1433,8 +1453,7 @@ declare namespace Paths {
|
|
|
1433
1453
|
*/
|
|
1434
1454
|
org_read_message?: string[];
|
|
1435
1455
|
/**
|
|
1436
|
-
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
1437
|
-
* Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
1456
|
+
* Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
|
|
1438
1457
|
*
|
|
1439
1458
|
*/
|
|
1440
1459
|
send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
|
|
@@ -1442,6 +1461,12 @@ declare namespace Paths {
|
|
|
1442
1461
|
* Message type
|
|
1443
1462
|
*/
|
|
1444
1463
|
type?: "SENT" | "RECEIVED";
|
|
1464
|
+
/**
|
|
1465
|
+
* Template ID used for sending message.
|
|
1466
|
+
* example:
|
|
1467
|
+
* 3f34ce73-089c-4d45-a5ee-c161234e41c3
|
|
1468
|
+
*/
|
|
1469
|
+
template_id?: string;
|
|
1445
1470
|
}
|
|
1446
1471
|
export interface $403 {
|
|
1447
1472
|
}
|
|
@@ -1694,7 +1719,7 @@ export interface OperationMethods {
|
|
|
1694
1719
|
/**
|
|
1695
1720
|
* assignUsers - assignUsers
|
|
1696
1721
|
*
|
|
1697
|
-
* Assign users to thread for receiving notifications.
|
|
1722
|
+
* Assign users to thread for receiving notifications.
|
|
1698
1723
|
* The operation replaces all existing assigned users in thread.
|
|
1699
1724
|
*
|
|
1700
1725
|
*/
|
|
@@ -1943,7 +1968,7 @@ export interface PathsDictionary {
|
|
|
1943
1968
|
/**
|
|
1944
1969
|
* assignUsers - assignUsers
|
|
1945
1970
|
*
|
|
1946
|
-
* Assign users to thread for receiving notifications.
|
|
1971
|
+
* Assign users to thread for receiving notifications.
|
|
1947
1972
|
* The operation replaces all existing assigned users in thread.
|
|
1948
1973
|
*
|
|
1949
1974
|
*/
|
package/dist/openapi.json
CHANGED
|
@@ -599,7 +599,7 @@
|
|
|
599
599
|
"post": {
|
|
600
600
|
"operationId": "assignUsers",
|
|
601
601
|
"summary": "assignUsers",
|
|
602
|
-
"description": "Assign users to thread for receiving notifications
|
|
602
|
+
"description": "Assign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n",
|
|
603
603
|
"tags": [
|
|
604
604
|
"Threads"
|
|
605
605
|
],
|
|
@@ -945,7 +945,7 @@
|
|
|
945
945
|
},
|
|
946
946
|
"references": {
|
|
947
947
|
"type": "string",
|
|
948
|
-
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent
|
|
948
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
949
949
|
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
950
950
|
},
|
|
951
951
|
"in_reply_to": {
|
|
@@ -977,7 +977,7 @@
|
|
|
977
977
|
},
|
|
978
978
|
"send_status": {
|
|
979
979
|
"type": "array",
|
|
980
|
-
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc
|
|
980
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
981
981
|
"items": {
|
|
982
982
|
"type": "string",
|
|
983
983
|
"enum": [
|
|
@@ -997,6 +997,11 @@
|
|
|
997
997
|
"SENT",
|
|
998
998
|
"RECEIVED"
|
|
999
999
|
]
|
|
1000
|
+
},
|
|
1001
|
+
"template_id": {
|
|
1002
|
+
"type": "string",
|
|
1003
|
+
"description": "Template ID used for sending message.",
|
|
1004
|
+
"example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
|
|
1000
1005
|
}
|
|
1001
1006
|
}
|
|
1002
1007
|
},
|
|
@@ -1038,9 +1043,19 @@
|
|
|
1038
1043
|
"description": "Email address",
|
|
1039
1044
|
"example": "messaging@epilot.cloud"
|
|
1040
1045
|
},
|
|
1046
|
+
"email_type": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"description": "Type of the email, Internal (360 Agents), Partners, External users(Customers)\n",
|
|
1049
|
+
"nullable": true,
|
|
1050
|
+
"enum": [
|
|
1051
|
+
"INTERNAL",
|
|
1052
|
+
"EXTERNAL",
|
|
1053
|
+
"PARTNER"
|
|
1054
|
+
]
|
|
1055
|
+
},
|
|
1041
1056
|
"send_status": {
|
|
1042
1057
|
"type": "string",
|
|
1043
|
-
"description": "Sent message status regarding to this recipient
|
|
1058
|
+
"description": "Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1044
1059
|
"enum": [
|
|
1045
1060
|
"SEND",
|
|
1046
1061
|
"DELIVERY",
|
|
@@ -1052,7 +1067,7 @@
|
|
|
1052
1067
|
},
|
|
1053
1068
|
"send_error": {
|
|
1054
1069
|
"type": "object",
|
|
1055
|
-
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR
|
|
1070
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1056
1071
|
}
|
|
1057
1072
|
}
|
|
1058
1073
|
},
|
|
@@ -1096,12 +1111,12 @@
|
|
|
1096
1111
|
},
|
|
1097
1112
|
"inline": {
|
|
1098
1113
|
"type": "boolean",
|
|
1099
|
-
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list)
|
|
1114
|
+
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image).\n",
|
|
1100
1115
|
"default": false
|
|
1101
1116
|
},
|
|
1102
1117
|
"send_as_link": {
|
|
1103
1118
|
"type": "boolean",
|
|
1104
|
-
"description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller
|
|
1119
|
+
"description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment.\n",
|
|
1105
1120
|
"default": false
|
|
1106
1121
|
}
|
|
1107
1122
|
}
|
|
@@ -1118,7 +1133,7 @@
|
|
|
1118
1133
|
"required": [
|
|
1119
1134
|
"topic"
|
|
1120
1135
|
],
|
|
1121
|
-
"description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...)
|
|
1136
|
+
"description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.\n",
|
|
1122
1137
|
"properties": {
|
|
1123
1138
|
"topic": {
|
|
1124
1139
|
"type": "string",
|
|
@@ -1143,7 +1158,7 @@
|
|
|
1143
1158
|
},
|
|
1144
1159
|
"parent_id": {
|
|
1145
1160
|
"type": "string",
|
|
1146
|
-
"description": "Entity ID of parent message which this message replies to or forwards from
|
|
1161
|
+
"description": "Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.\n",
|
|
1147
1162
|
"example": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2"
|
|
1148
1163
|
},
|
|
1149
1164
|
"subject": {
|
|
@@ -1190,6 +1205,11 @@
|
|
|
1190
1205
|
},
|
|
1191
1206
|
"file": {
|
|
1192
1207
|
"$ref": "#/components/schemas/AttachmentsRelation"
|
|
1208
|
+
},
|
|
1209
|
+
"template_id": {
|
|
1210
|
+
"type": "string",
|
|
1211
|
+
"description": "Template ID used for sending message.",
|
|
1212
|
+
"example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
|
|
1193
1213
|
}
|
|
1194
1214
|
}
|
|
1195
1215
|
},
|