@twilio/conversations 3.0.0-rc.8 → 3.0.0

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 (99) hide show
  1. package/README.md +39 -29
  2. package/builds/browser.esm.js +10838 -0
  3. package/builds/browser.esm.js.map +1 -0
  4. package/builds/browser.js +2494 -476
  5. package/builds/browser.js.map +1 -1
  6. package/builds/lib.d.ts +805 -70
  7. package/builds/lib.esm.d.ts +3178 -0
  8. package/builds/lib.esm.js +10837 -0
  9. package/builds/lib.js +2494 -476
  10. package/builds/lib.js.map +1 -1
  11. package/builds/twilio-conversations.js +29167 -26611
  12. package/builds/twilio-conversations.js.map +1 -0
  13. package/builds/twilio-conversations.min.js +2 -1
  14. package/builds/twilio-conversations.min.js.map +1 -0
  15. package/dist/aggregated-delivery-receipt.js +10 -5
  16. package/dist/aggregated-delivery-receipt.js.map +1 -1
  17. package/dist/channel-metadata-client.js +187 -0
  18. package/dist/channel-metadata-client.js.map +1 -0
  19. package/dist/client.js +266 -192
  20. package/dist/client.js.map +1 -1
  21. package/dist/command-executor.js +51 -14
  22. package/dist/command-executor.js.map +1 -1
  23. package/dist/configuration.js +23 -12
  24. package/dist/configuration.js.map +1 -1
  25. package/dist/content-client.js +180 -0
  26. package/dist/content-client.js.map +1 -0
  27. package/dist/content-template.js +304 -0
  28. package/dist/content-template.js.map +1 -0
  29. package/dist/conversation.js +213 -134
  30. package/dist/conversation.js.map +1 -1
  31. package/dist/data/conversations.js +70 -50
  32. package/dist/data/conversations.js.map +1 -1
  33. package/dist/data/messages.js +40 -27
  34. package/dist/data/messages.js.map +1 -1
  35. package/dist/data/participants.js +38 -32
  36. package/dist/data/participants.js.map +1 -1
  37. package/dist/data/users.js +19 -14
  38. package/dist/data/users.js.map +1 -1
  39. package/dist/detailed-delivery-receipt.js +9 -4
  40. package/dist/detailed-delivery-receipt.js.map +1 -1
  41. package/dist/index.js +26 -41
  42. package/dist/index.js.map +1 -1
  43. package/dist/interfaces/notification-types.js +9 -4
  44. package/dist/interfaces/notification-types.js.map +1 -1
  45. package/dist/interfaces/{attributes.js → rules.js} +26 -13
  46. package/dist/interfaces/rules.js.map +1 -0
  47. package/dist/logger.js +17 -28
  48. package/dist/logger.js.map +1 -1
  49. package/dist/media.js +40 -24
  50. package/dist/media.js.map +1 -1
  51. package/dist/message-builder.js +79 -12
  52. package/dist/message-builder.js.map +1 -1
  53. package/dist/message-recipients-client.js +231 -0
  54. package/dist/message-recipients-client.js.map +1 -0
  55. package/dist/message.js +258 -92
  56. package/dist/message.js.map +1 -1
  57. package/dist/node_modules/quick-lru/index.js +261 -0
  58. package/dist/node_modules/quick-lru/index.js.map +1 -0
  59. package/dist/node_modules/tslib/tslib.es6.js +15 -5
  60. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  61. package/dist/packages/conversations/package.json.js +12 -7
  62. package/dist/packages/conversations/package.json.js.map +1 -1
  63. package/dist/participant.js +42 -38
  64. package/dist/participant.js.map +1 -1
  65. package/dist/push-notification.js +9 -4
  66. package/dist/push-notification.js.map +1 -1
  67. package/dist/rest-paginator.js +9 -4
  68. package/dist/rest-paginator.js.map +1 -1
  69. package/dist/services/network.js +11 -6
  70. package/dist/services/network.js.map +1 -1
  71. package/dist/services/typing-indicator.js +17 -11
  72. package/dist/services/typing-indicator.js.map +1 -1
  73. package/dist/unsent-message.js +14 -9
  74. package/dist/unsent-message.js.map +1 -1
  75. package/dist/user.js +40 -32
  76. package/dist/user.js.map +1 -1
  77. package/dist/util/deferred.js +9 -4
  78. package/dist/util/deferred.js.map +1 -1
  79. package/dist/util/index.js +44 -8
  80. package/dist/util/index.js.map +1 -1
  81. package/docs/assets/js/search.js +1 -1
  82. package/docs/classes/AggregatedDeliveryReceipt.html +1 -1
  83. package/docs/classes/ChannelMetadata.html +3050 -0
  84. package/docs/classes/Client.html +98 -27
  85. package/docs/classes/ContentTemplate.html +3116 -0
  86. package/docs/classes/ContentTemplateVariable.html +3116 -0
  87. package/docs/classes/Conversation.html +46 -9
  88. package/docs/classes/EmailRecipientDescriptor.html +3098 -0
  89. package/docs/classes/Message.html +99 -5
  90. package/docs/classes/MessageBuilder.html +41 -0
  91. package/docs/classes/Participant.html +2 -2
  92. package/docs/classes/UnknownRecipientDescriptor.html +3067 -0
  93. package/docs/index.html +892 -28
  94. package/docs/interfaces/ClientOptions.html +32 -0
  95. package/docs/interfaces/CreateConversationOptions.html +17 -0
  96. package/docs/modules.html +891 -27
  97. package/package.json +21 -19
  98. package/CHANGELOG.md +0 -501
  99. package/dist/interfaces/attributes.js.map +0 -1
