@twilio/conversations 2.1.0 → 3.0.0-canary.5

package/builds/lib.d.ts

@@ -1,11 +1,11 @@
 import { SyncClient, SyncDocument, SyncList } from "twilio-sync";
 import { LogLevelDesc } from "loglevel";
-import { Transport, TwilsockClient, InitRegistration, TransportResult } from "twilsock";
+import { Transport, TwilsockClient, InitRegistration, ConnectionError, TransportResult } from "twilsock";
 import { ConnectionState as TwilsockConnectionState } from "twilsock";
 import { ReplayEventEmitter } from "@twilio/replay-event-emitter";
 import { ChannelType, Notifications } from "@twilio/notifications";
 import { Notifications as NotificationClient } from "@twilio/notifications";
-import { McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
+import { CancellablePromise, McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
 import { MediaCategory as McsMediaCategory } from "@twilio/mcs-client";
 interface ConfigurationResponse {
     options: {
@@ -72,13 +72,13 @@ interface ConversationLimits {
      */
     mediaAttachmentsTotalSizeLimitInMb: number;
     /**
-     * Allowed mime types for E-Mail histories.
+     * Allowed content types for E-Mail histories.
      */
-    emailHistoriesAllowedMimeTypes: string[];
+    emailHistoriesAllowedContentTypes: string[];
     /**
-     * Allowed mime types for E-Mail bodies.
+     * Allowed content types for E-Mail bodies.
      */
-    emailBodiesAllowedMimeTypes: string[];
+    emailBodiesAllowedContentTypes: string[];
 }
 interface BackoffConfiguration {
     min: number;
@@ -301,7 +301,7 @@ declare class Users extends ReplayEventEmitter<UsersEvents> {
      * if not - then subscribes and adds user to the FIFO stack
      * @returns {Promise<User>} Fully initialized user
      */
-    getUser(identity?: string, entityName?: string): Promise<User>;
+    getUser(identity: string, entityName?: string): Promise<User>;
     /**
      * @returns {Promise<Array<User>>} returns list of subscribed User objects {@see User}
      */
@@ -326,9 +326,9 @@ interface ParticipantDescriptor {
     identity: string;
     roleSid?: string;
     lastConsumedMessageIndex: number | null;
-    lastConsumptionTimestamp: number;
+    lastConsumptionTimestamp: number | null;
     type: ParticipantType;
-    userInfo: string;
+    userInfo?: string;
     bindings?: ParticipantBindings;
 }
 interface ParticipantServices {
@@ -490,26 +490,6 @@ 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 | null;
-    messaging_binding: {
-        type: string;
-        address: string;
-        proxy_address: string;
-    } | null;
-    url: string;
-    links: {
-        conversation: string;
-    };
-}
 interface ParticipantBindingOptions {
     email?: ParticipantEmailBinding;
 }
@@ -568,17 +548,7 @@ declare class Media {
      * If the URL becomes expired, you need to request a new one.
      * Each call to this function produces a new temporary URL.
      */
-    getContentTemporaryUrl(): Promise<string | null>;
-    /**
-     * Returns cached direct content URL for the media.
-     *
-     * This URL will expire in several minutes. This function does not refresh the URL and can be used to query it several times
-     * without causing network traffic.
-     * If the URL becomes expired, you need to request a new one using getContentTemporaryUrl().
-     *
-     * @returns {Promise<String>}
-     */
-    getCachedTemporaryUrl(): Promise<string | null>;
+    getContentTemporaryUrl(): CancellablePromise<string | null>;
     private _fetchMcsMedia;
 }
 /**
@@ -862,16 +832,16 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * @param categories Array of categories to match.
      * @returns Array of media descriptors matching given categories.
      */
-    getMediaByCategory(categories: Array<MediaCategory>): Array<Media> | null;
+    getMediaByCategories(categories: MediaCategory[]): Media[] | null;
     /**
      * Get a media descriptor for an email body attachment of a provided type.
-     * Allowed body types are returned in the Conversation.limits().emailBodiesAllowedMimeTypes array.
+     * Allowed body types are returned in the Conversation.limits().emailBodiesAllowedContentTypes array.
      * @param type Type of email body to request, defaults to `text/plain`.
      */
     getEmailBody(type?: string): Media | null;
     /**
      * Get a media descriptor for an email history attachment of a provided type.
-     * Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedMimeTypes array.
+     * Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedContentTypes array.
      * @param type Type of email history to request, defaults to `text/plain`.
      */
     getEmailHistory(type?: string): Media | null;
@@ -899,10 +869,19 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     updateAttributes(attributes: JSONValue): Promise<Message>;
     /**
-     * Get content URLs for all media attachments in the given set using single operation.
-     * @param contentSet Set of media attachments to query for content URL.
+     * 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.
+     */
+    getTemporaryContentUrlsForMedia(contentSet: Media[] | null): CancellablePromise<Map<string, string>>;
+    /**
+     * Get content URLs for all media attachments in the given set of media sids using a single operation.
+     * @param mediaSids Set of media sids to query for the content URL.
      */
-    attachTemporaryUrlsFor(contentSet: Media[] | null): Promise<Media[]>;
+    getTemporaryContentUrlsForMediaSids(mediaSids: string[]): CancellablePromise<Map<string, string>>;
+    /**
+     * Get content URLs for all media attached to the message.
+     */
+    getTemporaryContentUrlsForAttachedMedia(): CancellablePromise<Map<string, string>>;
     private _getDetailedDeliveryReceiptsPaginator;
 }
 /**
@@ -959,7 +938,7 @@ declare class TypingIndicator {
     private sentUpdates;
     private getConversation;
     private serviceTypingTimeout;
-    constructor(getConversation: any, config: Configuration, services: TypingIndicatorServices);
+    constructor(getConversation: (conversationSid: string) => Promise<Conversation>, config: Configuration, services: TypingIndicatorServices);
     get typingTimeout(): number;
     /**
      * Initialize TypingIndicator controller
@@ -978,25 +957,6 @@ declare class TypingIndicator {
     send(conversationSid: string): Promise<void>;
     private _send;
 }
-/**
- * An unsent message. Returned from {@link MessageBuilder.build}.
- */
-declare class UnsentMessage {
-    private messagesEntity;
-    text?: string;
-    attributes: JSONValue;
-    mediaContent: [MediaCategory, FormData | SendMediaOptions][];
-    emailOptions: SendEmailOptions;
-    /**
-     * @internal
-     */
-    constructor(messagesEntity: any);
-    /**
-     * Send the prepared message to the conversation.
-     * @returns Index of the new message in the conversation.
-     */
-    send(): Promise<number | null>;
-}
 /**
  * Pagination helper class.
  */
@@ -1103,11 +1063,10 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
     subscribe(name: string): Promise<SyncList>;
     unsubscribe(): Promise<void>;
     /**
-     * Send Message to the conversation, message could include both text and multiple media attachments.
+     * Send a message to the conversation. The message could include text and multiple media attachments.
      * @param message Message to post
-     * @returns Returns a promise which can fail
      */
-    sendV2(message: UnsentMessage): Promise<MessageResponse>;
+    sendV2(message: UnsentMessage): CancellablePromise<MessageResponse>;
     /**
      * Send Message to the conversation
      * @param message Message to post
@@ -1144,6 +1103,25 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
      */
     private _getMessages;
 }
+/**
+ * An unsent message. Returned from {@link MessageBuilder.build}.
+ */
+declare class UnsentMessage {
+    private messagesEntity;
+    text?: string;
+    attributes: JSONValue;
+    mediaContent: [MediaCategory, FormData | SendMediaOptions][];
+    emailOptions: SendEmailOptions;
+    /**
+     * @internal
+     */
+    constructor(messagesEntity: Messages);
+    /**
+     * Send the prepared message to the conversation.
+     * @returns Index of the new message in the conversation.
+     */
+    send(): CancellablePromise<number | null>;
+}
 /**
  * Message builder. Allows the message to be built and sent via method chaining.
  *
@@ -1184,17 +1162,17 @@ declare class MessageBuilder {
      */
     setAttributes(attributes: JSONValue): MessageBuilder;
     /**
-     * Set email body with given MIME-type.
-     * @param mimeType Format of the body to set (text/plain or text/html).
-     * @param body Body payload in selected format.
+     * Set the email body with a given content type.
+     * @param contentType Format of the body to set (text/plain or text/html).
+     * @param body Body payload in the selected format.
      */
-    setEmailBody(mimeType: string, body: FormData | SendMediaOptions): MessageBuilder;
+    setEmailBody(contentType: string, body: FormData | SendMediaOptions): MessageBuilder;
     /**
-     * Set email history with given MIME-type.
-     * @param mimeType Format of the history to set (text/plain or text/html).
-     * @param history History payload in selected format.
+     * Set the email history with a given content type.
+     * @param contentType Format of the history to set (text/plain or text/html).
+     * @param history History payload in the selected format.
      */
-    setEmailHistory(mimeType: string, history: FormData | SendMediaOptions): MessageBuilder;
+    setEmailHistory(contentType: string, history: FormData | SendMediaOptions): MessageBuilder;
     /**
      * Adds media to the message.
      * @param payload Media to add.
@@ -1204,8 +1182,15 @@ declare class MessageBuilder {
      * Builds the message, making it ready to be sent.
      */
     build(): UnsentMessage;
+    /**
+     * Prepares a message and sends it to the conversation.
+     */
+    buildAndSend(): CancellablePromise<number | null>;
     private getPayloadContentType;
 }
+/**
+ * Conversation events.
+ */
 type ConversationEvents = {
     participantJoined: (participant: Participant) => void;
     participantLeft: (participant: Participant) => void;
@@ -1227,55 +1212,28 @@ type ConversationEvents = {
     }) => void;
     removed: (conversation: Conversation) => void;
 };
-interface ConversationServices {
-    users: Users;
-    typingIndicator: TypingIndicator;
-    network: Network;
-    mcsClient: McsClient;
-    syncClient: SyncClient;
-    commandExecutor: CommandExecutor;
-}
-interface ConversationDescriptor {
-    channel: string;
-    entityName: string;
-    uniqueName: string;
-    attributes: JSONValue;
-    createdBy?: string;
-    friendlyName?: string;
-    lastConsumedMessageIndex: number;
-    dateCreated: Date | null;
-    dateUpdated: Date | null;
-    notificationLevel?: NotificationLevel;
-    bindings?: ConversationBindings;
-}
-interface ConversationLinks {
-    self: string;
-    messages: string;
-    participants: string;
-}
 /**
- * The reason for the `updated` event being emitted by a conversation.
+ * Reason for the `updated` event emission by a conversation.
  */
 type ConversationUpdateReason = "attributes" | "createdBy" | "dateCreated" | "dateUpdated" | "friendlyName" | "lastReadMessageIndex" | "state" | "status" | "uniqueName" | "lastMessage" | "notificationLevel" | "bindings";
 /**
- * The status of the conversation, relative to the client: whether
- * the conversation has been `joined` or the client is
- * `notParticipating` in the conversation.
+ * Status of the conversation, relative to the client: whether the conversation
+ * has been `joined` or the client is `notParticipating` in the conversation.
  */
 type ConversationStatus = "notParticipating" | "joined";
 /**
- * The user's notification level for the conversation. Determines
+ * User's notification level for the conversation. Determines
  * whether the currently logged-in user will receive pushes for events
  * in this conversation. Can be either `muted` or `default`, where
  * `default` defers to the global service push configuration.
  */
 type NotificationLevel = "default" | "muted";
 /**
- * The state of the conversation.
+ * State of the conversation.
  */
 interface ConversationState {
     /**
-     * The current state.
+     * Current state.
      */
     current: "active" | "inactive" | "closed";
     /**
@@ -1283,6 +1241,9 @@ interface ConversationState {
      */
     dateUpdated: Date;
 }
+/**
+ * Event arguments for the `updated` event.
+ */
 interface ConversationUpdatedEventArgs {
     conversation: Conversation;
     updateReasons: ConversationUpdateReason[];
@@ -1301,6 +1262,9 @@ interface ConversationEmailBinding {
     name?: string;
     projected_address: string;
 }
+/**
+ * Binding for SMS conversation.
+ */
 interface ConversationSmsBinding {
     address?: string;
 }
@@ -1346,33 +1310,51 @@ interface LastMessage {
     dateCreated?: Date;
 }
 /**
- * A conversation represents communication between multiple Conversations clients
+ * Conversation services.
+ */
+interface ConversationServices {
+    users: Users;
+    typingIndicator: TypingIndicator;
+    network: Network;
+    mcsClient: McsClient;
+    syncClient: SyncClient;
+    commandExecutor: CommandExecutor;
+}
+/**
+ * Conversation descriptor.
+ */
+interface ConversationDescriptor {
+    channel: string;
+    entityName: string;
+    uniqueName: string;
+    attributes: JSONValue;
+    createdBy?: string;
+    friendlyName?: string;
+    lastConsumedMessageIndex: number;
+    dateCreated: Date | null;
+    dateUpdated: Date | null;
+    notificationLevel?: NotificationLevel;
+    bindings?: ConversationBindings;
+}
+/**
+ * Conversation links.
+ */
+interface ConversationLinks {
+    self: string;
+    messages: string;
+    participants: string;
+}
+/**
+ * A conversation represents communication between multiple Conversations
+ * clients.
  */
 declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
-    /**
-     * Unique system identifier of the conversation.
-     */
-    readonly sid: string;
-    readonly links: ConversationLinks;
-    private readonly configuration;
-    private readonly services;
-    private channelState;
-    private statusSource;
-    private entityPromise;
-    private entityName;
-    private entity;
-    private messagesEntity;
-    private participantsEntity;
-    private readonly participants;
-    /**
-     * @internal
-     */
-    constructor(descriptor: ConversationDescriptor, sid: string, links: ConversationLinks, configuration: Configuration, services: ConversationServices);
     /**
      * Fired when a participant has joined the conversation.
      *
      * Parameters:
-     * 1. {@link Participant} `participant` - participant that joined the conversation
+     * 1. {@link Participant} `participant` - participant that joined the
+     * conversation
      * @event
      */
     static readonly participantJoined = "participantJoined";
@@ -1380,7 +1362,8 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when a participant has left the conversation.
      *
      * Parameters:
-     * 1. {@link Participant} `participant` - participant that left the conversation
+     * 1. {@link Participant} `participant` - participant that left the
+     * conversation
      * @event
      */
     static readonly participantLeft = "participantLeft";
@@ -1388,9 +1371,12 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when data of a participant has been updated.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
-     *     * {@link Participant} `participant` - participant that has received the update
-     *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons for update
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
+     *     * {@link Participant} `participant` - participant that has received the
+     *     update
+     *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons
+     *     for the update
      * @event
      */
     static readonly participantUpdated = "participantUpdated";
@@ -1414,9 +1400,11 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when data of a message has been updated.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * {@link Message} `message` - message that has received the update
-     *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for update
+     *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for
+     *     the update
      * @event
      */
     static readonly messageUpdated = "messageUpdated";
@@ -1424,7 +1412,8 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when a participant has stopped typing.
      *
      * Parameters:
-     * 1. {@link Participant} `participant` - the participant that has stopped typing
+     * 1. {@link Participant} `participant` - the participant that has stopped
+     * typing
      * @event
      */
     static readonly typingEnded = "typingEnded";
@@ -1432,7 +1421,8 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when a participant has started typing.
      *
      * Parameters:
-     * 1. {@link Participant} `participant` - the participant that has started typing
+     * 1. {@link Participant} `participant` - the participant that has started
+     * typing
      * @event
      */
     static readonly typingStarted = "typingStarted";
@@ -1440,20 +1430,87 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Fired when the data of the conversation has been updated.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
-     *     * {@link Conversation} `conversation` - conversation that has received the update
-     *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons for update
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
+     *     * {@link Conversation} `conversation` - conversation that has received
+     *     the update
+     *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons
+     *     for the update
      * @event
      */
     static readonly updated = "updated";
     /**
-     * Fired when the conversation was destroyed or the currently-logged-in user has left private conversation.
+     * Fired when the conversation was destroyed or the currently-logged-in user
+     * has left private conversation.
      *
      * Parameters:
      * 1. {@link Conversation} `conversation` - conversation that has been removed
      * @event
      */
     static readonly removed = "removed";
+    /**
+     * Logger instance.
+     */
+    private static readonly _logger;
+    /**
+     * Unique system identifier of the conversation.
+     */
+    readonly sid: string;
+    /**
+     * Conversation links for REST requests.
+     * @internal
+     */
+    readonly _links: ConversationLinks;
+    /**
+     * Map of participants.
+     * @internal
+     */
+    readonly _participants: Map<string, Participant>;
+    /**
+     * Configuration of the client that the conversation belongs to.
+     */
+    private readonly _configuration;
+    /**
+     * Conversation service objects.
+     */
+    private readonly _services;
+    /**
+     * Internal state of the conversation.
+     */
+    private readonly _internalState;
+    /**
+     * Name of the conversation entity document.
+     */
+    private readonly _entityName;
+    /**
+     * Messages entity.
+     */
+    private readonly _messagesEntity;
+    /**
+     * Participants entity.
+     */
+    private readonly _participantsEntity;
+    /**
+     * Source of the most recent update.
+     */
+    private _dataSource;
+    /**
+     * Promise for the conversation entity document.
+     */
+    private _entityPromise;
+    /**
+     * Conversation entity document.
+     */
+    private _entity;
+    /**
+     * @param descriptor Conversation descriptor.
+     * @param sid Conversation SID.
+     * @param links Conversation links for REST requests.
+     * @param configuration Client configuration.
+     * @param services Conversation services.
+     * @internal
+     */
+    constructor(descriptor: ConversationDescriptor, sid: string, links: ConversationLinks, configuration: Configuration, services: ConversationServices);
     /**
      * Unique name of the conversation.
      */
@@ -1494,6 +1551,10 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * User notification level for this conversation.
      */
     get notificationLevel(): NotificationLevel;
+    /**
+     * Conversation bindings. Undocumented feature (for now).
+     * @internal
+     */
     get bindings(): ConversationBindings;
     /**
      * Current conversation limits.
@@ -1504,65 +1565,38 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     get state(): ConversationState | undefined;
     /**
-     * Load and subscribe to this conversation and do not subscribe to its participants and messages.
-     * This or _subscribeStreams will need to be called before any events on conversation will fire.
-     * @internal
-     */
-    _subscribe(): Promise<void | SyncDocument>;
-    /**
-     * Load the attributes of this conversation and instantiate its participants and messages.
-     * This or _subscribe will need to be called before any events on the conversation will fire.
-     * This will need to be called before any events on participants or messages will fire
-     * @internal
-     */
-    _subscribeStreams(): Promise<void>;
-    /**
-     * Stop listening for and firing events on this conversation.
-     * @internal
-     */
-    _unsubscribe(): Promise<[
-        void,
-        void
-    ]>;
-    /**
-     * Set conversation status.
+     * Source of the conversation update.
      * @internal
      */
-    _setStatus(status: ConversationStatus, source: ConversationsDataSource): void;
+    get _statusSource(): ConversationsDataSource;
     /**
-     * Get the source of the conversation update.
-     * @internal
+     * Preprocess the update object.
+     * @param update The update object received from Sync.
+     * @param conversationSid The SID of the conversation in question.
      */
-    _statusSource(): ConversationsDataSource;
     private static preprocessUpdate;
-    /**
-     * Update the local conversation object with new values.
-     * @internal
-     */
-    _update(update: any): void;
-    /**
-     * @internal
-     */
-    private _onMessageAdded;
-    private _setLastReadMessageIndex;
     /**
      * Add a participant to the conversation by its identity.
      * @param identity Identity of the Client to add.
      * @param attributes Attributes to be attached to the participant.
+     * @returns The added participant.
      */
-    add(identity: string, attributes?: JSONValue): Promise<ParticipantResponse>;
+    add(identity: string, attributes?: JSONValue): Promise<Participant>;
     /**
      * Add a non-chat participant to the conversation.
      * @param proxyAddress Proxy (Twilio) address of the participant.
      * @param address User address of the participant.
      * @param attributes Attributes to be attached to the participant.
-     * @param bindingOptions Options for adding email participants - name and CC/To level.
+     * @param bindingOptions Options for adding email participants - name and
+     * CC/To level.
+     * @returns The added participant.
      */
-    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<ParticipantResponse>;
+    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<Participant>;
     /**
-     * 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 read message index is updated only if the new index value is higher than the previous.
+     * 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
+     * read message index is updated only if the new index value is higher than
+     * the previous.
      * @param index Message index to advance to.
      * @return Resulting unread messages count in the conversation.
      */
@@ -1577,10 +1611,13 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     getAttributes(): Promise<JSONValue>;
     /**
      * Returns messages from the conversation using the paginator interface.
-     * @param pageSize Number of messages to return in a single chunk. Default is 30.
-     * @param anchor Index of the newest message to fetch. Default is from the end.
-     * @param direction Query direction. By default it queries backwards
-     * from newer to older. The `"forward"` value will query in the opposite direction.
+     * @param pageSize Number of messages to return in a single chunk. Default is
+     * 30.
+     * @param anchor Index of the newest message to fetch. Default is from the
+     * end.
+     * @param direction Query direction. By default, it queries backwards
+     * from newer to older. The `"forward"` value will query in the opposite
+     * direction.
      * @return A page of messages.
      */
     getMessages(pageSize?: number, anchor?: number, direction?: "backwards" | "forward"): Promise<Paginator<Message>>;
@@ -1591,12 +1628,13 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     /**
      * Get conversation participants count.
      *
-     * 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 Conversations system does not
-     * provide real time events for counter values changes.
+     * 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
+     * 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.
+     * 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.
      */
     getParticipantsCount(): Promise<number>;
     /**
@@ -1612,28 +1650,30 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     /**
      * Get the total message count in the conversation.
      *
-     * 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 Conversations system does not
-     * provide real time events for counter values changes.
+     * 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
+     * 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.
+     * 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.
      */
     getMessagesCount(): Promise<number>;
     /**
-     * Get unread messages count for the user if they are a participant of this conversation.
-     * Rejects if the user is not a participant of the conversation.
+     * Get unread messages count 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
      * {@link Conversation.updateLastReadMessageIndex} instead of relying on the
      * 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 Conversations system does not
-     * provide real time events for counter values changes.
+     * 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
+     * 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.
+     * 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.
      */
     getUnreadMessagesCount(): Promise<number | null>;
     /**
@@ -1655,7 +1695,8 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     /**
      * Send a message to the conversation.
      * @param message Message body for the text message,
-     * `FormData` or {@link SendMediaOptions} for media content. Sending FormData is supported only with the browser engine.
+     * `FormData` or {@link SendMediaOptions} for media content. Sending FormData
+     * is supported only with the browser engine.
      * @param messageAttributes Attributes for the message.
      * @param emailOptions Email options for the message.
      * @return Index of the new message.
@@ -1663,12 +1704,13 @@ 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 instead of `sendMessage`.
+     * Use this instead of {@link Message.sendMessage}.
      * @return A MessageBuilder to help set all message sending options.
      */
     prepareMessage(): MessageBuilder;
     /**
-     * Set last read message index of the conversation to the index of the last known message.
+     * Set last read message index of the conversation to the index of the last
+     * known message.
      * @return Resulting unread messages count in the conversation.
      */
     setAllMessagesRead(): Promise<number>;
@@ -1683,8 +1725,10 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     setUserNotificationLevel(notificationLevel: NotificationLevel): Promise<void>;
     /**
-     * Send a notification to the server indicating that this client is currently typing in this conversation.
-     * Typing ended notification is sent after a while automatically, but by calling this method again you ensure that typing ended is not received.
+     * Send a notification to the server indicating that this client is currently
+     * typing in this conversation. Typing ended notification is sent after a
+     * while automatically, but by calling this method again you ensure that
+     * typing ended is not received.
      */
     typing(): Promise<void>;
     /**
@@ -1699,21 +1743,61 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     updateFriendlyName(friendlyName: string): Promise<Conversation>;
     /**
      * 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}.
+     * @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.
      */
     updateLastReadMessageIndex(index: number | null): Promise<number>;
     /**
      * Update the unique name of the conversation.
-     * @param uniqueName New unique name for the conversation. Setting unique name to null removes it.
+     * @param uniqueName New unique name for the conversation. Setting unique name
+     * to null removes it.
      */
     updateUniqueName(uniqueName: string | null): Promise<Conversation>;
+    /**
+     * Load and subscribe to this conversation and do not subscribe to its
+     * participants and messages. This or _subscribeStreams will need to be called
+     * before any events on conversation will fire.
+     * @internal
+     */
+    _subscribe(): Promise<SyncDocument>;
+    /**
+     * Load the attributes of this conversation and instantiate its participants
+     * and messages. This or _subscribe will need to be called before any events
+     * on the conversation will fire. This will need to be called before any
+     * events on participants or messages will fire
+     * @internal
+     */
+    _subscribeStreams(): Promise<void>;
+    /**
+     * Stop listening for and firing events on this conversation.
+     * @internal
+     */
+    _unsubscribe(): Promise<[
+        void,
+        void
+    ]>;
+    /**
+     * Set conversation status.
+     * @internal
+     */
+    _setStatus(status: ConversationStatus, source: ConversationsDataSource): void;
+    /**
+     * Update the local conversation object with new values.
+     * @internal
+     */
+    _update(update: any): void;
+    /**
+     * Handle onMessageAdded event.
+     */
+    private _onMessageAdded;
+    /**
+     * Set last read message index.
+     * @param index New index to set.
+     */
+    private _setLastReadMessageIndex;
 }
-type ConversationsDataSource = "sync" | "chat" | "rest";
-/**
- * Push notification type.
- */
+type ConversationsDataSource = "sync" | "rest";
 type PushNotificationType = "twilio.conversations.new_message" | "twilio.conversations.added_to_conversation" | "twilio.conversations.removed_from_conversation";
 interface PushNotificationDescriptor {
     title: string | null;
@@ -1732,6 +1816,10 @@ interface PushNotificationData {
      * SID of the conversation.
      */
     conversationSid?: string;
+    /**
+     * Title of the conversation.
+     */
+    conversationTitle?: string;
     /**
      * Index of the message in the conversation.
      */
@@ -1740,6 +1828,14 @@ interface PushNotificationData {
      * SID of the message in the conversation.
      */
     messageSid?: string;
+    /**
+     * Media of the notification
+     */
+    media?: Media;
+    /**
+     * Amount of the attached media of the message.
+     */
+    mediaCount?: number;
 }
 /**
  * Push notification for a Conversations client.
@@ -1778,6 +1874,9 @@ declare class PushNotification {
      */
     constructor(data: PushNotificationDescriptor);
 }
+/**
+ * Client events.
+ */
 type ClientEvents = {
     conversationAdded: (conversation: Conversation) => void;
     conversationJoined: (conversation: Conversation) => void;
@@ -1799,7 +1898,7 @@ type ClientEvents = {
         message: Message;
         updateReasons: MessageUpdateReason[];
     }) => void;
-    tokenAboutToExpire: (ttl: number) => void;
+    tokenAboutToExpire: () => void;
     tokenExpired: () => void;
     typingEnded: (participant: Participant) => void;
     typingStarted: (participant: Participant) => void;
@@ -1810,22 +1909,22 @@ type ClientEvents = {
         user: User;
         updateReasons: UserUpdateReason[];
     }) => void;
-    stateChanged: (state: State) => void;
-    connectionStateChanged: (state: TwilsockConnectionState) => void;
-    connectionError: (data: {
-        terminal: boolean;
-        message: string;
-        httpStatusCode?: number;
-        errorCode?: number;
+    stateChanged: ({ state, error }: {
+        state: State;
+        error?: ConnectionError;
     }) => void;
+    connectionStateChanged: (state: TwilsockConnectionState) => void;
+    connectionError: (data: ConnectionError) => void;
 };
 /**
  * Connection state of the client. Possible values are as follows:
  * * `'connecting'` - client is offline and connection attempt is in process
  * * `'connected'` - client is online and ready
  * * `'disconnecting'` - client is going offline as disconnection is in process
- * * `'disconnected'` - client is offline and no connection attempt is in process
- * * `'denied'` - client connection is denied because of invalid JWT access token. User must refresh token in order to proceed
+ * * `'disconnected'` - client is offline and no connection attempt is in
+ * process
+ * * `'denied'` - client connection is denied because of invalid JWT access
+ * token. User must refresh token in order to proceed
  */
 type ConnectionState = TwilsockConnectionState;
 /**
@@ -1840,6 +1939,9 @@ type State = "failed" | "initialized";
  * * `'apn'`
  */
 type NotificationsChannelType = ChannelType;
+/**
+ * Level of logging.
+ */
 type LogLevel = "trace" | "debug" | "info" | "warn" | "error" | "silent";
 /**
  * Conversations client options.
@@ -1894,43 +1996,9 @@ interface CreateConversationOptions {
  */
 declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
-     * Client connection state.
-     */
-    connectionState: ConnectionState;
-    private conversationsPromise;
-    private _ensureReady;
-    private _resolveEnsureReady;
-    private _rejectEnsureReady;
-    private fpaToken;
-    private configuration;
-    private conversations;
-    private readonly options;
-    private services;
-    private readonly _myself;
-    /**
-     * Current version of the Conversations client.
-     */
-    static readonly version: string;
-    /**
-     * Current version of the Conversations client.
-     */
-    readonly version: string;
-    private static readonly supportedPushChannels;
-    private static readonly supportedPushDataFields;
-    /**
-     * Returned Conversations instance is not yet fully initialized. Calling any operations will block until it is.
-     * Use connection events to monitor when client becomes fully available (connectionStateChanged with state
-     * 'connected') or not available (connectionStateChange with state 'denied', event tokenExpired, event connectionError).
-     *
-     * @param fpaToken Access token
-     * @param options Options to customize the Client
-     * @returns A not yet fully-initialized client.
-     */
-    constructor(fpaToken: string, options?: ClientOptions | null);
-    static populateInitRegistrations(reg: InitRegistration): void;
-    /**
-     * Fired when a conversation becomes visible to the client. The event is also triggered when the client creates a new conversation.
-     * Fired for all conversations client has joined.
+     * Fired when a conversation becomes visible to the client. The event is also
+     * triggered when the client creates a new conversation.
+     * Fired for all conversations that the client has joined.
      *
      * Parameters:
      * 1. {@link Conversation} `conversation` - the conversation in question
@@ -1962,14 +2030,17 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static readonly conversationRemoved = "conversationRemoved";
     /**
-     * Fired when the attributes or the metadata of a conversation have been updated.
-     * During conversation's creation and initialization, this event might be fired multiple times
-     * for same joined or created conversation as new data is arriving from different sources.
+     * Fired when the attributes or the metadata of a conversation have been
+     * updated. During conversation's creation and initialization, this event
+     * might be fired multiple times for same joined or created conversation as
+     * new data is arriving from different sources.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * {@link Conversation} `conversation` - the conversation in question
-     *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons for the update
+     *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons
+     *     for the update
      * @event
      */
     static readonly conversationUpdated = "conversationUpdated";
@@ -1993,9 +2064,11 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Fired when a participant's fields have been updated.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * {@link Participant} `participant` - the participant in question
-     *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons for the update
+     *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons
+     *     for the update
      * @event
      */
     static readonly participantUpdated = "participantUpdated";
@@ -2019,16 +2092,16 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Fired when the fields of an existing message are updated with new values.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * {@link Message} `message` - the message in question
-     *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for the update
+     *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for
+     *     the update
      * @event
      */
     static readonly messageUpdated = "messageUpdated";
     /**
      * Fired when the token is about to expire and needs to be updated.
-     * * Parameters:
-     * 1. number `message` - token's time to live
      * @event
      */
     static readonly tokenAboutToExpire = "tokenAboutToExpire";
@@ -2054,10 +2127,12 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static readonly typingStarted = "typingStarted";
     /**
-     * Fired when the client has received (and parsed) a push notification via one of the push channels (apn or fcm).
+     * Fired when the client has received (and parsed) a push notification via one
+     * of the push channels (apn or fcm).
      *
      * Parameters:
-     * 1. {@link PushNotification} `pushNotification` - the push notification in question
+     * 1. {@link PushNotification} `pushNotification` - the push notification in
+     * question
      * @event
      */
     static readonly pushNotification = "pushNotification";
@@ -2078,12 +2153,15 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static readonly userUnsubscribed = "userUnsubscribed";
     /**
-     * Fired when the properties or the reachability status of a user have been updated.
+     * Fired when the properties or the reachability status of a user have been
+     * updated.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * {@link User} `user` - the user in question
-     *     * {@link UserUpdateReason}[] `updateReasons` - array of reasons for the update
+     *     * {@link UserUpdateReason}[] `updateReasons` - array of reasons for the
+     *     update
      * @event
      */
     static readonly userUpdated = "userUpdated";
@@ -2091,14 +2169,17 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Fired when the state of the client has been changed.
      *
      * Parameters:
-     * 1. {@link State} `state` - the new client state
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
+     *     * {@link State} `state` - the new client state
+     *     * Error? `error` - the initialization error if present
      * @event
      */
     static readonly stateChanged = "stateChanged";
     /**
      * Fired when the connection state of the client has been changed.
      *
-     * Paremeters:
+     * Parameters:
      * 1. {@link ConnectionState} `state` - the new connection state
      * @event
      */
@@ -2107,7 +2188,8 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Fired when the connection is interrupted for an unexpected reason.
      *
      * Parameters:
-     * 1. object `data` - info object provided with the event. It has the following properties:
+     * 1. object `data` - info object provided with the event. It has the
+     * following properties:
      *     * boolean `terminal` - Twilsock will stop connection attempts if true
      *     * string `message` - the error message of the root cause
      *     * number? `httpStatusCode` - http status code if available
@@ -2115,6 +2197,93 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @event
      */
     static readonly connectionError = "connectionError";
+    /**
+     * Current version of the Conversations client.
+     */
+    static readonly version: string;
+    /**
+     * Logger instance.
+     */
+    private static readonly _logger;
+    /**
+     * Supported push notification channels.
+     */
+    private static readonly _supportedPushChannels;
+    /**
+     * Supported push data fields.
+     */
+    private static readonly _supportedPushDataFields;
+    /**
+     * Current version of the Conversations client.
+     */
+    readonly version: string;
+    /**
+     * Client connection state.
+     */
+    connectionState: ConnectionState;
+    /**
+     * Promise that resolves on successful initialization.
+     */
+    private readonly _ensureReady;
+    /**
+     * Options passed to the client.
+     */
+    private readonly _options;
+    /**
+     * Client service objects.
+     */
+    private readonly _services;
+    /**
+     * The user of the client.
+     */
+    private readonly _myself;
+    /**
+     * Resolves the {@link Client._ensureReady} promise.
+     */
+    private _resolveEnsureReady;
+    /**
+     * Rejects the {@link Client._ensureReady} promise.
+     */
+    private _rejectEnsureReady;
+    /**
+     * The current token of the client.
+     */
+    private _fpaToken;
+    /**
+     * The constructed configuration object.
+     */
+    private _configuration;
+    /**
+     * The Conversations entity.
+     */
+    private _conversationsEntity;
+    /**
+     * Promise that resolves when initial conversations are fetched.
+     */
+    private _conversationsPromise;
+    /**
+     * Returned Conversations instance is not yet fully initialized. Calling any
+     * operations will block until it is. Use connection events to monitor when
+     * client becomes fully available (connectionStateChanged with state
+     * 'connected') or not available (connectionStateChange with state 'denied',
+     * event tokenExpired, event connectionError).
+     *
+     * @param fpaToken Access token
+     * @param options Options to customize the Client
+     * @returns A not yet fully-initialized client.
+     */
+    constructor(fpaToken: string, options?: ClientOptions | null);
+    /**
+     * Information of the logged-in user. Before client initialization, returns an
+     * uninitialized user. Will trigger a {@link Client.userUpdated} event after
+     * initialization.
+     */
+    get user(): User;
+    /**
+     * Client reachability state. Throws an error if accessed before the client
+     * initialization was completed.
+     */
+    get reachabilityEnabled(): boolean;
     /**
      * @deprecated Call constructor directly.
      *
@@ -2136,20 +2305,21 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     static create(token: string, options?: ClientOptions | null): Promise<Client>;
     /**
-     * Information of the logged-in user. Before client initialization, returns an
-     * uninitialized user. Will trigger a {@link Client.userUpdated} event after
-     * initialization.
+     * Static method for push notification payload parsing. Returns parsed push as
+     * a {@link PushNotification} object.
+     * @param notificationPayload Push notification payload.
      */
-    get user(): User;
+    static parsePushNotification(notificationPayload: any): PushNotification;
     /**
-     * Client reachability state. Throws if accessed before the client
-     * initialization was completed.
+     * Static method for parsing push notification chat data.
+     * @param data Data to parse
      */
-    get reachabilityEnabled(): boolean;
-    get token(): string;
-    private _subscribeToPushNotifications;
-    private _unsubscribeFromPushNotifications;
-    private _initialize;
+    private static _parsePushNotificationChatData;
+    /**
+     * Populate the client with init registrations.
+     * @param reg The init registration to populate.
+     */
+    static populateInitRegistrations(reg: InitRegistration): void;
     /**
      * Gracefully shut down the client.
      */
@@ -2164,6 +2334,12 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param conversationSid Conversation sid
      */
     getConversationBySid(conversationSid: string): Promise<Conversation>;
+    /**
+     * Peek a conversation by its SID.
+     * @param conversationSid Conversation sid
+     * @internal
+     */
+    peekConversationBySid(conversationSid: string): Promise<Conversation>;
     /**
      * Get a known conversation by its unique identifier name.
      * @param uniqueName The unique identifier name of the conversation.
@@ -2182,7 +2358,8 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
      * Register for push notifications.
      * @param channelType Channel type.
-     * @param registrationId Push notification ID provided by the FCM/APNS service on the platform.
+     * @param registrationId Push notification ID provided by the FCM/APNS service
+     * on the platform.
      */
     setPushRegistrationId(channelType: NotificationsChannelType, registrationId: string): Promise<void>;
     /**
@@ -2195,27 +2372,29 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Clear existing registrations directly using provided device token.
      * This is useful to ensure stopped subscriptions without resubscribing.
      *
-     * This function goes completely beside the state machine and removes all registrations.
-     * Use with caution: if it races with current state machine operations, madness will ensue.
+     * This function goes completely beside the state machine and removes all
+     * registrations.
+     * Use with caution: if it races with current state machine operations,
+     * madness will ensue.
      *
      * @param channelType Channel type.
-     * @param registrationId Push notification ID provided by the FCM/APNS service on the platform.
+     * @param registrationId Push notification ID provided by the FCM/APNS service
+     * on the platform.
      */
     removePushRegistrations(channelType: ChannelType, registrationId: string): Promise<void>;
-    private static parsePushNotificationChatData;
     /**
-     * Static method for push notification payload parsing. Returns parsed push as a {@link PushNotification} object.
-     * @param notificationPayload Push notification payload.
+     * Current version of the Conversations client.
      */
-    static parsePushNotification(notificationPayload: any): PushNotification;
     parsePushNotification: typeof Client.parsePushNotification;
     /**
-     * Handle push notification payload parsing and emit the {@link Client.pushNotification} event on this {@link Client} instance.
+     * Handle push notification payload parsing and emit the
+     * {@link Client.pushNotification} event on this {@link Client} instance.
      * @param notificationPayload Push notification payload
      */
     handlePushNotification(notificationPayload: any): Promise<void>;
     /**
-     * Gets a user with the given identity. If it's in the subscribed list, then return the user object from it;
+     * Gets a user with the given identity. If it's in the subscribed list, then
+     * return the user object from it;
      * if not, then subscribe and add user to the subscribed list.
      * @param identity Identity of the user.
      * @returns A fully initialized user.
@@ -2225,6 +2404,32 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * Get a list of subscribed user objects.
      */
     getSubscribedUsers(): Promise<Array<User>>;
+    /**
+     * Get content URLs for all media attachments in the given set of media sids
+     * using a single operation.
+     * @param mediaSids Set of media sids to query for the content URL.
+     */
+    getTemporaryContentUrlsForMediaSids(mediaSids: string[]): CancellablePromise<Map<string, string>>;
+    /**
+     * 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.
+     */
+    getTemporaryContentUrlsForMedia(contentSet: Media[]): CancellablePromise<Map<string, string>>;
+    /**
+     * Initialize the client.
+     */
+    private _initialize;
+    /**
+     * Subscribe to push notifications.
+     * @param channelType The channel type to subscribe to.
+     */
+    private _subscribeToPushNotifications;
+    /**
+     * Unsubscribe from push notifications.
+     * @param channelType The channel type to unsubscribe from.
+     */
+    private _unsubscribeFromPushNotifications;
 }
 declare class NotificationTypes {
     static readonly TYPING_INDICATOR = "twilio.ipmsg.typing_indicator";