@twilio/conversations 3.0.0-rc.9 → 3.0.1-rc.102

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/README.md +38 -28
  2. package/builds/browser.js +1659 -264
  3. package/builds/browser.js.map +1 -1
  4. package/builds/lib.d.ts +650 -25
  5. package/builds/lib.js +1650 -264
  6. package/builds/lib.js.map +1 -1
  7. package/builds/twilio-conversations.js +4300 -1842
  8. package/builds/twilio-conversations.min.js +1 -1
  9. package/dist/aggregated-delivery-receipt.js +10 -1
  10. package/dist/aggregated-delivery-receipt.js.map +1 -1
  11. package/dist/channel-metadata-client.js +192 -0
  12. package/dist/channel-metadata-client.js.map +1 -0
  13. package/dist/client.js +70 -10
  14. package/dist/client.js.map +1 -1
  15. package/dist/command-executor.js +48 -6
  16. package/dist/command-executor.js.map +1 -1
  17. package/dist/configuration.js +14 -3
  18. package/dist/configuration.js.map +1 -1
  19. package/dist/content-client.js +184 -0
  20. package/dist/content-client.js.map +1 -0
  21. package/dist/content-template.js +310 -0
  22. package/dist/content-template.js.map +1 -0
  23. package/dist/conversation.js +59 -16
  24. package/dist/conversation.js.map +1 -1
  25. package/dist/data/conversations.js +25 -3
  26. package/dist/data/conversations.js.map +1 -1
  27. package/dist/data/messages.js +23 -6
  28. package/dist/data/messages.js.map +1 -1
  29. package/dist/data/participants.js +17 -8
  30. package/dist/data/participants.js.map +1 -1
  31. package/dist/data/users.js +9 -0
  32. package/dist/data/users.js.map +1 -1
  33. package/dist/detailed-delivery-receipt.js +9 -0
  34. package/dist/detailed-delivery-receipt.js.map +1 -1
  35. package/dist/index.js +14 -0
  36. package/dist/index.js.map +1 -1
  37. package/dist/interfaces/notification-types.js +9 -0
  38. package/dist/interfaces/notification-types.js.map +1 -1
  39. package/dist/interfaces/{attributes.js → rules.js} +26 -7
  40. package/dist/interfaces/rules.js.map +1 -0
  41. package/dist/logger.js +9 -0
  42. package/dist/logger.js.map +1 -1
  43. package/dist/media.js +9 -0
  44. package/dist/media.js.map +1 -1
  45. package/dist/message-builder.js +77 -6
  46. package/dist/message-builder.js.map +1 -1
  47. package/dist/message.js +156 -12
  48. package/dist/message.js.map +1 -1
  49. package/dist/node_modules/quick-lru/index.js +265 -0
  50. package/dist/node_modules/quick-lru/index.js.map +1 -0
  51. package/dist/node_modules/tslib/tslib.es6.js +9 -0
  52. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  53. package/dist/packages/conversations/package.json.js +10 -1
  54. package/dist/packages/conversations/package.json.js.map +1 -1
  55. package/dist/participant.js +11 -2
  56. package/dist/participant.js.map +1 -1
  57. package/dist/push-notification.js +9 -0
  58. package/dist/push-notification.js.map +1 -1
  59. package/dist/rest-paginator.js +9 -0
  60. package/dist/rest-paginator.js.map +1 -1
  61. package/dist/services/network.js +9 -0
  62. package/dist/services/network.js.map +1 -1
  63. package/dist/services/typing-indicator.js +9 -0
  64. package/dist/services/typing-indicator.js.map +1 -1
  65. package/dist/unsent-message.js +9 -0
  66. package/dist/unsent-message.js.map +1 -1
  67. package/dist/user.js +20 -3
  68. package/dist/user.js.map +1 -1
  69. package/dist/util/deferred.js +9 -0
  70. package/dist/util/deferred.js.map +1 -1
  71. package/dist/util/index.js +9 -0
  72. package/dist/util/index.js.map +1 -1
  73. package/docs/assets/js/search.js +1 -1
  74. package/docs/classes/AggregatedDeliveryReceipt.html +1 -1
  75. package/docs/classes/ChannelMetadata.html +3050 -0
  76. package/docs/classes/Client.html +64 -25
  77. package/docs/classes/ContentTemplate.html +3116 -0
  78. package/docs/classes/ContentTemplateVariable.html +3116 -0
  79. package/docs/classes/Conversation.html +14 -9
  80. package/docs/classes/Message.html +76 -5
  81. package/docs/classes/MessageBuilder.html +41 -0
  82. package/docs/classes/Participant.html +2 -2
  83. package/docs/index.html +849 -25
  84. package/docs/interfaces/ClientOptions.html +16 -0
  85. package/docs/modules.html +848 -24
  86. package/package.json +18 -14
  87. package/CHANGELOG.md +0 -509
  88. package/dist/interfaces/attributes.js.map +0 -1
