@twilio/conversations 2.0.1 → 2.1.0-rc.6

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 (86) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/NOTICE.txt +679 -0
  3. package/builds/browser.js +889 -619
  4. package/builds/browser.js.map +1 -1
  5. package/builds/lib.d.ts +384 -129
  6. package/builds/lib.js +889 -619
  7. package/builds/lib.js.map +1 -1
  8. package/builds/twilio-conversations.js +1065 -939
  9. package/builds/twilio-conversations.min.js +2 -14
  10. package/dist/aggregated-delivery-receipt.js +6 -1
  11. package/dist/aggregated-delivery-receipt.js.map +1 -1
  12. package/dist/client.js +165 -142
  13. package/dist/client.js.map +1 -1
  14. package/dist/command-executor.js +16 -14
  15. package/dist/command-executor.js.map +1 -1
  16. package/dist/configuration.js +14 -10
  17. package/dist/configuration.js.map +1 -1
  18. package/dist/conversation.js +232 -159
  19. package/dist/conversation.js.map +1 -1
  20. package/dist/data/conversations.js +82 -78
  21. package/dist/data/conversations.js.map +1 -1
  22. package/dist/data/messages.js +43 -39
  23. package/dist/data/messages.js.map +1 -1
  24. package/dist/data/participants.js +100 -78
  25. package/dist/data/participants.js.map +1 -1
  26. package/dist/data/users.js +24 -22
  27. package/dist/data/users.js.map +1 -1
  28. package/dist/detailed-delivery-receipt.js +1 -1
  29. package/dist/detailed-delivery-receipt.js.map +1 -1
  30. package/dist/interfaces/attributes.js +147 -0
  31. package/dist/interfaces/attributes.js.map +1 -0
  32. package/dist/interfaces/notification-types.js +5 -5
  33. package/dist/interfaces/notification-types.js.map +1 -1
  34. package/dist/logger.js +36 -15
  35. package/dist/logger.js.map +1 -1
  36. package/dist/media.js +21 -9
  37. package/dist/media.js.map +1 -1
  38. package/dist/message-builder.js +56 -3
  39. package/dist/message-builder.js.map +1 -1
  40. package/dist/message.js +157 -78
  41. package/dist/message.js.map +1 -1
  42. package/dist/packages/conversations/package.json.js +1 -1
  43. package/dist/participant.js +101 -50
  44. package/dist/participant.js.map +1 -1
  45. package/dist/push-notification.js.map +1 -1
  46. package/dist/rest-paginator.js +16 -6
  47. package/dist/rest-paginator.js.map +1 -1
  48. package/dist/services/network.js +18 -14
  49. package/dist/services/network.js.map +1 -1
  50. package/dist/services/typing-indicator.js +20 -17
  51. package/dist/services/typing-indicator.js.map +1 -1
  52. package/dist/unsent-message.js.map +1 -1
  53. package/dist/user.js +87 -60
  54. package/dist/user.js.map +1 -1
  55. package/dist/util/deferred.js +3 -1
  56. package/dist/util/deferred.js.map +1 -1
  57. package/dist/util/index.js +6 -6
  58. package/dist/util/index.js.map +1 -1
  59. package/docs/assets/js/search.js +1 -1
  60. package/docs/classes/AggregatedDeliveryReceipt.html +0 -102
  61. package/docs/classes/Client.html +24 -132
  62. package/docs/classes/Conversation.html +37 -132
  63. package/docs/classes/DetailedDeliveryReceipt.html +1 -103
  64. package/docs/classes/Media.html +0 -102
  65. package/docs/classes/Message.html +73 -109
  66. package/docs/classes/MessageBuilder.html +78 -104
  67. package/docs/classes/Participant.html +37 -110
  68. package/docs/classes/PushNotification.html +0 -102
  69. package/docs/classes/RestPaginator.html +0 -102
  70. package/docs/classes/UnsentMessage.html +0 -102
  71. package/docs/classes/User.html +7 -109
  72. package/docs/index.html +93 -3
  73. package/docs/interfaces/ClientOptions.html +0 -102
  74. package/docs/interfaces/ConversationBindings.html +3001 -0
  75. package/docs/interfaces/ConversationEmailBinding.html +3001 -0
  76. package/docs/interfaces/ConversationState.html +0 -102
  77. package/docs/interfaces/CreateConversationOptions.html +1 -103
  78. package/docs/interfaces/LastMessage.html +0 -102
  79. package/docs/interfaces/Paginator.html +0 -102
  80. package/docs/interfaces/ParticipantBindings.html +3001 -0
  81. package/docs/interfaces/ParticipantEmailBinding.html +3001 -0
  82. package/docs/interfaces/PushNotificationData.html +0 -102
  83. package/docs/interfaces/SendEmailOptions.html +0 -102
  84. package/docs/interfaces/SendMediaOptions.html +0 -102
  85. package/docs/modules.html +93 -3
  86. package/package.json +23 -17
