@twilio/conversations 2.0.1-rc.9 → 2.1.0-rc.5

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 (88) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/NOTICE.txt +679 -0
  3. package/builds/browser.js +892 -619
  4. package/builds/browser.js.map +1 -1
  5. package/builds/lib.d.ts +371 -124
  6. package/builds/lib.js +892 -619
  7. package/builds/lib.js.map +1 -1
  8. package/builds/twilio-conversations.js +1067 -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/index.js +1 -0
  31. package/dist/index.js.map +1 -1
  32. package/dist/interfaces/attributes.js +147 -0
  33. package/dist/interfaces/attributes.js.map +1 -0
  34. package/dist/interfaces/notification-types.js +5 -5
  35. package/dist/interfaces/notification-types.js.map +1 -1
  36. package/dist/logger.js +36 -15
  37. package/dist/logger.js.map +1 -1
  38. package/dist/media.js +21 -9
  39. package/dist/media.js.map +1 -1
  40. package/dist/message-builder.js +56 -3
  41. package/dist/message-builder.js.map +1 -1
  42. package/dist/message.js +158 -78
  43. package/dist/message.js.map +1 -1
  44. package/dist/packages/conversations/package.json.js +1 -1
  45. package/dist/participant.js +101 -50
  46. package/dist/participant.js.map +1 -1
  47. package/dist/push-notification.js.map +1 -1
  48. package/dist/rest-paginator.js +16 -6
  49. package/dist/rest-paginator.js.map +1 -1
  50. package/dist/services/network.js +18 -14
  51. package/dist/services/network.js.map +1 -1
  52. package/dist/services/typing-indicator.js +20 -17
  53. package/dist/services/typing-indicator.js.map +1 -1
  54. package/dist/unsent-message.js.map +1 -1
  55. package/dist/user.js +87 -60
  56. package/dist/user.js.map +1 -1
  57. package/dist/util/deferred.js +3 -1
  58. package/dist/util/deferred.js.map +1 -1
  59. package/dist/util/index.js +6 -6
  60. package/dist/util/index.js.map +1 -1
  61. package/docs/assets/js/search.js +1 -1
  62. package/docs/classes/AggregatedDeliveryReceipt.html +15 -0
  63. package/docs/classes/Client.html +39 -30
  64. package/docs/classes/Conversation.html +52 -30
  65. package/docs/classes/DetailedDeliveryReceipt.html +16 -1
  66. package/docs/classes/Media.html +15 -0
  67. package/docs/classes/Message.html +88 -7
  68. package/docs/classes/MessageBuilder.html +93 -2
  69. package/docs/classes/Participant.html +52 -8
  70. package/docs/classes/PushNotification.html +15 -0
  71. package/docs/classes/RestPaginator.html +15 -0
  72. package/docs/classes/UnsentMessage.html +15 -0
  73. package/docs/classes/User.html +22 -7
  74. package/docs/index.html +37 -3
  75. package/docs/interfaces/ClientOptions.html +15 -0
  76. package/docs/interfaces/ConversationBindings.html +3118 -0
  77. package/docs/interfaces/ConversationEmailBinding.html +3118 -0
  78. package/docs/interfaces/ConversationState.html +15 -0
  79. package/docs/interfaces/CreateConversationOptions.html +16 -1
  80. package/docs/interfaces/LastMessage.html +15 -0
  81. package/docs/interfaces/Paginator.html +15 -0
  82. package/docs/interfaces/ParticipantBindings.html +3118 -0
  83. package/docs/interfaces/ParticipantEmailBinding.html +3118 -0
  84. package/docs/interfaces/PushNotificationData.html +15 -0
  85. package/docs/interfaces/SendEmailOptions.html +15 -0
  86. package/docs/interfaces/SendMediaOptions.html +15 -0
  87. package/docs/modules.html +37 -3
  88. package/package.json +24 -18
