@twilio/conversations 3.0.1-rc.103 → 3.0.1

package/builds/lib.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { SyncClient, SyncDocument, SyncList } from "twilio-sync";
 import { LogLevelDesc } from "loglevel";
 import { Transport, TwilsockClient, InitRegistration, TransportResult } from "twilsock";
@@ -6,8 +5,7 @@ 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 { CancellablePromise, McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
-import { MediaCategory as McsMediaCategory } from "@twilio/mcs-client";
+import { CancellablePromise, McsClient, MediaCategory, McsMedia, McsMediaCategory, McsMediaState } from "@twilio/mcs-client";
 interface ConfigurationResponse {
     options: {
         consumption_report_interval: string;
@@ -524,13 +522,6 @@ interface ParticipantBindingOptions {
  * * `'history'`
  */
 type MediaCategory$0 = McsMediaCategory;
-interface MediaState {
-    sid: string;
-    category: MediaCategory$0;
-    filename: string | null;
-    contentType: string;
-    size: number;
-}
 interface MediaServices {
     mcsClient: McsClient;
 }
@@ -544,7 +535,7 @@ declare class Media {
     /**
      * @internal
      */
-    constructor(data: MediaState | McsMedia, services: MediaServices);
+    constructor(data: McsMediaState | McsMedia, services: MediaServices);
     /**
      * Server-assigned unique identifier for the media.
      */
@@ -574,6 +565,10 @@ declare class Media {
      */
     getContentTemporaryUrl(): CancellablePromise<string | null>;
     private _fetchMcsMedia;
+    /**
+     * @internal
+     */
+    _state(): McsMediaState;
 }
 /**
  * Signifies the amount of participants which have the status for the message.
@@ -1245,6 +1240,9 @@ interface Paginator<T> {
      */
     prevPage(): Promise<Paginator<T>>;
 }
+interface PaginatorOptions {
+    pageSize?: number;
+}
 type MessageRecipientsClientServices = {
     commandExecutor: CommandExecutor;
 };
@@ -1315,7 +1313,7 @@ declare class MessageRecipientsClient {
     getRecipientsFromMessage(conversationSid: string, messageSid: string): Promise<RecipientDescriptor[]>;
     getRecipientsFromConversation(conversationSid: string, paginatorOptions?: {
         pageToken?: string;
-        pageSize?: string;
+        pageSize?: number;
     }): Promise<Paginator<RecipientDescriptor>>;
     private _wrapResponse;
 }
@@ -1340,9 +1338,9 @@ interface MessageLinks {
 /**
  * The reason for the `updated` event being emitted by a message.
  */
-type MessageUpdateReason = "body" | "lastUpdatedBy" | "dateCreated" | "dateUpdated" | "attributes" | "author" | "deliveryReceipt" | "subject";
+type MessageUpdateReason = "body" | "lastUpdatedBy" | "dateCreated" | "dateUpdated" | "attributes" | "author" | "deliveryReceipt" | "subject" | "media";
 /**
- * Type of a message.
+ * Type of message.
  */
 type MessageType = "text" | "media";
 interface MessageUpdatedEventArgs {
@@ -1370,6 +1368,7 @@ interface MessageData {
  * A message in a conversation.
  */
 declare class Message extends ReplayEventEmitter<MessageEvents> {
+    #private;
     /**
      * Conversation that the message is in.
      */
@@ -2120,11 +2119,6 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @internal
      */
     readonly _links: ConversationLinks;
-    /**
-     * Map of participants.
-     * @internal
-     */
-    readonly _participants: Map<string, Participant>;
     /**
      * Configuration of the client that the conversation belongs to.
      */
@@ -2149,6 +2143,11 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Sync list containing messages.
      */
     private _messagesList?;
+    /**
+     * Map of participants.
+     * @internal
+     */
+    readonly _participants: Map<string, Participant>;
     /**
      * Participants entity.
      */
@@ -2165,6 +2164,10 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * Promise for the conversation entity document.
      */
     private _entityPromise;
+    /**
+     * Promise for the messages list.
+     */
+    private _streamsPromise;
     /**
      * Conversation entity document.
      */
@@ -2219,7 +2222,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      */
     get notificationLevel(): NotificationLevel;
     /**
-     * Conversation bindings. Undocumented feature (for now).
+     * Conversation bindings. An undocumented feature (for now).
      * @internal
      */
     get bindings(): ConversationBindings;
@@ -2428,12 +2431,13 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     updateUniqueName(uniqueName: string | null): Promise<Conversation>;
     /**
      * Get recipients of all messages in the conversation.
+     * @param options Optional configuration, set pageSize to request a specific pagination page size. Page size specifies a number of messages to include in a single batch. Each message may include multiple recipients.
      */
-    getMessageRecipients(): Promise<Paginator<RecipientDescriptor>>;
+    getMessageRecipients(options?: PaginatorOptions): Promise<Paginator<RecipientDescriptor>>;
     /**
      * 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.
+     * before any events in the conversation will fire.
      * @internal
      */
     _subscribe(): Promise<SyncDocument>;
@@ -2446,7 +2450,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * will throw an exception that will be caught and handled gracefully.
      * @internal
      */
-    _fetchStreams(): Promise<void>;
+    _fetchStreams(): Promise<boolean>;
     /**
      * Load the attributes of this conversation and instantiate its participants
      * and messages. This or _subscribe will need to be called before any events
@@ -2668,6 +2672,7 @@ interface ClientOptions {
     disableDeepClone?: boolean;
     typingUri?: string;
     apiUri?: string;
+    throwErrorsAlways?: boolean;
 }
 type ConnectionError = {
     terminal: boolean;
@@ -2689,6 +2694,11 @@ interface CreateConversationOptions {
      * A unique identifier of the conversation.
      */
     uniqueName?: string;
+    /**
+     * The access control for the conversation.
+     * null for existing conversations, 'restricted' for conversations that need to support users with restricted access
+     */
+    access?: string;
 }
 /**
  * A client is the starting point to the Twilio Conversations functionality.
@@ -2936,7 +2946,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
      * Promise that resolves on successful initialization.
      */
-    private readonly _ensureReady;
+    private _ensureReady;
     /**
      * Options passed to the client.
      */
@@ -2974,7 +2984,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     private _conversationsPromise;
     /**
-     * Returned Conversations instance is not yet fully initialized. Calling any
+     * Returned Conversations Client 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',
@@ -3055,7 +3065,6 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
      * Peek a conversation by its SID.
      * @param conversationSid Conversation sid
-     * @internal
      */
     peekConversationBySid(conversationSid: string): Promise<Conversation>;
     /**
@@ -3101,7 +3110,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      */
     removePushRegistrations(channelType: ChannelType, registrationId: string): Promise<void>;
     /**
-     * Current version of the Conversations client.
+     * Parse a push notification payload.
      */
     parsePushNotification: typeof Client.parsePushNotification;
     /**
@@ -3153,6 +3162,10 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param channelType The channel type to unsubscribe from.
      */
     private _unsubscribeFromPushNotifications;
+    /**
+     * Initialize the ensureReady promise.
+     */
+    private _initializeEnsureReady;
 }
 declare class NotificationTypes {
     static readonly TYPING_INDICATOR = "twilio.ipmsg.typing_indicator";