@twilio/conversations 2.0.1-rc.9 → 2.1.0-rc.5

package/dist/conversation.js

@@ -137,6 +137,7 @@ var participant = require('./participant.js');
 var messages = require('./data/messages.js');
 var index = require('./util/index.js');
 var declarativeTypeValidator = require('@twilio/declarative-type-validator');
+var attributes = require('./interfaces/attributes.js');
 var messageBuilder = require('./message-builder.js');
 var replayEventEmitter = require('@twilio/replay-event-emitter');
 var isEqual = require('lodash.isequal');
@@ -145,20 +146,21 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
 
-const log = logger.Logger.scope('Conversation');
+const log = logger.Logger.scope("Conversation");
 const fieldMappings = {
-    lastMessage: 'lastMessage',
-    attributes: 'attributes',
-    createdBy: 'createdBy',
-    dateCreated: 'dateCreated',
-    dateUpdated: 'dateUpdated',
-    friendlyName: 'friendlyName',
-    lastConsumedMessageIndex: 'lastConsumedMessageIndex',
-    notificationLevel: 'notificationLevel',
-    sid: 'sid',
-    status: 'status',
-    uniqueName: 'uniqueName',
-    state: 'state'
+    lastMessage: "lastMessage",
+    attributes: "attributes",
+    createdBy: "createdBy",
+    dateCreated: "dateCreated",
+    dateUpdated: "dateUpdated",
+    friendlyName: "friendlyName",
+    lastConsumedMessageIndex: "lastConsumedMessageIndex",
+    notificationLevel: "notificationLevel",
+    sid: "sid",
+    status: "status",
+    uniqueName: "uniqueName",
+    state: "state",
+    bindings: "bindings",
 };
 function parseTime(timeString) {
     try {
@@ -176,96 +178,130 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @internal
      */
     constructor(descriptor, sid, links, configuration, services) {
+        var _a;
         super();
         this.sid = sid;
         this.links = links;
         this.configuration = configuration;
         this.services = services;
-        let attributes = descriptor.attributes || {};
-        let createdBy = descriptor.createdBy;
-        let dateCreated = parseTime(descriptor.dateCreated);
-        let dateUpdated = parseTime(descriptor.dateUpdated);
-        let friendlyName = descriptor.friendlyName || null;
-        let lastReadMessageIndex = Number.isInteger(descriptor.lastConsumedMessageIndex) ? descriptor.lastConsumedMessageIndex : null;
-        let uniqueName = descriptor.uniqueName || null;
+        const attributes = descriptor.attributes || {};
+        const createdBy = descriptor.createdBy;
+        const dateCreated = parseTime(descriptor.dateCreated);
+        const dateUpdated = parseTime(descriptor.dateUpdated);
+        const friendlyName = descriptor.friendlyName || null;
+        const lastReadMessageIndex = Number.isInteger(descriptor.lastConsumedMessageIndex)
+            ? descriptor.lastConsumedMessageIndex
+            : null;
+        const uniqueName = descriptor.uniqueName || null;
         try {
             JSON.stringify(attributes);
         }
         catch (e) {
-            throw new Error('Attributes must be a valid JSON object.');
+            throw new Error("Attributes must be a valid JSON object.");
         }
         this.entityName = descriptor.channel;
         this.channelState = {
             uniqueName,
-            status: 'notParticipating',
+            status: "notParticipating",
             attributes,
             createdBy,
             dateCreated,
             dateUpdated,
             friendlyName,
-            lastReadMessageIndex: lastReadMessageIndex
+            lastReadMessageIndex,
+            bindings: (_a = descriptor.bindings) !== null && _a !== void 0 ? _a : {},
         };
         if (descriptor.notificationLevel) {
             this.channelState.notificationLevel = descriptor.notificationLevel;
         }
         const participantsLinks = {
-            participants: this.links.participants
+            participants: this.links.participants,
         };
         this.participants = new Map();
         this.participantsEntity = new participants.Participants(this, this.participants, participantsLinks, this.configuration, this.services);
-        this.participantsEntity.on('participantJoined', this.emit.bind(this, 'participantJoined'));
-        this.participantsEntity.on('participantLeft', this.emit.bind(this, 'participantLeft'));
-        this.participantsEntity.on('participantUpdated', (args) => this.emit('participantUpdated', args));
+        this.participantsEntity.on("participantJoined", (participant) => this.emit("participantJoined", participant));
+        this.participantsEntity.on("participantLeft", (participant) => this.emit("participantLeft", participant));
+        this.participantsEntity.on("participantUpdated", (args) => this.emit("participantUpdated", args));
         this.messagesEntity = new messages.Messages(this, configuration, services);
-        this.messagesEntity.on('messageAdded', message => this._onMessageAdded(message));
-        this.messagesEntity.on('messageUpdated', (args) => this.emit('messageUpdated', args));
-        this.messagesEntity.on('messageRemoved', this.emit.bind(this, 'messageRemoved'));
+        this.messagesEntity.on("messageAdded", (message) => this._onMessageAdded(message));
+        this.messagesEntity.on("messageUpdated", (args) => this.emit("messageUpdated", args));
+        this.messagesEntity.on("messageRemoved", (message) => this.emit("messageRemoved", message));
     }
     /**
      * Unique name of the conversation.
      */
-    get uniqueName() { return this.channelState.uniqueName; }
+    get uniqueName() {
+        return this.channelState.uniqueName;
+    }
     /**
      * Status of the conversation.
      */
-    get status() { return this.channelState.status; }
+    get status() {
+        return this.channelState.status;
+    }
     /**
      * Name of the conversation.
      */
-    get friendlyName() { return this.channelState.friendlyName; }
+    get friendlyName() {
+        return this.channelState.friendlyName;
+    }
     /**
      * Date this conversation was last updated on.
      */
-    get dateUpdated() { return this.channelState.dateUpdated; }
+    get dateUpdated() {
+        return this.channelState.dateUpdated;
+    }
     /**
      * Date this conversation was created on.
      */
-    get dateCreated() { return this.channelState.dateCreated; }
+    get dateCreated() {
+        return this.channelState.dateCreated;
+    }
     /**
      * Identity of the user that created this conversation.
      */
-    get createdBy() { return this.channelState.createdBy; }
+    get createdBy() {
+        var _a;
+        return (_a = this.channelState.createdBy) !== null && _a !== void 0 ? _a : "";
+    }
     /**
      * Custom attributes of the conversation.
      */
-    get attributes() { return this.channelState.attributes; }
+    get attributes() {
+        return this.channelState.attributes;
+    }
     /**
      * Index of the last message the user has read in this conversation.
      */
-    get lastReadMessageIndex() { return this.channelState.lastReadMessageIndex; }
+    get lastReadMessageIndex() {
+        return this.channelState.lastReadMessageIndex;
+    }
     /**
      * Last message sent to this conversation.
      */
-    get lastMessage() { return this.channelState.lastMessage; }
+    get lastMessage() {
+        var _a;
+        return (_a = this.channelState.lastMessage) !== null && _a !== void 0 ? _a : undefined;
+    }
     /**
      * User notification level for this conversation.
      */
-    get notificationLevel() { return this.channelState.notificationLevel; }
-    get limits() { return this.configuration.limits; }
+    get notificationLevel() {
+        var _a;
+        return (_a = this.channelState.notificationLevel) !== null && _a !== void 0 ? _a : "default";
+    }
+    get bindings() {
+        return this.channelState.bindings;
+    }
+    get limits() {
+        return this.configuration.limits;
+    }
     /**
      * State of the conversation.
      */
-    get state() { return this.channelState.state; }
+    get state() {
+        return this.channelState.state;
+    }
     /**
      * 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.
@@ -273,23 +309,27 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      */
     _subscribe() {
         var _a;
-        return this.entityPromise = (_a = this.entityPromise) !== null && _a !== void 0 ? _a : this.services.syncClient.document({ id: this.entityName, mode: 'open_existing' })
-            .then(entity => {
-            this.entity = entity;
-            this.entity.on('updated', args => { this._update(args.data); });
-            this.entity.on('removed', () => this.emit('removed', this));
-            this._update(this.entity.data);
-            return entity;
-        })
-            .catch(err => {
-            this.entity = null;
-            this.entityPromise = null;
-            if (this.services.syncClient.connectionState != 'disconnected') {
-                log.error('Failed to get conversation object', err);
-            }
-            log.debug('ERROR: Failed to get conversation object', err);
-            throw err;
-        });
+        return (this.entityPromise =
+            (_a = this.entityPromise) !== null && _a !== void 0 ? _a : this.services.syncClient
+                .document({ id: this.entityName, mode: "open_existing" })
+                .then((entity) => {
+                this.entity = entity;
+                this.entity.on("updated", (args) => {
+                    this._update(args.data);
+                });
+                this.entity.on("removed", () => this.emit("removed", this));
+                this._update(this.entity.data);
+                return entity;
+            })
+                .catch((err) => {
+                this.entity = null;
+                this.entityPromise = null;
+                if (this.services.syncClient.connectionState != "disconnected") {
+                    log.error("Failed to get conversation object", err);
+                }
+                log.debug("ERROR: Failed to get conversation object", err);
+                throw err;
+            }));
     }
     /**
      * Load the attributes of this conversation and instantiate its participants and messages.
@@ -298,21 +338,24 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @internal
      */
     async _subscribeStreams() {
+        var _a, _b, _c;
         try {
             await this._subscribe();
-            log.trace('_subscribeStreams, this.entity.data=', this.entity.data);
-            const messagesObjectName = this.entity.data.messages;
-            const rosterObjectName = this.entity.data.roster;
+            log.trace("_subscribeStreams, this.entity.data=", (_a = this.entity) === null || _a === void 0 ? void 0 : _a.data);
+            const messagesObjectName = ((_b = this.entity) === null || _b === void 0 ? void 0 : _b.data)
+                .messages;
+            const rosterObjectName = ((_c = this.entity) === null || _c === void 0 ? void 0 : _c.data)
+                .roster;
             await Promise.all([
                 this.messagesEntity.subscribe(messagesObjectName),
-                this.participantsEntity.subscribe(rosterObjectName)
+                this.participantsEntity.subscribe(rosterObjectName),
             ]);
         }
         catch (err) {
-            if (this.services.syncClient.connectionState !== 'disconnected') {
-                log.error('Failed to subscribe on conversation objects', this.sid, err);
+            if (this.services.syncClient.connectionState !== "disconnected") {
+                log.error("Failed to subscribe on conversation objects", this.sid, err);
             }
-            log.debug('ERROR: Failed to subscribe on conversation objects', this.sid, err);
+            log.debug("ERROR: Failed to subscribe on conversation objects", this.sid, err);
             throw err;
         }
     }
@@ -328,7 +371,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
         }
         return Promise.all([
             this.participantsEntity.unsubscribe(),
-            this.messagesEntity.unsubscribe()
+            this.messagesEntity.unsubscribe(),
         ]);
     }
     /**
@@ -341,19 +384,18 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             return;
         }
         this.channelState.status = status;
-        if (status === 'joined') {
-            this._subscribeStreams()
-                .catch(err => {
-                log.debug('ERROR while setting conversation status ' + status, err);
-                if (this.services.syncClient.connectionState !== 'disconnected') {
+        if (status === "joined") {
+            this._subscribeStreams().catch((err) => {
+                log.debug("ERROR while setting conversation status " + status, err);
+                if (this.services.syncClient.connectionState !== "disconnected") {
                     throw err;
                 }
             });
         }
         else if (this.entityPromise) {
-            this._unsubscribe().catch(err => {
-                log.debug('ERROR while setting conversation status ' + status, err);
-                if (this.services.syncClient.connectionState !== 'disconnected') {
+            this._unsubscribe().catch((err) => {
+                log.debug("ERROR while setting conversation status " + status, err);
+                if (this.services.syncClient.connectionState !== "disconnected") {
                     throw err;
                 }
             });
@@ -368,7 +410,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
     }
     static preprocessUpdate(update, conversationSid) {
         try {
-            if (typeof update.attributes === 'string') {
+            if (typeof update.attributes === "string") {
                 update.attributes = JSON.parse(update.attributes);
             }
             else if (update.attributes) {
@@ -376,7 +418,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
         }
         catch (e) {
-            log.warn('Retrieved malformed attributes from the server for conversation: ' + conversationSid);
+            log.warn("Retrieved malformed attributes from the server for conversation: " +
+                conversationSid);
             update.attributes = {};
         }
         try {
@@ -385,7 +428,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
         }
         catch (e) {
-            log.warn('Retrieved malformed dateCreated from the server for conversation: ' + conversationSid);
+            log.warn("Retrieved malformed dateCreated from the server for conversation: " +
+                conversationSid);
             delete update.dateCreated;
         }
         try {
@@ -394,7 +438,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
         }
         catch (e) {
-            log.warn('Retrieved malformed dateUpdated from the server for conversation: ' + conversationSid);
+            log.warn("Retrieved malformed dateUpdated from the server for conversation: " +
+                conversationSid);
             delete update.dateUpdated;
         }
         try {
@@ -403,7 +448,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
         }
         catch (e) {
-            log.warn('Retrieved malformed lastMessage.timestamp from the server for conversation: ' + conversationSid);
+            log.warn("Retrieved malformed lastMessage.timestamp from the server for conversation: " +
+                conversationSid);
             delete update.lastMessage.timestamp;
         }
     }
@@ -413,7 +459,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      */
     _update(update) {
         var _a, _b, _c, _d, _e;
-        log.trace('_update', update);
+        log.trace("_update", update);
         Conversation.preprocessUpdate(update, this.sid);
         const updateReasons = new Set();
         for (const key of Object.keys(update)) {
@@ -423,8 +469,9 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
             switch (localKey) {
                 case fieldMappings.status:
-                    if (!update.status || update.status === 'unknown'
-                        || this.channelState.status === update.status) {
+                    if (!update.status ||
+                        update.status === "unknown" ||
+                        this.channelState.status === update.status) {
                         break;
                     }
                     this.channelState.status = update.status;
@@ -438,12 +485,14 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
                     updateReasons.add(localKey);
                     break;
                 case fieldMappings.lastConsumedMessageIndex:
-                    if (update.lastConsumedMessageIndex === undefined
-                        || update.lastConsumedMessageIndex === this.channelState.lastReadMessageIndex) {
+                    if (update.lastConsumedMessageIndex === undefined ||
+                        update.lastConsumedMessageIndex ===
+                            this.channelState.lastReadMessageIndex) {
                         break;
                     }
-                    this.channelState.lastReadMessageIndex = update.lastConsumedMessageIndex;
-                    updateReasons.add('lastReadMessageIndex');
+                    this.channelState.lastReadMessageIndex =
+                        update.lastConsumedMessageIndex;
+                    updateReasons.add("lastReadMessageIndex");
                     break;
                 case fieldMappings.lastMessage:
                     if (this.channelState.lastMessage && !update.lastMessage) {
@@ -452,14 +501,16 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
                         break;
                     }
                     this.channelState.lastMessage = this.channelState.lastMessage || {};
-                    if (((_a = update.lastMessage) === null || _a === void 0 ? void 0 : _a.index) !== undefined
-                        && update.lastMessage.index !== this.channelState.lastMessage.index) {
+                    if (((_a = update.lastMessage) === null || _a === void 0 ? void 0 : _a.index) !== undefined &&
+                        update.lastMessage.index !== this.channelState.lastMessage.index) {
                         this.channelState.lastMessage.index = update.lastMessage.index;
                         updateReasons.add(localKey);
                     }
-                    if (((_b = update.lastMessage) === null || _b === void 0 ? void 0 : _b.timestamp) !== undefined
-                        && ((_d = (_c = this.channelState.lastMessage) === null || _c === void 0 ? void 0 : _c.dateCreated) === null || _d === void 0 ? void 0 : _d.getTime()) !== update.lastMessage.timestamp.getTime()) {
-                        this.channelState.lastMessage.dateCreated = update.lastMessage.timestamp;
+                    if (((_b = update.lastMessage) === null || _b === void 0 ? void 0 : _b.timestamp) !== undefined &&
+                        ((_d = (_c = this.channelState.lastMessage) === null || _c === void 0 ? void 0 : _c.dateCreated) === null || _d === void 0 ? void 0 : _d.getTime()) !==
+                            update.lastMessage.timestamp.getTime()) {
+                        this.channelState.lastMessage.dateCreated =
+                            update.lastMessage.timestamp;
                         updateReasons.add(localKey);
                     }
                     if (isEqual__default['default'](this.channelState.lastMessage, {})) {
@@ -477,9 +528,17 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
                     this.channelState.state = state;
                     updateReasons.add(localKey);
                     break;
+                case fieldMappings.bindings:
+                    if (isEqual__default['default'](this.channelState.bindings, update.bindings)) {
+                        break;
+                    }
+                    this.channelState.bindings = update.bindings;
+                    updateReasons.add(localKey);
+                    break;
                 default:
                     const isDate = update[key] instanceof Date;
-                    const keysMatchAsDates = isDate && ((_e = this.channelState[localKey]) === null || _e === void 0 ? void 0 : _e.getTime()) === update[key].getTime();
+                    const keysMatchAsDates = isDate &&
+                        ((_e = this.channelState[localKey]) === null || _e === void 0 ? void 0 : _e.getTime()) === update[key].getTime();
                     const keysMatchAsNonDates = !isDate && this[localKey] === update[key];
                     if (keysMatchAsDates || keysMatchAsNonDates) {
                         break;
@@ -489,24 +548,27 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             }
         }
         if (updateReasons.size > 0) {
-            this.emit('updated', { conversation: this, updateReasons: [...updateReasons] });
+            this.emit("updated", {
+                conversation: this,
+                updateReasons: [...updateReasons],
+            });
         }
     }
     /**
      * @internal
      */
     _onMessageAdded(message) {
-        for (let participant of this.participants.values()) {
+        for (const participant of this.participants.values()) {
             if (participant.identity === message.author) {
                 participant._endTyping();
                 break;
             }
         }
-        this.emit('messageAdded', message);
+        this.emit("messageAdded", message);
     }
     async _setLastReadMessageIndex(index) {
-        const result = await this.services.commandExecutor.mutateResource('post', `${this.configuration.links.myConversations}/${this.sid}`, {
-            last_read_message_index: index
+        const result = await this.services.commandExecutor.mutateResource("post", `${this.configuration.links.myConversations}/${this.sid}`, {
+            last_read_message_index: index,
         });
         return result.unread_messages_count;
     }
@@ -516,16 +578,17 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @param attributes Attributes to be attached to the participant.
      */
     async add(identity, attributes) {
-        return this.participantsEntity.add(identity, attributes);
+        return this.participantsEntity.add(identity, attributes !== null && attributes !== void 0 ? attributes : {});
     }
     /**
      * Add a non-chat participant to the conversation.
      * @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.
      */
-    async addNonChatParticipant(proxyAddress, address, attributes) {
-        return this.participantsEntity.addNonChatParticipant(proxyAddress, address, attributes);
+    async addNonChatParticipant(proxyAddress, address, attributes = {}, bindingOptions = {}) {
+        return this.participantsEntity.addNonChatParticipant(proxyAddress, address, attributes !== null && attributes !== void 0 ? attributes : {}, bindingOptions !== null && bindingOptions !== void 0 ? bindingOptions : {});
     }
     /**
      * Advance the conversation's last read message index to the current read horizon.
@@ -536,7 +599,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      */
     async advanceLastReadMessageIndex(index) {
         await this._subscribeStreams();
-        if (index < this.lastReadMessageIndex) {
+        if (index < (this.lastReadMessageIndex || 0)) {
             return await this._setLastReadMessageIndex(this.lastReadMessageIndex);
         }
         return await this._setLastReadMessageIndex(index);
@@ -545,7 +608,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * Delete the conversation and unsubscribe from its events.
      */
     async delete() {
-        await this.services.commandExecutor.mutateResource('delete', this.links.self);
+        await this.services.commandExecutor.mutateResource("delete", this.links.self);
         return this;
     }
     /**
@@ -585,11 +648,12 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * logic based on these counters being accurate in real time.
      */
     async getParticipantsCount() {
+        var _a;
         const url = new index.UriBuilder(this.configuration.links.conversations)
             .path(this.sid)
             .build();
         const response = await this.services.network.get(url);
-        return response.body.participants_count;
+        return (_a = response.body.participants_count) !== null && _a !== void 0 ? _a : 0;
     }
     /**
      * Get a participant by its SID.
@@ -602,8 +666,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * Get a participant by its identity.
      * @param identity Participant identity.
      */
-    async getParticipantByIdentity(identity) {
-        return this.participantsEntity.getParticipantByIdentity(identity);
+    async getParticipantByIdentity(identity = "") {
+        return this.participantsEntity.getParticipantByIdentity(identity !== null && identity !== void 0 ? identity : "");
     }
     /**
      * Get the total message count in the conversation.
@@ -616,11 +680,12 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * logic based on these counters being accurate in real time.
      */
     async getMessagesCount() {
+        var _a;
         const url = new index.UriBuilder(this.configuration.links.conversations)
             .path(this.sid)
             .build();
         const response = await this.services.network.get(url);
-        return response.body.messages_count;
+        return (_a = response.body.messages_count) !== null && _a !== void 0 ? _a : 0;
     }
     /**
      * Get unread messages count for the user if they are a participant of this conversation.
@@ -643,10 +708,10 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
             .build();
         const response = await this.services.network.get(url);
         if (response.body.conversation_sid !== this.sid) {
-            throw new Error('Conversation was not found in the user conversations list');
+            throw new Error("Conversation was not found in the user conversations list");
         }
         const unreadMessageCount = response.body.unread_messages_count;
-        if (typeof unreadMessageCount === 'number') {
+        if (typeof unreadMessageCount === "number") {
             return unreadMessageCount;
         }
         return null;
@@ -655,8 +720,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * Join the conversation and subscribe to its events.
      */
     async join() {
-        await this.services.commandExecutor.mutateResource('post', this.links.participants, {
-            identity: this.configuration.userIdentity
+        await this.services.commandExecutor.mutateResource("post", this.links.participants, {
+            identity: this.configuration.userIdentity,
         });
         return this;
     }
@@ -664,8 +729,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * Leave the conversation.
      */
     async leave() {
-        if (this.channelState.status === 'joined') {
-            await this.services.commandExecutor.mutateResource('delete', `${this.links.participants}/${this.configuration.userIdentity}`);
+        if (this.channelState.status === "joined") {
+            await this.services.commandExecutor.mutateResource("delete", `${this.links.participants}/${this.configuration.userIdentity}`);
         }
         return this;
     }
@@ -674,10 +739,10 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * argument, it will assume that the string is an identity or SID.
      * @param participant Identity, SID or the participant object to remove.
      */
+    /* eslint-disable @typescript-eslint/ban-ts-comment */
+    // @ts-ignore TODO: fix validateTypesAsync typing
     async removeParticipant(participant) {
-        await this.participantsEntity.remove(typeof participant === 'string'
-            ? participant
-            : participant.sid);
+        await this.participantsEntity.remove(typeof participant === "string" ? participant : participant.sid);
     }
     /**
      * Send a message to the conversation.
@@ -688,16 +753,18 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @return Index of the new message.
      */
     async sendMessage(message, messageAttributes, emailOptions) {
-        if (typeof message === 'string' || message === null) {
-            let response = await this.messagesEntity.send(message, messageAttributes, emailOptions);
-            return index.parseToNumber(response.index);
+        var _a, _b;
+        if (typeof message === "string" || message === null) {
+            const response = await this.messagesEntity.send(message, messageAttributes, emailOptions);
+            return (_a = index.parseToNumber(response.index)) !== null && _a !== void 0 ? _a : 0;
         }
-        let response = await this.messagesEntity.sendMedia(message, messageAttributes, emailOptions);
-        return index.parseToNumber(response.index);
+        const response = await this.messagesEntity.sendMedia(message, messageAttributes, emailOptions);
+        return (_b = index.parseToNumber(response.index)) !== null && _b !== void 0 ? _b : 0;
     }
     /**
      * New interface to prepare for sending a message.
      * Use instead of `sendMessage`.
+     * @return A MessageBuilder to help set all message sending options.
      */
     prepareMessage() {
         return new messageBuilder.MessageBuilder(this.limits, this.messagesEntity);
@@ -708,7 +775,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      */
     async setAllMessagesRead() {
         await this._subscribeStreams();
-        let messagesPage = await this.getMessages(1);
+        const messagesPage = await this.getMessages(1);
         if (messagesPage.items.length > 0) {
             return this.advanceLastReadMessageIndex(messagesPage.items[0].index);
         }
@@ -727,8 +794,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @param notificationLevel New user notification level.
      */
     async setUserNotificationLevel(notificationLevel) {
-        await this.services.commandExecutor.mutateResource('post', `${this.configuration.links.myConversations}/${this.sid}`, {
-            notification_level: notificationLevel
+        await this.services.commandExecutor.mutateResource("post", `${this.configuration.links.myConversations}/${this.sid}`, {
+            notification_level: notificationLevel,
         });
     }
     /**
@@ -743,8 +810,8 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      * @param attributes New attributes.
      */
     async updateAttributes(attributes) {
-        await this.services.commandExecutor.mutateResource('post', this.links.self, {
-            attributes: attributes !== undefined ? JSON.stringify(attributes) : undefined
+        await this.services.commandExecutor.mutateResource("post", this.links.self, {
+            attributes: attributes !== undefined ? JSON.stringify(attributes) : undefined,
         });
         return this;
     }
@@ -754,7 +821,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
      */
     async updateFriendlyName(friendlyName) {
         if (this.channelState.friendlyName !== friendlyName) {
-            await this.services.commandExecutor.mutateResource('post', this.links.self, { friendly_name: friendlyName });
+            await this.services.commandExecutor.mutateResource("post", this.links.self, { friendly_name: friendlyName });
         }
         return this;
     }
@@ -775,10 +842,10 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
     async updateUniqueName(uniqueName) {
         if (this.channelState.uniqueName !== uniqueName) {
             if (!uniqueName) {
-                uniqueName = '';
+                uniqueName = "";
             }
-            await this.services.commandExecutor.mutateResource('post', this.links.self, {
-                unique_name: uniqueName
+            await this.services.commandExecutor.mutateResource("post", this.links.self, {
+                unique_name: uniqueName,
             });
         }
         return this;
@@ -791,7 +858,7 @@ class Conversation extends replayEventEmitter.ReplayEventEmitter {
  * 1. {@link Participant} `participant` - participant that joined the conversation
  * @event
  */
-Conversation.participantJoined = 'participantJoined';
+Conversation.participantJoined = "participantJoined";
 /**
  * Fired when a participant has left the conversation.
  *
@@ -799,7 +866,7 @@ Conversation.participantJoined = 'participantJoined';
  * 1. {@link Participant} `participant` - participant that left the conversation
  * @event
  */
-Conversation.participantLeft = 'participantLeft';
+Conversation.participantLeft = "participantLeft";
 /**
  * Fired when data of a participant has been updated.
  *
@@ -809,7 +876,7 @@ Conversation.participantLeft = 'participantLeft';
  *     * {@link ParticipantUpdateReason}[] `updateReasons` - array of reasons for update
  * @event
  */
-Conversation.participantUpdated = 'participantUpdated';
+Conversation.participantUpdated = "participantUpdated";
 /**
  * Fired when a new message has been added to the conversation.
  *
@@ -817,7 +884,7 @@ Conversation.participantUpdated = 'participantUpdated';
  * 1. {@link Message} `message` - message that has been added
  * @event
  */
-Conversation.messageAdded = 'messageAdded';
+Conversation.messageAdded = "messageAdded";
 /**
  * Fired when message is removed from the conversation's message list.
  *
@@ -825,7 +892,7 @@ Conversation.messageAdded = 'messageAdded';
  * 1. {@link Message} `message` - message that has been removed
  * @event
  */
-Conversation.messageRemoved = 'messageRemoved';
+Conversation.messageRemoved = "messageRemoved";
 /**
  * Fired when data of a message has been updated.
  *
@@ -835,7 +902,7 @@ Conversation.messageRemoved = 'messageRemoved';
  *     * {@link MessageUpdateReason}[] `updateReasons` - array of reasons for update
  * @event
  */
-Conversation.messageUpdated = 'messageUpdated';
+Conversation.messageUpdated = "messageUpdated";
 /**
  * Fired when a participant has stopped typing.
  *
@@ -843,7 +910,7 @@ Conversation.messageUpdated = 'messageUpdated';
  * 1. {@link Participant} `participant` - the participant that has stopped typing
  * @event
  */
-Conversation.typingEnded = 'typingEnded';
+Conversation.typingEnded = "typingEnded";
 /**
  * Fired when a participant has started typing.
  *
@@ -851,7 +918,7 @@ Conversation.typingEnded = 'typingEnded';
  * 1. {@link Participant} `participant` - the participant that has started typing
  * @event
  */
-Conversation.typingStarted = 'typingStarted';
+Conversation.typingStarted = "typingStarted";
 /**
  * Fired when the data of the conversation has been updated.
  *
@@ -861,7 +928,7 @@ Conversation.typingStarted = 'typingStarted';
  *     * {@link ConversationUpdateReason}[] `updateReasons` - array of reasons for update
  * @event
  */
-Conversation.updated = 'updated';
+Conversation.updated = "updated";
 /**
  * Fired when the conversation was destroyed or the currently-logged-in user has left private conversation.
  *
@@ -869,17 +936,17 @@ Conversation.updated = 'updated';
  * 1. {@link Conversation} `conversation` - conversation that has been removed
  * @event
  */
-Conversation.removed = 'removed';
+Conversation.removed = "removed";
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString, ['undefined', 'string', 'number', 'boolean', 'object', declarativeTypeValidator.literal(null)]),
+    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString, attributes.optionalAttributesValidator),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [String, Object]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "add", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString, declarativeTypeValidator.nonEmptyString, ['undefined', 'string', 'number', 'boolean', 'object', declarativeTypeValidator.literal(null)]),
+    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.nonEmptyString, declarativeTypeValidator.nonEmptyString, attributes.optionalAttributesValidator),
     tslib_es6.__metadata("design:type", Function),
-    tslib_es6.__metadata("design:paramtypes", [String, String, Object]),
+    tslib_es6.__metadata("design:paramtypes", [String, String, Object, Object]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "addNonChatParticipant", null);
 tslib_es6.__decorate([
@@ -889,7 +956,7 @@ tslib_es6.__decorate([
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "advanceLastReadMessageIndex", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(['undefined', declarativeTypeValidator.nonNegativeInteger], ['undefined', declarativeTypeValidator.nonNegativeInteger], ['undefined', declarativeTypeValidator.literal('backwards', 'forward')]),
+    declarativeTypeValidator.validateTypesAsync(["undefined", declarativeTypeValidator.nonNegativeInteger], ["undefined", declarativeTypeValidator.nonNegativeInteger], ["undefined", declarativeTypeValidator.literal("backwards", "forward")]),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [Number, Number, String]),
     tslib_es6.__metadata("design:returntype", Promise)
@@ -914,44 +981,50 @@ tslib_es6.__decorate([
 ], Conversation.prototype, "removeParticipant", null);
 tslib_es6.__decorate([
     declarativeTypeValidator.validateTypesAsync([
-        'string',
+        "string",
         declarativeTypeValidator.literal(null),
         // Wrapping it into a custom rule is necessary because the FormData class is not available on initialization.
-        declarativeTypeValidator.custom((value) => [value instanceof FormData, 'an instance of FormData']),
-        declarativeTypeValidator.objectSchema('media options', {
+        declarativeTypeValidator.custom((value) => [value instanceof FormData, "an instance of FormData"]),
+        declarativeTypeValidator.objectSchema("media options", {
             contentType: declarativeTypeValidator.nonEmptyString,
             media: declarativeTypeValidator.custom((value) => {
-                let isValid = (typeof value === 'string' && value.length > 0) || value instanceof Uint8Array || value instanceof ArrayBuffer;
-                if (typeof Blob === 'function') {
+                let isValid = (typeof value === "string" && value.length > 0) ||
+                    value instanceof Uint8Array ||
+                    value instanceof ArrayBuffer;
+                if (typeof Blob === "function") {
                     isValid = isValid || value instanceof Blob;
                 }
                 return [
                     isValid,
-                    'a non-empty string, an instance of Buffer or an instance of Blob'
+                    "a non-empty string, an instance of Buffer or an instance of Blob",
                 ];
-            })
-        })
-    ], ['undefined', 'string', 'number', 'boolean', 'object', declarativeTypeValidator.literal(null)], ['undefined', declarativeTypeValidator.literal(null), declarativeTypeValidator.objectSchema('email attributes', {
-            subject: [declarativeTypeValidator.nonEmptyString, 'undefined']
-        })]),
+            }),
+        }),
+    ], attributes.optionalAttributesValidator, [
+        "undefined",
+        declarativeTypeValidator.literal(null),
+        declarativeTypeValidator.objectSchema("email attributes", {
+            subject: [declarativeTypeValidator.nonEmptyString, "undefined"],
+        }),
+    ]),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [Object, Object, Object]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "sendMessage", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.literal('default', 'muted')),
+    declarativeTypeValidator.validateTypesAsync(declarativeTypeValidator.literal("default", "muted")),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [String]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "setUserNotificationLevel", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(['string', 'number', 'boolean', 'object', declarativeTypeValidator.literal(null)]),
+    declarativeTypeValidator.validateTypesAsync(attributes.attributesValidator),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [Object]),
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "updateAttributes", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(['string']),
+    declarativeTypeValidator.validateTypesAsync(["string"]),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [String]),
     tslib_es6.__metadata("design:returntype", Promise)
@@ -963,7 +1036,7 @@ tslib_es6.__decorate([
     tslib_es6.__metadata("design:returntype", Promise)
 ], Conversation.prototype, "updateLastReadMessageIndex", null);
 tslib_es6.__decorate([
-    declarativeTypeValidator.validateTypesAsync(['string', declarativeTypeValidator.literal(null)]),
+    declarativeTypeValidator.validateTypesAsync(["string", declarativeTypeValidator.literal(null)]),
     tslib_es6.__metadata("design:type", Function),
     tslib_es6.__metadata("design:paramtypes", [String]),
     tslib_es6.__metadata("design:returntype", Promise)