@twilio/conversations 3.0.0-rc.9 → 3.0.0

package/docs/classes/Message.html

@@ -2726,6 +2726,9 @@ img {
 				<li class=" tsd-kind-get-signature tsd-parent-kind-class">
 					<a href="Message.html#body" class="tsd-kind-icon">body</a>
 				</li>
+				<li class=" tsd-kind-get-signature tsd-parent-kind-class">
+					<a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a>
+				</li>
 				<li class=" tsd-kind-get-signature tsd-parent-kind-class">
 					<a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a>
 				</li>
@@ -2753,6 +2756,12 @@ img {
 				<li class=" tsd-kind-get-signature tsd-parent-kind-class">
 					<a href="Message.html#type" class="tsd-kind-icon">type</a>
 				</li>
+				<li class=" tsd-kind-method tsd-parent-kind-class">
+					<a href="Message.html#getChannelMetadata" class="tsd-kind-icon">get<wbr>Channel<wbr>Metadata</a>
+				</li>
+				<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>
 				<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>
@@ -2765,6 +2774,9 @@ img {
 				<li class=" tsd-kind-method tsd-parent-kind-class">
 					<a href="Message.html#getMediaByCategories" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategories</a>
 				</li>
+				<li class=" tsd-kind-method tsd-parent-kind-class">
+					<a href="Message.html#getMessageRecipients" class="tsd-kind-icon">get<wbr>Message<wbr>Recipients</a>
+				</li>
 				<li class=" tsd-kind-method tsd-parent-kind-class">
 					<a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a>
 				</li>
@@ -2831,6 +2843,7 @@ img {
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#attributes" class="tsd-kind-icon">attributes</a></li>
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#author" class="tsd-kind-icon">author</a></li>
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#body" class="tsd-kind-icon">body</a></li>
+							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a></li>
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a></li>
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateUpdated" class="tsd-kind-icon">date<wbr>Updated</a></li>
 							<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#index" class="tsd-kind-icon">index</a></li>
@@ -2845,10 +2858,13 @@ img {
 					<section class="tsd-index-section ">
 						<h3>Methods</h3>
 						<ul class="tsd-index-list">
+							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getChannelMetadata" class="tsd-kind-icon">get<wbr>Channel<wbr>Metadata</a></li>
+							<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>
 							<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>
 							<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>
 							<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>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getMediaByCategories" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategories</a></li>
+							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getMessageRecipients" class="tsd-kind-icon">get<wbr>Message<wbr>Recipients</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getTemporaryContentUrlsForAttachedMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Attached<wbr>Media</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a></li>
@@ -2993,6 +3009,25 @@ img {
 					</li>
 				</ul>
 			</section>
+			<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
+				<a name="contentSid" class="tsd-anchor"></a>
+				<h3>content<wbr>Sid</h3>
+				<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
+					<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>
+				</ul>
+				<ul class="tsd-descriptions">
+					<li class="tsd-description">
+						<aside class="tsd-sources">
+						</aside>
+						<div class="tsd-comment tsd-typography">
+							<div class="lead">
+								<p>Unique identifier of <a href="ContentTemplate.html">ContentTemplate</a> for this message.</p>
+							</div>
+						</div>
+						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
+					</li>
+				</ul>
+			</section>
 			<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
 				<a name="dateCreated" class="tsd-anchor"></a>
 				<h3>date<wbr>Created</h3>
@@ -3043,13 +3078,13 @@ img {
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<p>Index of the message in the conversation&#39;s messages list.
-									By design of the Conversations system, the message indices may have arbitrary gaps between them,
-									that does not necessarily mean they were deleted or otherwise modified - just that
-								messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
+								<p>Index of this message in the conversation&#39;s list of messages.</p>
 							</div>
+							<p>By design, the message indices may have arbitrary gaps between them,
+								that does not necessarily mean they were deleted or otherwise modified - just that
+							messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
 							<p>Trying to use indices for some calculations is going to be unreliable.</p>
-							<p>To calculate the number of unread messages it is better to use the read horizon API.
+							<p>To calculate the number of unread messages, it is better to use the Read Horizon API.
 							See <a href="Conversation.html#getUnreadMessagesCount">Conversation.getUnreadMessagesCount</a> for details.</p>
 						</div>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
@@ -3178,6 +3213,46 @@ img {
 		</section>
 		<section class="tsd-panel-group tsd-member-group ">
 			<h2>Methods</h2>
+			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+				<a name="getChannelMetadata" class="tsd-anchor"></a>
+				<h3>get<wbr>Channel<wbr>Metadata</h3>
+				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+					<li class="tsd-signature tsd-kind-icon">get<wbr>Channel<wbr>Metadata<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><a href="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">&gt;</span></li>
+				</ul>
+				<ul class="tsd-descriptions">
+					<li class="tsd-description">
+						<aside class="tsd-sources">
+						</aside>
+						<div class="tsd-comment tsd-typography">
+							<div class="lead">
+								<p>Get the <a href="ChannelMetadata.html">ChannelMetadata</a> for this message. Resolves to <code>null</code> if
+								the message doesn&#39;t have any channel metadata.</p>
+							</div>
+						</div>
+						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">&gt;</span></h4>
+					</li>
+				</ul>
+			</section>
+			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+				<a name="getContentData" class="tsd-anchor"></a>
+				<h3>get<wbr>Content<wbr>Data</h3>
+				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+					<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>
+				</ul>
+				<ul class="tsd-descriptions">
+					<li class="tsd-description">
+						<aside class="tsd-sources">
+						</aside>
+						<div class="tsd-comment tsd-typography">
+							<div class="lead">
+								<p>Get the <a href="../modules.html#ContentData">ContentData</a> for this message. Resolves to <code>null</code> when
+								<a href="Message.html#contentSid">Message.contentSid</a> is null.</p>
+							</div>
+						</div>
+						<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>
+					</li>
+				</ul>
+			</section>
 			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
 				<a name="getDetailedDeliveryReceipts" class="tsd-anchor"></a>
 				<h3>get<wbr>Detailed<wbr>Delivery<wbr>Receipts</h3>
@@ -3285,6 +3360,25 @@ img {
 					</li>
 				</ul>
 			</section>
+			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+				<a name="getMessageRecipients" class="tsd-anchor"></a>
+				<h3>get<wbr>Message<wbr>Recipients</h3>
+				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+					<li class="tsd-signature tsd-kind-icon">get<wbr>Message<wbr>Recipients<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><a href="../modules.html#RecipientDescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">RecipientDescriptor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
+				</ul>
+				<ul class="tsd-descriptions">
+					<li class="tsd-description">
+						<aside class="tsd-sources">
+						</aside>
+						<div class="tsd-comment tsd-typography">
+							<div class="lead">
+								<p>Get recipients of the message.</p>
+							</div>
+						</div>
+						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#RecipientDescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">RecipientDescriptor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
+					</li>
+				</ul>
+			</section>
 			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
 				<a name="getParticipant" class="tsd-anchor"></a>
 				<h3>get<wbr>Participant</h3>

package/docs/classes/MessageBuilder.html

@@ -2720,6 +2720,9 @@ img {
 				<li class=" tsd-kind-method tsd-parent-kind-class">
 					<a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a>
 				</li>
+				<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>
 				<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>
@@ -2771,6 +2774,7 @@ img {
 							<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>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
+							<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>
 							<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>
 							<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>
 							<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 {
 					</li>
 				</ul>
 			</section>
+			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+				<a name="setContentTemplate" class="tsd-anchor"></a>
+				<h3>set<wbr>Content<wbr>Template</h3>
+				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+					<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>
+				</ul>
+				<ul class="tsd-descriptions">
+					<li class="tsd-description">
+						<aside class="tsd-sources">
+						</aside>
+						<div class="tsd-comment tsd-typography">
+							<div class="lead">
+								<p>Adds <a href="ContentTemplate.html">ContentTemplate</a> SID for the message alongside optional
+								variables. When no variables provided, the default values will be used.</p>
+							</div>
+							<p>Adding the content SID converts the message to a rich message. In this
+								case, other fields are ignored and the message is sent using the content
+							from the the <a href="ContentTemplate.html">ContentTemplate</a>.</p>
+							<p>Use <a href="Client.html#getContentTemplates">Client.getContentTemplates</a> to request all available
+							<a href="ContentTemplate.html">ContentTemplate</a>s.</p>
+						</div>
+						<h4 class="tsd-parameters-title">Parameters</h4>
+						<ul class="tsd-parameters">
+							<li>
+								<h5>contentSid: <span class="tsd-signature-type">string</span></h5>
+								<div class="tsd-comment tsd-typography">
+									<p>SID of the <a href="ContentTemplate.html">ContentTemplate</a></p>
+								</div>
+							</li>
+							<li>
+								<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>
+							</li>
+						</ul>
+						<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
+					</li>
+				</ul>
+			</section>
 			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
 				<a name="setEmailBody" class="tsd-anchor"></a>
 				<h3>set<wbr>Email<wbr>Body</h3>

package/docs/classes/Participant.html

@@ -3082,7 +3082,7 @@ img {
 				<a name="type" class="tsd-anchor"></a>
 				<h3>type</h3>
 				<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
-					<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ParticipantType" class="tsd-signature-type" data-tsd-kind="Type alias">ParticipantType</a></li>
+					<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<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>
 				</ul>
 				<ul class="tsd-descriptions">
 					<li class="tsd-description">
@@ -3093,7 +3093,7 @@ img {
 								<p>Type of the participant.</p>
 							</div>
 						</div>
-						<h4 class="tsd-returns-title">Returns <a href="../modules.html#ParticipantType" class="tsd-signature-type" data-tsd-kind="Type alias">ParticipantType</a></h4>
+						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
 					</li>
 				</ul>
 			</section>