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

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 {
@@ -1180,6 +1181,21 @@ declare class ContentTemplate {
      */
     constructor(contentTemplateResponse: ContentTemplateResponse);
 }
+type ChannelMetadataClientServices = {
+    commandExecutor: CommandExecutor;
+};
+declare class ChannelMetadata {
+    readonly type: string;
+    readonly data: unknown;
+    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 +1206,7 @@ interface MessageServices {
     mcsClient: McsClient;
     network: Network;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 interface MessageLinks {
     self: string;
@@ -1223,6 +1240,7 @@ interface MessageData {
     media?: Media;
     memberSid?: string;
     delivery?: AggregatedDeliveryDescriptor;
+    channelMetadata?: boolean;
 }
 /**
  * A message in a conversation.
@@ -1395,6 +1413,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 +1580,7 @@ interface MessagesServices {
     network: Network;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Represents the collection of messages in a conversation
@@ -1851,6 +1875,7 @@ interface ConversationServices {
     mcsClient: McsClient;
     syncClient: SyncClient;
     commandExecutor: CommandExecutor;
+    channelMetadataClient: ChannelMetadataClient;
 }
 /**
  * Conversation descriptor.
@@ -2507,6 +2532,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;