@suprsend/node-sdk 1.7.0 → 1.8.0

package/dist/attachment.js

@@ -19,21 +19,30 @@ function check_is_web_url() {
 }
 
 function get_attachment_json_for_file(file_path, file_name, ignore_if_error) {
-  var abs_path = _path["default"].resolve((0, _utils.resolveTilde)(file_path));
+  try {
+    var abs_path = _path["default"].resolve((0, _utils.resolveTilde)(file_path));
 
-  var final_file_name = _path["default"].basename(abs_path);
+    var final_file_name = _path["default"].basename(abs_path);
 
-  if (file_name && file_name.trim()) {
-    final_file_name = file_name.trim();
-  }
+    if (file_name && file_name.trim()) {
+      final_file_name = file_name.trim();
+    }
 
-  return {
-    filename: final_file_name,
-    contentType: _mimeTypes["default"].lookup(abs_path),
-    data: (0, _utils.base64Encode)(abs_path),
-    url: null,
-    ignore_if_error: ignore_if_error
-  };
+    return {
+      filename: final_file_name,
+      contentType: _mimeTypes["default"].lookup(abs_path),
+      data: (0, _utils.base64Encode)(abs_path),
+      url: null,
+      ignore_if_error: ignore_if_error
+    };
+  } catch (ex) {
+    if (ignore_if_error) {
+      console.log("WARNING: ignoring error while processing attachment file.", ex);
+      return;
+    } else {
+      throw ex;
+    }
+  }
 }
 
 function get_attachment_json_for_url(file_url, file_name, ignore_if_error) {

package/dist/bulk_response.js

@@ -52,6 +52,30 @@ var BulkResponse = /*#__PURE__*/function () {
       var failed_recs = ch_resp.failed_records || [];
       this.failed_records = [].concat((0, _toConsumableArray2["default"])(this.failed_records), (0, _toConsumableArray2["default"])(failed_recs));
     }
+  }], [{
+    key: "empty_chunk_success_response",
+    value: function empty_chunk_success_response() {
+      return {
+        status: "success",
+        status_code: 200,
+        total: 0,
+        success: 0,
+        failure: 0,
+        failed_records: []
+      };
+    }
+  }, {
+    key: "invalid_records_chunk_response",
+    value: function invalid_records_chunk_response(invalid_records) {
+      return {
+        status: "fail",
+        status_code: 500,
+        total: invalid_records.length,
+        success: 0,
+        failure: invalid_records.length,
+        failed_records: invalid_records
+      };
+    }
   }]);
   return BulkResponse;
 }();

package/dist/event.js

