@twilio/conversations 1.3.0-rc7 → 2.0.0-rc.3

package/browser/aggregateddeliveryreceipt.js

@@ -1,152 +0,0 @@
-"use strict";
-
-var _classCallCheck2 = require("babel-runtime/helpers/classCallCheck");
-
-var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);
-
-var _createClass2 = require("babel-runtime/helpers/createClass");
-
-var _createClass3 = _interopRequireDefault(_createClass2);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @classdesc Contains aggregated information about a {@link Message}'s delivery statuses across all {@link Participant}s
- * of a {@link Conversation}.
- *
- * At any moment during delivering message to a {@link Participant} the message can have zero or more of following
- * delivery statuses:
- *
- * <ul><li>
- * Message considered as <b>sent</b> to a participant, if the nearest upstream carrier accepted the message.
- * </li><li>
- * Message considered as <b>delivered</b> to a participant, if Twilio has received confirmation of message
- * delivery from the upstream carrier, and, where available, the destination handset.
- * </li><li>
- * Message considered as <b>undelivered</b> to a participant, if Twilio has received a delivery receipt
- * indicating that the message was not delivered. This can happen for many reasons including carrier content
- * filtering and the availability of the destination handset.
- * </li><li>
- * Message considered as <b>read</b> by a participant, if the message has been delivered and opened by the
- * recipient in the conversation. The recipient must have enabled read receipts.
- * </li><li>
- * Message considered as <b>failed</b> to be delivered to a participant if the message could not be sent.
- * This can happen for various reasons including queue overflows, account suspensions and media
- * errors (in the case of MMS for instance).
- *</li></ul>
- *
- * {@link AggregatedDeliveryReceipt} class contains aggregated value {@link AggregatedDeliveryReceipt#DeliveryAmount} for each delivery status.
- *
- * @property {number} total - Maximum number of delivery events expected for the message
- * @property {AggregatedDeliveryReceipt#DeliveryAmount} sent - Amount of participants that have <b>sent</b> delivery status for the message.
- * @property {AggregatedDeliveryReceipt#DeliveryAmount} delivered - Amount of participants that have <b>delivered</b> delivery status
- *   for the message.
- * @property {AggregatedDeliveryReceipt#DeliveryAmount} read - Amount of participants that have <b>read</b> delivery status for the message.
- * @property {AggregatedDeliveryReceipt#DeliveryAmount} undelivered - Amount of participants that have <b>undelivered</b> delivery status
- *   for the message.
- * @property {AggregatedDeliveryReceipt#DeliveryAmount} failed - Amount of participants that have <b>failed</b> delivery status for the message.
- */
-
-var AggregatedDeliveryReceipt = function () {
-    /**
-     * Signifies amount of participants which have the status for the message.
-     * @typedef {('none'|'some'|'all')} AggregatedDeliveryReceipt#DeliveryAmount
-     */
-    function AggregatedDeliveryReceipt(data) {
-        (0, _classCallCheck3.default)(this, AggregatedDeliveryReceipt);
-
-        this.state = data;
-    }
-    /**
-     * @return Maximum number of delivery events expected for the message.
-     */
-
-
-    (0, _createClass3.default)(AggregatedDeliveryReceipt, [{
-        key: "_update",
-        value: function _update(data) {
-            this.state = data;
-        }
-    }, {
-        key: "_isEquals",
-        value: function _isEquals(data) {
-            var isTotalSame = this.total === data.total;
-            var isSentSame = this.sent === data.sent;
-            var isDeliveredSame = this.delivered === data.delivered;
-            var isReadSame = this.read === data.read;
-            var isUndeliveredSame = this.undelivered === data.undelivered;
-            var isFailedSame = this.failed === data.failed;
-            return isTotalSame && isSentSame && isDeliveredSame && isReadSame && isUndeliveredSame && isFailedSame;
-        }
-    }, {
-        key: "total",
-        get: function get() {
-            return this.state.total;
-        }
-        /**
-         * Message considered as <b>sent</b> to a participant, if the nearest upstream carrier accepted the message.
-         *
-         * @return {@link DeliveryAmount} of participants that have <b>sent</b> delivery status for the message.
-         */
-
-    }, {
-        key: "sent",
-        get: function get() {
-            return this.state.sent;
-        }
-        /**
-         * Message considered as <b>delivered</b> to a participant, if Twilio has received confirmation of message
-         * delivery from the upstream carrier, and, where available, the destination handset.
-         *
-         * @return {@link DeliveryAmount} of participants that have <b>delivered</b> delivery status for the message.
-         */
-
-    }, {
-        key: "delivered",
-        get: function get() {
-            return this.state.delivered;
-        }
-        /**
-         * Message considered as <b>read</b> by a participant, if the message has been delivered and opened by the
-         * recipient in the conversation. The recipient must have enabled read receipts.
-         *
-         * @return {@link DeliveryAmount} of participants that have <b>read</b> delivery status for the message.
-         */
-
-    }, {
-        key: "read",
-        get: function get() {
-            return this.state.read;
-        }
-        /**
-         * Message considered as <b>undelivered</b> to a participant, if Twilio has received a delivery receipt
-         * indicating that the message was not delivered. This can happen for many reasons including carrier content
-         * filtering and the availability of the destination handset.
-         *
-         * @return {@link DeliveryAmount} of participants that have <b>undelivered</b> delivery status for the message.
-         */
-
-    }, {
-        key: "undelivered",
-        get: function get() {
-            return this.state.undelivered;
-        }
-        /**
-         * Message considered as <b>failed</b> to be delivered to a participant if the message could not be sent.
-         * This can happen for various reasons including queue overflows, account suspensions and media
-         * errors (in the case of MMS for instance). Twilio does not charge you for failed messages.
-         *
-         * @return {@link DeliveryAmount} of participants that have <b>failed</b> delivery status for the message.
-         */
-
-    }, {
-        key: "failed",
-        get: function get() {
-            return this.state.failed;
-        }
-    }]);
-    return AggregatedDeliveryReceipt;
-}();
-
-exports.AggregatedDeliveryReceipt = AggregatedDeliveryReceipt;