@epilot/message-client 1.0.0 → 1.1.0

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 (5) hide show
  1. package/README.md +1 -1
  2. package/dist/definition.js +1 -1
  3. package/dist/openapi.d.ts +469 -117
  4. package/dist/openapi.json +1795 -1256
  5. package/package.json +4 -3
package/dist/openapi.json CHANGED
@@ -8,20 +8,20 @@
8
8
  "security": [
9
9
  {
10
10
  "EpilotAuth": []
11
+ },
12
+ {
13
+ "EpilotOrg": []
11
14
  }
12
15
  ],
13
16
  "tags": [
14
17
  {
15
- "name": "Messages",
16
- "description": "Email Messages"
18
+ "name": "Messages"
17
19
  },
18
20
  {
19
- "name": "Threads",
20
- "description": "Email Message Threads"
21
+ "name": "Threads"
21
22
  },
22
23
  {
23
- "name": "Attachments",
24
- "description": "Email File Attachments"
24
+ "name": "Drafts"
25
25
  }
26
26
  ],
27
27
  "paths": {
@@ -272,70 +272,40 @@
272
272
  }
273
273
  }
274
274
  },
275
- "attachments": {
276
- "type": "array",
277
- "description": "Message attachments",
278
- "items": {
279
- "type": "object",
280
- "required": [
281
- "filename",
282
- "size",
283
- "content_type",
284
- "url",
285
- "bucket",
286
- "object_key"
287
- ],
288
- "properties": {
289
- "cid": {
290
- "type": "string",
291
- "description": "Attachment ID",
292
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
293
- },
294
- "filename": {
295
- "type": "string",
296
- "description": "File name",
297
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
298
- },
299
- "size": {
300
- "type": "number",
301
- "description": "File size in bytes",
302
- "example": 451349
303
- },
304
- "content_type": {
305
- "type": "string",
306
- "description": "Content type",
307
- "example": "application/pdf"
308
- },
309
- "url": {
310
- "type": "string",
311
- "description": "URL to download the attachment.",
312
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
313
- },
314
- "bucket": {
315
- "type": "string",
316
- "description": "S3 bucket where file is stored",
317
- "example": "893487340562-message-attachment"
318
- },
319
- "object_key": {
320
- "type": "string",
321
- "description": "S3 object apiKey",
322
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
323
- },
324
- "inline": {
325
- "type": "boolean",
326
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
327
- "default": false
328
- },
329
- "send_as_link": {
330
- "type": "boolean",
331
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
332
- "default": false
333
- },
334
- "copy_to_message": {
335
- "type": "boolean",
336
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
337
- "default": false
338
- }
275
+ "file": {
276
+ "type": "object",
277
+ "required": [
278
+ "entity_id"
279
+ ],
280
+ "properties": {
281
+ "entity_id": {
282
+ "type": "string",
283
+ "description": "File entity ID",
284
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
285
+ },
286
+ "filename": {
287
+ "type": "string",
288
+ "description": "File name",
289
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
290
+ },
291
+ "is_message_attachment": {
292
+ "type": "boolean",
293
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
294
+ },
295
+ "cid": {
296
+ "type": "string",
297
+ "description": "Content ID (for inline)",
298
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
299
+ },
300
+ "inline": {
301
+ "type": "boolean",
302
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
303
+ "default": false
304
+ },
305
+ "send_as_link": {
306
+ "type": "boolean",
307
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
308
+ "default": false
339
309
  }
340
310
  }
341
311
  }
@@ -620,70 +590,40 @@
620
590
  }
621
591
  }
622
592
  },
623
- "attachments": {
624
- "type": "array",
625
- "description": "Message attachments",
626
- "items": {
627
- "type": "object",
628
- "required": [
629
- "filename",
630
- "size",
631
- "content_type",
632
- "url",
633
- "bucket",
634
- "object_key"
635
- ],
636
- "properties": {
637
- "cid": {
638
- "type": "string",
639
- "description": "Attachment ID",
640
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
641
- },
642
- "filename": {
643
- "type": "string",
644
- "description": "File name",
645
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
646
- },
647
- "size": {
648
- "type": "number",
649
- "description": "File size in bytes",
650
- "example": 451349
651
- },
652
- "content_type": {
653
- "type": "string",
654
- "description": "Content type",
655
- "example": "application/pdf"
656
- },
657
- "url": {
658
- "type": "string",
659
- "description": "URL to download the attachment.",
660
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
661
- },
662
- "bucket": {
663
- "type": "string",
664
- "description": "S3 bucket where file is stored",
665
- "example": "893487340562-message-attachment"
666
- },
667
- "object_key": {
668
- "type": "string",
669
- "description": "S3 object apiKey",
670
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
671
- },
672
- "inline": {
673
- "type": "boolean",
674
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
675
- "default": false
676
- },
677
- "send_as_link": {
678
- "type": "boolean",
679
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
680
- "default": false
681
- },
682
- "copy_to_message": {
683
- "type": "boolean",
684
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
685
- "default": false
686
- }
593
+ "file": {
594
+ "type": "object",
595
+ "required": [
596
+ "entity_id"
597
+ ],
598
+ "properties": {
599
+ "entity_id": {
600
+ "type": "string",
601
+ "description": "File entity ID",
602
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
603
+ },
604
+ "filename": {
605
+ "type": "string",
606
+ "description": "File name",
607
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
608
+ },
609
+ "is_message_attachment": {
610
+ "type": "boolean",
611
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
612
+ },
613
+ "cid": {
614
+ "type": "string",
615
+ "description": "Content ID (for inline)",
616
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
617
+ },
618
+ "inline": {
619
+ "type": "boolean",
620
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
621
+ "default": false
622
+ },
623
+ "send_as_link": {
624
+ "type": "boolean",
625
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
626
+ "default": false
687
627
  }
688
628
  }
689
629
  },
@@ -708,6 +648,17 @@
708
648
  ]
709
649
  }
710
650
  },