@@ -43,26 +43,24 @@ var Event = /*#__PURE__*/function () {
     this.event_name = event_name;
     this.properties = properties;
     this.idempotency_key = kwargs === null || kwargs === void 0 ? void 0 : kwargs.idempotency_key;
-    this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id; // --- validate
+    this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id; // default values
 
-    this.__validate_distinct_id();
-
-    this.__validate_event_name();
-
-    this.__validate_properties();
+    if (!this.properties) {
+      this.properties = {};
+    }
   }
 
   (0, _createClass2["default"])(Event, [{
     key: "__validate_distinct_id",
     value: function __validate_distinct_id() {
-      if (this.distinct_id instanceof String) {
-        throw new _utils.SuprsendError("distinct_id must be a string. an Id which uniquely identify a user in your app");
+      if (typeof this.distinct_id !== "string") {
+        throw new _utils.InputValueError("distinct_id must be a string. an Id which uniquely identify a user in your app");
       }
 
       var distinct_id = this.distinct_id.trim();
 
       if (!distinct_id) {
-        throw new _utils.SuprsendError("distinct_id missing");
+        throw new _utils.InputValueError("distinct_id missing");
       }
 
       this.distinct_id = distinct_id;
@@ -70,12 +68,8 @@ var Event = /*#__PURE__*/function () {
   }, {
     key: "__validate_properties",
     value: function __validate_properties() {
-      if (!this.properties) {
-        this.properties = {};
-      }
-
       if (!(this.properties instanceof Object)) {
-        throw new _utils.SuprsendError("properties must be a dictionary");
+        throw new _utils.InputValueError("properties must be a dictionary");
       }
     }
   }, {
@@ -83,7 +77,7 @@ var Event = /*#__PURE__*/function () {
     value: function __check_event_prefix(event_name) {
       if (!RESERVED_EVENT_NAMES.includes(event_name)) {
         if ((0, _utils.has_special_char)(event_name)) {
-          throw new _utils.SuprsendError("event_names starting with [$,ss_] are reserved by SuprSend");
+          throw new _utils.InputValueError("event_names starting with [$,ss_] are reserved by SuprSend");
         }
       }
     }
@@ -91,11 +85,15 @@ var Event = /*#__PURE__*/function () {
     key: "__validate_event_name",
     value: function __validate_event_name() {
       if (!(0, _utils.is_string)(this.event_name)) {
-        throw new _utils.SuprsendError("event_name must be a string");
+        throw new _utils.InputValueError("event_name must be a string");
       }
 
       var event_name = this.event_name.trim();
 
+      if (!event_name) {
+        throw new _utils.InputValueError("event_name missing");
+      }
+
       this.__check_event_prefix(event_name);
 
       this.event_name = event_name;
@@ -107,8 +105,19 @@ var Event = /*#__PURE__*/function () {
 
       var kwargs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var file_name = kwargs === null || kwargs === void 0 ? void 0 : kwargs.file_name;
-      var ignore_if_error = (_kwargs$ignore_if_err = kwargs === null || kwargs === void 0 ? void 0 : kwargs.ignore_if_error) !== null && _kwargs$ignore_if_err !== void 0 ? _kwargs$ignore_if_err : false;
-      var attachment = (0, _attachment["default"])(file_path, file_name, ignore_if_error); // --- add the attachment to properties->$attachments
+      var ignore_if_error = (_kwargs$ignore_if_err = kwargs === null || kwargs === void 0 ? void 0 : kwargs.ignore_if_error) !== null && _kwargs$ignore_if_err !== void 0 ? _kwargs$ignore_if_err : false; // if properties is not a dict, not raising error while adding attachment.
+
+      if (!(this.properties instanceof Object)) {
+        console.log("WARNING: attachment cannot be added. please make sure properties is a dictionary. Event" + JSON.stringify(this.as_json()));
+        return;
+      }
+
+      var attachment = (0, _attachment["default"])(file_path, file_name, ignore_if_error);
+
+      if (!attachment) {
+        return;
+      } // --- add the attachment to properties->$attachments
+
 
       if (!this.properties["$attachments"]) {
         this.properties["$attachments"] = [];
@@ -120,6 +129,14 @@ var Event = /*#__PURE__*/function () {
     key: "get_final_json",
     value: function get_final_json(config) {
       var is_part_of_bulk = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+
+      // --- validate
+      this.__validate_distinct_id();
+
+      this.__validate_event_name();
+
+      this.__validate_properties();
+
       var super_props = {
         $ss_sdk_version: config.user_agent
       };
@@ -144,11 +161,30 @@ var Event = /*#__PURE__*/function () {
       var apparent_size = (0, _utils.get_apparent_event_size)(event_dict, is_part_of_bulk);
 
       if (apparent_size > _constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-        throw new _utils.SuprsendError("Event size too big - ".concat(apparent_size, " Bytes,must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+        throw new _utils.InputValueError("Event size too big - ".concat(apparent_size, " Bytes,must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
       }
 
       return [event_dict, apparent_size];
     }
+  }, {
+    key: "as_json",
+    value: function as_json() {
+      var event_dict = {
+        event: this.event_name,
+        distinct_id: this.distinct_id,
+        properties: this.properties
+      };
+
+      if (this.idempotency_key) {
+        event_dict["$idempotency_key"] = this.idempotency_key;
+      }
+
+      if (this.brand_id) {
+        event_dict["brand_id"] = this.brand_id;
+      }
+
+      return event_dict;
+    }
   }]);
   return Event;
 }();

package/dist/events_bulk.js

@@ -124,7 +124,7 @@ var _BulkEventsChunk = /*#__PURE__*/function () {
       }
 
       if (event_size > _constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-        throw new _utils.SuprsendError("Event properties too big - ".concat(event_size, " Bytes, must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+        throw new _utils.InputValueError("Event properties too big - ".concat(event_size, " Bytes, must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
       }
 
       if (this.__running_size + event_size > _constants.BODY_MAX_APPARENT_SIZE_IN_BYTES) {
@@ -195,7 +195,7 @@ var _BulkEventsChunk = /*#__PURE__*/function () {
                 _context.prev = 12;
                 _context.t0 = _context["catch"](4);
                 error_status = _context.t0.status || 500;
-                return _context.abrupt("return", {
+                this.response = {
                   status: "fail",
                   status_code: error_status,
                   message: _context.t0.message,
@@ -209,7 +209,7 @@ var _BulkEventsChunk = /*#__PURE__*/function () {
                       code: error_status
                     };
                   })
-                });
+                };
 
               case 16:
               case "end":
@@ -236,30 +236,35 @@ var BulkEvents = /*#__PURE__*/function () {
     this.__events = [];
     this.__pending_records = [];
     this.chunks = [];
-    this.response = new _bulk_response["default"]();
+    this.response = new _bulk_response["default"](); // invalid_record json: {"record": event-json, "error": error_str, "code": 500}
+
+    this.__invalid_records = [];
   }
 
   (0, _createClass2["default"])(BulkEvents, [{
     key: "__validate_events",
     value: function __validate_events() {
-      if (!this.__events) {
-        throw new _utils.SuprsendError("events list is empty in bulk request");
-      }
-
       var _iterator = _createForOfIteratorHelper(this.__events),
           _step;
 
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
           var ev = _step.value;
-          var is_part_of_bulk = true;
 
-          var _ev$get_final_json = ev.get_final_json(this.config, is_part_of_bulk),
-              _ev$get_final_json2 = (0, _slicedToArray2["default"])(_ev$get_final_json, 2),
-              ev_json = _ev$get_final_json2[0],
-              body_size = _ev$get_final_json2[1];
+          try {
+            var is_part_of_bulk = true;
 
-          this.__pending_records.push([ev_json, body_size]);
+            var _ev$get_final_json = ev.get_final_json(this.config, is_part_of_bulk),
+                _ev$get_final_json2 = (0, _slicedToArray2["default"])(_ev$get_final_json, 2),
+                ev_json = _ev$get_final_json2[0],
+                body_size = _ev$get_final_json2[1];
+
+            this.__pending_records.push([ev_json, body_size]);
+          } catch (ex) {
+            var inv_rec = (0, _utils.invalid_record_json)(ev.as_json(), ex);
+
+            this.__invalid_records.push(inv_rec);
+          }
         }
       } catch (err) {
         _iterator.e(err);
@@ -309,30 +314,24 @@ var BulkEvents = /*#__PURE__*/function () {
       }
 
       if (!events) {
-        throw new _utils.SuprsendError("events list empty. must pass one or more events");
+        return;
       }
 
       for (var _i = 0, _events = events; _i < _events.length; _i++) {
         var ev = _events[_i];
 
-        if (!ev) {
-          throw new _utils.SuprsendError("null/empty element found in bulk instance");
-        }
+        if (ev && ev instanceof _event["default"]) {
+          var ev_copy = (0, _lodash.cloneDeep)(ev);
 
-        if (!(ev instanceof _event["default"])) {
-          throw new _utils.SuprsendError("element must be an instance of suprsend.Event");
+          this.__events.push(ev_copy);
         }
-
-        var ev_copy = (0, _lodash.cloneDeep)(ev);
-
-        this.__events.push(ev_copy);
       }
     }
   }, {
     key: "trigger",
     value: function () {
       var _trigger2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-        var _iterator3, _step3, _step3$value, c_idx, ch;
+        var ch_response, _iterator3, _step3, _step3$value, c_idx, ch;
 
         return _regenerator["default"].wrap(function _callee2$(_context2) {
           while (1) {
@@ -340,16 +339,26 @@ var BulkEvents = /*#__PURE__*/function () {
               case 0:
                 this.__validate_events();
 
+                if (this.__invalid_records.length > 0) {
+                  ch_response = _bulk_response["default"].invalid_records_chunk_response(this.__invalid_records);
+                  this.response.merge_chunk_response(ch_response);
+                }
+
+                if (!this.__pending_records.length) {
+                  _context2.next = 25;
+                  break;
+                }
+
                 this.__chunkify();
 
                 _iterator3 = _createForOfIteratorHelper(this.chunks.entries());
-                _context2.prev = 3;
+                _context2.prev = 5;
 
                 _iterator3.s();
 
-              case 5:
+              case 7:
                 if ((_step3 = _iterator3.n()).done) {
-                  _context2.next = 13;
+                  _context2.next = 15;
                   break;
                 }
 
@@ -360,43 +369,54 @@ var BulkEvents = /*#__PURE__*/function () {
                 } // do api call
 
 
-                _context2.next = 10;
+                _context2.next = 12;
                 return ch.trigger();
 
-              case 10:
+              case 12:
                 // merge response
                 this.response.merge_chunk_response(ch.response);
 
-              case 11:
-                _context2.next = 5;
-                break;
-
               case 13:
-                _context2.next = 18;
+                _context2.next = 7;
                 break;
 
               case 15:
-                _context2.prev = 15;
-                _context2.t0 = _context2["catch"](3);
+                _context2.next = 20;
+                break;
+
+              case 17:
+                _context2.prev = 17;
+                _context2.t0 = _context2["catch"](5);
 
                 _iterator3.e(_context2.t0);
 
-              case 18:
-                _context2.prev = 18;
+              case 20:
+                _context2.prev = 20;
 
                 _iterator3.f();
 
-                return _context2.finish(18);
+                return _context2.finish(20);
+
+              case 23:
+                _context2.next = 26;
+                break;
+
+              case 25:
+                // if no records. i.e. invalid_records.length and pending_records.length both are 0
+                // then add empty success response
+                if (this.__invalid_records.length === 0) {
+                  this.response.merge_chunk_response(_bulk_response["default"].empty_chunk_success_response());
+                }
 
-              case 21:
+              case 26:
                 return _context2.abrupt("return", this.response);
 
-              case 22:
+              case 27:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[3, 15, 18, 21]]);
+        }, _callee2, this, [[5, 17, 20, 23]]);
       }));
 
       function trigger() {

package/dist/index.js

@@ -143,12 +143,12 @@ var Suprsend = /*#__PURE__*/function () {
       var file_name = kwargs === null || kwargs === void 0 ? void 0 : kwargs.file_name;
       var ignore_if_error = (_kwargs$ignore_if_err = kwargs === null || kwargs === void 0 ? void 0 : kwargs.ignore_if_error) !== null && _kwargs$ignore_if_err !== void 0 ? _kwargs$ignore_if_err : false;
 
-      if (!body.data) {
+      if (!(body !== null && body !== void 0 && body.data)) {
         body.data = {};
       }
 
-      if (!body.data instanceof Object) {
-        throw new _utils.SuprsendError("data must be an object");
+      if (!(body.data instanceof Object)) {
+        throw new _utils.InputValueError("data must be an object");
       }
 
       var attachment = (0, _attachment["default"])(file_path, file_name, ignore_if_error);
@@ -185,7 +185,7 @@ var Suprsend = /*#__PURE__*/function () {
     key: "track_event",
     value: function track_event(event) {
       if (!(event instanceof _event["default"])) {
-        throw new _utils.SuprsendError("argument must be an instance of suprsend.Event");
+        throw new _utils.InputValueError("argument must be an instance of suprsend.Event");
       }
 
       return this._eventcollector.collect(event);

package/dist/subscriber.js

@@ -50,13 +50,13 @@ var SubscriberFactory = /*#__PURE__*/function () {
     key: "get_instance",
     value: function get_instance(distinct_id) {
       if (!(0, _utils.is_string)(distinct_id)) {
-        throw new _utils.SuprsendError("distinct_id must be a string. an Id which uniquely identify a user in your app");
+        throw new _utils.InputValueError("distinct_id must be a string. an Id which uniquely identify a user in your app");
       }
 
       distinct_id = distinct_id.trim();
 
       if (!distinct_id) {
-        throw new _utils.SuprsendError("distinct_id must be passed");
+        throw new _utils.InputValueError("distinct_id must be passed");
       }
 
       return new Subscriber(this.config, distinct_id);
@@ -78,6 +78,7 @@ var Subscriber = /*#__PURE__*/function () {
     this.__info = [];
     this.user_operations = [];
     this._helper = new _subscriber_helper["default"]();
+    this.__warnings_list = [];
   }
 
   (0, _createClass2["default"])(Subscriber, [{
@@ -114,13 +115,23 @@ var Subscriber = /*#__PURE__*/function () {
         properties: this.__super_props
       };
     }
+  }, {
+    key: "as_json",
+    value: function as_json() {
+      var event_dict = {
+        distinct_id: this.distinct_id,
+        $user_operations: this.user_operations,
+        warnings: this.__warnings_list
+      };
+      return event_dict;
+    }
   }, {
     key: "validate_event_size",
     value: function validate_event_size(event_dict) {
       var apparent_size = (0, _utils.get_apparent_identity_event_size)(event_dict);
 
       if (apparent_size > _constants.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-        throw new _utils.SuprsendError("User Event size too big - ".concat(apparent_size, " Bytes, must not cross ").concat(_constants.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+        throw new _utils.InputValueError("User Event size too big - ".concat(apparent_size, " Bytes, must not cross ").concat(_constants.IDENTITY_SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
       }
 
       return [event_dict, apparent_size];
@@ -129,28 +140,31 @@ var Subscriber = /*#__PURE__*/function () {
     key: "validate_body",
     value: function validate_body() {
       var is_part_of_bulk = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-      var warnings_list = [];
+      this.__warnings_list = [];
 
       if (!(0, _utils.is_empty)(this.__info)) {
         var msg = "[distinct_id: ".concat(this.distinct_id, "]").concat(this.__info.join("\n"));
-        warnings_list.push(msg);
+
+        this.__warnings_list.push(msg);
+
         console.log("WARNING: ".concat(msg));
       }
 
       if (!(0, _utils.is_empty)(this.__errors)) {
         var _msg = "[distinct_id: ".concat(this.distinct_id, "] ").concat(this.__errors.join("\n"));
 
-        warnings_list.push(_msg);
+        this.__warnings_list.push(_msg);
+
         var err_msg = "ERROR: ".concat(_msg);
 
         if (is_part_of_bulk) {
           console.log(err_msg);
         } else {
-          throw new _utils.SuprsendError(err_msg);
+          throw new _utils.InputValueError(err_msg);
         }
       }
 
-      return warnings_list;
+      return this.__warnings_list;
     }
   }, {
     key: "save",

package/dist/subscriber_list.js

@@ -11,10 +11,10 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -27,6 +27,8 @@ var _axios = _interopRequireDefault(require("axios"));
 
 var _constants = require("./constants");
 
+var _attachment = _interopRequireDefault(require("./attachment"));
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -37,7 +39,7 @@ var SubscriberListBroadcast = /*#__PURE__*/function () {
     (0, _classCallCheck2["default"])(this, SubscriberListBroadcast);
 
     if (!(body instanceof Object)) {
-      throw new _utils.SuprsendError("broadcast body must be a json/dictionary");
+      throw new _utils.InputValueError("broadcast body must be a json/dictionary");
     }
 
     this.body = body;
@@ -46,6 +48,39 @@ var SubscriberListBroadcast = /*#__PURE__*/function () {
   }
 
   (0, _createClass2["default"])(SubscriberListBroadcast, [{
+    key: "add_attachment",
+    value: function add_attachment(file_path) {
+      var _kwargs$ignore_if_err, _this$body, _this$body$data;
+
+      var kwargs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var file_name = kwargs === null || kwargs === void 0 ? void 0 : kwargs.file_name;
+      var ignore_if_error = (_kwargs$ignore_if_err = kwargs === null || kwargs === void 0 ? void 0 : kwargs.ignore_if_error) !== null && _kwargs$ignore_if_err !== void 0 ? _kwargs$ignore_if_err : false;
+
+      if (!((_this$body = this.body) !== null && _this$body !== void 0 && _this$body["data"])) {
+        this.body["data"] = {};
+      } // if body["data"] is not a dict, not raising error while adding attachment.
+
+
+      if (!(this.body["data"] instanceof Object)) {
+        console.log("WARNING: attachment cannot be added. please make sure body['data'] is a dictionary. " + "SubscriberListBroadcast" + JSON.stringify(this.as_json()));
+        return;
+      }
+
+      var attachment = (0, _attachment["default"])(file_path, file_name, ignore_if_error);
+
+      if (!attachment) {
+        return;
+      } //  --- add the attachment to body->data->$attachments
+
+
+      if (!((_this$body$data = this.body["data"]) !== null && _this$body$data !== void 0 && _this$body$data["$attachments"])) {
+        this.body["data"]["$attachments"] = [];
+      } // -----
+
+
+      this.body["data"]["$attachments"].push(attachment);
+    }
+  }, {
     key: "get_final_json",
     value: function get_final_json() {
       this.body["$insert_id"] = (0, _utils.uuid)();
@@ -63,11 +98,27 @@ var SubscriberListBroadcast = /*#__PURE__*/function () {
       var apparent_size = (0, _utils.get_apparent_list_broadcast_body_size)(this.body);
 
       if (apparent_size > _constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-        throw new _utils.SuprsendError("SubscriberListBroadcast body too big - ".concat(apparent_size, " Bytes, must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
+        throw new _utils.InputValueError("SubscriberListBroadcast body too big - ".concat(apparent_size, " Bytes, must not cross ").concat(_constants.SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE));
       }
 
       return [this.body, apparent_size];
     }
+  }, {
+    key: "as_json",
+    value: function as_json() {
+      var body_dict = _objectSpread({}, this.body);
+
+      if (this.idempotency_key) {
+        body_dict["$idempotency_key"] = this.idempotency_key;
+      }
+
+      if (this.brand_id) {
+        body_dict["brand_id"] = this.brand_id;
+      } // -----
+
+
+      return body_dict;
+    }
   }]);
   return SubscriberListBroadcast;
 }();
@@ -444,7 +495,7 @@ var SubscriberListsApi = /*#__PURE__*/function () {
                   break;
                 }
 
-                throw new _utils.SuprsendError("argument must be an instance of suprsend.SubscriberListBroadcast");
+                throw new _utils.InputValueError("argument must be an instance of suprsend.SubscriberListBroadcast");
 
               case 2:
                 _broadcast_instance$g = broadcast_instance.get_final_json(this.config), _broadcast_instance$g2 = (0, _slicedToArray2["default"])(_broadcast_instance$g, 2), broadcast_body = _broadcast_instance$g2[0], body_size = _broadcast_instance$g2[1];