@twilio/conversations 2.0.0-rc.1 → 2.0.1-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +25 -28
  2. package/dist/browser.js +3125 -3460
  3. package/dist/browser.js.map +1 -1
  4. package/dist/docs/assets/js/search.js +1 -1
  5. package/dist/docs/classes/AggregatedDeliveryReceipt.html +22 -6
  6. package/dist/docs/classes/Client.html +78 -33
  7. package/dist/docs/classes/Conversation.html +33 -17
  8. package/dist/docs/classes/DetailedDeliveryReceipt.html +22 -6
  9. package/dist/docs/classes/Media.html +23 -7
  10. package/dist/docs/classes/Message.html +23 -7
  11. package/dist/docs/classes/MessageBuilder.html +3280 -0
  12. package/dist/docs/classes/Participant.html +23 -7
  13. package/dist/docs/classes/PushNotification.html +24 -8
  14. package/dist/docs/classes/RestPaginator.html +28 -9
  15. package/dist/docs/classes/UnsentMessage.html +3144 -0
  16. package/dist/docs/classes/User.html +25 -9
  17. package/dist/docs/index.html +89 -47
  18. package/dist/docs/interfaces/ClientOptions.html +22 -6
  19. package/dist/docs/interfaces/ConversationState.html +22 -6
  20. package/dist/docs/interfaces/CreateConversationOptions.html +22 -6
  21. package/dist/docs/interfaces/LastMessage.html +22 -6
  22. package/dist/docs/interfaces/Paginator.html +3243 -0
  23. package/dist/docs/interfaces/PushNotificationData.html +3168 -0
  24. package/dist/docs/interfaces/SendEmailOptions.html +22 -6
  25. package/dist/docs/interfaces/SendMediaOptions.html +24 -7
  26. package/dist/docs/modules.html +88 -46
  27. package/dist/lib/aggregated-delivery-receipt.js +227 -0
  28. package/dist/lib/aggregated-delivery-receipt.js.map +1 -0
  29. package/dist/lib/client.js +872 -0
  30. package/dist/lib/client.js.map +1 -0
  31. package/dist/lib/command-executor.js +203 -0
  32. package/dist/lib/command-executor.js.map +1 -0
  33. package/dist/lib/configuration.js +196 -0
  34. package/dist/lib/configuration.js.map +1 -0
  35. package/dist/lib/conversation.js +973 -0
  36. package/dist/lib/conversation.js.map +1 -0
  37. package/dist/lib/data/conversations.js +443 -0
  38. package/dist/lib/data/conversations.js.map +1 -0
  39. package/dist/lib/data/messages.js +341 -0
  40. package/dist/lib/data/messages.js.map +1 -0
  41. package/dist/lib/data/participants.js +313 -0
  42. package/dist/lib/data/participants.js.map +1 -0
  43. package/dist/lib/data/users.js +228 -0
  44. package/dist/lib/data/users.js.map +1 -0
  45. package/dist/lib/detailed-delivery-receipt.js +154 -0
  46. package/dist/lib/detailed-delivery-receipt.js.map +1 -0
  47. package/dist/lib/index.js +167 -0
  48. package/dist/lib/index.js.map +1 -0
  49. package/dist/lib/interfaces/notification-types.js +143 -0
  50. package/dist/lib/interfaces/notification-types.js.map +1 -0
  51. package/dist/lib/logger.js +190 -0
  52. package/dist/lib/logger.js.map +1 -0
  53. package/dist/lib/media.js +213 -0
  54. package/dist/lib/media.js.map +1 -0
  55. package/dist/lib/message-builder.js +209 -0
  56. package/dist/lib/message-builder.js.map +1 -0
  57. package/dist/lib/message.js +450 -0
  58. package/dist/lib/message.js.map +1 -0
  59. package/dist/lib/node_modules/tslib/tslib.es6.js +161 -0
  60. package/dist/lib/node_modules/tslib/tslib.es6.js.map +1 -0
  61. package/dist/lib/packages/conversations/package.json.js +136 -0
  62. package/dist/lib/packages/conversations/package.json.js.map +1 -0
  63. package/dist/lib/participant.js +346 -0
  64. package/dist/lib/participant.js.map +1 -0
  65. package/dist/lib/push-notification.js +152 -0
  66. package/dist/lib/push-notification.js.map +1 -0
  67. package/dist/lib/rest-paginator.js +175 -0
  68. package/dist/lib/rest-paginator.js.map +1 -0
  69. package/dist/lib/services/network.js +205 -0
  70. package/dist/lib/services/network.js.map +1 -0
  71. package/dist/lib/services/typing-indicator.js +235 -0
  72. package/dist/lib/services/typing-indicator.js.map +1 -0
  73. package/dist/lib/unsent-message.js +159 -0
  74. package/dist/lib/unsent-message.js.map +1 -0
  75. package/dist/lib/user.js +392 -0
  76. package/dist/lib/user.js.map +1 -0
  77. package/dist/lib/util/deferred.js +154 -0
  78. package/dist/lib/util/deferred.js.map +1 -0
  79. package/dist/lib/util/index.js +206 -0
  80. package/dist/lib/util/index.js.map +1 -0
  81. package/dist/lib.d.ts +250 -59
  82. package/dist/lib.js +3055 -2919
  83. package/dist/lib.js.map +1 -1
  84. package/dist/twilio-conversations.js +25175 -23918
  85. package/dist/twilio-conversations.min.js +14 -2
  86. package/package.json +16 -14
  87. package/CHANGELOG.md +0 -168
  88. package/dist/post-install.js +0 -29
  89. package/dist/react-native.js +0 -4412
  90. package/dist/react-native.js.map +0 -1