package/docs/interfaces/ClientOptions.html CHANGED
@@ -2705,9 +2705,15 @@ img {
2705
2705
  <li class="current tsd-kind-interface">
2706
2706
  <a href="ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
2707
2707
  <ul>
2708
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
2709
+ <a href="ClientOptions.html#channelMetadataCacheCapacity" class="tsd-kind-icon">channel<wbr>Metadata<wbr>Cache<wbr>Capacity</a>
2710
+ </li>
2708
2711
  <li class=" tsd-kind-property tsd-parent-kind-interface">
2709
2712
  <a href="ClientOptions.html#logLevel" class="tsd-kind-icon">log<wbr>Level</a>
2710
2713
  </li>
2714
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
2715
+ <a href="ClientOptions.html#messageRecipientsCacheCapacity" class="tsd-kind-icon">message<wbr>Recipients<wbr>Cache<wbr>Capacity</a>
2716
+ </li>
2711
2717
  </ul>
2712
2718
  </li>
2713
2719
  </ul>
@@ -2736,7 +2742,9 @@ img {
2736
2742
  <section class="tsd-index-section ">
2737
2743
  <h3>Properties</h3>
2738
2744
  <ul class="tsd-index-list">
2745
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClientOptions.html#channelMetadataCacheCapacity" class="tsd-kind-icon">channel<wbr>Metadata<wbr>Cache<wbr>Capacity</a></li>
2739
2746
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClientOptions.html#logLevel" class="tsd-kind-icon">log<wbr>Level</a></li>
2747
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClientOptions.html#messageRecipientsCacheCapacity" class="tsd-kind-icon">message<wbr>Recipients<wbr>Cache<wbr>Capacity</a></li>
2740
2748
  </ul>
2741
2749
  </section>
2742
2750
  </div>
@@ -2744,6 +2752,18 @@ img {
2744
2752
  </section>
2745
2753
  <section class="tsd-panel-group tsd-member-group ">
2746
2754
  <h2>Properties</h2>
2755
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2756
+ <a name="channelMetadataCacheCapacity" class="tsd-anchor"></a>
2757
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> channel<wbr>Metadata<wbr>Cache<wbr>Capacity</h3>
2758
+ <div class="tsd-signature tsd-kind-icon">channel<wbr>Metadata<wbr>Cache<wbr>Capacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
2759
+ <aside class="tsd-sources">
2760
+ </aside>
2761
+ <div class="tsd-comment tsd-typography">
2762
+ <div class="lead">
2763
+ <p>The cache capacity for channel metadata.</p>
2764
+ </div>
2765
+ </div>
2766
+ </section>
2747
2767
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2748
2768
  <a name="logLevel" class="tsd-anchor"></a>
2749
2769
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr>Level</h3>
@@ -2756,6 +2776,18 @@ img {
2756
2776
  </div>
2757
2777
  </div>
2758
2778
  </section>
2779
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2780
+ <a name="messageRecipientsCacheCapacity" class="tsd-anchor"></a>
2781
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> message<wbr>Recipients<wbr>Cache<wbr>Capacity</h3>
2782
+ <div class="tsd-signature tsd-kind-icon">message<wbr>Recipients<wbr>Cache<wbr>Capacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
2783
+ <aside class="tsd-sources">
2784
+ </aside>
2785
+ <div class="tsd-comment tsd-typography">
2786
+ <div class="lead">
2787
+ <p>The cache capacity for message recipients.</p>
2788
+ </div>
2789
+ </div>
2790
+ </section>
2759
2791
  </section>
2760
2792
  <footer>
2761
2793
  <div class="container">
package/docs/interfaces/CreateConversationOptions.html CHANGED
@@ -2705,6 +2705,9 @@ img {
2705
2705
  <li class="current tsd-kind-interface">
2706
2706
  <a href="CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
2707
2707
  <ul>
2708
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
2709
+ <a href="CreateConversationOptions.html#access" class="tsd-kind-icon">access</a>
2710
+ </li>
2708
2711
  <li class=" tsd-kind-property tsd-parent-kind-interface">
2709
2712
  <a href="CreateConversationOptions.html#attributes" class="tsd-kind-icon">attributes</a>
2710
2713
  </li>
@@ -2742,6 +2745,7 @@ img {
2742
2745
  <section class="tsd-index-section ">
2743
2746
  <h3>Properties</h3>
2744
2747
  <ul class="tsd-index-list">
2748
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateConversationOptions.html#access" class="tsd-kind-icon">access</a></li>
2745
2749
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateConversationOptions.html#attributes" class="tsd-kind-icon">attributes</a></li>
2746
2750
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateConversationOptions.html#friendlyName" class="tsd-kind-icon">friendly<wbr>Name</a></li>
2747
2751
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateConversationOptions.html#uniqueName" class="tsd-kind-icon">unique<wbr>Name</a></li>
@@ -2752,6 +2756,19 @@ img {
2752
2756
  </section>
2753
2757
  <section class="tsd-panel-group tsd-member-group ">
2754
2758
  <h2>Properties</h2>
2759
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2760
+ <a name="access" class="tsd-anchor"></a>
2761
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access</h3>
2762
+ <div class="tsd-signature tsd-kind-icon">access<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
2763
+ <aside class="tsd-sources">
2764
+ </aside>
2765
+ <div class="tsd-comment tsd-typography">
2766
+ <div class="lead">
2767
+ <p>The access control for the conversation.
2768
+ null for existing conversations, &#39;restricted&#39; for conversations that need to support users with restricted access</p>
2769
+ </div>
2770
+ </div>
2771
+ </section>
2755
2772
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2756
2773
  <a name="attributes" class="tsd-anchor"></a>
2757
2774
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> attributes</h3>