package/docs/classes/Media.html CHANGED
@@ -2702,18 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-class">
2706
- <a href="AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2707
- </li>
2708
- <li class=" tsd-kind-class">
2709
- <a href="Client.html" class="tsd-kind-icon">Client</a>
2710
- </li>
2711
- <li class=" tsd-kind-class">
2712
- <a href="Conversation.html" class="tsd-kind-icon">Conversation</a>
2713
- </li>
2714
- <li class=" tsd-kind-class">
2715
- <a href="DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a>
2716
- </li>
2717
2705
  <li class="current tsd-kind-class">
2718
2706
  <a href="Media.html" class="tsd-kind-icon">Media</a>
2719
2707
  <ul>
@@ -2740,96 +2728,6 @@ img {
2740
2728
  </li>
2741
2729
  </ul>
2742
2730
  </li>
2743
- <li class=" tsd-kind-class">
2744
- <a href="Message.html" class="tsd-kind-icon">Message</a>
2745
- </li>
2746
- <li class=" tsd-kind-class">
2747
- <a href="MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2748
- </li>
2749
- <li class=" tsd-kind-class">
2750
- <a href="Participant.html" class="tsd-kind-icon">Participant</a>
2751
- </li>
2752
- <li class=" tsd-kind-class">
2753
- <a href="PushNotification.html" class="tsd-kind-icon">Push<wbr>Notification</a>
2754
- </li>
2755
- <li class=" tsd-kind-class tsd-has-type-parameter">
2756
- <a href="RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2757
- </li>
2758
- <li class=" tsd-kind-class">
2759
- <a href="UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2760
- </li>
2761
- <li class=" tsd-kind-class">
2762
- <a href="User.html" class="tsd-kind-icon">User</a>
2763
- </li>
2764
- <li class=" tsd-kind-interface">
2765
- <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2766
- </li>
2767
- <li class=" tsd-kind-interface">
2768
- <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2769
- </li>
2770
- <li class=" tsd-kind-interface">
2771
- <a href="../interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
2772
- </li>
2773
- <li class=" tsd-kind-interface">
2774
- <a href="../interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2775
- </li>
2776
- <li class=" tsd-kind-interface tsd-has-type-parameter">
2777
- <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2778
- </li>
2779
- <li class=" tsd-kind-interface">
2780
- <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2781
- </li>
2782
- <li class=" tsd-kind-interface">
2783
- <a href="../interfaces/SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2784
- </li>
2785
- <li class=" tsd-kind-interface">
2786
- <a href="../interfaces/SendMediaOptions.html" class="tsd-kind-icon">Send<wbr>Media<wbr>Options</a>
2787
- </li>
2788
- <li class=" tsd-kind-type-alias">
2789
- <a href="../modules.html#ConnectionState" class="tsd-kind-icon">Connection<wbr>State</a>
2790
- </li>
2791
- <li class=" tsd-kind-type-alias">
2792
- <a href="../modules.html#ConversationStatus" class="tsd-kind-icon">Conversation<wbr>Status</a>
2793
- </li>
2794
- <li class=" tsd-kind-type-alias">
2795
- <a href="../modules.html#ConversationUpdateReason" class="tsd-kind-icon">Conversation<wbr>Update<wbr>Reason</a>
2796
- </li>
2797
- <li class=" tsd-kind-type-alias">
2798
- <a href="../modules.html#DeliveryAmount" class="tsd-kind-icon">Delivery<wbr>Amount</a>
2799
- </li>
2800
- <li class=" tsd-kind-type-alias">
2801
- <a href="../modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2802
- </li>
2803
- <li class=" tsd-kind-type-alias">
2804
- <a href="../modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2805
- </li>
2806
- <li class=" tsd-kind-type-alias">
2807
- <a href="../modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2808
- </li>
2809
- <li class=" tsd-kind-type-alias">
2810
- <a href="../modules.html#MessageUpdateReason" class="tsd-kind-icon">Message<wbr>Update<wbr>Reason</a>
2811
- </li>
2812
- <li class=" tsd-kind-type-alias">
2813
- <a href="../modules.html#NotificationLevel" class="tsd-kind-icon">Notification<wbr>Level</a>
2814
- </li>
2815
- <li class=" tsd-kind-type-alias">
2816
- <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2817
- </li>
2818
- <li class=" tsd-kind-type-alias">
2819
- <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2820
- </li>
2821
- <li class=" tsd-kind-type-alias">
2822
- <a href="../modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a>
2823
- </li>
2824
- <li class=" tsd-kind-type-alias">
2825
- <a href="../modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2826
- </li>
2827
- <li class=" tsd-kind-type-alias">
2828
- <a href="../modules.html#State" class="tsd-kind-icon">State</a>
2829
- </li>
2830
- <li class=" tsd-kind-type-alias">
2831
- <a href="../modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2832
- </li>
2833
2731
  </ul>
2834
2732
  </nav>
2835
2733
  <div class="container container-main">
package/docs/classes/Message.html CHANGED
@@ -2702,21 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-class">
2706
- <a href="AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2707
- </li>
2708
- <li class=" tsd-kind-class">
2709
- <a href="Client.html" class="tsd-kind-icon">Client</a>
2710
- </li>
2711
- <li class=" tsd-kind-class">
2712
- <a href="Conversation.html" class="tsd-kind-icon">Conversation</a>
2713
- </li>
2714
- <li class=" tsd-kind-class">
2715
- <a href="DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a>
2716
- </li>
2717
- <li class=" tsd-kind-class">
2718
- <a href="Media.html" class="tsd-kind-icon">Media</a>
2719
- </li>
2720
2705
  <li class="current tsd-kind-class">
2721
2706
  <a href="Message.html" class="tsd-kind-icon">Message</a>
2722
2707
  <ul>
@@ -2774,6 +2759,12 @@ img {
2774
2759
  <li class=" tsd-kind-method tsd-parent-kind-class">
2775
2760
  <a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a>
2776
2761
  </li>
2762
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2763
+ <a href="Message.html#getEmailBody" class="tsd-kind-icon">get<wbr>Email<wbr>Body</a>
2764
+ </li>
2765
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2766
+ <a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a>
2767
+ </li>
2777
2768
  <li class=" tsd-kind-method tsd-parent-kind-class">
2778
2769
  <a href="Message.html#getMediaByCategory" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategory</a>
2779
2770
  </li>
@@ -2791,93 +2782,6 @@ img {
2791
2782
  </li>
2792
2783
  </ul>
2793
2784
  </li>
2794
- <li class=" tsd-kind-class">
2795
- <a href="MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2796
- </li>
2797
- <li class=" tsd-kind-class">
2798
- <a href="Participant.html" class="tsd-kind-icon">Participant</a>
2799
- </li>
2800
- <li class=" tsd-kind-class">
2801
- <a href="PushNotification.html" class="tsd-kind-icon">Push<wbr>Notification</a>
2802
- </li>
2803
- <li class=" tsd-kind-class tsd-has-type-parameter">
2804
- <a href="RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2805
- </li>
2806
- <li class=" tsd-kind-class">
2807
- <a href="UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2808
- </li>
2809
- <li class=" tsd-kind-class">
2810
- <a href="User.html" class="tsd-kind-icon">User</a>
2811
- </li>
2812
- <li class=" tsd-kind-interface">
2813
- <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2814
- </li>
2815
- <li class=" tsd-kind-interface">
2816
- <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2817
- </li>
2818
- <li class=" tsd-kind-interface">
2819
- <a href="../interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
2820
- </li>
2821
- <li class=" tsd-kind-interface">
2822
- <a href="../interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2823
- </li>
2824
- <li class=" tsd-kind-interface tsd-has-type-parameter">
2825
- <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2826
- </li>
2827
- <li class=" tsd-kind-interface">
2828
- <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2829
- </li>
2830
- <li class=" tsd-kind-interface">
2831
- <a href="../interfaces/SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2832
- </li>
2833
- <li class=" tsd-kind-interface">
2834
- <a href="../interfaces/SendMediaOptions.html" class="tsd-kind-icon">Send<wbr>Media<wbr>Options</a>
2835
- </li>
2836
- <li class=" tsd-kind-type-alias">
2837
- <a href="../modules.html#ConnectionState" class="tsd-kind-icon">Connection<wbr>State</a>
2838
- </li>
2839
- <li class=" tsd-kind-type-alias">
2840
- <a href="../modules.html#ConversationStatus" class="tsd-kind-icon">Conversation<wbr>Status</a>
2841
- </li>
2842
- <li class=" tsd-kind-type-alias">
2843
- <a href="../modules.html#ConversationUpdateReason" class="tsd-kind-icon">Conversation<wbr>Update<wbr>Reason</a>
2844
- </li>
2845
- <li class=" tsd-kind-type-alias">
2846
- <a href="../modules.html#DeliveryAmount" class="tsd-kind-icon">Delivery<wbr>Amount</a>
2847
- </li>
2848
- <li class=" tsd-kind-type-alias">
2849
- <a href="../modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2850
- </li>
2851
- <li class=" tsd-kind-type-alias">
2852
- <a href="../modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2853
- </li>
2854
- <li class=" tsd-kind-type-alias">
2855
- <a href="../modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2856
- </li>
2857
- <li class=" tsd-kind-type-alias">
2858
- <a href="../modules.html#MessageUpdateReason" class="tsd-kind-icon">Message<wbr>Update<wbr>Reason</a>
2859
- </li>
2860
- <li class=" tsd-kind-type-alias">
2861
- <a href="../modules.html#NotificationLevel" class="tsd-kind-icon">Notification<wbr>Level</a>
2862
- </li>
2863
- <li class=" tsd-kind-type-alias">
2864
- <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2865
- </li>
2866
- <li class=" tsd-kind-type-alias">
2867
- <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2868
- </li>
2869
- <li class=" tsd-kind-type-alias">
2870
- <a href="../modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a>
2871
- </li>
2872
- <li class=" tsd-kind-type-alias">
2873
- <a href="../modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2874
- </li>
2875
- <li class=" tsd-kind-type-alias">
2876
- <a href="../modules.html#State" class="tsd-kind-icon">State</a>
2877
- </li>
2878
- <li class=" tsd-kind-type-alias">
2879
- <a href="../modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2880
- </li>
2881
2785
  </ul>
2882
2786
  </nav>
2883
2787
  <div class="container container-main">
@@ -2937,6 +2841,8 @@ img {
2937
2841
  <ul class="tsd-index-list">
2938
2842
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#attachTemporaryUrlsFor" class="tsd-kind-icon">attach<wbr>Temporary<wbr>Urls<wbr>For</a></li>
2939
2843
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a></li>
2844
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailBody" class="tsd-kind-icon">get<wbr>Email<wbr>Body</a></li>
2845
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a></li>
2940
2846
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getMediaByCategory" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategory</a></li>
2941
2847
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a></li>
2942
2848
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#remove" class="tsd-kind-icon">remove</a></li>
@@ -2964,7 +2870,7 @@ img {
2964
2870
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
2965
2871
  <a name="updated" class="tsd-anchor"></a>
2966
2872
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> updated</h3>
2967
- <div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;updated&quot;</span><span class="tsd-signature-symbol"> = &#x27;updated&#x27;</span></div>
2873
+ <div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;updated&quot;</span><span class="tsd-signature-symbol"> = &quot;updated&quot;</span></div>
2968
2874
  <aside class="tsd-sources">
2969
2875
  </aside>
2970
2876
  <div class="tsd-comment tsd-typography">
@@ -3026,7 +2932,7 @@ img {
3026
2932
  <a name="attributes" class="tsd-anchor"></a>
3027
2933
  <h3>attributes</h3>
3028
2934
  <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
3029
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span></li>
2935
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a></li>
3030
2936
  </ul>
3031
2937
  <ul class="tsd-descriptions">
3032
2938
  <li class="tsd-description">
@@ -3037,7 +2943,7 @@ img {
3037
2943
  <p>Custom attributes of the message.</p>
3038
2944
  </div>
3039
2945
  </div>
3040
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Object</span></h4>
2946
+ <h4 class="tsd-returns-title">Returns <a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a></h4>
3041
2947
  </li>
3042
2948
  </ul>
3043
2949
  </section>
@@ -3173,7 +3079,7 @@ img {
3173
3079
  </aside>
3174
3080
  <div class="tsd-comment tsd-typography">
3175
3081
  <div class="lead">
3176
- <p>One of the attached media.</p>
3082
+ <p>One of the attached media (if present).</p>
3177
3083
  </div>
3178
3084
  <dl class="tsd-comment-tags">
3179
3085
  <dt>deprecated</dt>
@@ -3254,7 +3160,7 @@ img {
3254
3160
  </aside>
3255
3161
  <div class="tsd-comment tsd-typography">
3256
3162
  <div class="lead">
3257
- <p>Push notification type of the message.</p>
3163
+ <p>Type of the message.</p>
3258
3164
  </div>
3259
3165
  </div>
3260
3166
  <h4 class="tsd-returns-title">Returns <a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a></h4>
@@ -3311,6 +3217,64 @@ img {
3311
3217
  </li>
3312
3218
  </ul>
3313
3219
  </section>
3220
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3221
+ <a name="getEmailBody" class="tsd-anchor"></a>
3222
+ <h3>get<wbr>Email<wbr>Body</h3>
3223
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3224
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Email<wbr>Body<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></li>
3225
+ </ul>
3226
+ <ul class="tsd-descriptions">
3227
+ <li class="tsd-description">
3228
+ <aside class="tsd-sources">
3229
+ </aside>
3230
+ <div class="tsd-comment tsd-typography">
3231
+ <div class="lead">
3232
+ <p>Get a media descriptor for an email body attachment of a provided type.
3233
+ Allowed body types are returned in the Conversation.limits().emailBodiesAllowedMimeTypes array.</p>
3234
+ </div>
3235
+ </div>
3236
+ <h4 class="tsd-parameters-title">Parameters</h4>
3237
+ <ul class="tsd-parameters">
3238
+ <li>
3239
+ <h5>type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;text/plain&quot;</span></h5>
3240
+ <div class="tsd-comment tsd-typography">
3241
+ <p>Type of email body to request, defaults to <code>text/plain</code>.</p>
3242
+ </div>
3243
+ </li>
3244
+ </ul>
3245
+ <h4 class="tsd-returns-title">Returns <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></h4>
3246
+ </li>
3247
+ </ul>
3248
+ </section>
3249
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3250
+ <a name="getEmailHistory" class="tsd-anchor"></a>
3251
+ <h3>get<wbr>Email<wbr>History</h3>
3252
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3253
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Email<wbr>History<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></li>
3254
+ </ul>
3255
+ <ul class="tsd-descriptions">
3256
+ <li class="tsd-description">
3257
+ <aside class="tsd-sources">
3258
+ </aside>
3259
+ <div class="tsd-comment tsd-typography">
3260
+ <div class="lead">
3261
+ <p>Get a media descriptor for an email history attachment of a provided type.
3262
+ Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedMimeTypes array.</p>
3263
+ </div>
3264
+ </div>
3265
+ <h4 class="tsd-parameters-title">Parameters</h4>
3266
+ <ul class="tsd-parameters">
3267
+ <li>
3268
+ <h5>type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;text/plain&quot;</span></h5>
3269
+ <div class="tsd-comment tsd-typography">
3270
+ <p>Type of email history to request, defaults to <code>text/plain</code>.</p>
3271
+ </div>
3272
+ </li>
3273
+ </ul>
3274
+ <h4 class="tsd-returns-title">Returns <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></h4>
3275
+ </li>
3276
+ </ul>
3277
+ </section>
3314
3278
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3315
3279
  <a name="getMediaByCategory" class="tsd-anchor"></a>
3316
3280
  <h3>get<wbr>Media<wbr>ByCategory</h3>
@@ -3383,7 +3347,7 @@ img {
3383
3347
  <a name="updateAttributes" class="tsd-anchor"></a>
3384
3348
  <h3>update<wbr>Attributes</h3>
3385
3349
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3386
- <li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">&gt;</span></li>
3350
+ <li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">&gt;</span></li>
3387
3351
  </ul>
3388
3352
  <ul class="tsd-descriptions">
3389
3353
  <li class="tsd-description">
@@ -3397,7 +3361,7 @@ img {
3397
3361
  <h4 class="tsd-parameters-title">Parameters</h4>
3398
3362
  <ul class="tsd-parameters">
3399
3363
  <li>
3400
- <h5>attributes: <span class="tsd-signature-type">any</span></h5>
3364
+ <h5>attributes: <a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a></h5>
3401
3365
  <div class="tsd-comment tsd-typography">
3402
3366
  <p>New attributes.</p>
3403
3367
  </div>
package/docs/classes/MessageBuilder.html CHANGED
@@ -2702,24 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-class">
2706
- <a href="AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2707
- </li>
2708
- <li class=" tsd-kind-class">
2709
- <a href="Client.html" class="tsd-kind-icon">Client</a>
2710
- </li>
2711
- <li class=" tsd-kind-class">
2712
- <a href="Conversation.html" class="tsd-kind-icon">Conversation</a>
2713
- </li>
2714
- <li class=" tsd-kind-class">
2715
- <a href="DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a>
2716
- </li>
2717
- <li class=" tsd-kind-class">
2718
- <a href="Media.html" class="tsd-kind-icon">Media</a>
2719
- </li>
2720
- <li class=" tsd-kind-class">
2721
- <a href="Message.html" class="tsd-kind-icon">Message</a>
2722
- </li>
2723
2705
  <li class="current tsd-kind-class">
2724
2706
  <a href="MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2725
2707
  <ul>
@@ -2735,95 +2717,17 @@ img {
2735
2717
  <li class=" tsd-kind-method tsd-parent-kind-class">
2736
2718
  <a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a>
2737
2719
  </li>
2720
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2721
+ <a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a>
2722
+ </li>
2723
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2724
+ <a href="MessageBuilder.html#setEmailHistory" class="tsd-kind-icon">set<wbr>Email<wbr>History</a>
2725
+ </li>
2738
2726
  <li class=" tsd-kind-method tsd-parent-kind-class">
2739
2727
  <a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a>
2740
2728
  </li>
2741
2729
  </ul>
2742
2730
  </li>
2743
- <li class=" tsd-kind-class">
2744
- <a href="Participant.html" class="tsd-kind-icon">Participant</a>
2745
- </li>
2746
- <li class=" tsd-kind-class">
2747
- <a href="PushNotification.html" class="tsd-kind-icon">Push<wbr>Notification</a>
2748
- </li>
2749
- <li class=" tsd-kind-class tsd-has-type-parameter">
2750
- <a href="RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2751
- </li>
2752
- <li class=" tsd-kind-class">
2753
- <a href="UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2754
- </li>
2755
- <li class=" tsd-kind-class">
2756
- <a href="User.html" class="tsd-kind-icon">User</a>
2757
- </li>
2758
- <li class=" tsd-kind-interface">
2759
- <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2760
- </li>
2761
- <li class=" tsd-kind-interface">
2762
- <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2763
- </li>
2764
- <li class=" tsd-kind-interface">
2765
- <a href="../interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
2766
- </li>
2767
- <li class=" tsd-kind-interface">
2768
- <a href="../interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2769
- </li>
2770
- <li class=" tsd-kind-interface tsd-has-type-parameter">
2771
- <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2772
- </li>
2773
- <li class=" tsd-kind-interface">
2774
- <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2775
- </li>
2776
- <li class=" tsd-kind-interface">
2777
- <a href="../interfaces/SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2778
- </li>
2779
- <li class=" tsd-kind-interface">
2780
- <a href="../interfaces/SendMediaOptions.html" class="tsd-kind-icon">Send<wbr>Media<wbr>Options</a>
2781
- </li>
2782
- <li class=" tsd-kind-type-alias">
2783
- <a href="../modules.html#ConnectionState" class="tsd-kind-icon">Connection<wbr>State</a>
2784
- </li>
2785
- <li class=" tsd-kind-type-alias">
2786
- <a href="../modules.html#ConversationStatus" class="tsd-kind-icon">Conversation<wbr>Status</a>
2787
- </li>
2788
- <li class=" tsd-kind-type-alias">
2789
- <a href="../modules.html#ConversationUpdateReason" class="tsd-kind-icon">Conversation<wbr>Update<wbr>Reason</a>
2790
- </li>
2791
- <li class=" tsd-kind-type-alias">
2792
- <a href="../modules.html#DeliveryAmount" class="tsd-kind-icon">Delivery<wbr>Amount</a>
2793
- </li>
2794
- <li class=" tsd-kind-type-alias">
2795
- <a href="../modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2796
- </li>
2797
- <li class=" tsd-kind-type-alias">
2798
- <a href="../modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2799
- </li>
2800
- <li class=" tsd-kind-type-alias">
2801
- <a href="../modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2802
- </li>
2803
- <li class=" tsd-kind-type-alias">
2804
- <a href="../modules.html#MessageUpdateReason" class="tsd-kind-icon">Message<wbr>Update<wbr>Reason</a>
2805
- </li>
2806
- <li class=" tsd-kind-type-alias">
2807
- <a href="../modules.html#NotificationLevel" class="tsd-kind-icon">Notification<wbr>Level</a>
2808
- </li>
2809
- <li class=" tsd-kind-type-alias">
2810
- <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2811
- </li>
2812
- <li class=" tsd-kind-type-alias">
2813
- <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2814
- </li>
2815
- <li class=" tsd-kind-type-alias">
2816
- <a href="../modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a>
2817
- </li>
2818
- <li class=" tsd-kind-type-alias">
2819
- <a href="../modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2820
- </li>
2821
- <li class=" tsd-kind-type-alias">
2822
- <a href="../modules.html#State" class="tsd-kind-icon">State</a>
2823
- </li>
2824
- <li class=" tsd-kind-type-alias">
2825
- <a href="../modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2826
- </li>
2827
2731
  </ul>
2828
2732
  </nav>
2829
2733
  <div class="container container-main">
@@ -2863,6 +2767,8 @@ img {
2863
2767
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#build" class="tsd-kind-icon">build</a></li>
2864
2768
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
2865
2769
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
2770
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a></li>
2771
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setEmailHistory" class="tsd-kind-icon">set<wbr>Email<wbr>History</a></li>
2866
2772
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a></li>
2867
2773
  </ul>
2868
2774
  </section>
@@ -2922,7 +2828,7 @@ img {
2922
2828
  <a name="setAttributes" class="tsd-anchor"></a>
2923
2829
  <h3>set<wbr>Attributes</h3>
2924
2830
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2925
- <li class="tsd-signature tsd-kind-icon">set<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></li>
2831
+ <li class="tsd-signature tsd-kind-icon">set<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></li>
2926
2832
  </ul>
2927
2833
  <ul class="tsd-descriptions">
2928
2834
  <li class="tsd-description">
@@ -2936,7 +2842,7 @@ img {
2936
2842
  <h4 class="tsd-parameters-title">Parameters</h4>
2937
2843
  <ul class="tsd-parameters">
2938
2844
  <li>
2939
- <h5>attributes: <span class="tsd-signature-type">any</span></h5>
2845
+ <h5>attributes: <a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a></h5>
2940
2846
  <div class="tsd-comment tsd-typography">
2941
2847
  <p>Message attributes.</p>
2942
2848
  </div>
@@ -2974,6 +2880,74 @@ img {
2974
2880
  </li>
2975
2881
  </ul>
2976
2882
  </section>
2883
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2884
+ <a name="setEmailBody" class="tsd-anchor"></a>
2885
+ <h3>set<wbr>Email<wbr>Body</h3>
2886
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2887
+ <li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>Body<span class="tsd-signature-symbol">(</span>mimeType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></li>
2888
+ </ul>
2889
+ <ul class="tsd-descriptions">
2890
+ <li class="tsd-description">
2891
+ <aside class="tsd-sources">
2892
+ </aside>
2893
+ <div class="tsd-comment tsd-typography">
2894
+ <div class="lead">
2895
+ <p>Set email body with given MIME-type.</p>
2896
+ </div>
2897
+ </div>
2898
+ <h4 class="tsd-parameters-title">Parameters</h4>
2899
+ <ul class="tsd-parameters">
2900
+ <li>
2901
+ <h5>mimeType: <span class="tsd-signature-type">string</span></h5>
2902
+ <div class="tsd-comment tsd-typography">
2903
+ <p>Format of the body to set (text/plain or text/html).</p>
2904
+ </div>
2905
+ </li>
2906
+ <li>
2907
+ <h5>body: <span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a></h5>
2908
+ <div class="tsd-comment tsd-typography">
2909
+ <p>Body payload in selected format.</p>
2910
+ </div>
2911
+ </li>
2912
+ </ul>
2913
+ <h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
2914
+ </li>
2915
+ </ul>
2916
+ </section>
2917
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2918
+ <a name="setEmailHistory" class="tsd-anchor"></a>
2919
+ <h3>set<wbr>Email<wbr>History</h3>
2920
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2921
+ <li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>History<span class="tsd-signature-symbol">(</span>mimeType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, history<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></li>
2922
+ </ul>
2923
+ <ul class="tsd-descriptions">
2924
+ <li class="tsd-description">
2925
+ <aside class="tsd-sources">
2926
+ </aside>
2927
+ <div class="tsd-comment tsd-typography">
2928
+ <div class="lead">
2929
+ <p>Set email history with given MIME-type.</p>
2930
+ </div>
2931
+ </div>
2932
+ <h4 class="tsd-parameters-title">Parameters</h4>
2933
+ <ul class="tsd-parameters">
2934
+ <li>
2935
+ <h5>mimeType: <span class="tsd-signature-type">string</span></h5>
2936
+ <div class="tsd-comment tsd-typography">
2937
+ <p>Format of the history to set (text/plain or text/html).</p>
2938
+ </div>
2939
+ </li>
2940
+ <li>
2941
+ <h5>history: <span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a></h5>
2942
+ <div class="tsd-comment tsd-typography">
2943
+ <p>History payload in selected format.</p>
2944
+ </div>
2945
+ </li>
2946
+ </ul>
2947
+ <h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
2948
+ </li>
2949
+ </ul>
2950
+ </section>
2977
2951
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2978
2952
  <a name="setSubject" class="tsd-anchor"></a>
2979
2953
  <h3>set<wbr>Subject</h3>