@twilio/conversations 2.2.2 → 2.3.0-rc.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 (76) hide show
  1. package/builds/browser.js +629 -25
  2. package/builds/browser.js.map +1 -1
  3. package/builds/lib.d.ts +501 -3
  4. package/builds/lib.js +620 -25
  5. package/builds/lib.js.map +1 -1
  6. package/builds/twilio-conversations.js +887 -267
  7. package/builds/twilio-conversations.min.js +1 -1
  8. package/dist/aggregated-delivery-receipt.js +9 -0
  9. package/dist/aggregated-delivery-receipt.js.map +1 -1
  10. package/dist/client.js +19 -0
  11. package/dist/client.js.map +1 -1
  12. package/dist/command-executor.js +9 -0
  13. package/dist/command-executor.js.map +1 -1
  14. package/dist/configuration.js +9 -0
  15. package/dist/configuration.js.map +1 -1
  16. package/dist/content-client.js +184 -0
  17. package/dist/content-client.js.map +1 -0
  18. package/dist/content-template.js +310 -0
  19. package/dist/content-template.js.map +1 -0
  20. package/dist/conversation.js +9 -0
  21. package/dist/conversation.js.map +1 -1
  22. package/dist/data/conversations.js +9 -0
  23. package/dist/data/conversations.js.map +1 -1
  24. package/dist/data/messages.js +13 -0
  25. package/dist/data/messages.js.map +1 -1
  26. package/dist/data/participants.js +9 -0
  27. package/dist/data/participants.js.map +1 -1
  28. package/dist/data/users.js +9 -0
  29. package/dist/data/users.js.map +1 -1
  30. package/dist/detailed-delivery-receipt.js +9 -0
  31. package/dist/detailed-delivery-receipt.js.map +1 -1
  32. package/dist/index.js +12 -0
  33. package/dist/index.js.map +1 -1
  34. package/dist/interfaces/attributes.js +9 -0
  35. package/dist/interfaces/attributes.js.map +1 -1
  36. package/dist/interfaces/notification-types.js +9 -0
  37. package/dist/interfaces/notification-types.js.map +1 -1
  38. package/dist/logger.js +9 -0
  39. package/dist/logger.js.map +1 -1
  40. package/dist/media.js +9 -0
  41. package/dist/media.js.map +1 -1
  42. package/dist/message-builder.js +28 -0
  43. package/dist/message-builder.js.map +1 -1
  44. package/dist/message.js +94 -0
  45. package/dist/message.js.map +1 -1
  46. package/dist/node_modules/tslib/tslib.es6.js +9 -0
  47. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  48. package/dist/packages/conversations/package.json.js +10 -1
  49. package/dist/packages/conversations/package.json.js.map +1 -1
  50. package/dist/participant.js +9 -0
  51. package/dist/participant.js.map +1 -1
  52. package/dist/push-notification.js +9 -0
  53. package/dist/push-notification.js.map +1 -1
  54. package/dist/rest-paginator.js +9 -0
  55. package/dist/rest-paginator.js.map +1 -1
  56. package/dist/services/network.js +9 -0
  57. package/dist/services/network.js.map +1 -1
  58. package/dist/services/typing-indicator.js +9 -0
  59. package/dist/services/typing-indicator.js.map +1 -1
  60. package/dist/unsent-message.js +9 -0
  61. package/dist/unsent-message.js.map +1 -1
  62. package/dist/user.js +9 -0
  63. package/dist/user.js.map +1 -1
  64. package/dist/util/deferred.js +9 -0
  65. package/dist/util/deferred.js.map +1 -1
  66. package/dist/util/index.js +9 -0
  67. package/dist/util/index.js.map +1 -1
  68. package/docs/assets/js/search.js +1 -1
  69. package/docs/classes/Client.html +24 -0
  70. package/docs/classes/ContentTemplate.html +3116 -0
  71. package/docs/classes/ContentTemplateVariable.html +3116 -0
  72. package/docs/classes/Message.html +47 -0
  73. package/docs/classes/MessageBuilder.html +41 -0
  74. package/docs/index.html +813 -0
  75. package/docs/modules.html +813 -0
  76. package/package.json +9 -8
