@twilio/conversations 3.0.1-rc.102 → 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;
@@ -111,6 +109,7 @@ declare class Configuration {
     readonly userInfo: string;
     readonly myConversations: string;
     readonly channelMetadataCacheCapacity: number;
+    readonly messageRecipientsCacheCapacity: number;
     constructor(options: ClientOptions, configurationResponse: ConfigurationResponse, logger: Logger);
 }
 interface CommandExecutorServices {
@@ -523,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;
 }
@@ -543,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.
      */
@@ -573,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.
@@ -1209,6 +1205,118 @@ declare class ChannelMetadataClient {
     constructor(services: ChannelMetadataClientServices, configuration: Configuration);
     getChannelMetadata(conversationSid: string, messageSid: string): Promise<ChannelMetadata | null>;
 }
+type MessageRecipient = {
+    message_sid: string;
+    type: "email"; // discriminant for future expansion
+    level: "to" | "from" | "cc";
+    name: string;
+    address: string;
+};
+/**
+ * Pagination helper interface.
+ * @typeParam T The item type.
+ */
+interface Paginator<T> {
+    /**
+     * Indicates the existence of the next page.
+     */
+    hasNextPage: boolean;
+    /**
+     * Indicates the existence of the previous page.
+     */
+    hasPrevPage: boolean;
+    /**
+     * Array of elements of type T on the current page.
+     */
+    items: T[];
+    /**
+     * Request next page.
+     * Does not modify the existing object.
+     */
+    nextPage(): Promise<Paginator<T>>;
+    /**
+     * Request previous page.
+     * Does not modify the existing object.
+     */
+    prevPage(): Promise<Paginator<T>>;
+}
+interface PaginatorOptions {
+    pageSize?: number;
+}
+type MessageRecipientsClientServices = {
+    commandExecutor: CommandExecutor;
+};
+/**
+ * Message recipient descriptor.
+ */
+type RecipientDescriptor = EmailRecipientDescriptor | UnknownRecipientDescriptor;
+/**
+ * Email recipient level.
+ */
+type EmailRecipientLevel = "to" | "from" | "cc";
+/**
+ * Email recipient descriptor.
+ */
+declare class EmailRecipientDescriptor {
+    /**
+     * Type of recipient.
+     */
+    readonly type = "email";
+    /**
+     * Sid of the message that this recipient belongs to.
+     */
+    readonly messageSid: string;
+    /**
+     * Email recipient level.
+     */
+    readonly level: EmailRecipientLevel;
+    /**
+     * Name of the recipient.
+     */
+    readonly name: string;
+    /**
+     * Address of the recipient.
+     */
+    readonly address: string;
+    /**
+     * @internal
+     */
+    constructor(recipient: MessageRecipient);
+}
+/**
+ * Unknown recipient descriptor. Used to be able to handle recipient types that
+ * are not supported by the current version of the SDK.
+ */
+declare class UnknownRecipientDescriptor {
+    /**
+     * Type of recipient.
+     */
+    readonly type: string;
+    /**
+     * Sid of the message that this recipient belongs to.
+     */
+    readonly messageSid: string;
+    /**
+     * Recipient data as a JSON string.
+     */
+    readonly rawData: string;
+    /**
+     * @internal
+     */
+    constructor(recipient: MessageRecipient);
+}
+declare class MessageRecipientsClient {
+    private readonly _services;
+    private readonly _configuration;
+    private readonly _cache;
+    constructor(services: MessageRecipientsClientServices, configuration: Configuration);
+    getRecipientsFromMessage(conversationSid: string, messageSid: string): Promise<RecipientDescriptor[]>;
+    getRecipientsFromConversation(conversationSid: string, paginatorOptions?: {
+        pageToken?: string;
+        pageSize?: number;
+    }): Promise<Paginator<RecipientDescriptor>>;
+    private _wrapResponse;
+}
 type MessageEvents = {
     updated: (data: {
         message: Message;
@@ -1220,6 +1328,7 @@ interface MessageServices {
     network: Network;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 interface MessageLinks {
     self: string;
@@ -1229,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 {
@@ -1259,6 +1368,7 @@ interface MessageData {
  * A message in a conversation.
  */
 declare class Message extends ReplayEventEmitter<MessageEvents> {
+    #private;
     /**
      * Conversation that the message is in.
      */
@@ -1431,34 +1541,10 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * the message doesn't have any channel metadata.
      */
     getChannelMetadata(): Promise<ChannelMetadata | null>;
-}
-/**
- * Pagination helper interface.
- * @typeParam T The item type.
- */
-interface Paginator<T> {
-    /**
-     * Indicates the existence of the next page.
-     */
-    hasNextPage: boolean;
-    /**
-     * Indicates the existence of the previous page.
-     */
-    hasPrevPage: boolean;
     /**
-     * Array of elements of type T on the current page.
+     * Get recipients of the message.
      */
-    items: T[];
-    /**
-     * Request next page.
-     * Does not modify the existing object.
-     */
-    nextPage(): Promise<Paginator<T>>;
-    /**
-     * Request previous page.
-     * Does not modify the existing object.
-     */
-    prevPage(): Promise<Paginator<T>>;
+    getMessageRecipients(): Promise<RecipientDescriptor[]>;
 }
 interface TypingIndicatorServices {
     twilsockClient: TwilsockClient;
@@ -1594,6 +1680,7 @@ interface MessagesServices {
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 /**
  * Represents the collection of messages in a conversation
@@ -1889,6 +1976,7 @@ interface ConversationServices {
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 /**
  * Conversation descriptor.
@@ -2031,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.
      */
@@ -2060,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.
      */
@@ -2076,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.
      */
@@ -2130,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;
@@ -2337,10 +2429,15 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * to null removes it.
      */
     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(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>;
@@ -2353,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
@@ -2549,6 +2646,10 @@ interface ClientOptions {
      * The cache capacity for channel metadata.
      */
     channelMetadataCacheCapacity?: number;
+    /**
+     * The cache capacity for message recipients.
+     */
+    messageRecipientsCacheCapacity?: number;
     region?: string;
     productId?: string;
     twilsockClient?: TwilsockClient;
@@ -2571,6 +2672,7 @@ interface ClientOptions {
     disableDeepClone?: boolean;
     typingUri?: string;
     apiUri?: string;
+    throwErrorsAlways?: boolean;
 }
 type ConnectionError = {
     terminal: boolean;
@@ -2592,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.
@@ -2839,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.
      */
@@ -2877,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',
@@ -2958,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>;
     /**
@@ -3004,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;
     /**
@@ -3056,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";
@@ -3065,4 +3175,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, ContentDataActionUrl, ContentDataActionPhone, ContentDataActionReply, ContentDataActionOther, ContentDataAction, ContentDataText, ContentDataMedia, ContentDataLocation, ContentDataReply, ContentDataQuickReply, ContentDataCallToAction, ContentDataListPicker, ContentDataListItem, ContentDataCard, ContentDataOther, ContentData, ContentTemplate, ContentTemplateVariable, ChannelMetadata };
+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, RecipientDescriptor, EmailRecipientDescriptor, UnknownRecipientDescriptor, EmailRecipientLevel };