package/docs/classes/Client.html CHANGED
@@ -2729,6 +2729,12 @@ img {
2729
2729
  <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2730
2730
  <a href="Client.html#conversationUpdated" class="tsd-kind-icon">conversation<wbr>Updated</a>
2731
2731
  </li>
2732
+ <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2733
+ <a href="Client.html#initFailed" class="tsd-kind-icon">init<wbr>Failed</a>
2734
+ </li>
2735
+ <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2736
+ <a href="Client.html#initialized" class="tsd-kind-icon">initialized</a>
2737
+ </li>
2732
2738
  <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2733
2739
  <a href="Client.html#messageAdded" class="tsd-kind-icon">message<wbr>Added</a>
2734
2740
  </li>
@@ -2750,9 +2756,6 @@ img {
2750
2756
  <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2751
2757
  <a href="Client.html#pushNotification" class="tsd-kind-icon">push<wbr>Notification</a>
2752
2758
  </li>
2753
- <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2754
- <a href="Client.html#stateChanged" class="tsd-kind-icon">state<wbr>Changed</a>
2755
- </li>
2756
2759
  <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
2757
2760
  <a href="Client.html#tokenAboutToExpire" class="tsd-kind-icon">token<wbr>About<wbr>ToExpire</a>
2758
2761
  </li>
@@ -2795,6 +2798,9 @@ img {
2795
2798
  <li class=" tsd-kind-method tsd-parent-kind-class">
2796
2799
  <a href="Client.html#createConversation" class="tsd-kind-icon">create<wbr>Conversation</a>
2797
2800
  </li>
2801
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2802
+ <a href="Client.html#getContentTemplates" class="tsd-kind-icon">get<wbr>Content<wbr>Templates</a>
2803
+ </li>
2798
2804
  <li class=" tsd-kind-method tsd-parent-kind-class">
2799
2805
  <a href="Client.html#getConversationBySid" class="tsd-kind-icon">get<wbr>Conversation<wbr>BySid</a>
2800
2806
  </li>
@@ -2886,6 +2892,8 @@ img {
2886
2892
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationLeft" class="tsd-kind-icon">conversation<wbr>Left</a></li>
2887
2893
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationRemoved" class="tsd-kind-icon">conversation<wbr>Removed</a></li>
2888
2894
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationUpdated" class="tsd-kind-icon">conversation<wbr>Updated</a></li>
2895
+ <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#initFailed" class="tsd-kind-icon">init<wbr>Failed</a></li>
2896
+ <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#initialized" class="tsd-kind-icon">initialized</a></li>
2889
2897
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageAdded" class="tsd-kind-icon">message<wbr>Added</a></li>
2890
2898
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageRemoved" class="tsd-kind-icon">message<wbr>Removed</a></li>
2891
2899
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageUpdated" class="tsd-kind-icon">message<wbr>Updated</a></li>
@@ -2893,7 +2901,6 @@ img {
2893
2901
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#participantLeft" class="tsd-kind-icon">participant<wbr>Left</a></li>
2894
2902
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#participantUpdated" class="tsd-kind-icon">participant<wbr>Updated</a></li>
2895
2903
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#pushNotification" class="tsd-kind-icon">push<wbr>Notification</a></li>
2896
- <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#stateChanged" class="tsd-kind-icon">state<wbr>Changed</a></li>
2897
2904
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#tokenAboutToExpire" class="tsd-kind-icon">token<wbr>About<wbr>ToExpire</a></li>
2898
2905
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#tokenExpired" class="tsd-kind-icon">token<wbr>Expired</a></li>
2899
2906
  <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#typingEnded" class="tsd-kind-icon">typing<wbr>Ended</a></li>
@@ -2923,6 +2930,7 @@ img {
2923
2930
  <h3>Methods</h3>
2924
2931
  <ul class="tsd-index-list">
2925
2932
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#createConversation" class="tsd-kind-icon">create<wbr>Conversation</a></li>
2933
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getContentTemplates" class="tsd-kind-icon">get<wbr>Content<wbr>Templates</a></li>
2926
2934
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getConversationBySid" class="tsd-kind-icon">get<wbr>Conversation<wbr>BySid</a></li>
2927
2935
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getConversationByUniqueName" class="tsd-kind-icon">get<wbr>Conversation<wbr>ByUnique<wbr>Name</a></li>
2928
2936
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getSubscribedConversations" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Conversations</a></li>
@@ -3122,6 +3130,38 @@ img {
3122
3130
  </ol>
3123
3131
  </div>
3124
3132
  </section>
3133
+ <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3134
+ <a name="initFailed" class="tsd-anchor"></a>
3135
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> init<wbr>Failed</h3>
3136
+ <div class="tsd-signature tsd-kind-icon">init<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;initFailed&quot;</span><span class="tsd-signature-symbol"> = &quot;initFailed&quot;</span></div>
3137
+ <aside class="tsd-sources">
3138
+ </aside>
3139
+ <div class="tsd-comment tsd-typography">
3140
+ <div class="lead">
3141
+ <p>Fired when the client initialization failed.</p>
3142
+ </div>
3143
+ <p>Parameters:</p>
3144
+ <ol>
3145
+ <li>object <code>data</code> - info object provided with the event. It has the
3146
+ following property:<ul>
3147
+ <li>Error? <code>error</code> - the initialization error if present</li>
3148
+ </ul>
3149
+ </li>
3150
+ </ol>
3151
+ </div>
3152
+ </section>
3153
+ <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3154
+ <a name="initialized" class="tsd-anchor"></a>
3155
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> initialized</h3>
3156
+ <div class="tsd-signature tsd-kind-icon">initialized<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;initialized&quot;</span><span class="tsd-signature-symbol"> = &quot;initialized&quot;</span></div>
3157
+ <aside class="tsd-sources">
3158
+ </aside>
3159
+ <div class="tsd-comment tsd-typography">
3160
+ <div class="lead">
3161
+ <p>Fired when the client has completed initialization successfully.</p>
3162
+ </div>
3163
+ </div>
3164
+ </section>
3125
3165
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3126
3166
  <a name="messageAdded" class="tsd-anchor"></a>
3127
3167
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Added</h3>
@@ -3248,27 +3288,6 @@ img {
3248
3288
  </ol>
3249
3289
  </div>
3250
3290
  </section>
3251
- <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3252
- <a name="stateChanged" class="tsd-anchor"></a>
3253
- <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> state<wbr>Changed</h3>
3254
- <div class="tsd-signature tsd-kind-icon">state<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stateChanged&quot;</span><span class="tsd-signature-symbol"> = &quot;stateChanged&quot;</span></div>
3255
- <aside class="tsd-sources">
3256
- </aside>
3257
- <div class="tsd-comment tsd-typography">
3258
- <div class="lead">
3259
- <p>Fired when the state of the client has been changed.</p>
3260
- </div>
3261
- <p>Parameters:</p>
3262
- <ol>
3263
- <li>object <code>data</code> - info object provided with the event. It has the
3264
- following properties:<ul>
3265
- <li><a href="../modules.html#State">State</a> <code>state</code> - the new client state</li>
3266
- <li>Error? <code>error</code> - the initialization error if present</li>
3267
- </ul>
3268
- </li>
3269
- </ol>
3270
- </div>
3271
- </section>
3272
3291
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3273
3292
  <a name="tokenAboutToExpire" class="tsd-anchor"></a>
3274
3293
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> token<wbr>About<wbr>ToExpire</h3>
@@ -3537,6 +3556,26 @@ img {
3537
3556
  </li>
3538
3557
  </ul>
3539
3558
  </section>
3559
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3560
+ <a name="getContentTemplates" class="tsd-anchor"></a>
3561
+ <h3>get<wbr>Content<wbr>Templates</h3>
3562
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3563
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Templates<span class="tsd-signature-symbol">(</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><span class="tsd-signature-symbol">readonly </span><a href="ContentTemplate.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
3564
+ </ul>
3565
+ <ul class="tsd-descriptions">
3566
+ <li class="tsd-description">
3567
+ <aside class="tsd-sources">
3568
+ </aside>
3569
+ <div class="tsd-comment tsd-typography">
3570
+ <div class="lead">
3571
+ <p>Returns rich content templates belonging to the account. Rich content
3572
+ templates can be created via the Twilio console or the REST API.</p>
3573
+ </div>
3574
+ </div>
3575
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">readonly </span><a href="ContentTemplate.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
3576
+ </li>
3577
+ </ul>
3578
+ </section>
3540
3579
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3541
3580
  <a name="getConversationBySid" class="tsd-anchor"></a>
3542
3581
  <h3>get<wbr>Conversation<wbr>BySid</h3>