package/docs/classes/Message.html CHANGED
@@ -2726,6 +2726,9 @@ img {
2726
2726
  <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2727
2727
  <a href="Message.html#body" class="tsd-kind-icon">body</a>
2728
2728
  </li>
2729
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2730
+ <a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a>
2731
+ </li>
2729
2732
  <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2730
2733
  <a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a>
2731
2734
  </li>
@@ -2753,6 +2756,9 @@ img {
2753
2756
  <li class=" tsd-kind-get-signature tsd-parent-kind-class">
2754
2757
  <a href="Message.html#type" class="tsd-kind-icon">type</a>
2755
2758
  </li>
2759
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2760
+ <a href="Message.html#getContentData" class="tsd-kind-icon">get<wbr>Content<wbr>Data</a>
2761
+ </li>
2756
2762
  <li class=" tsd-kind-method tsd-parent-kind-class">
2757
2763
  <a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a>
2758
2764
  </li>
@@ -2831,6 +2837,7 @@ img {
2831
2837
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#attributes" class="tsd-kind-icon">attributes</a></li>
2832
2838
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#author" class="tsd-kind-icon">author</a></li>
2833
2839
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#body" class="tsd-kind-icon">body</a></li>
2840
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a></li>
2834
2841
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a></li>
2835
2842
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateUpdated" class="tsd-kind-icon">date<wbr>Updated</a></li>
2836
2843
  <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#index" class="tsd-kind-icon">index</a></li>
@@ -2845,6 +2852,7 @@ img {
2845
2852
  <section class="tsd-index-section ">
2846
2853
  <h3>Methods</h3>
2847
2854
  <ul class="tsd-index-list">
2855
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getContentData" class="tsd-kind-icon">get<wbr>Content<wbr>Data</a></li>
2848
2856
  <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>
2849
2857
  <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>
2850
2858
  <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>
@@ -2993,6 +3001,25 @@ img {
2993
3001
  </li>
2994
3002
  </ul>
2995
3003
  </section>
3004
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
3005
+ <a name="contentSid" class="tsd-anchor"></a>
3006
+ <h3>content<wbr>Sid</h3>
3007
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
3008
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> contentSid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
3009
+ </ul>
3010
+ <ul class="tsd-descriptions">
3011
+ <li class="tsd-description">
3012
+ <aside class="tsd-sources">
3013
+ </aside>
3014
+ <div class="tsd-comment tsd-typography">
3015
+ <div class="lead">
3016
+ <p>Unique identifier of <a href="ContentTemplate.html">ContentTemplate</a> for this message.</p>
3017
+ </div>
3018
+ </div>
3019
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
3020
+ </li>
3021
+ </ul>
3022
+ </section>
2996
3023
  <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
2997
3024
  <a name="dateCreated" class="tsd-anchor"></a>
2998
3025
  <h3>date<wbr>Created</h3>
@@ -3178,6 +3205,26 @@ img {
3178
3205
  </section>
3179
3206
  <section class="tsd-panel-group tsd-member-group ">
3180
3207
  <h2>Methods</h2>
3208
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3209
+ <a name="getContentData" class="tsd-anchor"></a>
3210
+ <h3>get<wbr>Content<wbr>Data</h3>
3211
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3212
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ContentData" class="tsd-signature-type" data-tsd-kind="Type alias">ContentData</a><span class="tsd-signature-symbol">&gt;</span></li>
3213
+ </ul>
3214
+ <ul class="tsd-descriptions">
3215
+ <li class="tsd-description">
3216
+ <aside class="tsd-sources">
3217
+ </aside>
3218
+ <div class="tsd-comment tsd-typography">
3219
+ <div class="lead">
3220
+ <p>Get the <a href="../modules.html#ContentData">ContentData</a> for this message. Resolves to <code>null</code> when
3221
+ <a href="Message.html#contentSid">Message.contentSid</a> is null.</p>
3222
+ </div>
3223
+ </div>
3224
+ <h4 class="tsd-returns-title">Returns <a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ContentData" class="tsd-signature-type" data-tsd-kind="Type alias">ContentData</a><span class="tsd-signature-symbol">&gt;</span></h4>
3225
+ </li>
3226
+ </ul>
3227
+ </section>
3181
3228
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3182
3229
  <a name="getDetailedDeliveryReceipts" class="tsd-anchor"></a>
3183
3230
  <h3>get<wbr>Detailed<wbr>Delivery<wbr>Receipts</h3>
package/docs/classes/MessageBuilder.html CHANGED
@@ -2720,6 +2720,9 @@ img {
2720
2720
  <li class=" tsd-kind-method tsd-parent-kind-class">
2721
2721
  <a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a>
2722
2722
  </li>
2723
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2724
+ <a href="MessageBuilder.html#setContentTemplate" class="tsd-kind-icon">set<wbr>Content<wbr>Template</a>
2725
+ </li>
2723
2726
  <li class=" tsd-kind-method tsd-parent-kind-class">
2724
2727
  <a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a>
2725
2728
  </li>
@@ -2771,6 +2774,7 @@ img {
2771
2774
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#buildAndSend" class="tsd-kind-icon">build<wbr>And<wbr>Send</a></li>
2772
2775
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
2773
2776
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
2777
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setContentTemplate" class="tsd-kind-icon">set<wbr>Content<wbr>Template</a></li>
2774
2778
  <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>
2775
2779
  <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>
2776
2780
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a></li>
@@ -2903,6 +2907,43 @@ img {
2903
2907
  </li>
2904
2908
  </ul>
2905
2909
  </section>
2910
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2911
+ <a name="setContentTemplate" class="tsd-anchor"></a>
2912
+ <h3>set<wbr>Content<wbr>Template</h3>
2913
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2914
+ <li class="tsd-signature tsd-kind-icon">set<wbr>Content<wbr>Template<span class="tsd-signature-symbol">(</span>contentSid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contentVariables<span class="tsd-signature-symbol">?: </span><a href="ContentTemplateVariable.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplateVariable</a><span class="tsd-signature-symbol">[]</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>
2915
+ </ul>
2916
+ <ul class="tsd-descriptions">
2917
+ <li class="tsd-description">
2918
+ <aside class="tsd-sources">
2919
+ </aside>
2920
+ <div class="tsd-comment tsd-typography">
2921
+ <div class="lead">
2922
+ <p>Adds <a href="ContentTemplate.html">ContentTemplate</a> SID for the message alongside optional
2923
+ variables. When no variables provided, the default values will be used.</p>
2924
+ </div>
2925
+ <p>Adding the content SID converts the message to a rich message. In this
2926
+ case, other fields are ignored and the message is sent using the content
2927
+ from the the <a href="ContentTemplate.html">ContentTemplate</a>.</p>
2928
+ <p>Use <a href="Client.html#getContentTemplates">Client.getContentTemplates</a> to request all available
2929
+ <a href="ContentTemplate.html">ContentTemplate</a>s.</p>
2930
+ </div>
2931
+ <h4 class="tsd-parameters-title">Parameters</h4>
2932
+ <ul class="tsd-parameters">
2933
+ <li>
2934
+ <h5>contentSid: <span class="tsd-signature-type">string</span></h5>
2935
+ <div class="tsd-comment tsd-typography">
2936
+ <p>SID of the <a href="ContentTemplate.html">ContentTemplate</a></p>
2937
+ </div>
2938
+ </li>
2939
+ <li>
2940
+ <h5>contentVariables: <a href="ContentTemplateVariable.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplateVariable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
2941
+ </li>
2942
+ </ul>
2943
+ <h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
2944
+ </li>
2945
+ </ul>
2946
+ </section>
2906
2947
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2907
2948
  <a name="setEmailBody" class="tsd-anchor"></a>
2908
2949
  <h3>set<wbr>Email<wbr>Body</h3>