@twilio/conversations 2.3.1-rc.0 → 2.4.0-rc.1

package/builds/lib.d.ts

@@ -110,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 {
@@ -344,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[];
@@ -1180,6 +1182,33 @@ declare class ContentTemplate {
      */
     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;
@@ -1190,6 +1219,7 @@ interface MessageServices {
     mcsClient: McsClient;
     network: Network;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 interface MessageLinks {
     self: string;
@@ -1223,6 +1253,7 @@ interface MessageData {
     media?: Media;
     memberSid?: string;
     delivery?: AggregatedDeliveryDescriptor;
+    channelMetadata?: boolean;
 }
 /**
  * A message in a conversation.
@@ -1395,6 +1426,11 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * {@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.
@@ -1557,6 +1593,7 @@ interface MessagesServices {
     network: Network;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Represents the collection of messages in a conversation
@@ -1851,6 +1888,7 @@ interface ConversationServices {
     mcsClient: McsClient;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Conversation descriptor.
@@ -2507,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;
@@ -3023,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, ContentDataActionUrl, ContentDataActionPhone, ContentDataActionReply, ContentDataActionOther, ContentDataAction, ContentDataText, ContentDataMedia, ContentDataLocation, ContentDataReply, ContentDataQuickReply, ContentDataCallToAction, ContentDataListPicker, ContentDataListItem, ContentDataCard, ContentDataOther, ContentData, ContentTemplate, ContentTemplateVariable };
+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 };