package/dist/docs/interfaces/SendEmailOptions.html CHANGED
@@ -2702,9 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-reference">
2706
- <a href="../modules.html#default" class="tsd-kind-icon">default</a>
2707
- </li>
2708
2705
  <li class=" tsd-kind-class">
2709
2706
  <a href="../classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2710
2707
  </li>
@@ -2723,6 +2720,9 @@ img {
2723
2720
  <li class=" tsd-kind-class">
2724
2721
  <a href="../classes/Message.html" class="tsd-kind-icon">Message</a>
2725
2722
  </li>
2723
+ <li class=" tsd-kind-class">
2724
+ <a href="../classes/MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2725
+ </li>
2726
2726
  <li class=" tsd-kind-class">
2727
2727
  <a href="../classes/Participant.html" class="tsd-kind-icon">Participant</a>
2728
2728
  </li>
@@ -2732,6 +2732,9 @@ img {
2732
2732
  <li class=" tsd-kind-class tsd-has-type-parameter">
2733
2733
  <a href="../classes/RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2734
2734
  </li>
2735
+ <li class=" tsd-kind-class">
2736
+ <a href="../classes/UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2737
+ </li>
2735
2738
  <li class=" tsd-kind-class">
2736
2739
  <a href="../classes/User.html" class="tsd-kind-icon">User</a>
2737
2740
  </li>
@@ -2747,6 +2750,12 @@ img {
2747
2750
  <li class=" tsd-kind-interface">
2748
2751
  <a href="LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2749
2752
  </li>
2753
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
2754
+ <a href="Paginator.html" class="tsd-kind-icon">Paginator</a>
2755
+ </li>
2756
+ <li class=" tsd-kind-interface">
2757
+ <a href="PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2758
+ </li>
2750
2759
  <li class="current tsd-kind-interface">
2751
2760
  <a href="SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2752
2761
  <ul>
@@ -2773,6 +2782,9 @@ img {
2773
2782
  <li class=" tsd-kind-type-alias">
2774
2783
  <a href="../modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2775
2784
  </li>
2785
+ <li class=" tsd-kind-type-alias">
2786
+ <a href="../modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2787
+ </li>
2776
2788
  <li class=" tsd-kind-type-alias">
2777
2789
  <a href="../modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2778
2790
  </li>
@@ -2794,6 +2806,9 @@ img {
2794
2806
  <li class=" tsd-kind-type-alias">
2795
2807
  <a href="../modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2796
2808
  </li>
2809
+ <li class=" tsd-kind-type-alias">
2810
+ <a href="../modules.html#State" class="tsd-kind-icon">State</a>
2811
+ </li>
2797
2812
  <li class=" tsd-kind-type-alias">
2798
2813
  <a href="../modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2799
2814
  </li>
@@ -2855,11 +2870,12 @@ img {
2855
2870
  <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
2856
2871
  </ul>
2857
2872
  <ul class="tsd-legend">
2858
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
2859
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
2873
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
2874
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
2860
2875
  </ul>
2861
2876
  <ul class="tsd-legend">
2862
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
2877
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
2878
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
2863
2879
  </ul>
2864
2880
  </div>
2865
2881
  </div>
package/dist/docs/interfaces/SendMediaOptions.html CHANGED
@@ -2702,9 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-reference">
2706
- <a href="../modules.html#default" class="tsd-kind-icon">default</a>
2707
- </li>
2708
2705
  <li class=" tsd-kind-class">
2709
2706
  <a href="../classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2710
2707
  </li>
@@ -2723,6 +2720,9 @@ img {
2723
2720
  <li class=" tsd-kind-class">
2724
2721
  <a href="../classes/Message.html" class="tsd-kind-icon">Message</a>
2725
2722
  </li>
2723
+ <li class=" tsd-kind-class">
2724
+ <a href="../classes/MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2725
+ </li>
2726
2726
  <li class=" tsd-kind-class">
2727
2727
  <a href="../classes/Participant.html" class="tsd-kind-icon">Participant</a>
2728
2728
  </li>
@@ -2732,6 +2732,9 @@ img {
2732
2732
  <li class=" tsd-kind-class tsd-has-type-parameter">
2733
2733
  <a href="../classes/RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2734
2734
  </li>
2735
+ <li class=" tsd-kind-class">
2736
+ <a href="../classes/UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2737
+ </li>
2735
2738
  <li class=" tsd-kind-class">
2736
2739
  <a href="../classes/User.html" class="tsd-kind-icon">User</a>
2737
2740
  </li>
@@ -2747,6 +2750,12 @@ img {
2747
2750
  <li class=" tsd-kind-interface">
2748
2751
  <a href="LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2749
2752
  </li>
2753
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
2754
+ <a href="Paginator.html" class="tsd-kind-icon">Paginator</a>
2755
+ </li>
2756
+ <li class=" tsd-kind-interface">
2757
+ <a href="PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2758
+ </li>
2750
2759
  <li class=" tsd-kind-interface">
2751
2760
  <a href="SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2752
2761
  </li>
@@ -2779,6 +2788,9 @@ img {
2779
2788
  <li class=" tsd-kind-type-alias">
2780
2789
  <a href="../modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2781
2790
  </li>
2791
+ <li class=" tsd-kind-type-alias">
2792
+ <a href="../modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2793
+ </li>
2782
2794
  <li class=" tsd-kind-type-alias">
2783
2795
  <a href="../modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2784
2796
  </li>
@@ -2800,6 +2812,9 @@ img {
2800
2812
  <li class=" tsd-kind-type-alias">
2801
2813
  <a href="../modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2802
2814
  </li>
2815
+ <li class=" tsd-kind-type-alias">
2816
+ <a href="../modules.html#State" class="tsd-kind-icon">State</a>
2817
+ </li>
2803
2818
  <li class=" tsd-kind-type-alias">
2804
2819
  <a href="../modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2805
2820
  </li>
@@ -2811,7 +2826,8 @@ img {
2811
2826
  <div class="tsd-comment tsd-typography">
2812
2827
  <div class="lead">
2813
2828
  <p>Configuration for attaching a media file to a message.
2814
- These options can be passed to <a href="../classes/Conversation.html#sendMessage">Conversation.sendMessage</a>.</p>
2829
+ These options can be passed to <a href="../classes/Conversation.html#sendMessage">Conversation.sendMessage</a> and
2830
+ <a href="../classes/MessageBuilder.html#addMedia">MessageBuilder.addMedia</a>.</p>
2815
2831
  </div>
2816
2832
  </div>
2817
2833
  </section>
@@ -2888,11 +2904,12 @@ img {
2888
2904
  <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
2889
2905
  </ul>
2890
2906
  <ul class="tsd-legend">
2891
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
2892
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
2907
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
2908
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
2893
2909
  </ul>
2894
2910
  <ul class="tsd-legend">
2895
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
2911
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
2912
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
2896
2913
  </ul>
2897
2914
  </div>
2898
2915
  </div>
package/dist/docs/modules.html CHANGED
@@ -2702,9 +2702,6 @@ img {
2702
2702
  </header>
2703
2703
  <nav class="tsd-navigation secondary">
2704
2704
  <ul>
2705
- <li class=" tsd-kind-reference">
2706
- <a href="modules.html#default" class="tsd-kind-icon">default</a>
2707
- </li>
2708
2705
  <li class=" tsd-kind-class">
2709
2706
  <a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
2710
2707
  </li>
@@ -2723,6 +2720,9 @@ img {
2723
2720
  <li class=" tsd-kind-class">
2724
2721
  <a href="classes/Message.html" class="tsd-kind-icon">Message</a>
2725
2722
  </li>
2723
+ <li class=" tsd-kind-class">
2724
+ <a href="classes/MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a>
2725
+ </li>
2726
2726
  <li class=" tsd-kind-class">
2727
2727
  <a href="classes/Participant.html" class="tsd-kind-icon">Participant</a>
2728
2728
  </li>
@@ -2732,6 +2732,9 @@ img {
2732
2732
  <li class=" tsd-kind-class tsd-has-type-parameter">
2733
2733
  <a href="classes/RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a>
2734
2734
  </li>
2735
+ <li class=" tsd-kind-class">
2736
+ <a href="classes/UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a>
2737
+ </li>
2735
2738
  <li class=" tsd-kind-class">
2736
2739
  <a href="classes/User.html" class="tsd-kind-icon">User</a>
2737
2740
  </li>
@@ -2747,6 +2750,12 @@ img {
2747
2750
  <li class=" tsd-kind-interface">
2748
2751
  <a href="interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a>
2749
2752
  </li>
2753
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
2754
+ <a href="interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2755
+ </li>
2756
+ <li class=" tsd-kind-interface">
2757
+ <a href="interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2758
+ </li>
2750
2759
  <li class=" tsd-kind-interface">
2751
2760
  <a href="interfaces/SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a>
2752
2761
  </li>
@@ -2768,6 +2777,9 @@ img {
2768
2777
  <li class=" tsd-kind-type-alias">
2769
2778
  <a href="modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a>
2770
2779
  </li>
2780
+ <li class=" tsd-kind-type-alias">
2781
+ <a href="modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a>
2782
+ </li>
2771
2783
  <li class=" tsd-kind-type-alias">
2772
2784
  <a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a>
2773
2785
  </li>
@@ -2789,6 +2801,9 @@ img {
2789
2801
  <li class=" tsd-kind-type-alias">
2790
2802
  <a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
2791
2803
  </li>
2804
+ <li class=" tsd-kind-type-alias">
2805
+ <a href="modules.html#State" class="tsd-kind-icon">State</a>
2806
+ </li>
2792
2807
  <li class=" tsd-kind-type-alias">
2793
2808
  <a href="modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a>
2794
2809
  </li>
@@ -2805,43 +2820,44 @@ img {
2805
2820
  <a href="#instantiating-and-using" id="instantiating-and-using" style="color: inherit; text-decoration: none;">
2806
2821
  <h2>Instantiating and using</h2>
2807
2822
  </a>
2808
- <p>To use the library you need <a href="https://www.twilio.com/docs/conversations/create-tokens">to generate a token</a> and pass it to the conversations Client <code>create</code> factory.</p>
2823
+ <p>To use the library you need <a href="https://www.twilio.com/docs/conversations/create-tokens">to generate a token</a> and pass it to the Conversations Client constructor.</p>
2809
2824
  <a href="#npm" id="npm" style="color: inherit; text-decoration: none;">
2810
2825
  <h3>NPM</h3>
2811
2826
  </a>
2812
2827
  <pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> --</span><span style="color: #001080">save</span><span style="color: #000000"> @</span><span style="color: #001080">twilio</span><span style="color: #000000">/</span><span style="color: #001080">conversations</span>
2813
2828
  </code></pre>
2814
- <p>Using this method, you can <code>require</code> <code>twilio-conversations</code> and then use the client:</p>
2815
- <pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Conversations</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">);</span>
2816
- <span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #001080">Client</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">client</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2817
- <span style="color: #000000"> </span><span style="color: #008000">// Use client</span>
2818
- <span style="color: #000000">});</span>
2819
- </code></pre>
2820
- <p>Or, if you prefer <code>async</code>/<code>await</code> syntax:</p>
2821
- <pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">Conversations</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">);</span>
2822
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #001080">Client</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2823
- <span style="color: #008000">// Use client</span>
2829
+ <p>Using this method, you can <code>require</code> <code>twilio-conversations</code> and then use the
2830
+ client:</p>
2831
+ <pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">Client</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">);</span>
2832
+ <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2833
+ <span style="color: #008000">// Before you use the client, subscribe to the `&#039;stateChanged&#039;` event and wait </span>
2834
+ <span style="color: #008000">// for the `&#039;initialized&#039;` state to be reported.</span>
2835
+ <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;stateChanged&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">state</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2836
+ <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">) {</span>
2837
+ <span style="color: #000000"> </span><span style="color: #008000">// Use the client</span>
2838
+ <span style="color: #000000"> }</span>
2839
+ <span style="color: #000000">}</span>
2824
2840
  </code></pre>
2825
2841
  <p>The SDK could also be imported using the ES module syntax:</p>
2826
- <pre><code><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">Conversations</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">;</span>
2827
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #001080">Client</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2828
- <span style="color: #008000">// Use client</span>
2842
+ <pre><code><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@twilio/conversations&#039;</span><span style="color: #000000">;</span>
2843
+ <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2844
+ <span style="color: #008000">// Before you use the client, subscribe to the `&#039;stateChanged&#039;` event and wait </span>
2845
+ <span style="color: #008000">// for the `&#039;initialized&#039;` state to be reported.</span>
2846
+ <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;stateChanged&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">state</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2847
+ <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">&#039;initialized&#039;</span><span style="color: #000000">) {</span>
2848
+ <span style="color: #000000"> </span><span style="color: #008000">// Use the client</span>
2849
+ <span style="color: #000000"> }</span>
2850
+ <span style="color: #000000">}</span>
2829
2851
  </code></pre>
2830
2852
  <a href="#cdn" id="cdn" style="color: inherit; text-decoration: none;">
2831
2853
  <h3>CDN</h3>
2832
2854
  </a>
2833
2855
  <p>Releases of <code>twilio-conversations.js</code> are hosted on a CDN, and you can include these
2834
2856
  directly in your web app using a <code>&lt;script&gt;</code> tag.</p>
2835
- <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;https://media.twiliocdn.com/sdk/js/conversations/v1.2/twilio-conversations.min.js&quot;</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2836
- </code></pre>
2837
- <p>Using this method, <code>twilio-conversations.js</code> will set a browser global <code>Twilio.Conversations</code> through which you can use the client :</p>
2838
- <pre><code><span style="color: #001080">Twilio</span><span style="color: #000000">.</span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #001080">Client</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">client</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
2839
- <span style="color: #000000"> </span><span style="color: #008000">// Use client</span>
2840
- <span style="color: #000000">});</span>
2857
+ <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js&quot;</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2841
2858
  </code></pre>
2842
- <p>or, if you prefer <code>async</code>/<code>await</code> syntax:</p>
2843
- <pre><code><span style="color: #0000FF">let</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">Twilio</span><span style="color: #000000">.</span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #001080">Client</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2844
- <span style="color: #008000">// Use client</span>
2859
+ <p>Using this method, <code>twilio-conversations.js</code> will set a browser global <code>Twilio.Conversations</code> through which you can use the client:</p>
2860
+ <pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #001080">Twilio</span><span style="color: #000000">.</span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
2845
2861
  </code></pre>
2846
2862
  <a href="#security" id="security" style="color: inherit; text-decoration: none;">
2847
2863
  <h3>Security</h3>
@@ -2851,7 +2867,7 @@ img {
2851
2867
  <p>If you require more security you will have to consume SDK by using <a href="https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity">SRI</a> and using an exact version
2852
2868
  number. While less flexible it is significantly more secure, which is required by some applications.</p>
2853
2869
  <p>To consume securely use the following script snippet format:</p>
2854
- <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;https://media.twiliocdn.com/sdk/js/conversations/releases/1.2.0/twilio-conversations.min.js&quot;</span>
2870
+ <pre><code class="language-html"><span style="color: #800000">&lt;script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.1/twilio-conversations.min.js&quot;</span>
2855
2871
  <span style="color: #000000FF"> </span><span style="color: #FF0000">integrity</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;sha256-&lt;HASH FROM THE CHANGELOGS PAGE&gt;&quot;</span>
2856
2872
  <span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">&quot;anonymous&quot;</span><span style="color: #800000">&gt;&lt;/script&gt;</span>
2857
2873
  </code></pre>
@@ -2865,12 +2881,6 @@ img {
2865
2881
  <h2>Index</h2>
2866
2882
  <section class="tsd-panel tsd-index-panel">
2867
2883
  <div class="tsd-index-content">
2868
- <section class="tsd-index-section ">
2869
- <h3>References</h3>
2870
- <ul class="tsd-index-list">
2871
- <li class="tsd-kind-reference"><a href="modules.html#default" class="tsd-kind-icon">default</a></li>
2872
- </ul>
2873
- </section>
2874
2884
  <section class="tsd-index-section ">
2875
2885
  <h3>Classes</h3>
2876
2886
  <ul class="tsd-index-list">
@@ -2880,9 +2890,11 @@ img {
2880
2890
  <li class="tsd-kind-class"><a href="classes/DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a></li>
2881
2891
  <li class="tsd-kind-class"><a href="classes/Media.html" class="tsd-kind-icon">Media</a></li>
2882
2892
  <li class="tsd-kind-class"><a href="classes/Message.html" class="tsd-kind-icon">Message</a></li>
2893
+ <li class="tsd-kind-class"><a href="classes/MessageBuilder.html" class="tsd-kind-icon">Message<wbr>Builder</a></li>
2883
2894
  <li class="tsd-kind-class"><a href="classes/Participant.html" class="tsd-kind-icon">Participant</a></li>
2884
2895
  <li class="tsd-kind-class"><a href="classes/PushNotification.html" class="tsd-kind-icon">Push<wbr>Notification</a></li>
2885
2896
  <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/RestPaginator.html" class="tsd-kind-icon">Rest<wbr>Paginator</a></li>
2897
+ <li class="tsd-kind-class"><a href="classes/UnsentMessage.html" class="tsd-kind-icon">Unsent<wbr>Message</a></li>
2886
2898
  <li class="tsd-kind-class"><a href="classes/User.html" class="tsd-kind-icon">User</a></li>
2887
2899
  </ul>
2888
2900
  </section>
@@ -2893,6 +2905,8 @@ img {
2893
2905
  <li class="tsd-kind-interface"><a href="interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a></li>
2894
2906
  <li class="tsd-kind-interface"><a href="interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a></li>
2895
2907
  <li class="tsd-kind-interface"><a href="interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a></li>
2908
+ <li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a></li>
2909
+ <li class="tsd-kind-interface"><a href="interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a></li>
2896
2910
  <li class="tsd-kind-interface"><a href="interfaces/SendEmailOptions.html" class="tsd-kind-icon">Send<wbr>Email<wbr>Options</a></li>
2897
2911
  <li class="tsd-kind-interface"><a href="interfaces/SendMediaOptions.html" class="tsd-kind-icon">Send<wbr>Media<wbr>Options</a></li>
2898
2912
  </ul>
@@ -2905,6 +2919,7 @@ img {
2905
2919
  <li class="tsd-kind-type-alias"><a href="modules.html#ConversationUpdateReason" class="tsd-kind-icon">Conversation<wbr>Update<wbr>Reason</a></li>
2906
2920
  <li class="tsd-kind-type-alias"><a href="modules.html#DeliveryAmount" class="tsd-kind-icon">Delivery<wbr>Amount</a></li>
2907
2921
  <li class="tsd-kind-type-alias"><a href="modules.html#DeliveryStatus" class="tsd-kind-icon">Delivery<wbr>Status</a></li>
2922
+ <li class="tsd-kind-type-alias"><a href="modules.html#MediaCategory" class="tsd-kind-icon">Media<wbr>Category</a></li>
2908
2923
  <li class="tsd-kind-type-alias"><a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr>Type</a></li>
2909
2924
  <li class="tsd-kind-type-alias"><a href="modules.html#MessageUpdateReason" class="tsd-kind-icon">Message<wbr>Update<wbr>Reason</a></li>
2910
2925
  <li class="tsd-kind-type-alias"><a href="modules.html#NotificationLevel" class="tsd-kind-icon">Notification<wbr>Level</a></li>
@@ -2912,20 +2927,13 @@ img {
2912
2927
  <li class="tsd-kind-type-alias"><a href="modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a></li>
2913
2928
  <li class="tsd-kind-type-alias"><a href="modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a></li>
2914
2929
  <li class="tsd-kind-type-alias"><a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a></li>
2930
+ <li class="tsd-kind-type-alias"><a href="modules.html#State" class="tsd-kind-icon">State</a></li>
2915
2931
  <li class="tsd-kind-type-alias"><a href="modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a></li>
2916
2932
  </ul>
2917
2933
  </section>
2918
2934
  </div>
2919
2935
  </section>
2920
2936
  </section>
2921
- <section class="tsd-panel-group tsd-member-group ">
2922
- <h2>References</h2>
2923
- <section class="tsd-panel tsd-member tsd-kind-reference">
2924
- <a name="default" class="tsd-anchor"></a>
2925
- <h3>default</h3>
2926
- Renames and exports <a href="classes/Client.html">Client</a>
2927
- </section>
2928
- </section>
2929
2937
  <section class="tsd-panel-group tsd-member-group ">
2930
2938
  <h2>Type aliases</h2>
2931
2939
  <section class="tsd-panel tsd-member tsd-kind-type-alias">
@@ -2997,6 +3005,23 @@ img {
2997
3005
  </div>
2998
3006
  </div>
2999
3007
  </section>
3008
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
3009
+ <a name="MediaCategory" class="tsd-anchor"></a>
3010
+ <h3>Media<wbr>Category</h3>
3011
+ <div class="tsd-signature tsd-kind-icon">Media<wbr>Category<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">McsMediaCategory</span></div>
3012
+ <aside class="tsd-sources">
3013
+ </aside>
3014
+ <div class="tsd-comment tsd-typography">
3015
+ <div class="lead">
3016
+ <p>Category of media. Possible values are as follows:</p>
3017
+ <ul>
3018
+ <li><code>&#39;media&#39;</code></li>
3019
+ <li><code>&#39;body&#39;</code></li>
3020
+ <li><code>&#39;history&#39;</code></li>
3021
+ </ul>
3022
+ </div>
3023
+ </div>
3024
+ </section>
3000
3025
  <section class="tsd-panel tsd-member tsd-kind-type-alias">
3001
3026
  <a name="MessageType" class="tsd-anchor"></a>
3002
3027
  <h3>Message<wbr>Type</h3>
@@ -3005,7 +3030,7 @@ img {
3005
3030
  </aside>
3006
3031
  <div class="tsd-comment tsd-typography">
3007
3032
  <div class="lead">
3008
- <p>Push notification type of a message.</p>
3033
+ <p>Type of a message.</p>
3009
3034
  </div>
3010
3035
  </div>
3011
3036
  </section>
@@ -3060,7 +3085,7 @@ img {
3060
3085
  </aside>
3061
3086
  <div class="tsd-comment tsd-typography">
3062
3087
  <div class="lead">
3063
- <p>Push notification type of a participant.</p>
3088
+ <p>Type of a participant.</p>
3064
3089
  </div>
3065
3090
  </div>
3066
3091
  </section>
@@ -3088,6 +3113,22 @@ img {
3088
3113
  </div>
3089
3114
  </div>
3090
3115
  </section>
3116
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
3117
+ <a name="State" class="tsd-anchor"></a>
3118
+ <h3>State</h3>
3119
+ <div class="tsd-signature tsd-kind-icon">State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;failed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initialized&quot;</span></div>
3120
+ <aside class="tsd-sources">
3121
+ </aside>
3122
+ <div class="tsd-comment tsd-typography">
3123
+ <div class="lead">
3124
+ <p>State of the client. Possible values are as follows:</p>
3125
+ <ul>
3126
+ <li><code>&#39;failed&#39;</code> - the client failed to initialize</li>
3127
+ <li><code>&#39;initialized&#39;</code> - the client successfully initialized</li>
3128
+ </ul>
3129
+ </div>
3130
+ </div>
3131
+ </section>
3091
3132
  <section class="tsd-panel tsd-member tsd-kind-type-alias">
3092
3133
  <a name="UserUpdateReason" class="tsd-anchor"></a>
3093
3134
  <h3>User<wbr>Update<wbr>Reason</h3>
@@ -3112,11 +3153,12 @@ img {
3112
3153
  <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
3113
3154
  </ul>
3114
3155
  <ul class="tsd-legend">
3115
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
3116
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
3156
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
3157
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
3117
3158
  </ul>
3118
3159
  <ul class="tsd-legend">
3119
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
3160
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
3161
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
3120
3162
  </ul>
3121
3163
  </div>
3122
3164
  </div>