package/docs/classes/MessageBuilder.html CHANGED
@@ -2735,6 +2735,12 @@ img {
2735
2735
  <li class=" tsd-kind-method tsd-parent-kind-class">
2736
2736
  <a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a>
2737
2737
  </li>
2738
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2739
+ <a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a>
2740
+ </li>
2741
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2742
+ <a href="MessageBuilder.html#setEmailHistory" class="tsd-kind-icon">set<wbr>Email<wbr>History</a>
2743
+ </li>
2738
2744
  <li class=" tsd-kind-method tsd-parent-kind-class">
2739
2745
  <a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a>
2740
2746
  </li>
@@ -2758,6 +2764,12 @@ img {
2758
2764
  <li class=" tsd-kind-interface">
2759
2765
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2760
2766
  </li>
2767
+ <li class=" tsd-kind-interface">
2768
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2769
+ </li>
2770
+ <li class=" tsd-kind-interface">
2771
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2772
+ </li>
2761
2773
  <li class=" tsd-kind-interface">
2762
2774
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2763
2775
  </li>
@@ -2770,6 +2782,12 @@ img {
2770
2782
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2771
2783
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2772
2784
  </li>
2785
+ <li class=" tsd-kind-interface">
2786
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2787
+ </li>
2788
+ <li class=" tsd-kind-interface">
2789
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2790
+ </li>
2773
2791
  <li class=" tsd-kind-interface">
2774
2792
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2775
2793
  </li>
@@ -2809,6 +2827,9 @@ img {
2809
2827
  <li class=" tsd-kind-type-alias">
2810
2828
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2811
2829
  </li>
2830
+ <li class=" tsd-kind-type-alias">
2831
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2832
+ </li>
2812
2833
  <li class=" tsd-kind-type-alias">
2813
2834
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2814
2835
  </li>
@@ -2863,6 +2884,8 @@ img {
2863
2884
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#build" class="tsd-kind-icon">build</a></li>
2864
2885
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
2865
2886
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
2887
+ <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>
2888
+ <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
2889
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a></li>
2867
2890
  </ul>
2868
2891
  </section>
@@ -2922,7 +2945,7 @@ img {
2922
2945
  <a name="setAttributes" class="tsd-anchor"></a>
2923
2946
  <h3>set<wbr>Attributes</h3>
2924
2947
  <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>
2948
+ <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">JSONValue</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>
2926
2949
  </ul>
2927
2950
  <ul class="tsd-descriptions">
2928
2951
  <li class="tsd-description">
@@ -2936,7 +2959,7 @@ img {
2936
2959
  <h4 class="tsd-parameters-title">Parameters</h4>
2937
2960
  <ul class="tsd-parameters">
2938
2961
  <li>
2939
- <h5>attributes: <span class="tsd-signature-type">any</span></h5>
2962
+ <h5>attributes: <span class="tsd-signature-type">JSONValue</span></h5>
2940
2963
  <div class="tsd-comment tsd-typography">
2941
2964
  <p>Message attributes.</p>
2942
2965
  </div>
@@ -2974,6 +2997,74 @@ img {
2974
2997
  </li>
2975
2998
  </ul>
2976
2999
  </section>
3000
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3001
+ <a name="setEmailBody" class="tsd-anchor"></a>
3002
+ <h3>set<wbr>Email<wbr>Body</h3>
3003
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3004
+ <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>
3005
+ </ul>
3006
+ <ul class="tsd-descriptions">
3007
+ <li class="tsd-description">
3008
+ <aside class="tsd-sources">
3009
+ </aside>
3010
+ <div class="tsd-comment tsd-typography">
3011
+ <div class="lead">
3012
+ <p>Set email body with given MIME-type.</p>
3013
+ </div>
3014
+ </div>
3015
+ <h4 class="tsd-parameters-title">Parameters</h4>
3016
+ <ul class="tsd-parameters">
3017
+ <li>
3018
+ <h5>mimeType: <span class="tsd-signature-type">string</span></h5>
3019
+ <div class="tsd-comment tsd-typography">
3020
+ <p>Format of the body to set (text/plain or text/html).</p>
3021
+ </div>
3022
+ </li>
3023
+ <li>
3024
+ <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>
3025
+ <div class="tsd-comment tsd-typography">
3026
+ <p>Body payload in selected format.</p>
3027
+ </div>
3028
+ </li>
3029
+ </ul>
3030
+ <h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
3031
+ </li>
3032
+ </ul>
3033
+ </section>
3034
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3035
+ <a name="setEmailHistory" class="tsd-anchor"></a>
3036
+ <h3>set<wbr>Email<wbr>History</h3>
3037
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3038
+ <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>
3039
+ </ul>
3040
+ <ul class="tsd-descriptions">
3041
+ <li class="tsd-description">
3042
+ <aside class="tsd-sources">
3043
+ </aside>
3044
+ <div class="tsd-comment tsd-typography">
3045
+ <div class="lead">
3046
+ <p>Set email history with given MIME-type.</p>
3047
+ </div>
3048
+ </div>
3049
+ <h4 class="tsd-parameters-title">Parameters</h4>
3050
+ <ul class="tsd-parameters">
3051
+ <li>
3052
+ <h5>mimeType: <span class="tsd-signature-type">string</span></h5>
3053
+ <div class="tsd-comment tsd-typography">
3054
+ <p>Format of the history to set (text/plain or text/html).</p>
3055
+ </div>
3056
+ </li>
3057
+ <li>
3058
+ <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>
3059
+ <div class="tsd-comment tsd-typography">
3060
+ <p>History payload in selected format.</p>
3061
+ </div>
3062
+ </li>
3063
+ </ul>
3064
+ <h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
3065
+ </li>
3066
+ </ul>
3067
+ </section>
2977
3068
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2978
3069
  <a name="setSubject" class="tsd-anchor"></a>
2979
3070
  <h3>set<wbr>Subject</h3>
package/docs/classes/Participant.html CHANGED
@@ -2741,6 +2741,9 @@ img {
2741
2741
  <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2742
2742
  <a href="Participant.html#attributes" class="tsd-kind-icon">attributes</a>
2743
2743
  </li>
2744
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2745
+ <a href="Participant.html#bindings" class="tsd-kind-icon">bindings</a>
2746
+ </li>
2744
2747
  <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2745
2748
  <a href="Participant.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a>
2746
2749
  </li>
@@ -2791,6 +2794,12 @@ img {
2791
2794
  <li class=" tsd-kind-interface">
2792
2795
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2793
2796
  </li>
2797
+ <li class=" tsd-kind-interface">
2798
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2799
+ </li>
2800
+ <li class=" tsd-kind-interface">
2801
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2802
+ </li>
2794
2803
  <li class=" tsd-kind-interface">
2795
2804
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2796
2805
  </li>
@@ -2803,6 +2812,12 @@ img {
2803
2812
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2804
2813
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2805
2814
  </li>
2815
+ <li class=" tsd-kind-interface">
2816
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2817
+ </li>
2818
+ <li class=" tsd-kind-interface">
2819
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2820
+ </li>
2806
2821
  <li class=" tsd-kind-interface">
2807
2822
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2808
2823
  </li>
@@ -2842,6 +2857,9 @@ img {
2842
2857
  <li class=" tsd-kind-type-alias">
2843
2858
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2844
2859
  </li>
2860
+ <li class=" tsd-kind-type-alias">
2861
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2862
+ </li>
2845
2863
  <li class=" tsd-kind-type-alias">
2846
2864
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2847
2865
  </li>
@@ -2903,6 +2921,7 @@ img {
2903
2921
  <h3>Accessors</h3>
2904
2922
  <ul class="tsd-index-list">
2905
2923
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Participant.html#attributes" class="tsd-kind-icon">attributes</a></li>
2924
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Participant.html#bindings" class="tsd-kind-icon">bindings</a></li>
2906
2925
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Participant.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a></li>
2907
2926
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Participant.html#dateUpdated" class="tsd-kind-icon">date<wbr>Updated</a></li>
2908
2927
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Participant.html#identity" class="tsd-kind-icon">identity</a></li>
@@ -2929,7 +2948,7 @@ img {
2929
2948
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
2930
2949
  <a name="typingEnded" class="tsd-anchor"></a>
2931
2950
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> typing<wbr>Ended</h3>
2932
- <div class="tsd-signature tsd-kind-icon">typing<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;typingEnded&quot;</span><span class="tsd-signature-symbol"> = &#x27;typingEnded&#x27;</span></div>
2951
+ <div class="tsd-signature tsd-kind-icon">typing<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;typingEnded&quot;</span><span class="tsd-signature-symbol"> = &quot;typingEnded&quot;</span></div>
2933
2952
  <aside class="tsd-sources">
2934
2953
  </aside>
2935
2954
  <div class="tsd-comment tsd-typography">
@@ -2945,7 +2964,7 @@ img {
2945
2964
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
2946
2965
  <a name="typingStarted" class="tsd-anchor"></a>
2947
2966
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> typing<wbr>Started</h3>
2948
- <div class="tsd-signature tsd-kind-icon">typing<wbr>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;typingStarted&quot;</span><span class="tsd-signature-symbol"> = &#x27;typingStarted&#x27;</span></div>
2967
+ <div class="tsd-signature tsd-kind-icon">typing<wbr>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;typingStarted&quot;</span><span class="tsd-signature-symbol"> = &quot;typingStarted&quot;</span></div>
2949
2968
  <aside class="tsd-sources">
2950
2969
  </aside>
2951
2970
  <div class="tsd-comment tsd-typography">
@@ -2961,7 +2980,7 @@ img {
2961
2980
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
2962
2981
  <a name="updated" class="tsd-anchor"></a>
2963
2982
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> updated</h3>
2964
- <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>
2983
+ <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>
2965
2984
  <aside class="tsd-sources">
2966
2985
  </aside>
2967
2986
  <div class="tsd-comment tsd-typography">
@@ -3000,7 +3019,7 @@ img {
3000
3019
  <a name="attributes" class="tsd-anchor"></a>
3001
3020
  <h3>attributes</h3>
3002
3021
  <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
3003
- <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>
3022
+ <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">JSONValue</span></li>
3004
3023
  </ul>
3005
3024
  <ul class="tsd-descriptions">
3006
3025
  <li class="tsd-description">
@@ -3011,7 +3030,32 @@ img {
3011
3030
  <p>Custom attributes of the participant.</p>
3012
3031
  </div>
3013
3032
  </div>
3014
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Object</span></h4>
3033
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JSONValue</span></h4>
3034
+ </li>
3035
+ </ul>
3036
+ </section>
3037
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
3038
+ <a name="bindings" class="tsd-anchor"></a>
3039
+ <h3>bindings</h3>
3040
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
3041
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bindings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ParticipantBindings.html" class="tsd-signature-type" data-tsd-kind="Interface">ParticipantBindings</a></li>
3042
+ </ul>
3043
+ <ul class="tsd-descriptions">
3044
+ <li class="tsd-description">
3045
+ <aside class="tsd-sources">
3046
+ </aside>
3047
+ <div class="tsd-comment tsd-typography">
3048
+ <div class="lead">
3049
+ <p>Get the bindings mapping for the current participant.
3050
+ Available binding depends on the participant type.
3051
+ You could access it as <code>participant.bindings.sms?.address</code> or
3052
+ using the type dynamically <code>participant.bindings[participant.type]</code>
3053
+ just be aware that the binding information has different structure for
3054
+ each participant type.
3055
+ See also {ParticipantEmailBinding}, the only available currently binding descriptor.</p>
3056
+ </div>
3057
+ </div>
3058
+ <h4 class="tsd-returns-title">Returns <a href="../interfaces/ParticipantBindings.html" class="tsd-signature-type" data-tsd-kind="Interface">ParticipantBindings</a></h4>
3015
3059
  </li>
3016
3060
  </ul>
3017
3061
  </section>
@@ -3163,7 +3207,7 @@ img {
3163
3207
  </aside>
3164
3208
  <div class="tsd-comment tsd-typography">
3165
3209
  <div class="lead">
3166
- <p>Message type of the participant.</p>
3210
+ <p>Type of the participant.</p>
3167
3211
  </div>
3168
3212
  </div>
3169
3213
  <h4 class="tsd-returns-title">Returns <a href="../modules.html#ParticipantType" class="tsd-signature-type" data-tsd-kind="Type alias">ParticipantType</a></h4>
@@ -3215,7 +3259,7 @@ img {
3215
3259
  <a name="updateAttributes" class="tsd-anchor"></a>
3216
3260
  <h3>update<wbr>Attributes</h3>
3217
3261
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3218
- <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="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">&gt;</span></li>
3262
+ <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">JSONValue</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="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">&gt;</span></li>
3219
3263
  </ul>
3220
3264
  <ul class="tsd-descriptions">
3221
3265
  <li class="tsd-description">
@@ -3229,7 +3273,7 @@ img {
3229
3273
  <h4 class="tsd-parameters-title">Parameters</h4>
3230
3274
  <ul class="tsd-parameters">
3231
3275
  <li>
3232
- <h5>attributes: <span class="tsd-signature-type">any</span></h5>
3276
+ <h5>attributes: <span class="tsd-signature-type">JSONValue</span></h5>
3233
3277
  <div class="tsd-comment tsd-typography">
3234
3278
  <p>New attributes.</p>
3235
3279
  </div>
package/docs/classes/PushNotification.html CHANGED
@@ -2764,6 +2764,12 @@ img {
2764
2764
  <li class=" tsd-kind-interface">
2765
2765
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2766
2766
  </li>
2767
+ <li class=" tsd-kind-interface">
2768
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2769
+ </li>
2770
+ <li class=" tsd-kind-interface">
2771
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2772
+ </li>
2767
2773
  <li class=" tsd-kind-interface">
2768
2774
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2769
2775
  </li>
@@ -2776,6 +2782,12 @@ img {
2776
2782
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2777
2783
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2778
2784
  </li>
2785
+ <li class=" tsd-kind-interface">
2786
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2787
+ </li>
2788
+ <li class=" tsd-kind-interface">
2789
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2790
+ </li>
2779
2791
  <li class=" tsd-kind-interface">
2780
2792
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2781
2793
  </li>
@@ -2815,6 +2827,9 @@ img {
2815
2827
  <li class=" tsd-kind-type-alias">
2816
2828
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2817
2829
  </li>
2830
+ <li class=" tsd-kind-type-alias">
2831
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2832
+ </li>
2818
2833
  <li class=" tsd-kind-type-alias">
2819
2834
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2820
2835
  </li>
package/docs/classes/RestPaginator.html CHANGED
@@ -2758,6 +2758,12 @@ img {
2758
2758
  <li class=" tsd-kind-interface">
2759
2759
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2760
2760
  </li>
2761
+ <li class=" tsd-kind-interface">
2762
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2763
+ </li>
2764
+ <li class=" tsd-kind-interface">
2765
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2766
+ </li>
2761
2767
  <li class=" tsd-kind-interface">
2762
2768
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2763
2769
  </li>
@@ -2770,6 +2776,12 @@ img {
2770
2776
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2771
2777
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2772
2778
  </li>
2779
+ <li class=" tsd-kind-interface">
2780
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2781
+ </li>
2782
+ <li class=" tsd-kind-interface">
2783
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2784
+ </li>
2773
2785
  <li class=" tsd-kind-interface">
2774
2786
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2775
2787
  </li>
@@ -2809,6 +2821,9 @@ img {
2809
2821
  <li class=" tsd-kind-type-alias">
2810
2822
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2811
2823
  </li>
2824
+ <li class=" tsd-kind-type-alias">
2825
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2826
+ </li>
2812
2827
  <li class=" tsd-kind-type-alias">
2813
2828
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2814
2829
  </li>
package/docs/classes/UnsentMessage.html CHANGED
@@ -2746,6 +2746,12 @@ img {
2746
2746
  <li class=" tsd-kind-interface">
2747
2747
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2748
2748
  </li>
2749
+ <li class=" tsd-kind-interface">
2750
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2751
+ </li>
2752
+ <li class=" tsd-kind-interface">
2753
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2754
+ </li>
2749
2755
  <li class=" tsd-kind-interface">
2750
2756
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2751
2757
  </li>
@@ -2758,6 +2764,12 @@ img {
2758
2764
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2759
2765
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2760
2766
  </li>
2767
+ <li class=" tsd-kind-interface">
2768
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2769
+ </li>
2770
+ <li class=" tsd-kind-interface">
2771
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2772
+ </li>
2761
2773
  <li class=" tsd-kind-interface">
2762
2774
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2763
2775
  </li>
@@ -2797,6 +2809,9 @@ img {
2797
2809
  <li class=" tsd-kind-type-alias">
2798
2810
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2799
2811
  </li>
2812
+ <li class=" tsd-kind-type-alias">
2813
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2814
+ </li>
2800
2815
  <li class=" tsd-kind-type-alias">
2801
2816
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2802
2817
  </li>
package/docs/classes/User.html CHANGED
@@ -2779,6 +2779,12 @@ img {
2779
2779
  <li class=" tsd-kind-interface">
2780
2780
  <a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2781
2781
  </li>
2782
+ <li class=" tsd-kind-interface">
2783
+ <a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
2784
+ </li>
2785
+ <li class=" tsd-kind-interface">
2786
+ <a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
2787
+ </li>
2782
2788
  <li class=" tsd-kind-interface">
2783
2789
  <a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
2784
2790
  </li>
@@ -2791,6 +2797,12 @@ img {
2791
2797
  <li class=" tsd-kind-interface tsd-has-type-parameter">
2792
2798
  <a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
2793
2799
  </li>
2800
+ <li class=" tsd-kind-interface">
2801
+ <a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
2802
+ </li>
2803
+ <li class=" tsd-kind-interface">
2804
+ <a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
2805
+ </li>
2794
2806
  <li class=" tsd-kind-interface">
2795
2807
  <a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
2796
2808
  </li>
@@ -2830,6 +2842,9 @@ img {
2830
2842
  <li class=" tsd-kind-type-alias">
2831
2843
  <a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
2832
2844
  </li>
2845
+ <li class=" tsd-kind-type-alias">
2846
+ <a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
2847
+ </li>
2833
2848
  <li class=" tsd-kind-type-alias">
2834
2849
  <a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
2835
2850
  </li>
@@ -2911,7 +2926,7 @@ img {
2911
2926
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class">
2912
2927
  <a name="updated" class="tsd-anchor"></a>
2913
2928
  <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> updated</h3>
2914
- <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>
2929
+ <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>
2915
2930
  <aside class="tsd-sources">
2916
2931
  </aside>
2917
2932
  <div class="tsd-comment tsd-typography">
@@ -2931,7 +2946,7 @@ img {
2931
2946
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class">
2932
2947
  <a name="userSubscribed" class="tsd-anchor"></a>
2933
2948
  <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> user<wbr>Subscribed</h3>
2934
- <div class="tsd-signature tsd-kind-icon">user<wbr>Subscribed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;userSubscribed&quot;</span><span class="tsd-signature-symbol"> = &#x27;userSubscribed&#x27;</span></div>
2949
+ <div class="tsd-signature tsd-kind-icon">user<wbr>Subscribed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;userSubscribed&quot;</span><span class="tsd-signature-symbol"> = &quot;userSubscribed&quot;</span></div>
2935
2950
  <aside class="tsd-sources">
2936
2951
  </aside>
2937
2952
  <div class="tsd-comment tsd-typography">
@@ -2947,7 +2962,7 @@ img {
2947
2962
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class">
2948
2963
  <a name="userUnsubscribed" class="tsd-anchor"></a>
2949
2964
  <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> user<wbr>Unsubscribed</h3>
2950
- <div class="tsd-signature tsd-kind-icon">user<wbr>Unsubscribed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;userUnsubscribed&quot;</span><span class="tsd-signature-symbol"> = &#x27;userUnsubscribed&#x27;</span></div>
2965
+ <div class="tsd-signature tsd-kind-icon">user<wbr>Unsubscribed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;userUnsubscribed&quot;</span><span class="tsd-signature-symbol"> = &quot;userUnsubscribed&quot;</span></div>
2951
2966
  <aside class="tsd-sources">
2952
2967
  </aside>
2953
2968
  <div class="tsd-comment tsd-typography">
@@ -2967,7 +2982,7 @@ img {
2967
2982
  <a name="attributes" class="tsd-anchor"></a>
2968
2983
  <h3>attributes</h3>
2969
2984
  <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
2970
- <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">any</span></li>
2985
+ <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">JSONValue</span></li>
2971
2986
  </ul>
2972
2987
  <ul class="tsd-descriptions">
2973
2988
  <li class="tsd-description">
@@ -2978,7 +2993,7 @@ img {
2978
2993
  <p>Custom attributes of the user.</p>
2979
2994
  </div>
2980
2995
  </div>
2981
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2996
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JSONValue</span></h4>
2982
2997
  </li>
2983
2998
  </ul>
2984
2999
  </section>
@@ -3121,7 +3136,7 @@ img {
3121
3136
  <a name="updateAttributes" class="tsd-anchor"></a>
3122
3137
  <h3>update<wbr>Attributes</h3>
3123
3138
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3124
- <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="User.html" class="tsd-signature-type" data-tsd-kind="Class">User</a><span class="tsd-signature-symbol">&gt;</span></li>
3139
+ <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">JSONValue</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="User.html" class="tsd-signature-type" data-tsd-kind="Class">User</a><span class="tsd-signature-symbol">&gt;</span></li>
3125
3140
  </ul>
3126
3141
  <ul class="tsd-descriptions">
3127
3142
  <li class="tsd-description">
@@ -3135,7 +3150,7 @@ img {
3135
3150
  <h4 class="tsd-parameters-title">Parameters</h4>
3136
3151
  <ul class="tsd-parameters">
3137
3152
  <li>
3138
- <h5>attributes: <span class="tsd-signature-type">any</span></h5>
3153
+ <h5>attributes: <span class="tsd-signature-type">JSONValue</span></h5>
3139
3154
  <div class="tsd-comment tsd-typography">
3140
3155
  <p>New attributes.</p>
3141
3156
  </div>