@twilio/conversations 2.4.1 → 2.5.0-rc.8

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";
@@ -110,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 {
@@ -1205,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;
@@ -1216,6 +1328,7 @@ interface MessageServices {
     network: Network;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 interface MessageLinks {
     self: string;
@@ -1428,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.
-     */
-    items: T[];
     /**
-     * Request next page.
-     * Does not modify the existing object.
+     * Get recipients of the message.
      */
-    nextPage(): Promise<Paginator<T>>;
-    /**
-     * Request previous page.
-     * Does not modify the existing object.
-     */
-    prevPage(): Promise<Paginator<T>>;
+    getMessageRecipients(): Promise<RecipientDescriptor[]>;
 }
 interface TypingIndicatorServices {
     twilsockClient: TwilsockClient;
@@ -1522,7 +1611,7 @@ declare class RestPaginator<T> implements Paginator<T> {
     /**
      * @internal
      */
-    constructor(items: any, source: any, prevToken: any, nextToken: any);
+    constructor(items: any, source: any, prevToken: any, nextToken: any, pageSize: any);
     /**
      * Request the next page. Does not modify the existing object.
      */
@@ -1591,6 +1680,7 @@ interface MessagesServices {
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 /**
  * Represents the collection of messages in a conversation
@@ -1886,6 +1976,7 @@ interface ConversationServices {
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
     channelMetadataClient: ChannelMetadataClient;
+    messageRecipientsClient: MessageRecipientsClient;
 }
 /**
  * Conversation descriptor.
@@ -2334,10 +2425,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>;
@@ -2546,6 +2642,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;
@@ -3062,4 +3162,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 };