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

package/builds/lib.d.ts

@@ -1,6 +1,7 @@
+/// <reference types="node" />
 import { SyncClient, SyncDocument, SyncList } from "twilio-sync";
 import { LogLevelDesc } from "loglevel";
-import { Transport, TwilsockClient, InitRegistration, ConnectionError, TransportResult } from "twilsock";
+import { Transport, TwilsockClient, InitRegistration, TransportResult } from "twilsock";
 import { ConnectionState as TwilsockConnectionState } from "twilsock";
 import { ReplayEventEmitter } from "@twilio/replay-event-emitter";
 import { ChannelType, Notifications } from "@twilio/notifications";
@@ -109,6 +110,7 @@ declare class Configuration {
     readonly userIdentity: string;
     readonly userInfo: string;
     readonly myConversations: string;
+    readonly channelMetadataCacheCapacity: number;
     constructor(options: ClientOptions, configurationResponse: ConfigurationResponse, logger: Logger);
 }
 interface CommandExecutorServices {
@@ -121,8 +123,8 @@ declare class CommandExecutor {
     constructor(_serviceUrl: string, _services: CommandExecutorServices, _productId?: string);
     private _preProcessUrl;
     private _makeRequest;
-    fetchResource<REQ = void, RESP = void>(url: string, requestBody?: REQ): Promise<RESP>;
-    mutateResource<REQ = void, RESP = void>(method: "post" | "delete", url: string, requestBody?: REQ): Promise<RESP>;
+    fetchResource<Request = void, Response = void>(url: string, requestBody?: Request): Promise<Response>;
+    mutateResource<Request = void, Response = void>(method: "post" | "delete", url: string, requestBody?: Request): Promise<Response>;
 }
 /**
  * Represents a JSON value.
@@ -343,9 +345,10 @@ interface ParticipantLinks {
  */
 type ParticipantUpdateReason = "attributes" | "dateCreated" | "dateUpdated" | "roleSid" | "lastReadMessageIndex" | "lastReadTimestamp" | "bindings";
 /**
- * Type of a participant.
+ * Participant type. The string variant can be used to denote new types of
+ * participant that aren't supported by this version of the SDK.
  */
-type ParticipantType = "chat" | "sms" | "whatsapp" | "email";
+type ParticipantType = "chat" | "sms" | "whatsapp" | "email" | string;
 interface ParticipantUpdatedEventArgs {
     participant: Participant;
     updateReasons: ParticipantUpdateReason[];
@@ -490,6 +493,26 @@ declare class Participant extends ReplayEventEmitter<ParticipantEvents> {
      */
     updateAttributes(attributes: JSONValue): Promise<Participant>;
 }
+interface ParticipantResponse {
+    account_sid: string;
+    chat_service_sid: string;
+    conversation_sid: string;
+    role_sid: string;
+    sid: string;
+    attributes: string;
+    date_created: string;
+    date_updated: string;
+    identity: string;
+    messaging_binding: {
+        type: "chat" | "sms" | "whatsapp" | "email";
+        address: string;
+        proxy_address: string;
+    } | null;
+    url: string;
+    links: {
+        conversation: string;
+    };
+}
 interface ParticipantBindingOptions {
     email?: ParticipantEmailBinding;
 }
@@ -567,7 +590,7 @@ interface AggregatedDeliveryDescriptor {
  * Contains aggregated information about delivery statuses of a message across all participants
  * of a conversation.
  *
- * At any moment during the message delivery to a participant, the message can have zero or more of following
+ * At any moment during the message delivery to a participant, the message can have zero or more of the following
  * delivery statuses:
  * * Message is considered as **sent** to a participant if the nearest upstream carrier accepted the message.
  * * Message is considered as **delivered** to a participant if Twilio has received confirmation of message
@@ -693,6 +716,499 @@ declare class DetailedDeliveryReceipt {
      */
     constructor(descriptor: DetailedDeliveryReceiptDescriptor);
 }
+type ContentDataActionResponse = Readonly<{
+    type: string;
+    title: string;
+    id?: string;
+    url?: string;
+    phone?: string;
+    index?: number;
+}>;
+type ContentDataTextResponse = Readonly<{
+    body: string;
+}>;
+type ContentDataMediaResponse = Readonly<{
+    body?: string;
+    media: string[];
+}>;
+type ContentDataLocationResponse = Readonly<{
+    longitude: number;
+    latitude: number;
+    label?: string;
+}>;
+type ContentDataQuickReplyResponse = Readonly<{
+    body: string;
+    actions: Readonly<{
+        title: string;
+        id?: string;
+    }>[];
+}>;
+type ContentDataCallToActionResponse = Readonly<{
+    body: string;
+    actions: ContentDataActionResponse[];
+}>;
+type ContentDataListPickerResponse = Readonly<{
+    body: string;
+    button: string;
+    items: Readonly<{
+        id: string;
+        item: string;
+        description?: string;
+    }>[];
+}>;
+type ContentDataCardResponse = Readonly<{
+    title: string;
+    subtitle?: string;
+    media?: string[];
+    actions?: ContentDataActionResponse[];
+}>;
+type ContentDataResponse = Readonly<{
+    "twilio/text"?: ContentDataTextResponse;
+    "twilio/media"?: ContentDataMediaResponse;
+    "twilio/location"?: ContentDataLocationResponse;
+    "twilio/quick-reply"?: ContentDataQuickReplyResponse;
+    "twilio/call-to-action"?: ContentDataCallToActionResponse;
+    "twilio/list-picker"?: ContentDataListPickerResponse;
+    "twilio/card"?: ContentDataCardResponse;
+}>;
+type ContentTemplateResponse = Readonly<{
+    sid: string;
+    account_sid: string;
+    friendly_name: string;
+    variables: string;
+    variants: ContentDataResponse;
+    date_created: string;
+    date_updated: string;
+}>;
+/**
+ * Shows a button that sends back a predefined text. Used in
+ * {@link ContentDataQuickReply}.
+ */
+type ContentDataReply = {
+    /**
+     * Display value of the action. This is the message that will be sent back
+     * when the user taps on the button.
+     */
+    readonly title: string;
+    /**
+     * Postback payload. This field is not visible to the end user.
+     */
+    readonly id?: string;
+};
+/**
+ * Shows a button that redirects recipient to a predefined URL.
+ */
+type ContentDataActionUrl = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "url";
+    /**
+     * Display value for the action.
+     */
+    readonly title: string;
+    /**
+     * URL to direct to when the recipient taps the button.
+     */
+    readonly url: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a button that calls a phone number.
+ */
+type ContentDataActionPhone = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "phone";
+    /**
+     * Display value for the action.
+     */
+    readonly title: string;
+    /**
+     * Phone number to call when the recipient taps the button.
+     */
+    readonly phone: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a button that sends back a predefined text.
+ */
+type ContentDataActionReply = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "reply";
+    /**
+     * Display value for the action. This is the message that will be sent back
+     * when the user taps on the button.
+     */
+    readonly title: string;
+    /**
+     * Postback payload. This field is not visible to the end user.
+     */
+    readonly id?: string;
+    /**
+     * Index for the action.
+     */
+    readonly index: number;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used for unknown action types which aren't present in the current version of
+ * the Conversations SDK.
+ */
+type ContentDataActionOther = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "other";
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * A union of possible actions used in {@link ContentDataCallToAction} and
+ * {@link ContentDataCard}.
+ */
+type ContentDataAction = ContentDataActionUrl | ContentDataActionPhone | ContentDataActionReply | ContentDataActionOther;
+/**
+ * Represents an item in the {@link ContentDataListPicker}.
+ */
+type ContentDataListItem = {
+    /**
+     * Unique item identifier. Not visible to the recipient.
+     */
+    readonly id: string;
+    /**
+     * Display value of the item.
+     */
+    readonly item: string;
+    /**
+     * Description of the item.
+     */
+    readonly description?: string;
+};
+/**
+ * Contains only the plain text-based content. Represents the twilio/text
+ * content type.
+ */
+type ContentDataText = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "text";
+    /**
+     * The text of the message you want to send.
+     */
+    readonly body: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used to send file attachments, or to send long texts via MMS in the US and
+ * Canada. Represents the twilio/media content type.
+ */
+type ContentDataMedia = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "media";
+    /**
+     * The text of the message you want to send.
+     */
+    readonly body?: string;
+    /**
+     * URLs of the media you want to send.
+     */
+    readonly media: string[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Contains a location pin and an optional label, which can be used to enhance
+ * delivery notifications or connect recipients to physical experiences you
+ * offer. Represents the twilio/location content type.
+ */
+type ContentDataLocation = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "location";
+    /**
+     * The longitude value of the location pin you want to send.
+     */
+    readonly longitude: number;
+    /**
+     * The latitude value of the location pin you want to send.
+     */
+    readonly latitude: number;
+    /**
+     * The label to be displayed to the end user alongside the location pin.
+     */
+    readonly label?: string;
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Let recipients tap, rather than type, to respond to the message. Represents
+ * the twilio/quick-reply content type.
+ */
+type ContentDataQuickReply = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "quickReply";
+    /**
+     * The text of the message you want to send. This is included as a regular
+     * text message.
+     */
+    readonly body: string;
+    /**
+     * Up to 3 buttons can be created for quick reply. See
+     * {@link ContentDataReply}.
+     */
+    readonly replies: ContentDataReply[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Buttons that let recipients tap to trigger actions such as launching a
+ * website or making a phone call. Represents the twilio/call-to-action content
+ * type.
+ */
+type ContentDataCallToAction = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "callToAction";
+    /**
+     * The text of the message you want to send. This is included as a regular
+     * text message.
+     */
+    readonly body: string;
+    /**
+     * Buttons that recipients can tap on to act on the message.
+     */
+    readonly actions: ContentDataAction[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a menu of up to 10 options, which offers a simple way for users to make
+ * a selection. Represents the twilio/list-picker content type.
+ */
+type ContentDataListPicker = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "listPicker";
+    /**
+     * The text of the message you want to send. This is rendered as the body of
+     * the message.
+     */
+    readonly body: string;
+    /**
+     * Display value of the primary button.
+     */
+    readonly button: string;
+    /**
+     * List item objects displayed in the list. See {@link ContentDataListItem}.
+     */
+    readonly items: ContentDataListItem[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Shows a menu of up to 10 options, which offers a simple way for users to make
+ * a selection. Represents the twilio/card content type.
+ */
+type ContentDataCard = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "card";
+    /**
+     * Title of the card.
+     */
+    readonly title: string;
+    /**
+     * Subtitle of the card.
+     */
+    readonly subtitle?: string;
+    /**
+     * URLs of the media to send with the message.
+     */
+    readonly media: string[];
+    /**
+     * Buttons that the recipients can tap on to act on the message.
+     */
+    readonly actions: ContentDataAction[];
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * Used for unknown content types which aren't present in the current version of
+ * the Conversations SDK.
+ */
+type ContentDataOther = {
+    /**
+     * The type discriminant.
+     */
+    readonly type: "other";
+    /**
+     * Full data as a stringified JSON. This could be used for future content
+     * types and fields which are not yet supported by the newest version of
+     * the Conversations SDK, or for using newer types in the older versions of
+     * the SDK.
+     */
+    readonly rawData: string;
+};
+/**
+ * A union of possible data types in rich content templates.
+ */
+type ContentData = ContentDataText | ContentDataMedia | ContentDataLocation | ContentDataQuickReply | ContentDataCallToAction | ContentDataListPicker | ContentDataCard | ContentDataOther;
+/**
+ * Represents a variable for a content template. See
+ * {@link ContentTemplate.variables}.
+ */
+declare class ContentTemplateVariable {
+    readonly name: string;
+    readonly value: string;
+    constructor(/**
+     * Name of the variable.
+     */
+    name: string, /**
+     * Key of the variable
+     */
+    value: string);
+    /**
+     * Copies the variable with a new value.
+     *
+     * @param value The new value for the variable.
+     */
+    copyWithValue(value: string): ContentTemplateVariable;
+}
+/**
+ * A rich content template.
+ *
+ * Use {@Link Client.getContentTemplates} to request all the templates available
+ * for the current account.
+ */
+declare class ContentTemplate {
+    /**
+     * The server-assigned unique identifier for the template.
+     */
+    readonly sid: string;
+    /**
+     * Friendly name used to describe the content. Not visible to the recipient.
+     */
+    readonly friendlyName: string;
+    /**
+     * Variables used by this template.
+     */
+    readonly variables: ContentTemplateVariable[];
+    /**
+     * Variants of the content. See {@link ContentData}.
+     */
+    readonly variants: Map<string, ContentData>;
+    /**
+     * Date of creation.
+     */
+    readonly dateCreated: Date;
+    /**
+     * Date of the last update.
+     */
+    readonly dateUpdated: Date;
+    /**
+     * @internal
+     */
+    constructor(contentTemplateResponse: ContentTemplateResponse);
+}
+type ChannelMetadataClientServices = {
+    commandExecutor: CommandExecutor;
+};
+/**
+ * Represents channel metadata.
+ */
+declare class ChannelMetadata {
+    /**
+     * Communication channel type.
+     */
+    readonly type: string;
+    /**
+     * The actual metadata.
+     */
+    readonly data: unknown;
+    /**
+     * @internal
+     */
+    constructor(type: string, data: unknown);
+}
+declare class ChannelMetadataClient {
+    private readonly _services;
+    private readonly _configuration;
+    private readonly _cache;
+    constructor(services: ChannelMetadataClientServices, configuration: Configuration);
+    getChannelMetadata(conversationSid: string, messageSid: string): Promise<ChannelMetadata | null>;
+}
 type MessageEvents = {
     updated: (data: {
         message: Message;
@@ -703,6 +1219,7 @@ interface MessageServices {
     mcsClient: McsClient;
     network: Network;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 interface MessageLinks {
     self: string;
@@ -727,6 +1244,7 @@ interface MessageData {
     type?: MessageType;
     author: string | null;
     subject: string | null;
+    contentSid: string | null;
     lastUpdatedBy?: string | null;
     attributes?: JSONValue;
     dateUpdated: string;
@@ -735,6 +1253,7 @@ interface MessageData {
     media?: Media;
     memberSid?: string;
     delivery?: AggregatedDeliveryDescriptor;
+    channelMetadata?: boolean;
 }
 /**
  * A message in a conversation.
@@ -773,6 +1292,10 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * Message subject. Used only in email conversations.
      */
     get subject(): string | null;
+    /**
+     * Unique identifier of {@link ContentTemplate} for this message.
+     */
+    get contentSid(): string | null;
     /**
      * Body of the message.
      */
@@ -782,14 +1305,15 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     get dateUpdated(): Date | null;
     /**
-     * Index of the message in the conversation's messages list.
-     * By design of the Conversations system, the message indices may have arbitrary gaps between them,
+     * Index of this message in the conversation's list of messages.
+     *
+     * 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.
      *
      * Trying to use indices for some calculations is going to be unreliable.
      *
-     * To calculate the number of unread messages it is better to use the read horizon API.
+     * To calculate the number of unread messages, it is better to use the Read Horizon API.
      * See {@link Conversation.getUnreadMessagesCount} for details.
      */
     get index(): number;
@@ -826,6 +1350,14 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * Aggregated information about the message delivery statuses across all participants of a conversation..
      */
     get aggregatedDeliveryReceipt(): AggregatedDeliveryReceipt | null;
+    /**
+     * @deprecated
+     * Return a (possibly empty) array of media matching a specific set of categories.
+     * Allowed category is so far only 'media'.
+     * @param categories Array of categories to match.
+     * @returns Array of media descriptors matching given categories.
+     */
+    getMediaByCategory(categories: Array<MediaCategory>): Array<Media> | null;
     /**
      * Return a (possibly empty) array of media matching a specific set of categories.
      * Allowed category is so far only 'media'.
@@ -868,6 +1400,12 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * @param attributes New attributes.
      */
     updateAttributes(attributes: JSONValue): Promise<Message>;
+    /**
+     * @deprecated
+     * Get content URLs for all media attachments in the given set using a single operation.
+     * @param contentSet Set of media attachments to query content URLs.
+     */
+    attachTemporaryUrlsFor(contentSet: Media[] | null): Promise<Media[]>;
     /**
      * Get content URLs for all media attachments in the given set using a single operation.
      * @param contentSet Set of media attachments to query content URLs.
@@ -883,6 +1421,16 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     getTemporaryContentUrlsForAttachedMedia(): CancellablePromise<Map<string, string>>;
     private _getDetailedDeliveryReceiptsPaginator;
+    /**
+     * Get the {@link ContentData} for this message. Resolves to `null` when
+     * {@link Message.contentSid} is null.
+     */
+    getContentData(): CancellablePromise<ContentData | null>;
+    /**
+     * Get the {@link ChannelMetadata} for this message. Resolves to `null` if
+     * the message doesn't have any channel metadata.
+     */
+    getChannelMetadata(): Promise<ChannelMetadata | null>;
 }
 /**
  * Pagination helper interface.
@@ -1045,6 +1593,7 @@ interface MessagesServices {
     network: Network;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Represents the collection of messages in a conversation
@@ -1058,9 +1607,10 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
     constructor(conversation: Conversation, configuration: Configuration, services: MessagesServices);
     /**
      * Subscribe to the Messages Event Stream
-     * @param name - The name of Sync object for the Messages resource.
+     * @param arg - Name of the Sync object, or the SyncList itself, that
+     * represents the Messages resource.
      */
-    subscribe(name: string): Promise<SyncList>;
+    subscribe(arg: string | SyncList): Promise<SyncList>;
     unsubscribe(): Promise<void>;
     /**
      * Send a message to the conversation. The message could include text and multiple media attachments.
@@ -1115,6 +1665,8 @@ declare class UnsentMessage {
         FormData | SendMediaOptions
     ][];
     emailOptions: SendEmailOptions;
+    contentSid?: string;
+    contentVariables?: ContentTemplateVariable[];
     /**
      * @internal
      */
@@ -1176,6 +1728,21 @@ declare class MessageBuilder {
      * @param history History payload in the selected format.
      */
     setEmailHistory(contentType: string, history: FormData | SendMediaOptions): MessageBuilder;
+    /**
+     * Adds {@link ContentTemplate} SID for the message alongside optional
+     * variables. When no variables provided, the default values will be used.
+     *
+     * 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 {@link ContentTemplate}.
+     *
+     * Use {@link Client.getContentTemplates} to request all available
+     * {@link ContentTemplate}s.
+     *
+     * @param contentSid SID of the {@link ContentTemplate}
+     * @param variables Custom variables to resolve the template.
+     */
+    setContentTemplate(contentSid: string, contentVariables?: ContentTemplateVariable[]): MessageBuilder;
     /**
      * Adds media to the message.
      * @param payload Media to add.
@@ -1189,7 +1756,6 @@ declare class MessageBuilder {
      * Prepares a message and sends it to the conversation.
      */
     buildAndSend(): CancellablePromise<number | null>;
-    private getPayloadContentType;
 }
 /**
  * Conversation events.
@@ -1322,6 +1888,7 @@ interface ConversationServices {
     mcsClient: McsClient;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Conversation descriptor.
@@ -1489,10 +2056,18 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Messages entity.
      */
     private readonly _messagesEntity;
+    /**
+     * Sync list containing messages.
+     */
+    private _messagesList?;
     /**
      * Participants entity.
      */
     private readonly _participantsEntity;
+    /**
+     * Sync map containing participants.
+     */
+    private _participantsMap?;
     /**
      * Source of the most recent update.
      */
@@ -1584,7 +2159,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @param attributes Attributes to be attached to the participant.
      * @returns The added participant.
      */
-    add(identity: string, attributes?: JSONValue): Promise<Participant>;
+    add(identity: string, attributes?: JSONValue): Promise<ParticipantResponse>;
     /**
      * Add a non-chat participant to the conversation.
      * @param proxyAddress Proxy (Twilio) address of the participant.
@@ -1594,7 +2169,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * CC/To level.
      * @returns The added participant.
      */
-    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<Participant>;
+    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<ParticipantResponse>;
     /**
      * Advance the conversation's last read message index to the current read
      * horizon. Rejects if the user is not a participant of the conversation. Last
@@ -1663,7 +2238,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     getMessagesCount(): Promise<number>;
     /**
-     * Get unread messages count for the user if they are a participant of this
+     * Get count of unread messages for the user if they are a participant of this
      * conversation. Rejects if the user is not a participant of the conversation.
      *
      * Use this method to obtain the number of unread messages together with
@@ -1671,12 +2246,19 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * message indices which may have gaps. See {@link Message.index} for details.
      *
      * This method is semi-realtime. This means that this data will be eventually
-     * correct, but will also be possibly incorrect for a few seconds. The
+     * correct, but it will also be possibly incorrect for a few seconds. The
      * Conversations system does not provide real time events for counter values
      * changes.
      *
      * This is useful for any UI badges, but it is not recommended to build any
      * core application logic based on these counters being accurate in real time.
+     *
+     * If the read horizon is not set, this function will return null. This could mean
+     * that all messages in the conversation are unread, or that the read horizon system
+     * is not being used. How to interpret this `null` value is up to the customer application.
+     *
+     * @return Number of unread messages based on the current read horizon set for
+     * the user or `null` if the read horizon is not set.
      */
     getUnreadMessagesCount(): Promise<number | null>;
     /**
@@ -1705,7 +2287,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     sendMessage(message: null | string | FormData | SendMediaOptions, messageAttributes?: JSONValue, emailOptions?: SendEmailOptions): Promise<number>;
     /**
      * New interface to prepare for sending a message.
-     * Use this instead of {@link Message.sendMessage}.
+     * Use this instead of {@link Conversation.sendMessage}.
      * @return A MessageBuilder to help set all message sending options.
      */
     prepareMessage(): MessageBuilder;
@@ -1717,7 +2299,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     setAllMessagesRead(): Promise<number>;
     /**
      * Set all messages in the conversation unread.
-     * @return Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     setAllMessagesUnread(): Promise<number>;
     /**
@@ -1746,7 +2328,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Set the last read message index to the current read horizon.
      * @param index Message index to set as last read. If null is provided, then
      * the behavior is identical to {@link Conversation.setAllMessagesUnread}.
-     * @returns Resulting unread messages count in the conversation.
+     * @returns New count of unread messages after this update.
      */
     updateLastReadMessageIndex(index: number | null): Promise<number>;
     /**
@@ -1762,6 +2344,16 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @internal
      */
     _subscribe(): Promise<SyncDocument>;
+    /**
+     * Fetch participants and messages of the conversation. This method needs to
+     * be called during conversation initialization to catch broken conversations
+     * (broken conversations are conversations that have essential Sync entities
+     * missing, i.e. the conversation document, the messages list or the
+     * participant map). In case of this conversation being broken, the method
+     * will throw an exception that will be caught and handled gracefully.
+     * @internal
+     */
+    _fetchStreams(): Promise<void>;
     /**
      * Load the attributes of this conversation and instantiate its participants
      * and messages. This or _subscribe will need to be called before any events
@@ -1910,8 +2502,9 @@ type ClientEvents = {
         user: User;
         updateReasons: UserUpdateReason[];
     }) => void;
-    stateChanged: ({ state, error }: {
-        state: State;
+    stateChanged: (state: State) => void;
+    initialized: () => void;
+    initFailed: ({ error }: {
         error?: ConnectionError;
     }) => void;
     connectionStateChanged: (state: TwilsockConnectionState) => void;
@@ -1952,6 +2545,10 @@ interface ClientOptions {
      * The level of logging to enable.
      */
     logLevel?: LogLevel;
+    /**
+     * The cache capacity for channel metadata.
+     */
+    channelMetadataCacheCapacity?: number;
     region?: string;
     productId?: string;
     twilsockClient?: TwilsockClient;
@@ -1975,6 +2572,10 @@ interface ClientOptions {
     typingUri?: string;
     apiUri?: string;
 }
+type ConnectionError = {
+    terminal: boolean;
+    message: string;
+};
 /**
  * Options for {@link Client.createConversation}.
  */
@@ -2167,16 +2768,29 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static readonly userUpdated = "userUpdated";
     /**
+     * @deprecated Use initialized or initFailed events instead
      * Fired when the state of the client has been changed.
      *
      * Parameters:
+     * 1. {@link State} `state` - the new client state
+     * @event
+     */
+    static readonly stateChanged = "stateChanged";
+    /**
+     * Fired when the client has completed initialization successfully.
+     * @event
+     */
+    static readonly initialized = "initialized";
+    /**
+     * Fired when the client initialization failed.
+     *
+     * Parameters:
      * 1. object `data` - info object provided with the event. It has the
-     * following properties:
-     *     * {@link State} `state` - the new client state
+     * following property:
      *     * Error? `error` - the initialization error if present
      * @event
      */
-    static readonly stateChanged = "stateChanged";
+    static readonly initFailed = "initFailed";
     /**
      * Fired when the connection state of the client has been changed.
      *
@@ -2285,6 +2899,12 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * initialization was completed.
      */
     get reachabilityEnabled(): boolean;
+    /**
+     * @deprecated
+     * Current token.
+     * @internal
+     */
+    get token(): string;
     /**
      * @deprecated Call constructor directly.
      *
@@ -2417,6 +3037,11 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param contentSet Set of media attachments to query content URLs.
      */
     getTemporaryContentUrlsForMedia(contentSet: Media[]): CancellablePromise<Map<string, string>>;
+    /**
+     * Returns rich content templates belonging to the account. Rich content
+     * templates can be created via the Twilio console or the REST API.
+     */
+    getContentTemplates(): Promise<Readonly<ContentTemplate[]>>;
     /**
      * Initialize the client.
      */
@@ -2440,4 +3065,4 @@ declare class NotificationTypes {
     static readonly REMOVED_FROM_CONVERSATION = "twilio.conversations.removed_from_conversation";
     static readonly CONSUMPTION_UPDATE = "twilio.channel.consumption_update";
 }
-export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray, CancellablePromise };
+export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray, CancellablePromise, ContentDataActionUrl, ContentDataActionPhone, ContentDataActionReply, ContentDataActionOther, ContentDataAction, ContentDataText, ContentDataMedia, ContentDataLocation, ContentDataReply, ContentDataQuickReply, ContentDataCallToAction, ContentDataListPicker, ContentDataListItem, ContentDataCard, ContentDataOther, ContentData, ContentTemplate, ContentTemplateVariable, ChannelMetadata };