@twilio/conversations 2.0.1-rc.6 → 2.1.0-rc.0

package/builds/lib.d.ts

@@ -292,6 +292,7 @@ interface ParticipantDescriptor {
     lastConsumptionTimestamp: number;
     type: ParticipantType;
     userInfo: string;
+    bindings?: Object;
 }
 interface ParticipantServices {
     users: Users;
@@ -303,15 +304,35 @@ interface ParticipantLinks {
 /**
  * The reason for the `updated` event being emitted by a participant.
  */
-type ParticipantUpdateReason = "attributes" | "dateCreated" | "dateUpdated" | "roleSid" | "lastReadMessageIndex" | "lastReadTimestamp";
+type ParticipantUpdateReason = "attributes" | "dateCreated" | "dateUpdated" | "roleSid" | "lastReadMessageIndex" | "lastReadTimestamp" | "bindings";
 /**
  * Type of a participant.
  */
-type ParticipantType = "chat" | "sms" | "whatsapp";
+type ParticipantType = "chat" | "sms" | "whatsapp" | "email";
 interface ParticipantUpdatedEventArgs {
     participant: Participant;
     updateReasons: ParticipantUpdateReason[];
 }
+/**
+ * Bindings for conversation participant.
+ */
+interface ParticipantBindings {
+    email?: ParticipantEmailBinding;
+}
+/**
+ * Email participation level.
+ * to = to/from
+ * cc = cc
+ */
+type ParticipantEmailLevel = "to" | "cc";
+/**
+ * Bindings for email participant.
+ */
+interface ParticipantEmailBinding {
+    name: string;
+    address: string;
+    level: ParticipantEmailLevel;
+}
 /**
  * A participant represents a remote client in a conversation.
  */
@@ -360,9 +381,19 @@ declare class Participant extends ReplayEventEmitter<ParticipantEvents> {
     get lastReadTimestamp(): Date;
     get roleSid(): string;
     /**
-     * Message type of the participant.
+     * Type of the participant.
      */
     get type(): ParticipantType;
+    /**
+     * Get the bindings mapping for the current participant.
+     * Available binding depends on the participant type.
+     * You could access it as `participant.bindings.sms?.address` or
+     * using the type dynamically `participant.bindings[participant.type]`
+     * just be aware that the binding information has different structure for
+     * each participant type.
+     * See also {ParticipantEmailBinding}, the only available currently binding descriptor.
+     */
+    get bindings(): ParticipantBindings;
     /**
      * @internal
      */
@@ -422,6 +453,9 @@ declare class Participant extends ReplayEventEmitter<ParticipantEvents> {
      */
     updateAttributes(attributes: any): Promise<Participant>;
 }
+interface ParticipantBindingOptions {
+    email?: ParticipantEmailBinding;
+}
 /**
  * Category of media. Possible values are as follows:
  * * `'media'`
@@ -730,14 +764,14 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      */
     get attributes(): Object;
     /**
-     * Push notification type of the message.
+     * Type of the message.
      */
     get type(): MessageType;
     /**
-     * One of the attached media.
+     * One of the attached media (if present).
      * @deprecated Use attachedMedia instead. Note that the latter is now an array.
      */
-    get media(): Media;
+    get media(): Media | null;
     /**
      * Return all media attachments, except email body/history attachments, without temporary urls.
      */
@@ -757,6 +791,18 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * @returns Array of media descriptors matching given categories.
      */
     getMediaByCategory(categories: Array<MediaCategory>): Array<Media> | null;
+    /**
+     * Get a media descriptor for an email body attachment of a provided type.
+     * Allowed body types are returned in the Conversation.limits().emailBodiesAllowedMimeTypes array.
+     * @param type Type of email body to request, defaults to `text/plain`.
+     */
+    getEmailBody(type?: string): Media | null;
+    /**
+     * Get a media descriptor for an email history attachment of a provided type.
+     * Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedMimeTypes array.
+     * @param type Type of email history to request, defaults to `text/plain`.
+     */
+    getEmailHistory(type?: string): Media | null;
     _update(data: any): void;
     /**
      * Get the participant who is the author of the message.
@@ -897,6 +943,8 @@ declare class UnsentMessage {
 declare class MessageBuilder {
     private readonly limits;
     private readonly message;
+    private emailBodies;
+    private emailHistories;
     /**
      * @internal
      */
@@ -916,6 +964,18 @@ declare class MessageBuilder {
      * @param attributes Message attributes.
      */
     setAttributes(attributes: any): MessageBuilder;
+    /**
+     * Set email body with given MIME-type.
+     * @param mimeType Format of the body to set (text/plain or text/html).
+     * @param body Body payload in selected format.
+     */
+    setEmailBody(mimeType: string, body: FormData | SendMediaOptions): MessageBuilder;
+    /**
+     * Set email history with given MIME-type.
+     * @param mimeType Format of the history to set (text/plain or text/html).
+     * @param history History payload in selected format.
+     */
+    setEmailHistory(mimeType: string, history: FormData | SendMediaOptions): MessageBuilder;
     /**
      * Adds media to the message.
      * @param payload Media to add.
@@ -967,6 +1027,7 @@ interface ConversationDescriptor {
     dateCreated: any;
     dateUpdated: any;
     notificationLevel?: NotificationLevel;
+    bindings?: ConversationBindings;
 }
 interface ConversationLinks {
     self: string;
@@ -976,7 +1037,7 @@ interface ConversationLinks {
 /**
  * The reason for the `updated` event being emitted by a conversation.
  */
-type ConversationUpdateReason = "attributes" | "createdBy" | "dateCreated" | "dateUpdated" | "friendlyName" | "lastReadMessageIndex" | "state" | "status" | "uniqueName" | "lastMessage" | "notificationLevel";
+type ConversationUpdateReason = "attributes" | "createdBy" | "dateCreated" | "dateUpdated" | "friendlyName" | "lastReadMessageIndex" | "state" | "status" | "uniqueName" | "lastMessage" | "notificationLevel" | "bindings";
 /**
  * The status of the conversation, relative to the client: whether
  * the conversation has been `joined` or the client is
@@ -1007,6 +1068,19 @@ interface ConversationUpdatedEventArgs {
     conversation: Conversation;
     updateReasons: ConversationUpdateReason[];
 }
+/**
+ * Binding for email conversation.
+ */
+interface ConversationBindings {
+    email?: ConversationEmailBinding;
+}
+/**
+ * Binding for email conversation.
+ */
+interface ConversationEmailBinding {
+    name?: string;
+    projected_address: string;
+}
 /**
  * Configuration for attaching a media file to a message.
  * These options can be passed to {@link Conversation.sendMessage} and
@@ -1197,6 +1271,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * User notification level for this conversation.
      */
     get notificationLevel(): NotificationLevel;
+    get bindings(): ConversationBindings;
     get limits(): Limits;
     /**
      * State of the conversation.
@@ -1255,8 +1330,9 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @param proxyAddress Proxy (Twilio) address of the participant.
      * @param address User address of the participant.
      * @param attributes Attributes to be attached to the participant.
+     * @param bindingOptions Options for adding email participants - name and CC/To level.
      */
-    addNonChatParticipant(proxyAddress: string, address: string, attributes?: any): Promise<void>;
+    addNonChatParticipant(proxyAddress: string, address: string, attributes?: Record<string, any>, bindingOptions?: ParticipantBindingOptions): Promise<void>;
     /**
      * Advance the conversation's last read message index to the current read horizon.
      * Rejects if the user is not a participant of the conversation.
@@ -1360,6 +1436,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
     /**
      * New interface to prepare for sending a message.
      * Use instead of `sendMessage`.
+     * @return A MessageBuilder to help set all message sending options.
      */
     prepareMessage(): MessageBuilder;
     /**
@@ -1957,4 +2034,4 @@ declare class NotificationTypes {
     static readonly REMOVED_FROM_CONVERSATION = "twilio.conversations.removed_from_conversation";
     static readonly CONSUMPTION_UPDATE = "twilio.channel.consumption_update";
 }
-export { Conversation, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions };
+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 };