651
+ "org_read_message": {
652
+ "type": "array",
653
+ "description": "Ivy Organization ID of organization read the message.",
654
+ "items": {
655
+ "type": "string",
656
+ "example": [
657
+ "789372",
658
+ "210291"
659
+ ]
660
+ }
661
+ },
711
662
  "send_status": {
712
663
  "type": "array",
713
664
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -750,406 +701,73 @@
750
701
  "tags": [
751
702
  "Messages"
752
703
  ],
753
- "requestBody": {
754
- "content": {
755
- "application/json": {
756
- "schema": {
757
- "type": "object",
758
- "required": [
759
- "subject",
760
- "from"
761
- ],
762
- "properties": {
763
- "message_id": {
764
- "type": "string",
765
- "description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
766
- "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
767
- },
768
- "sender": {
769
- "type": "string",
770
- "description": "Ivy User ID of user sends the message.",
771
- "example": "206801"
772
- },
773
- "subject": {
774
- "type": "string",
775
- "description": "Subject",
776
- "example": "Request for solar panel price"
777
- },
778
- "html": {
779
- "type": "string",
780
- "description": "HTML body",
781
- "example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
782
- },
783
- "text": {
784
- "type": "string",
785
- "description": "Text body",
786
- "example": "We at ABC GmbH would like to request a price quote for the solar panel."
787
- },
788
- "from": {
789
- "type": "object",
790
- "required": [
791
- "address"
792
- ],
793
- "properties": {
794
- "name": {
795
- "type": "string",
796
- "description": "Email address alias",
797
- "example": "epilot"
798
- },
799
- "address": {
800
- "type": "string",
801
- "description": "Email address",
802
- "example": "messaging@epilot.cloud"
803
- },
804
- "send_status": {
805
- "type": "string",
806
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
807
- "enum": [
808
- "SEND",
809
- "DELIVERY",
810
- "REJECT",
811
- "COMPLAINT",
812
- "BOUNCE",
813
- "ERROR"
814
- ]
815
- },
816
- "send_error": {
817
- "type": "object",
818
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
819
- }
820
- }
821
- },
822
- "reply_to": {
823
- "type": "object",
824
- "required": [
825
- "address"
826
- ],
827
- "properties": {
828
- "name": {
829
- "type": "string",
830
- "description": "Email address alias",
831
- "example": "epilot"
832
- },
833
- "address": {
834
- "type": "string",
835
- "description": "Email address",
836
- "example": "messaging@epilot.cloud"
837
- },
838
- "send_status": {
839
- "type": "string",
840
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
841
- "enum": [
842
- "SEND",
843
- "DELIVERY",
844
- "REJECT",
845
- "COMPLAINT",
846
- "BOUNCE",
847
- "ERROR"
848
- ]
849
- },
850
- "send_error": {
851
- "type": "object",
852
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
853
- }
854
- }
855
- },
856
- "to": {
857
- "type": "array",
858
- "description": "To email addresses",
859
- "items": {
704
+ "responses": {
705
+ "201": {
706
+ "description": "Success",
707
+ "content": {
708
+ "application/json": {
709
+ "schema": {
710
+ "allOf": [
711
+ {
860
712
  "type": "object",
861
713
  "required": [
862
- "address"
714
+ "_id",
715
+ "_title",
716
+ "_org",
717
+ "_schema",
718
+ "_created_at",
719
+ "_updated_at"
863
720
  ],
864
721
  "properties": {
865
- "name": {
722
+ "_id": {
866
723
  "type": "string",
867
- "description": "Email address alias",
868
- "example": "epilot"
724
+ "description": "Entity ID",
725
+ "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
869
726
  },
870
- "address": {
727
+ "_title": {
871
728
  "type": "string",
872
- "description": "Email address",
873
- "example": "messaging@epilot.cloud"
729
+ "description": "Entity title"
874
730
  },
875
- "send_status": {
731
+ "_org": {
876
732
  "type": "string",
877
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
878
- "enum": [
879
- "SEND",
880
- "DELIVERY",
881
- "REJECT",
882
- "COMPLAINT",
883
- "BOUNCE",
884
- "ERROR"
733
+ "description": "Ivy Organization ID the entity belongs to",
734
+ "example": "206801"
735
+ },
736
+ "_schema": {
737
+ "type": "string",
738
+ "description": "URL-friendly identifier for the entity schema",
739
+ "example": "message"
740
+ },
741
+ "_tags": {
742
+ "type": "array",
743
+ "description": "Entity tags",
744
+ "items": {
745
+ "type": "string"
746
+ },
747
+ "example": [
748
+ "pricing",
749
+ "INBOX"
885
750
  ]
886
751
  },
887
- "send_error": {
888
- "type": "object",
889
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
752
+ "_created_at": {
753
+ "type": "string",
754
+ "description": "Created date",
755
+ "format": "date-time",
756
+ "example": "2021-02-09T12:41:43.662Z"
757
+ },
758
+ "_updated_at": {
759
+ "type": "string",
760
+ "description": "Updated date",
761
+ "format": "date-time",
762
+ "example": "2021-02-10T09:14:31.990Z"
890
763
  }
891
764
  }
892
- }
893
- },
894
- "cc": {
895
- "type": "array",
896
- "description": "Cc email addresses",
897
- "items": {
765
+ },
766
+ {
898
767
  "type": "object",
899
768
  "required": [
900
- "address"
901
- ],
902
- "properties": {
903
- "name": {
904
- "type": "string",
905
- "description": "Email address alias",
906
- "example": "epilot"
907
- },
908
- "address": {
909
- "type": "string",
910
- "description": "Email address",
911
- "example": "messaging@epilot.cloud"
912
- },
913
- "send_status": {
914
- "type": "string",
915
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
916
- "enum": [
917
- "SEND",
918
- "DELIVERY",
919
- "REJECT",
920
- "COMPLAINT",
921
- "BOUNCE",
922
- "ERROR"
923
- ]
924
- },
925
- "send_error": {
926
- "type": "object",
927
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
928
- }
929
- }
930
- }
931
- },
932
- "bcc": {
933
- "type": "array",
934
- "description": "Bcc email addresses",
935
- "items": {
936
- "type": "object",
937
- "required": [
938
- "address"
939
- ],
940
- "properties": {
941
- "name": {
942
- "type": "string",
943
- "description": "Email address alias",
944
- "example": "epilot"
945
- },
946
- "address": {
947
- "type": "string",
948
- "description": "Email address",
949
- "example": "messaging@epilot.cloud"
950
- },
951
- "send_status": {
952
- "type": "string",
953
- "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
954
- "enum": [
955
- "SEND",
956
- "DELIVERY",
957
- "REJECT",
958
- "COMPLAINT",
959
- "BOUNCE",
960
- "ERROR"
961
- ]
962
- },
963
- "send_error": {
964
- "type": "object",
965
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
966
- }
967
- }
968
- }
969
- },
970
- "attachments": {
971
- "type": "array",
972
- "description": "Message attachments",
973
- "items": {
974
- "type": "object",
975
- "required": [
976
- "filename",
977
- "size",
978
- "content_type",
979
- "url",
980
- "bucket",
981
- "object_key"
982
- ],
983
- "properties": {
984
- "cid": {
985
- "type": "string",
986
- "description": "Attachment ID",
987
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
988
- },
989
- "filename": {
990
- "type": "string",
991
- "description": "File name",
992
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
993
- },
994
- "size": {
995
- "type": "number",
996
- "description": "File size in bytes",
997
- "example": 451349
998
- },
999
- "content_type": {
1000
- "type": "string",
1001
- "description": "Content type",
1002
- "example": "application/pdf"
1003
- },
1004
- "url": {
1005
- "type": "string",
1006
- "description": "URL to download the attachment.",
1007
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1008
- },
1009
- "bucket": {
1010
- "type": "string",
1011
- "description": "S3 bucket where file is stored",
1012
- "example": "893487340562-message-attachment"
1013
- },
1014
- "object_key": {
1015
- "type": "string",
1016
- "description": "S3 object apiKey",
1017
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1018
- },
1019
- "inline": {
1020
- "type": "boolean",
1021
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1022
- "default": false
1023
- },
1024
- "send_as_link": {
1025
- "type": "boolean",
1026
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
1027
- "default": false
1028
- },
1029
- "copy_to_message": {
1030
- "type": "boolean",
1031
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
1032
- "default": false
1033
- }
1034
- }
1035
- }
1036
- },
1037
- "references": {
1038
- "type": "string",
1039
- "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
1040
- "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
1041
- },
1042
- "in_reply_to": {
1043
- "type": "string",
1044
- "description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
1045
- "example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
1046
- },
1047
- "user_read_message": {
1048
- "type": "array",
1049
- "description": "Ivy User ID of user read the message.",
1050
- "items": {
1051
- "type": "string",
1052
- "example": [
1053
- "206801",
1054
- "200109"
1055
- ]
1056
- }
1057
- },
1058
- "send_status": {
1059
- "type": "array",
1060
- "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
1061
- "items": {
1062
- "type": "string",
1063
- "enum": [
1064
- "SEND",
1065
- "DELIVERY",
1066
- "REJECT",
1067
- "COMPLAINT",
1068
- "BOUNCE",
1069
- "ERROR"
1070
- ]
1071
- }
1072
- },
1073
- "type": {
1074
- "type": "string",
1075
- "description": "Message type",
1076
- "enum": [
1077
- "SENT",
1078
- "RECEIVED"
1079
- ]
1080
- }
1081
- }
1082
- }
1083
- }
1084
- }
1085
- },
1086
- "responses": {
1087
- "201": {
1088
- "description": "Success",
1089
- "content": {
1090
- "application/json": {
1091
- "schema": {
1092
- "allOf": [
1093
- {
1094
- "type": "object",
1095
- "required": [
1096
- "_id",
1097
- "_title",
1098
- "_org",
1099
- "_schema",
1100
- "_created_at",
1101
- "_updated_at"
1102
- ],
1103
- "properties": {
1104
- "_id": {
1105
- "type": "string",
1106
- "description": "Entity ID",
1107
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
1108
- },
1109
- "_title": {
1110
- "type": "string",
1111
- "description": "Entity title"
1112
- },
1113
- "_org": {
1114
- "type": "string",
1115
- "description": "Ivy Organization ID the entity belongs to",
1116
- "example": "206801"
1117
- },
1118
- "_schema": {
1119
- "type": "string",
1120
- "description": "URL-friendly identifier for the entity schema",
1121
- "example": "message"
1122
- },
1123
- "_tags": {
1124
- "type": "array",
1125
- "description": "Entity tags",
1126
- "items": {
1127
- "type": "string"
1128
- },
1129
- "example": [
1130
- "pricing",
1131
- "INBOX"
1132
- ]
1133
- },
1134
- "_created_at": {
1135
- "type": "string",
1136
- "description": "Created date",
1137
- "format": "date-time",
1138
- "example": "2021-02-09T12:41:43.662Z"
1139
- },
1140
- "_updated_at": {
1141
- "type": "string",
1142
- "description": "Updated date",
1143
- "format": "date-time",
1144
- "example": "2021-02-10T09:14:31.990Z"
1145
- }
1146
- }
1147
- },
1148
- {
1149
- "type": "object",
1150
- "required": [
1151
- "subject",
1152
- "from"
769
+ "subject",
770
+ "from"
1153
771
  ],
1154
772
  "properties": {
1155
773
  "message_id": {
@@ -1359,70 +977,40 @@
1359
977
  }
1360
978
  }
1361
979
  },
1362
- "attachments": {
1363
- "type": "array",
1364
- "description": "Message attachments",
1365
- "items": {
1366
- "type": "object",
1367
- "required": [
1368
- "filename",
1369
- "size",
1370
- "content_type",
1371
- "url",
1372
- "bucket",
1373
- "object_key"
1374
- ],
1375
- "properties": {
1376
- "cid": {
1377
- "type": "string",
1378
- "description": "Attachment ID",
1379
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
1380
- },
1381
- "filename": {
1382
- "type": "string",
1383
- "description": "File name",
1384
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
1385
- },
1386
- "size": {
1387
- "type": "number",
1388
- "description": "File size in bytes",
1389
- "example": 451349
1390
- },
1391
- "content_type": {
1392
- "type": "string",
1393
- "description": "Content type",
1394
- "example": "application/pdf"
1395
- },
1396
- "url": {
1397
- "type": "string",
1398
- "description": "URL to download the attachment.",
1399
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1400
- },
1401
- "bucket": {
1402
- "type": "string",
1403
- "description": "S3 bucket where file is stored",
1404
- "example": "893487340562-message-attachment"
1405
- },
1406
- "object_key": {
1407
- "type": "string",
1408
- "description": "S3 object apiKey",
1409
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1410
- },
1411
- "inline": {
1412
- "type": "boolean",
1413
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1414
- "default": false
1415
- },
1416
- "send_as_link": {
1417
- "type": "boolean",
1418
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
1419
- "default": false
1420
- },
1421
- "copy_to_message": {
1422
- "type": "boolean",
1423
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
1424
- "default": false
1425
- }
980
+ "file": {
981
+ "type": "object",
982
+ "required": [
983
+ "entity_id"
984
+ ],
985
+ "properties": {
986
+ "entity_id": {
987
+ "type": "string",
988
+ "description": "File entity ID",
989
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
990
+ },
991
+ "filename": {
992
+ "type": "string",
993
+ "description": "File name",
994
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
995
+ },
996
+ "is_message_attachment": {
997
+ "type": "boolean",
998
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
999
+ },
1000
+ "cid": {
1001
+ "type": "string",
1002
+ "description": "Content ID (for inline)",
1003
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
1004
+ },
1005
+ "inline": {
1006
+ "type": "boolean",
1007
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1008
+ "default": false
1009
+ },
1010
+ "send_as_link": {
1011
+ "type": "boolean",
1012
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
1013
+ "default": false
1426
1014
  }
1427
1015
  }
1428
1016
  },
@@ -1447,6 +1035,17 @@
1447
1035
  ]
1448
1036
  }
1449
1037
  },
1038
+ "org_read_message": {
1039
+ "type": "array",
1040
+ "description": "Ivy Organization ID of organization read the message.",
1041
+ "items": {
1042
+ "type": "string",
1043
+ "example": [
1044
+ "789372",
1045
+ "210291"
1046
+ ]
1047
+ }
1048
+ },
1450
1049
  "send_status": {
1451
1050
  "type": "array",
1452
1051
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -1570,28 +1169,86 @@
1570
1169
  }
1571
1170
  }
1572
1171
  },
1573
- "/v1/message/threads:search": {
1172
+ "/v1/message/messages/{id}/read": {
1574
1173
  "post": {
1575
- "operationId": "searchThreads",
1576
- "summary": "searchThreads",
1577
- "description": "Search for threads of email messages.\n\nMessages with no replies yet are treated as threads with single message.\n\nLucene syntax supported.\n",
1174
+ "operationId": "markReadMessage",
1175
+ "summary": "markReadMessage",
1176
+ "description": "Mark message as read",
1578
1177
  "tags": [
1579
- "Threads"
1178
+ "Messages"
1580
1179
  ],
1581
- "requestBody": {
1582
- "content": {
1583
- "application/json": {
1584
- "schema": {
1585
- "type": "object",
1586
- "required": [
1587
- "q"
1588
- ],
1589
- "properties": {
1590
- "q": {
1591
- "description": "Lucene query syntax supported with ElasticSearch",
1592
- "type": "string",
1593
- "example": "subject:\"Request for solar panel price\" AND _tags:INBOX"
1594
- },
1180
+ "parameters": [
1181
+ {
1182
+ "name": "id",
1183
+ "description": "Message ID",
1184
+ "in": "path",
1185
+ "required": true,
1186
+ "schema": {
1187
+ "type": "string"
1188
+ }
1189
+ }
1190
+ ],
1191
+ "responses": {
1192
+ "204": {
1193
+ "description": "Success"
1194
+ },
1195
+ "403": {
1196
+ "description": "Forbidden"
1197
+ }
1198
+ }
1199
+ }
1200
+ },
1201
+ "/v1/message/messages/{id}/unread": {
1202
+ "post": {
1203
+ "operationId": "markUnreadMessage",
1204
+ "summary": "markUnreadMessage",
1205
+ "description": "Mark message as unread",
1206
+ "tags": [
1207
+ "Messages"
1208
+ ],
1209
+ "parameters": [
1210
+ {
1211
+ "name": "id",
1212
+ "description": "Message ID",
1213
+ "in": "path",
1214
+ "required": true,
1215
+ "schema": {
1216
+ "type": "string"
1217
+ }
1218
+ }
1219
+ ],
1220
+ "responses": {
1221
+ "204": {
1222
+ "description": "Success"
1223
+ },
1224
+ "403": {
1225
+ "description": "Forbidden"
1226
+ }
1227
+ }
1228
+ }
1229
+ },
1230
+ "/v1/message/threads:search": {
1231
+ "post": {
1232
+ "operationId": "searchThreads",
1233
+ "summary": "searchThreads",
1234
+ "description": "Search for threads of email messages.\n\nMessages with no replies yet are treated as threads with single message.\n\nLucene syntax supported.\n",
1235
+ "tags": [
1236
+ "Threads"
1237
+ ],
1238
+ "requestBody": {
1239
+ "content": {
1240
+ "application/json": {
1241
+ "schema": {
1242
+ "type": "object",
1243
+ "required": [
1244
+ "q"
1245
+ ],
1246
+ "properties": {
1247
+ "q": {
1248
+ "description": "Lucene query syntax supported with ElasticSearch",
1249
+ "type": "string",
1250
+ "example": "subject:\"Request for solar panel price\" AND _tags:INBOX"
1251
+ },
1595
1252
  "from": {
1596
1253
  "type": "integer",
1597
1254
  "minimum": 0,
@@ -1706,6 +1363,17 @@
1706
1363
  ]
1707
1364
  }
1708
1365
  },
1366
+ "org_read_message": {
1367
+ "type": "array",
1368
+ "description": "Ivy Organization ID of organization read the message.",
1369
+ "items": {
1370
+ "type": "string",
1371
+ "example": [
1372
+ "789372",
1373
+ "210291"
1374
+ ]
1375
+ }
1376
+ },
1709
1377
  "latest_message": {
1710
1378
  "type": "object",
1711
1379
  "required": [
@@ -1920,70 +1588,40 @@
1920
1588
  }
1921
1589
  }
1922
1590
  },
1923
- "attachments": {
1924
- "type": "array",
1925
- "description": "Message attachments",
1926
- "items": {
1927
- "type": "object",
1928
- "required": [
1929
- "filename",
1930
- "size",
1931
- "content_type",
1932
- "url",
1933
- "bucket",
1934
- "object_key"
1935
- ],
1936
- "properties": {
1937
- "cid": {
1938
- "type": "string",
1939
- "description": "Attachment ID",
1940
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
1941
- },
1942
- "filename": {
1943
- "type": "string",
1944
- "description": "File name",
1945
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
1946
- },
1947
- "size": {
1948
- "type": "number",
1949
- "description": "File size in bytes",
1950
- "example": 451349
1951
- },
1952
- "content_type": {
1953
- "type": "string",
1954
- "description": "Content type",
1955
- "example": "application/pdf"
1956
- },
1957
- "url": {
1958
- "type": "string",
1959
- "description": "URL to download the attachment.",
1960
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1961
- },
1962
- "bucket": {
1963
- "type": "string",
1964
- "description": "S3 bucket where file is stored",
1965
- "example": "893487340562-message-attachment"
1966
- },
1967
- "object_key": {
1968
- "type": "string",
1969
- "description": "S3 object apiKey",
1970
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
1971
- },
1972
- "inline": {
1973
- "type": "boolean",
1974
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1975
- "default": false
1976
- },
1977
- "send_as_link": {
1978
- "type": "boolean",
1979
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
1980
- "default": false
1981
- },
1982
- "copy_to_message": {
1983
- "type": "boolean",
1984
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
1985
- "default": false
1986
- }
1591
+ "file": {
1592
+ "type": "object",
1593
+ "required": [
1594
+ "entity_id"
1595
+ ],
1596
+ "properties": {
1597
+ "entity_id": {
1598
+ "type": "string",
1599
+ "description": "File entity ID",
1600
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
1601
+ },
1602
+ "filename": {
1603
+ "type": "string",
1604
+ "description": "File name",
1605
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
1606
+ },
1607
+ "is_message_attachment": {
1608
+ "type": "boolean",
1609
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
1610
+ },
1611
+ "cid": {
1612
+ "type": "string",
1613
+ "description": "Content ID (for inline)",
1614
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
1615
+ },
1616
+ "inline": {
1617
+ "type": "boolean",
1618
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1619
+ "default": false
1620
+ },
1621
+ "send_as_link": {
1622
+ "type": "boolean",
1623
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
1624
+ "default": false
1987
1625
  }
1988
1626
  }
1989
1627
  },
@@ -2008,6 +1646,17 @@
2008
1646
  ]
2009
1647
  }
2010
1648
  },
1649
+ "org_read_message": {
1650
+ "type": "array",
1651
+ "description": "Ivy Organization ID of organization read the message.",
1652
+ "items": {
1653
+ "type": "string",
1654
+ "example": [
1655
+ "789372",
1656
+ "210291"
1657
+ ]
1658
+ }
1659
+ },
2011
1660
  "send_status": {
2012
1661
  "type": "array",
2013
1662
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -2248,70 +1897,40 @@
2248
1897
  }
2249
1898
  }
2250
1899
  },
2251
- "attachments": {
2252
- "type": "array",
2253
- "description": "Message attachments",
2254
- "items": {
2255
- "type": "object",
2256
- "required": [
2257
- "filename",
2258
- "size",
2259
- "content_type",
2260
- "url",
2261
- "bucket",
2262
- "object_key"
2263
- ],
2264
- "properties": {
2265
- "cid": {
2266
- "type": "string",
2267
- "description": "Attachment ID",
2268
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
2269
- },
2270
- "filename": {
2271
- "type": "string",
2272
- "description": "File name",
2273
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
2274
- },
2275
- "size": {
2276
- "type": "number",
2277
- "description": "File size in bytes",
2278
- "example": 451349
2279
- },
2280
- "content_type": {
2281
- "type": "string",
2282
- "description": "Content type",
2283
- "example": "application/pdf"
2284
- },
2285
- "url": {
2286
- "type": "string",
2287
- "description": "URL to download the attachment.",
2288
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
2289
- },
2290
- "bucket": {
2291
- "type": "string",
2292
- "description": "S3 bucket where file is stored",
2293
- "example": "893487340562-message-attachment"
2294
- },
2295
- "object_key": {
2296
- "type": "string",
2297
- "description": "S3 object apiKey",
2298
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
2299
- },
2300
- "inline": {
2301
- "type": "boolean",
2302
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
2303
- "default": false
2304
- },
2305
- "send_as_link": {
2306
- "type": "boolean",
2307
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
2308
- "default": false
2309
- },
2310
- "copy_to_message": {
2311
- "type": "boolean",
2312
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
2313
- "default": false
2314
- }
1900
+ "file": {
1901
+ "type": "object",
1902
+ "required": [
1903
+ "entity_id"
1904
+ ],
1905
+ "properties": {
1906
+ "entity_id": {
1907
+ "type": "string",
1908
+ "description": "File entity ID",
1909
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
1910
+ },
1911
+ "filename": {
1912
+ "type": "string",
1913
+ "description": "File name",
1914
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
1915
+ },
1916
+ "is_message_attachment": {
1917
+ "type": "boolean",
1918
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
1919
+ },
1920
+ "cid": {
1921
+ "type": "string",
1922
+ "description": "Content ID (for inline)",
1923
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
1924
+ },
1925
+ "inline": {
1926
+ "type": "boolean",
1927
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
1928
+ "default": false
1929
+ },
1930
+ "send_as_link": {
1931
+ "type": "boolean",
1932
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
1933
+ "default": false
2315
1934
  }
2316
1935
  }
2317
1936
  },
@@ -2336,6 +1955,17 @@
2336
1955
  ]
2337
1956
  }
2338
1957
  },
1958
+ "org_read_message": {
1959
+ "type": "array",
1960
+ "description": "Ivy Organization ID of organization read the message.",
1961
+ "items": {
1962
+ "type": "string",
1963
+ "example": [
1964
+ "789372",
1965
+ "210291"
1966
+ ]
1967
+ }
1968
+ },
2339
1969
  "send_status": {
2340
1970
  "type": "array",
2341
1971
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -2470,6 +2100,17 @@
2470
2100
  ]
2471
2101
  }
2472
2102
  },
2103
+ "org_read_message": {
2104
+ "type": "array",
2105
+ "description": "Ivy Organization ID of organization read the message.",
2106
+ "items": {
2107
+ "type": "string",
2108
+ "example": [
2109
+ "789372",
2110
+ "210291"
2111
+ ]
2112
+ }
2113
+ },
2473
2114
  "latest_message": {
2474
2115
  "type": "object",
2475
2116
  "required": [
@@ -2684,70 +2325,40 @@
2684
2325
  }
2685
2326
  }
2686
2327
  },
2687
- "attachments": {
2688
- "type": "array",
2689
- "description": "Message attachments",
2690
- "items": {
2691
- "type": "object",
2692
- "required": [
2693
- "filename",
2694
- "size",
2695
- "content_type",
2696
- "url",
2697
- "bucket",
2698
- "object_key"
2699
- ],
2700
- "properties": {
2701
- "cid": {
2702
- "type": "string",
2703
- "description": "Attachment ID",
2704
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
2705
- },
2706
- "filename": {
2707
- "type": "string",
2708
- "description": "File name",
2709
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
2710
- },
2711
- "size": {
2712
- "type": "number",
2713
- "description": "File size in bytes",
2714
- "example": 451349
2715
- },
2716
- "content_type": {
2717
- "type": "string",
2718
- "description": "Content type",
2719
- "example": "application/pdf"
2720
- },
2721
- "url": {
2722
- "type": "string",
2723
- "description": "URL to download the attachment.",
2724
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
2725
- },
2726
- "bucket": {
2727
- "type": "string",
2728
- "description": "S3 bucket where file is stored",
2729
- "example": "893487340562-message-attachment"
2730
- },
2731
- "object_key": {
2732
- "type": "string",
2733
- "description": "S3 object apiKey",
2734
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
2735
- },
2736
- "inline": {
2737
- "type": "boolean",
2738
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
2739
- "default": false
2740
- },
2741
- "send_as_link": {
2742
- "type": "boolean",
2743
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
2744
- "default": false
2745
- },
2746
- "copy_to_message": {
2747
- "type": "boolean",
2748
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
2749
- "default": false
2750
- }
2328
+ "file": {
2329
+ "type": "object",
2330
+ "required": [
2331
+ "entity_id"
2332
+ ],
2333
+ "properties": {
2334
+ "entity_id": {
2335
+ "type": "string",
2336
+ "description": "File entity ID",
2337
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
2338
+ },
2339
+ "filename": {
2340
+ "type": "string",
2341
+ "description": "File name",
2342
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
2343
+ },
2344
+ "is_message_attachment": {
2345
+ "type": "boolean",
2346
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
2347
+ },
2348
+ "cid": {
2349
+ "type": "string",
2350
+ "description": "Content ID (for inline)",
2351
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
2352
+ },
2353
+ "inline": {
2354
+ "type": "boolean",
2355
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
2356
+ "default": false
2357
+ },
2358
+ "send_as_link": {
2359
+ "type": "boolean",
2360
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
2361
+ "default": false
2751
2362
  }
2752
2363
  }
2753
2364
  },
@@ -2772,6 +2383,17 @@
2772
2383
  ]
2773
2384
  }
2774
2385
  },
2386
+ "org_read_message": {
2387
+ "type": "array",
2388
+ "description": "Ivy Organization ID of organization read the message.",
2389
+ "items": {
2390
+ "type": "string",
2391
+ "example": [
2392
+ "789372",
2393
+ "210291"
2394
+ ]
2395
+ }
2396
+ },
2775
2397
  "send_status": {
2776
2398
  "type": "array",
2777
2399
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -3012,70 +2634,40 @@
3012
2634
  }
3013
2635
  }
3014
2636
  },
3015
- "attachments": {
3016
- "type": "array",
3017
- "description": "Message attachments",
3018
- "items": {
3019
- "type": "object",
3020
- "required": [
3021
- "filename",
3022
- "size",
3023
- "content_type",
3024
- "url",
3025
- "bucket",
3026
- "object_key"
3027
- ],
3028
- "properties": {
3029
- "cid": {
3030
- "type": "string",
3031
- "description": "Attachment ID",
3032
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3033
- },
3034
- "filename": {
3035
- "type": "string",
3036
- "description": "File name",
3037
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3038
- },
3039
- "size": {
3040
- "type": "number",
3041
- "description": "File size in bytes",
3042
- "example": 451349
3043
- },
3044
- "content_type": {
3045
- "type": "string",
3046
- "description": "Content type",
3047
- "example": "application/pdf"
3048
- },
3049
- "url": {
3050
- "type": "string",
3051
- "description": "URL to download the attachment.",
3052
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3053
- },
3054
- "bucket": {
3055
- "type": "string",
3056
- "description": "S3 bucket where file is stored",
3057
- "example": "893487340562-message-attachment"
3058
- },
3059
- "object_key": {
3060
- "type": "string",
3061
- "description": "S3 object apiKey",
3062
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3063
- },
3064
- "inline": {
3065
- "type": "boolean",
3066
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3067
- "default": false
3068
- },
3069
- "send_as_link": {
3070
- "type": "boolean",
3071
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
3072
- "default": false
3073
- },
3074
- "copy_to_message": {
3075
- "type": "boolean",
3076
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
3077
- "default": false
3078
- }
2637
+ "file": {
2638
+ "type": "object",
2639
+ "required": [
2640
+ "entity_id"
2641
+ ],
2642
+ "properties": {
2643
+ "entity_id": {
2644
+ "type": "string",
2645
+ "description": "File entity ID",
2646
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
2647
+ },
2648
+ "filename": {
2649
+ "type": "string",
2650
+ "description": "File name",
2651
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
2652
+ },
2653
+ "is_message_attachment": {
2654
+ "type": "boolean",
2655
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
2656
+ },
2657
+ "cid": {
2658
+ "type": "string",
2659
+ "description": "Content ID (for inline)",
2660
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
2661
+ },
2662
+ "inline": {
2663
+ "type": "boolean",
2664
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
2665
+ "default": false
2666
+ },
2667
+ "send_as_link": {
2668
+ "type": "boolean",
2669
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
2670
+ "default": false
3079
2671
  }
3080
2672
  }
3081
2673
  },
@@ -3100,6 +2692,17 @@
3100
2692
  ]
3101
2693
  }
3102
2694
  },
2695
+ "org_read_message": {
2696
+ "type": "array",
2697
+ "description": "Ivy Organization ID of organization read the message.",
2698
+ "items": {
2699
+ "type": "string",
2700
+ "example": [
2701
+ "789372",
2702
+ "210291"
2703
+ ]
2704
+ }
2705
+ },
3103
2706
  "send_status": {
3104
2707
  "type": "array",
3105
2708
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -3226,76 +2829,1113 @@
3226
2829
  }
3227
2830
  }
3228
2831
  },
3229
- "/v1/message/attachments/upload-url": {
2832
+ "/v1/message/threads/{id}/read": {
3230
2833
  "post": {
3231
- "operationId": "createAttachmentUploadUrl",
3232
- "summary": "createAttachmentUploadUrl",
3233
- "description": "Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.",
2834
+ "operationId": "markReadThread",
2835
+ "summary": "markReadThread",
2836
+ "description": "Mark thread as read",
3234
2837
  "tags": [
3235
- "Attachments"
2838
+ "Threads"
3236
2839
  ],
3237
- "requestBody": {
3238
- "content": {
3239
- "application/json": {
3240
- "schema": {
3241
- "type": "object",
3242
- "required": [
3243
- "filename",
3244
- "content_type"
3245
- ],
3246
- "properties": {
3247
- "filename": {
2840
+ "parameters": [
2841
+ {
2842
+ "name": "id",
2843
+ "description": "Thread ID",
2844
+ "in": "path",
2845
+ "required": true,
2846
+ "schema": {
2847
+ "type": "string"
2848
+ }
2849
+ }
2850
+ ],
2851
+ "responses": {
2852
+ "204": {
2853
+ "description": "Success"
2854
+ },
2855
+ "403": {
2856
+ "description": "Forbidden"
2857
+ }
2858
+ }
2859
+ }
2860
+ },
2861
+ "/v1/message/threads/{id}/unread": {
2862
+ "post": {
2863
+ "operationId": "markUnreadThread",
2864
+ "summary": "markUnreadThread",
2865
+ "description": "Mark thread as unread",
2866
+ "tags": [
2867
+ "Threads"
2868
+ ],
2869
+ "parameters": [
2870
+ {
2871
+ "name": "id",
2872
+ "description": "Thread ID",
2873
+ "in": "path",
2874
+ "required": true,
2875
+ "schema": {
2876
+ "type": "string"
2877
+ }
2878
+ }
2879
+ ],
2880
+ "responses": {
2881
+ "204": {
2882
+ "description": "Success"
2883
+ },
2884
+ "403": {
2885
+ "description": "Forbidden"
2886
+ }
2887
+ }
2888
+ }
2889
+ },
2890
+ "/v1/message/drafts": {
2891
+ "post": {
2892
+ "operationId": "createDraft",
2893
+ "summary": "createDraft",
2894
+ "description": "Create a new draft",
2895
+ "tags": [
2896
+ "Drafts"
2897
+ ],
2898
+ "requestBody": {
2899
+ "content": {
2900
+ "application/json": {
2901
+ "schema": {
2902
+ "required": [
2903
+ "subject",
2904
+ "from"
2905
+ ],
2906
+ "properties": {
2907
+ "thread": {
2908
+ "type": "object",
2909
+ "required": [
2910
+ "topic"
2911
+ ],
2912
+ "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,...).\\\nThread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\\\n`thread` or `parent_id` must be provided either.\n",
2913
+ "properties": {
2914
+ "topic": {
2915
+ "type": "string",
2916
+ "description": "Message topic (e.g. which service sends the message or message category)"
2917
+ },
2918
+ "assigned_to": {
2919
+ "type": "array",
2920
+ "description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
2921
+ "items": {
2922
+ "type": "string"
2923
+ }
2924
+ }
2925
+ },
2926
+ "example": {
2927
+ "topic": "CUSTOMER_MESSAGE",
2928
+ "assigned_to": [
2929
+ "206801",
2930
+ "200109"
2931
+ ],
2932
+ "opportunity_id": 829072
2933
+ }
2934
+ },
2935
+ "parent_id": {
3248
2936
  "type": "string",
3249
- "description": "File name",
3250
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
2937
+ "description": "Entity ID of parent message which this message replies to or forwards from.\\\nIf both `parent_id` and `thread` are provided, `thread` is discarded.\n",
2938
+ "example": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2"
3251
2939
  },
3252
- "content_type": {
2940
+ "subject": {
3253
2941
  "type": "string",
3254
- "description": "Content type",
3255
- "example": "application/pdf"
3256
- }
2942
+ "description": "Subject",
2943
+ "example": "Request for solar panel price"
2944
+ },
2945
+ "html": {
2946
+ "type": "string",
2947
+ "description": "HTML body",
2948
+ "example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
2949
+ },
2950
+ "text": {
2951
+ "type": "string",
2952
+ "description": "Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)",
2953
+ "example": "We at ABC GmbH would like to request a price quote for the solar panel."
2954
+ },
2955
+ "from": {
2956
+ "type": "object",
2957
+ "required": [
2958
+ "address"
2959
+ ],
2960
+ "properties": {
2961
+ "name": {
2962
+ "type": "string",
2963
+ "description": "Email address alias",
2964
+ "example": "epilot"
2965
+ },
2966
+ "address": {
2967
+ "type": "string",
2968
+ "description": "Email address",
2969
+ "example": "messaging@epilot.cloud"
2970
+ },
2971
+ "send_status": {
2972
+ "type": "string",
2973
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
2974
+ "enum": [
2975
+ "SEND",
2976
+ "DELIVERY",
2977
+ "REJECT",
2978
+ "COMPLAINT",
2979
+ "BOUNCE",
2980
+ "ERROR"
2981
+ ]
2982
+ },
2983
+ "send_error": {
2984
+ "type": "object",
2985
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
2986
+ }
2987
+ }
2988
+ },
2989
+ "reply_to": {
2990
+ "type": "object",
2991
+ "required": [
2992
+ "address"
2993
+ ],
2994
+ "properties": {
2995
+ "name": {
2996
+ "type": "string",
2997
+ "description": "Email address alias",
2998
+ "example": "epilot"
2999
+ },
3000
+ "address": {
3001
+ "type": "string",
3002
+ "description": "Email address",
3003
+ "example": "messaging@epilot.cloud"
3004
+ },
3005
+ "send_status": {
3006
+ "type": "string",
3007
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3008
+ "enum": [
3009
+ "SEND",
3010
+ "DELIVERY",
3011
+ "REJECT",
3012
+ "COMPLAINT",
3013
+ "BOUNCE",
3014
+ "ERROR"
3015
+ ]
3016
+ },
3017
+ "send_error": {
3018
+ "type": "object",
3019
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3020
+ }
3021
+ }
3022
+ },
3023
+ "to": {
3024
+ "type": "array",
3025
+ "description": "To email addresses",
3026
+ "items": {
3027
+ "type": "object",
3028
+ "required": [
3029
+ "address"
3030
+ ],
3031
+ "properties": {
3032
+ "name": {
3033
+ "type": "string",
3034
+ "description": "Email address alias",
3035
+ "example": "epilot"
3036
+ },
3037
+ "address": {
3038
+ "type": "string",
3039
+ "description": "Email address",
3040
+ "example": "messaging@epilot.cloud"
3041
+ },
3042
+ "send_status": {
3043
+ "type": "string",
3044
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3045
+ "enum": [
3046
+ "SEND",
3047
+ "DELIVERY",
3048
+ "REJECT",
3049
+ "COMPLAINT",
3050
+ "BOUNCE",
3051
+ "ERROR"
3052
+ ]
3053
+ },
3054
+ "send_error": {
3055
+ "type": "object",
3056
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3057
+ }
3058
+ }
3059
+ }
3060
+ },
3061
+ "cc": {
3062
+ "type": "array",
3063
+ "description": "Cc email addresses",
3064
+ "items": {
3065
+ "type": "object",
3066
+ "required": [
3067
+ "address"
3068
+ ],
3069
+ "properties": {
3070
+ "name": {
3071
+ "type": "string",
3072
+ "description": "Email address alias",
3073
+ "example": "epilot"
3074
+ },
3075
+ "address": {
3076
+ "type": "string",
3077
+ "description": "Email address",
3078
+ "example": "messaging@epilot.cloud"
3079
+ },
3080
+ "send_status": {
3081
+ "type": "string",
3082
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3083
+ "enum": [
3084
+ "SEND",
3085
+ "DELIVERY",
3086
+ "REJECT",
3087
+ "COMPLAINT",
3088
+ "BOUNCE",
3089
+ "ERROR"
3090
+ ]
3091
+ },
3092
+ "send_error": {
3093
+ "type": "object",
3094
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3095
+ }
3096
+ }
3097
+ }
3098
+ },
3099
+ "bcc": {
3100
+ "type": "array",
3101
+ "description": "Bcc email addresses",
3102
+ "items": {
3103
+ "type": "object",
3104
+ "required": [
3105
+ "address"
3106
+ ],
3107
+ "properties": {
3108
+ "name": {
3109
+ "type": "string",
3110
+ "description": "Email address alias",
3111
+ "example": "epilot"
3112
+ },
3113
+ "address": {
3114
+ "type": "string",
3115
+ "description": "Email address",
3116
+ "example": "messaging@epilot.cloud"
3117
+ },
3118
+ "send_status": {
3119
+ "type": "string",
3120
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3121
+ "enum": [
3122
+ "SEND",
3123
+ "DELIVERY",
3124
+ "REJECT",
3125
+ "COMPLAINT",
3126
+ "BOUNCE",
3127
+ "ERROR"
3128
+ ]
3129
+ },
3130
+ "send_error": {
3131
+ "type": "object",
3132
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3133
+ }
3134
+ }
3135
+ }
3136
+ },
3137
+ "file": {
3138
+ "type": "object",
3139
+ "required": [
3140
+ "entity_id"
3141
+ ],
3142
+ "properties": {
3143
+ "entity_id": {
3144
+ "type": "string",
3145
+ "description": "File entity ID",
3146
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3147
+ },
3148
+ "filename": {
3149
+ "type": "string",
3150
+ "description": "File name",
3151
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3152
+ },
3153
+ "is_message_attachment": {
3154
+ "type": "boolean",
3155
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
3156
+ },
3157
+ "cid": {
3158
+ "type": "string",
3159
+ "description": "Content ID (for inline)",
3160
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
3161
+ },
3162
+ "inline": {
3163
+ "type": "boolean",
3164
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3165
+ "default": false
3166
+ },
3167
+ "send_as_link": {
3168
+ "type": "boolean",
3169
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
3170
+ "default": false
3171
+ }
3172
+ }
3173
+ }
3174
+ }
3175
+ }
3176
+ }
3177
+ }
3178
+ },
3179
+ "responses": {
3180
+ "201": {
3181
+ "description": "Success",
3182
+ "content": {
3183
+ "application/json": {
3184
+ "schema": {
3185
+ "allOf": [
3186
+ {
3187
+ "type": "object",
3188
+ "required": [
3189
+ "_id",
3190
+ "_title",
3191
+ "_org",
3192
+ "_schema",
3193
+ "_created_at",
3194
+ "_updated_at"
3195
+ ],
3196
+ "properties": {
3197
+ "_id": {
3198
+ "type": "string",
3199
+ "description": "Entity ID",
3200
+ "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3201
+ },
3202
+ "_title": {
3203
+ "type": "string",
3204
+ "description": "Entity title"
3205
+ },
3206
+ "_org": {
3207
+ "type": "string",
3208
+ "description": "Ivy Organization ID the entity belongs to",
3209
+ "example": "206801"
3210
+ },
3211
+ "_schema": {
3212
+ "type": "string",
3213
+ "description": "URL-friendly identifier for the entity schema",
3214
+ "example": "message"
3215
+ },
3216
+ "_tags": {
3217
+ "type": "array",
3218
+ "description": "Entity tags",
3219
+ "items": {
3220
+ "type": "string"
3221
+ },
3222
+ "example": [
3223
+ "pricing",
3224
+ "INBOX"
3225
+ ]
3226
+ },
3227
+ "_created_at": {
3228
+ "type": "string",
3229
+ "description": "Created date",
3230
+ "format": "date-time",
3231
+ "example": "2021-02-09T12:41:43.662Z"
3232
+ },
3233
+ "_updated_at": {
3234
+ "type": "string",
3235
+ "description": "Updated date",
3236
+ "format": "date-time",
3237
+ "example": "2021-02-10T09:14:31.990Z"
3238
+ }
3239
+ }
3240
+ },
3241
+ {
3242
+ "type": "object",
3243
+ "required": [
3244
+ "subject",
3245
+ "from"
3246
+ ],
3247
+ "properties": {
3248
+ "message_id": {
3249
+ "type": "string",
3250
+ "description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
3251
+ "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
3252
+ },
3253
+ "sender": {
3254
+ "type": "string",
3255
+ "description": "Ivy User ID of user sends the message.",
3256
+ "example": "206801"
3257
+ },
3258
+ "subject": {
3259
+ "type": "string",
3260
+ "description": "Subject",
3261
+ "example": "Request for solar panel price"
3262
+ },
3263
+ "html": {
3264
+ "type": "string",
3265
+ "description": "HTML body",
3266
+ "example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
3267
+ },
3268
+ "text": {
3269
+ "type": "string",
3270
+ "description": "Text body",
3271
+ "example": "We at ABC GmbH would like to request a price quote for the solar panel."
3272
+ },
3273
+ "from": {
3274
+ "type": "object",
3275
+ "required": [
3276
+ "address"
3277
+ ],
3278
+ "properties": {
3279
+ "name": {
3280
+ "type": "string",
3281
+ "description": "Email address alias",
3282
+ "example": "epilot"
3283
+ },
3284
+ "address": {
3285
+ "type": "string",
3286
+ "description": "Email address",
3287
+ "example": "messaging@epilot.cloud"
3288
+ },
3289
+ "send_status": {
3290
+ "type": "string",
3291
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3292
+ "enum": [
3293
+ "SEND",
3294
+ "DELIVERY",
3295
+ "REJECT",
3296
+ "COMPLAINT",
3297
+ "BOUNCE",
3298
+ "ERROR"
3299
+ ]
3300
+ },
3301
+ "send_error": {
3302
+ "type": "object",
3303
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3304
+ }
3305
+ }
3306
+ },
3307
+ "reply_to": {
3308
+ "type": "object",
3309
+ "required": [
3310
+ "address"
3311
+ ],
3312
+ "properties": {
3313
+ "name": {
3314
+ "type": "string",
3315
+ "description": "Email address alias",
3316
+ "example": "epilot"
3317
+ },
3318
+ "address": {
3319
+ "type": "string",
3320
+ "description": "Email address",
3321
+ "example": "messaging@epilot.cloud"
3322
+ },
3323
+ "send_status": {
3324
+ "type": "string",
3325
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3326
+ "enum": [
3327
+ "SEND",
3328
+ "DELIVERY",
3329
+ "REJECT",
3330
+ "COMPLAINT",
3331
+ "BOUNCE",
3332
+ "ERROR"
3333
+ ]
3334
+ },
3335
+ "send_error": {
3336
+ "type": "object",
3337
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3338
+ }
3339
+ }
3340
+ },
3341
+ "to": {
3342
+ "type": "array",
3343
+ "description": "To email addresses",
3344
+ "items": {
3345
+ "type": "object",
3346
+ "required": [
3347
+ "address"
3348
+ ],
3349
+ "properties": {
3350
+ "name": {
3351
+ "type": "string",
3352
+ "description": "Email address alias",
3353
+ "example": "epilot"
3354
+ },
3355
+ "address": {
3356
+ "type": "string",
3357
+ "description": "Email address",
3358
+ "example": "messaging@epilot.cloud"
3359
+ },
3360
+ "send_status": {
3361
+ "type": "string",
3362
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3363
+ "enum": [
3364
+ "SEND",
3365
+ "DELIVERY",
3366
+ "REJECT",
3367
+ "COMPLAINT",
3368
+ "BOUNCE",
3369
+ "ERROR"
3370
+ ]
3371
+ },
3372
+ "send_error": {
3373
+ "type": "object",
3374
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3375
+ }
3376
+ }
3377
+ }
3378
+ },
3379
+ "cc": {
3380
+ "type": "array",
3381
+ "description": "Cc email addresses",
3382
+ "items": {
3383
+ "type": "object",
3384
+ "required": [
3385
+ "address"
3386
+ ],
3387
+ "properties": {
3388
+ "name": {
3389
+ "type": "string",
3390
+ "description": "Email address alias",
3391
+ "example": "epilot"
3392
+ },
3393
+ "address": {
3394
+ "type": "string",
3395
+ "description": "Email address",
3396
+ "example": "messaging@epilot.cloud"
3397
+ },
3398
+ "send_status": {
3399
+ "type": "string",
3400
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3401
+ "enum": [
3402
+ "SEND",
3403
+ "DELIVERY",
3404
+ "REJECT",
3405
+ "COMPLAINT",
3406
+ "BOUNCE",
3407
+ "ERROR"
3408
+ ]
3409
+ },
3410
+ "send_error": {
3411
+ "type": "object",
3412
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3413
+ }
3414
+ }
3415
+ }
3416
+ },
3417
+ "bcc": {
3418
+ "type": "array",
3419
+ "description": "Bcc email addresses",
3420
+ "items": {
3421
+ "type": "object",
3422
+ "required": [
3423
+ "address"
3424
+ ],
3425
+ "properties": {
3426
+ "name": {
3427
+ "type": "string",
3428
+ "description": "Email address alias",
3429
+ "example": "epilot"
3430
+ },
3431
+ "address": {
3432
+ "type": "string",
3433
+ "description": "Email address",
3434
+ "example": "messaging@epilot.cloud"
3435
+ },
3436
+ "send_status": {
3437
+ "type": "string",
3438
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3439
+ "enum": [
3440
+ "SEND",
3441
+ "DELIVERY",
3442
+ "REJECT",
3443
+ "COMPLAINT",
3444
+ "BOUNCE",
3445
+ "ERROR"
3446
+ ]
3447
+ },
3448
+ "send_error": {
3449
+ "type": "object",
3450
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3451
+ }
3452
+ }
3453
+ }
3454
+ },
3455
+ "file": {
3456
+ "type": "object",
3457
+ "required": [
3458
+ "entity_id"
3459
+ ],
3460
+ "properties": {
3461
+ "entity_id": {
3462
+ "type": "string",
3463
+ "description": "File entity ID",
3464
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3465
+ },
3466
+ "filename": {
3467
+ "type": "string",
3468
+ "description": "File name",
3469
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3470
+ },
3471
+ "is_message_attachment": {
3472
+ "type": "boolean",
3473
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
3474
+ },
3475
+ "cid": {
3476
+ "type": "string",
3477
+ "description": "Content ID (for inline)",
3478
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
3479
+ },
3480
+ "inline": {
3481
+ "type": "boolean",
3482
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3483
+ "default": false
3484
+ },
3485
+ "send_as_link": {
3486
+ "type": "boolean",
3487
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
3488
+ "default": false
3489
+ }
3490
+ }
3491
+ },
3492
+ "references": {
3493
+ "type": "string",
3494
+ "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
3495
+ "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
3496
+ },
3497
+ "in_reply_to": {
3498
+ "type": "string",
3499
+ "description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
3500
+ "example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
3501
+ },
3502
+ "user_read_message": {
3503
+ "type": "array",
3504
+ "description": "Ivy User ID of user read the message.",
3505
+ "items": {
3506
+ "type": "string",
3507
+ "example": [
3508
+ "206801",
3509
+ "200109"
3510
+ ]
3511
+ }
3512
+ },
3513
+ "org_read_message": {
3514
+ "type": "array",
3515
+ "description": "Ivy Organization ID of organization read the message.",
3516
+ "items": {
3517
+ "type": "string",
3518
+ "example": [
3519
+ "789372",
3520
+ "210291"
3521
+ ]
3522
+ }
3523
+ },
3524
+ "send_status": {
3525
+ "type": "array",
3526
+ "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3527
+ "items": {
3528
+ "type": "string",
3529
+ "enum": [
3530
+ "SEND",
3531
+ "DELIVERY",
3532
+ "REJECT",
3533
+ "COMPLAINT",
3534
+ "BOUNCE",
3535
+ "ERROR"
3536
+ ]
3537
+ }
3538
+ },
3539
+ "type": {
3540
+ "type": "string",
3541
+ "description": "Message type",
3542
+ "enum": [
3543
+ "SENT",
3544
+ "RECEIVED"
3545
+ ]
3546
+ }
3547
+ }
3548
+ }
3549
+ ]
3257
3550
  }
3258
3551
  }
3259
3552
  }
3553
+ },
3554
+ "403": {
3555
+ "description": "Forbidden"
3260
3556
  }
3261
- },
3557
+ }
3558
+ }
3559
+ },
3560
+ "/v1/message/drafts:send": {
3561
+ "post": {
3562
+ "operationId": "sendDraft",
3563
+ "summary": "sendDraft",
3564
+ "description": "Send the existing draft to the recipients",
3565
+ "tags": [
3566
+ "Drafts"
3567
+ ],
3262
3568
  "responses": {
3263
- "200": {
3569
+ "201": {
3264
3570
  "description": "Success",
3265
3571
  "content": {
3266
3572
  "application/json": {
3267
3573
  "schema": {
3268
- "type": "object",
3269
- "required": [
3270
- "download_url",
3271
- "upload_url"
3272
- ],
3273
- "properties": {
3274
- "download_url": {
3275
- "type": "string",
3276
- "description": "URL to download the attachment. This URL is not accessible until attachment is uploaded successfully.",
3277
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3574
+ "allOf": [
3575
+ {
3576
+ "type": "object",
3577
+ "required": [
3578
+ "_id",
3579
+ "_title",
3580
+ "_org",
3581
+ "_schema",
3582
+ "_created_at",
3583
+ "_updated_at"
3584
+ ],
3585
+ "properties": {
3586
+ "_id": {
3587
+ "type": "string",
3588
+ "description": "Entity ID",
3589
+ "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3590
+ },
3591
+ "_title": {
3592
+ "type": "string",
3593
+ "description": "Entity title"
3594
+ },
3595
+ "_org": {
3596
+ "type": "string",
3597
+ "description": "Ivy Organization ID the entity belongs to",
3598
+ "example": "206801"
3599
+ },
3600
+ "_schema": {
3601
+ "type": "string",
3602
+ "description": "URL-friendly identifier for the entity schema",
3603
+ "example": "message"
3604
+ },
3605
+ "_tags": {
3606
+ "type": "array",
3607
+ "description": "Entity tags",
3608
+ "items": {
3609
+ "type": "string"
3610
+ },
3611
+ "example": [
3612
+ "pricing",
3613
+ "INBOX"
3614
+ ]
3615
+ },
3616
+ "_created_at": {
3617
+ "type": "string",
3618
+ "description": "Created date",
3619
+ "format": "date-time",
3620
+ "example": "2021-02-09T12:41:43.662Z"
3621
+ },
3622
+ "_updated_at": {
3623
+ "type": "string",
3624
+ "description": "Updated date",
3625
+ "format": "date-time",
3626
+ "example": "2021-02-10T09:14:31.990Z"
3627
+ }
3628
+ }
3278
3629
  },
3279
- "upload_url": {
3630
+ {
3280
3631
  "type": "object",
3281
3632
  "required": [
3282
- "url",
3283
- "fields"
3633
+ "subject",
3634
+ "from"
3284
3635
  ],
3285
3636
  "properties": {
3286
- "url": {
3287
- "type": "number",
3288
- "description": "URL to upload the attachment",
3289
- "example": "https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment"
3637
+ "message_id": {
3638
+ "type": "string",
3639
+ "description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
3640
+ "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
3641
+ },
3642
+ "sender": {
3643
+ "type": "string",
3644
+ "description": "Ivy User ID of user sends the message.",
3645
+ "example": "206801"
3646
+ },
3647
+ "subject": {
3648
+ "type": "string",
3649
+ "description": "Subject",
3650
+ "example": "Request for solar panel price"
3651
+ },
3652
+ "html": {
3653
+ "type": "string",
3654
+ "description": "HTML body",
3655
+ "example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
3656
+ },
3657
+ "text": {
3658
+ "type": "string",
3659
+ "description": "Text body",
3660
+ "example": "We at ABC GmbH would like to request a price quote for the solar panel."
3661
+ },
3662
+ "from": {
3663
+ "type": "object",
3664
+ "required": [
3665
+ "address"
3666
+ ],
3667
+ "properties": {
3668
+ "name": {
3669
+ "type": "string",
3670
+ "description": "Email address alias",
3671
+ "example": "epilot"
3672
+ },
3673
+ "address": {
3674
+ "type": "string",
3675
+ "description": "Email address",
3676
+ "example": "messaging@epilot.cloud"
3677
+ },
3678
+ "send_status": {
3679
+ "type": "string",
3680
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3681
+ "enum": [
3682
+ "SEND",
3683
+ "DELIVERY",
3684
+ "REJECT",
3685
+ "COMPLAINT",
3686
+ "BOUNCE",
3687
+ "ERROR"
3688
+ ]
3689
+ },
3690
+ "send_error": {
3691
+ "type": "object",
3692
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3693
+ }
3694
+ }
3695
+ },
3696
+ "reply_to": {
3697
+ "type": "object",
3698
+ "required": [
3699
+ "address"
3700
+ ],
3701
+ "properties": {
3702
+ "name": {
3703
+ "type": "string",
3704
+ "description": "Email address alias",
3705
+ "example": "epilot"
3706
+ },
3707
+ "address": {
3708
+ "type": "string",
3709
+ "description": "Email address",
3710
+ "example": "messaging@epilot.cloud"
3711
+ },
3712
+ "send_status": {
3713
+ "type": "string",
3714
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3715
+ "enum": [
3716
+ "SEND",
3717
+ "DELIVERY",
3718
+ "REJECT",
3719
+ "COMPLAINT",
3720
+ "BOUNCE",
3721
+ "ERROR"
3722
+ ]
3723
+ },
3724
+ "send_error": {
3725
+ "type": "object",
3726
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3727
+ }
3728
+ }
3729
+ },
3730
+ "to": {
3731
+ "type": "array",
3732
+ "description": "To email addresses",
3733
+ "items": {
3734
+ "type": "object",
3735
+ "required": [
3736
+ "address"
3737
+ ],
3738
+ "properties": {
3739
+ "name": {
3740
+ "type": "string",
3741
+ "description": "Email address alias",
3742
+ "example": "epilot"
3743
+ },
3744
+ "address": {
3745
+ "type": "string",
3746
+ "description": "Email address",
3747
+ "example": "messaging@epilot.cloud"
3748
+ },
3749
+ "send_status": {
3750
+ "type": "string",
3751
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3752
+ "enum": [
3753
+ "SEND",
3754
+ "DELIVERY",
3755
+ "REJECT",
3756
+ "COMPLAINT",
3757
+ "BOUNCE",
3758
+ "ERROR"
3759
+ ]
3760
+ },
3761
+ "send_error": {
3762
+ "type": "object",
3763
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3764
+ }
3765
+ }
3766
+ }
3767
+ },
3768
+ "cc": {
3769
+ "type": "array",
3770
+ "description": "Cc email addresses",
3771
+ "items": {
3772
+ "type": "object",
3773
+ "required": [
3774
+ "address"
3775
+ ],
3776
+ "properties": {
3777
+ "name": {
3778
+ "type": "string",
3779
+ "description": "Email address alias",
3780
+ "example": "epilot"
3781
+ },
3782
+ "address": {
3783
+ "type": "string",
3784
+ "description": "Email address",
3785
+ "example": "messaging@epilot.cloud"
3786
+ },
3787
+ "send_status": {
3788
+ "type": "string",
3789
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3790
+ "enum": [
3791
+ "SEND",
3792
+ "DELIVERY",
3793
+ "REJECT",
3794
+ "COMPLAINT",
3795
+ "BOUNCE",
3796
+ "ERROR"
3797
+ ]
3798
+ },
3799
+ "send_error": {
3800
+ "type": "object",
3801
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3802
+ }
3803
+ }
3804
+ }
3805
+ },
3806
+ "bcc": {
3807
+ "type": "array",
3808
+ "description": "Bcc email addresses",
3809
+ "items": {
3810
+ "type": "object",
3811
+ "required": [
3812
+ "address"
3813
+ ],
3814
+ "properties": {
3815
+ "name": {
3816
+ "type": "string",
3817
+ "description": "Email address alias",
3818
+ "example": "epilot"
3819
+ },
3820
+ "address": {
3821
+ "type": "string",
3822
+ "description": "Email address",
3823
+ "example": "messaging@epilot.cloud"
3824
+ },
3825
+ "send_status": {
3826
+ "type": "string",
3827
+ "description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3828
+ "enum": [
3829
+ "SEND",
3830
+ "DELIVERY",
3831
+ "REJECT",
3832
+ "COMPLAINT",
3833
+ "BOUNCE",
3834
+ "ERROR"
3835
+ ]
3836
+ },
3837
+ "send_error": {
3838
+ "type": "object",
3839
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3840
+ }
3841
+ }
3842
+ }
3290
3843
  },
3291
- "fields": {
3844
+ "file": {
3292
3845
  "type": "object",
3293
- "description": "Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request.",
3294
- "example": {}
3846
+ "required": [
3847
+ "entity_id"
3848
+ ],
3849
+ "properties": {
3850
+ "entity_id": {
3851
+ "type": "string",
3852
+ "description": "File entity ID",
3853
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3854
+ },
3855
+ "filename": {
3856
+ "type": "string",
3857
+ "description": "File name",
3858
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3859
+ },
3860
+ "is_message_attachment": {
3861
+ "type": "boolean",
3862
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
3863
+ },
3864
+ "cid": {
3865
+ "type": "string",
3866
+ "description": "Content ID (for inline)",
3867
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
3868
+ },
3869
+ "inline": {
3870
+ "type": "boolean",
3871
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3872
+ "default": false
3873
+ },
3874
+ "send_as_link": {
3875
+ "type": "boolean",
3876
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
3877
+ "default": false
3878
+ }
3879
+ }
3880
+ },
3881
+ "references": {
3882
+ "type": "string",
3883
+ "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
3884
+ "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
3885
+ },
3886
+ "in_reply_to": {
3887
+ "type": "string",
3888
+ "description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
3889
+ "example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
3890
+ },
3891
+ "user_read_message": {
3892
+ "type": "array",
3893
+ "description": "Ivy User ID of user read the message.",
3894
+ "items": {
3895
+ "type": "string",
3896
+ "example": [
3897
+ "206801",
3898
+ "200109"
3899
+ ]
3900
+ }
3901
+ },
3902
+ "org_read_message": {
3903
+ "type": "array",
3904
+ "description": "Ivy Organization ID of organization read the message.",
3905
+ "items": {
3906
+ "type": "string",
3907
+ "example": [
3908
+ "789372",
3909
+ "210291"
3910
+ ]
3911
+ }
3912
+ },
3913
+ "send_status": {
3914
+ "type": "array",
3915
+ "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
3916
+ "items": {
3917
+ "type": "string",
3918
+ "enum": [
3919
+ "SEND",
3920
+ "DELIVERY",
3921
+ "REJECT",
3922
+ "COMPLAINT",
3923
+ "BOUNCE",
3924
+ "ERROR"
3925
+ ]
3926
+ }
3927
+ },
3928
+ "type": {
3929
+ "type": "string",
3930
+ "description": "Message type",
3931
+ "enum": [
3932
+ "SENT",
3933
+ "RECEIVED"
3934
+ ]
3295
3935
  }
3296
3936
  }
3297
3937
  }
3298
- }
3938
+ ]
3299
3939
  }
3300
3940
  }
3301
3941
  }
@@ -3314,6 +3954,12 @@
3314
3954
  "scheme": "bearer",
3315
3955
  "description": "Authorization header with epilot OAuth2 bearer token",
3316
3956
  "bearerFormat": "JWT"
3957
+ },
3958
+ "EpilotOrg": {
3959
+ "description": "Overrides the target organization to allow shared tenant access",
3960
+ "name": "x-epilot-org-id",
3961
+ "in": "header",
3962
+ "type": "apiKey"
3317
3963
  }
3318
3964
  },
3319
3965
  "schemas": {
@@ -3394,6 +4040,17 @@
3394
4040
  ]
3395
4041
  }
3396
4042
  },
4043
+ "org_read_message": {
4044
+ "type": "array",
4045
+ "description": "Ivy Organization ID of organization read the message.",
4046
+ "items": {
4047
+ "type": "string",
4048
+ "example": [
4049
+ "789372",
4050
+ "210291"
4051
+ ]
4052
+ }
4053
+ },
3397
4054
  "latest_message": {
3398
4055
  "type": "object",
3399
4056
  "required": [
@@ -3598,83 +4255,53 @@
3598
4255
  "REJECT",
3599
4256
  "COMPLAINT",
3600
4257
  "BOUNCE",
3601
- "ERROR"
3602
- ]
3603
- },
3604
- "send_error": {
3605
- "type": "object",
3606
- "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3607
- }
3608
- }
3609
- }
3610
- },
3611
- "attachments": {
3612
- "type": "array",
3613
- "description": "Message attachments",
3614
- "items": {
3615
- "type": "object",
3616
- "required": [
3617
- "filename",
3618
- "size",
3619
- "content_type",
3620
- "url",
3621
- "bucket",
3622
- "object_key"
3623
- ],
3624
- "properties": {
3625
- "cid": {
3626
- "type": "string",
3627
- "description": "Attachment ID",
3628
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3629
- },
3630
- "filename": {
3631
- "type": "string",
3632
- "description": "File name",
3633
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3634
- },
3635
- "size": {
3636
- "type": "number",
3637
- "description": "File size in bytes",
3638
- "example": 451349
3639
- },
3640
- "content_type": {
3641
- "type": "string",
3642
- "description": "Content type",
3643
- "example": "application/pdf"
3644
- },
3645
- "url": {
3646
- "type": "string",
3647
- "description": "URL to download the attachment.",
3648
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3649
- },
3650
- "bucket": {
3651
- "type": "string",
3652
- "description": "S3 bucket where file is stored",
3653
- "example": "893487340562-message-attachment"
3654
- },
3655
- "object_key": {
3656
- "type": "string",
3657
- "description": "S3 object apiKey",
3658
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3659
- },
3660
- "inline": {
3661
- "type": "boolean",
3662
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3663
- "default": false
3664
- },
3665
- "send_as_link": {
3666
- "type": "boolean",
3667
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
3668
- "default": false
4258
+ "ERROR"
4259
+ ]
3669
4260
  },
3670
- "copy_to_message": {
3671
- "type": "boolean",
3672
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
3673
- "default": false
4261
+ "send_error": {
4262
+ "type": "object",
4263
+ "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
3674
4264
  }
3675
4265
  }
3676
4266
  }
3677
4267
  },
4268
+ "file": {
4269
+ "type": "object",
4270
+ "required": [
4271
+ "entity_id"
4272
+ ],
4273
+ "properties": {
4274
+ "entity_id": {
4275
+ "type": "string",
4276
+ "description": "File entity ID",
4277
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4278
+ },
4279
+ "filename": {
4280
+ "type": "string",
4281
+ "description": "File name",
4282
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4283
+ },
4284
+ "is_message_attachment": {
4285
+ "type": "boolean",
4286
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
4287
+ },
4288
+ "cid": {
4289
+ "type": "string",
4290
+ "description": "Content ID (for inline)",
4291
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
4292
+ },
4293
+ "inline": {
4294
+ "type": "boolean",
4295
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
4296
+ "default": false
4297
+ },
4298
+ "send_as_link": {
4299
+ "type": "boolean",
4300
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
4301
+ "default": false
4302
+ }
4303
+ }
4304
+ },
3678
4305
  "references": {
3679
4306
  "type": "string",
3680
4307
  "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
@@ -3696,6 +4323,17 @@
3696
4323
  ]
3697
4324
  }
3698
4325
  },
4326
+ "org_read_message": {
4327
+ "type": "array",
4328
+ "description": "Ivy Organization ID of organization read the message.",
4329
+ "items": {
4330
+ "type": "string",
4331
+ "example": [
4332
+ "789372",
4333
+ "210291"
4334
+ ]
4335
+ }
4336
+ },
3699
4337
  "send_status": {
3700
4338
  "type": "array",
3701
4339
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -3936,70 +4574,40 @@
3936
4574
  }
3937
4575
  }
3938
4576
  },
3939
- "attachments": {
3940
- "type": "array",
3941
- "description": "Message attachments",
3942
- "items": {
3943
- "type": "object",
3944
- "required": [
3945
- "filename",
3946
- "size",
3947
- "content_type",
3948
- "url",
3949
- "bucket",
3950
- "object_key"
3951
- ],
3952
- "properties": {
3953
- "cid": {
3954
- "type": "string",
3955
- "description": "Attachment ID",
3956
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
3957
- },
3958
- "filename": {
3959
- "type": "string",
3960
- "description": "File name",
3961
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
3962
- },
3963
- "size": {
3964
- "type": "number",
3965
- "description": "File size in bytes",
3966
- "example": 451349
3967
- },
3968
- "content_type": {
3969
- "type": "string",
3970
- "description": "Content type",
3971
- "example": "application/pdf"
3972
- },
3973
- "url": {
3974
- "type": "string",
3975
- "description": "URL to download the attachment.",
3976
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3977
- },
3978
- "bucket": {
3979
- "type": "string",
3980
- "description": "S3 bucket where file is stored",
3981
- "example": "893487340562-message-attachment"
3982
- },
3983
- "object_key": {
3984
- "type": "string",
3985
- "description": "S3 object apiKey",
3986
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
3987
- },
3988
- "inline": {
3989
- "type": "boolean",
3990
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
3991
- "default": false
3992
- },
3993
- "send_as_link": {
3994
- "type": "boolean",
3995
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
3996
- "default": false
3997
- },
3998
- "copy_to_message": {
3999
- "type": "boolean",
4000
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
4001
- "default": false
4002
- }
4577
+ "file": {
4578
+ "type": "object",
4579
+ "required": [
4580
+ "entity_id"
4581
+ ],
4582
+ "properties": {
4583
+ "entity_id": {
4584
+ "type": "string",
4585
+ "description": "File entity ID",
4586
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4587
+ },
4588
+ "filename": {
4589
+ "type": "string",
4590
+ "description": "File name",
4591
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4592
+ },
4593
+ "is_message_attachment": {
4594
+ "type": "boolean",
4595
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
4596
+ },
4597
+ "cid": {
4598
+ "type": "string",
4599
+ "description": "Content ID (for inline)",
4600
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
4601
+ },
4602
+ "inline": {
4603
+ "type": "boolean",
4604
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
4605
+ "default": false
4606
+ },
4607
+ "send_as_link": {
4608
+ "type": "boolean",
4609
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
4610
+ "default": false
4003
4611
  }
4004
4612
  }
4005
4613
  },
@@ -4024,6 +4632,17 @@
4024
4632
  ]
4025
4633
  }
4026
4634
  },
4635
+ "org_read_message": {
4636
+ "type": "array",
4637
+ "description": "Ivy Organization ID of organization read the message.",
4638
+ "items": {
4639
+ "type": "string",
4640
+ "example": [
4641
+ "789372",
4642
+ "210291"
4643
+ ]
4644
+ }
4645
+ },
4027
4646
  "send_status": {
4028
4647
  "type": "array",
4029
4648
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -4266,70 +4885,40 @@
4266
4885
  }
4267
4886
  }
4268
4887
  },
4269
- "attachments": {
4270
- "type": "array",
4271
- "description": "Message attachments",
4272
- "items": {
4273
- "type": "object",
4274
- "required": [
4275
- "filename",
4276
- "size",
4277
- "content_type",
4278
- "url",
4279
- "bucket",
4280
- "object_key"
4281
- ],
4282
- "properties": {
4283
- "cid": {
4284
- "type": "string",
4285
- "description": "Attachment ID",
4286
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4287
- },
4288
- "filename": {
4289
- "type": "string",
4290
- "description": "File name",
4291
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4292
- },
4293
- "size": {
4294
- "type": "number",
4295
- "description": "File size in bytes",
4296
- "example": 451349
4297
- },
4298
- "content_type": {
4299
- "type": "string",
4300
- "description": "Content type",
4301
- "example": "application/pdf"
4302
- },
4303
- "url": {
4304
- "type": "string",
4305
- "description": "URL to download the attachment.",
4306
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4307
- },
4308
- "bucket": {
4309
- "type": "string",
4310
- "description": "S3 bucket where file is stored",
4311
- "example": "893487340562-message-attachment"
4312
- },
4313
- "object_key": {
4314
- "type": "string",
4315
- "description": "S3 object apiKey",
4316
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4317
- },
4318
- "inline": {
4319
- "type": "boolean",
4320
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
4321
- "default": false
4322
- },
4323
- "send_as_link": {
4324
- "type": "boolean",
4325
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
4326
- "default": false
4327
- },
4328
- "copy_to_message": {
4329
- "type": "boolean",
4330
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
4331
- "default": false
4332
- }
4888
+ "file": {
4889
+ "type": "object",
4890
+ "required": [
4891
+ "entity_id"
4892
+ ],
4893
+ "properties": {
4894
+ "entity_id": {
4895
+ "type": "string",
4896
+ "description": "File entity ID",
4897
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4898
+ },
4899
+ "filename": {
4900
+ "type": "string",
4901
+ "description": "File name",
4902
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4903
+ },
4904
+ "is_message_attachment": {
4905
+ "type": "boolean",
4906
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
4907
+ },
4908
+ "cid": {
4909
+ "type": "string",
4910
+ "description": "Content ID (for inline)",
4911
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
4912
+ },
4913
+ "inline": {
4914
+ "type": "boolean",
4915
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
4916
+ "default": false
4917
+ },
4918
+ "send_as_link": {
4919
+ "type": "boolean",
4920
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
4921
+ "default": false
4333
4922
  }
4334
4923
  }
4335
4924
  },
@@ -4354,6 +4943,17 @@
4354
4943
  ]
4355
4944
  }
4356
4945
  },
4946
+ "org_read_message": {
4947
+ "type": "array",
4948
+ "description": "Ivy Organization ID of organization read the message.",
4949
+ "items": {
4950
+ "type": "string",
4951
+ "example": [
4952
+ "789372",
4953
+ "210291"
4954
+ ]
4955
+ }
4956
+ },
4357
4957
  "send_status": {
4358
4958
  "type": "array",
4359
4959
  "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`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
@@ -4413,20 +5013,62 @@
4413
5013
  }
4414
5014
  }
4415
5015
  },
4416
- "Attachment": {
5016
+ "AttachmentsRelation": {
5017
+ "type": "object",
5018
+ "description": "Message attachments",
5019
+ "properties": {
5020
+ "$relation": {
5021
+ "type": "array",
5022
+ "description": "It's normal entity relation with some additional properties for sending message attachment.",
5023
+ "items": {
5024
+ "type": "object",
5025
+ "required": [
5026
+ "entity_id"
5027
+ ],
5028
+ "properties": {
5029
+ "entity_id": {
5030
+ "type": "string",
5031
+ "description": "File entity ID",
5032
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
5033
+ },
5034
+ "filename": {
5035
+ "type": "string",
5036
+ "description": "File name",
5037
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
5038
+ },
5039
+ "is_message_attachment": {
5040
+ "type": "boolean",
5041
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
5042
+ },
5043
+ "cid": {
5044
+ "type": "string",
5045
+ "description": "Content ID (for inline)",
5046
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
5047
+ },
5048
+ "inline": {
5049
+ "type": "boolean",
5050
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
5051
+ "default": false
5052
+ },
5053
+ "send_as_link": {
5054
+ "type": "boolean",
5055
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
5056
+ "default": false
5057
+ }
5058
+ }
5059
+ }
5060
+ }
5061
+ }
5062
+ },
5063
+ "File": {
4417
5064
  "type": "object",
4418
5065
  "required": [
4419
- "filename",
4420
- "size",
4421
- "content_type",
4422
- "url",
4423
- "bucket",
4424
- "object_key"
5066
+ "entity_id"
4425
5067
  ],
4426
5068
  "properties": {
4427
- "cid": {
5069
+ "entity_id": {
4428
5070
  "type": "string",
4429
- "description": "Attachment ID",
5071
+ "description": "File entity ID",
4430
5072
  "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4431
5073
  },
4432
5074
  "filename": {
@@ -4434,30 +5076,14 @@
4434
5076
  "description": "File name",
4435
5077
  "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4436
5078
  },
4437
- "size": {
4438
- "type": "number",
4439
- "description": "File size in bytes",
4440
- "example": 451349
4441
- },
4442
- "content_type": {
4443
- "type": "string",
4444
- "description": "Content type",
4445
- "example": "application/pdf"
4446
- },
4447
- "url": {
4448
- "type": "string",
4449
- "description": "URL to download the attachment.",
4450
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4451
- },
4452
- "bucket": {
4453
- "type": "string",
4454
- "description": "S3 bucket where file is stored",
4455
- "example": "893487340562-message-attachment"
5079
+ "is_message_attachment": {
5080
+ "type": "boolean",
5081
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
4456
5082
  },
4457
- "object_key": {
5083
+ "cid": {
4458
5084
  "type": "string",
4459
- "description": "S3 object apiKey",
4460
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
5085
+ "description": "Content ID (for inline)",
5086
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
4461
5087
  },
4462
5088
  "inline": {
4463
5089
  "type": "boolean",
@@ -4466,12 +5092,7 @@
4466
5092
  },
4467
5093
  "send_as_link": {
4468
5094
  "type": "boolean",
4469
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
4470
- "default": false
4471
- },
4472
- "copy_to_message": {
4473
- "type": "boolean",
4474
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
5095
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
4475
5096
  "default": false
4476
5097
  }
4477
5098
  }
@@ -4712,70 +5333,40 @@
4712
5333
  }
4713
5334
  }
4714
5335
  },
4715
- "attachments": {
4716
- "type": "array",
4717
- "description": "Message attachments",
4718
- "items": {
4719
- "type": "object",
4720
- "required": [
4721
- "filename",
4722
- "size",
4723
- "content_type",
4724
- "url",
4725
- "bucket",
4726
- "object_key"
4727
- ],
4728
- "properties": {
4729
- "cid": {
4730
- "type": "string",
4731
- "description": "Attachment ID",
4732
- "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
4733
- },
4734
- "filename": {
4735
- "type": "string",
4736
- "description": "File name",
4737
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4738
- },
4739
- "size": {
4740
- "type": "number",
4741
- "description": "File size in bytes",
4742
- "example": 451349
4743
- },
4744
- "content_type": {
4745
- "type": "string",
4746
- "description": "Content type",
4747
- "example": "application/pdf"
4748
- },
4749
- "url": {
4750
- "type": "string",
4751
- "description": "URL to download the attachment.",
4752
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4753
- },
4754
- "bucket": {
4755
- "type": "string",
4756
- "description": "S3 bucket where file is stored",
4757
- "example": "893487340562-message-attachment"
4758
- },
4759
- "object_key": {
4760
- "type": "string",
4761
- "description": "S3 object apiKey",
4762
- "example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4763
- },
4764
- "inline": {
4765
- "type": "boolean",
4766
- "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
4767
- "default": false
4768
- },
4769
- "send_as_link": {
4770
- "type": "boolean",
4771
- "description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
4772
- "default": false
4773
- },
4774
- "copy_to_message": {
4775
- "type": "boolean",
4776
- "description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
4777
- "default": false
4778
- }
5336
+ "file": {
5337
+ "type": "object",
5338
+ "required": [
5339
+ "entity_id"
5340
+ ],
5341
+ "properties": {
5342
+ "entity_id": {
5343
+ "type": "string",
5344
+ "description": "File entity ID",
5345
+ "example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
5346
+ },
5347
+ "filename": {
5348
+ "type": "string",
5349
+ "description": "File name",
5350
+ "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
5351
+ },
5352
+ "is_message_attachment": {
5353
+ "type": "boolean",
5354
+ "description": "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
5355
+ },
5356
+ "cid": {
5357
+ "type": "string",
5358
+ "description": "Content ID (for inline)",
5359
+ "example": "fb222496-a1a5-4639-94f2-07b5e35e4068"
5360
+ },
5361
+ "inline": {
5362
+ "type": "boolean",
5363
+ "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
5364
+ "default": false
5365
+ },
5366
+ "send_as_link": {
5367
+ "type": "boolean",
5368
+ "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n",
5369
+ "default": false
4779
5370
  }
4780
5371
  }
4781
5372
  }
@@ -4803,58 +5394,6 @@
4803
5394
  "default": 10
4804
5395
  }
4805
5396
  }
4806
- },
4807
- "CreateAttachmentUploadUrlParams": {
4808
- "type": "object",
4809
- "required": [
4810
- "filename",
4811
- "content_type"
4812
- ],
4813
- "properties": {
4814
- "filename": {
4815
- "type": "string",
4816
- "description": "File name",
4817
- "example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
4818
- },
4819
- "content_type": {
4820
- "type": "string",
4821
- "description": "Content type",
4822
- "example": "application/pdf"
4823
- }
4824
- }
4825
- },
4826
- "AttachmentUploadUrl": {
4827
- "type": "object",
4828
- "required": [
4829
- "download_url",
4830
- "upload_url"
4831
- ],
4832
- "properties": {
4833
- "download_url": {
4834
- "type": "string",
4835
- "description": "URL to download the attachment. This URL is not accessible until attachment is uploaded successfully.",
4836
- "example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
4837
- },
4838
- "upload_url": {
4839
- "type": "object",
4840
- "required": [
4841
- "url",
4842
- "fields"
4843
- ],
4844
- "properties": {
4845
- "url": {
4846
- "type": "number",
4847
- "description": "URL to upload the attachment",
4848
- "example": "https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment"
4849
- },
4850
- "fields": {
4851
- "type": "object",
4852
- "description": "Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request.",
4853
- "example": {}
4854
- }
4855
- }
4856
- }
4857
- }
4858
5397
  }
4859
5398
  }
4860
5399
  }