@suprsend/node-sdk 1.1.2 → 1.2.0

package/dist/index.js

@@ -13,6 +13,12 @@ Object.defineProperty(exports, "Event", {
     return _event["default"];
   }
 });
+Object.defineProperty(exports, "SubscribersListBroadcast", {
+  enumerable: true,
+  get: function get() {
+    return _subscribers_list.SubscribersListBroadcast;
+  }
+});
 exports.Suprsend = void 0;
 Object.defineProperty(exports, "Workflow", {
   enumerable: true,
@@ -41,6 +47,8 @@ var _subscriber = _interopRequireDefault(require("./subscriber"));
 
 var _subscribers_bulk = _interopRequireDefault(require("./subscribers_bulk"));
 
+var _subscribers_list = require("./subscribers_list");
+
 var _brands = _interopRequireDefault(require("./brands"));
 
 var _constants = require("./constants");
@@ -69,6 +77,7 @@ var Suprsend = /*#__PURE__*/function () {
     this._bulk_users = new _subscribers_bulk["default"](this);
     this._user = new _subscriber["default"](this);
     this.brands = new _brands["default"](this);
+    this.subscribers_list = new _subscribers_list.SubscribersListApi(this);
 
     this._validate();
   }

package/dist/request_json/list_broadcast.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://github.com/suprsend/suprsend-node-sdk/request_json/list_broadcast.json",
+  "title": "list_broadcast_request",
+  "description": "Json schema for list_broadcast request",
+  "$comment": "Json schema for list_broadcast request",
+  "type": "object",
+  "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
+    "brand_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "brand id for workflow to be run in context of a brand"
+    },
+    "$insert_id": {
+      "type": "string",
+      "minLength": 36,
+      "description": "unique uuid generated per request"
+    },
+    "$time": {
+      "type": "integer",
+      "minimum": 1640995200000,
+      "description": "Timestamp: unix epoch in milliseconds"
+    },
+    "list_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SubscriberList id"
+    },
+    "template": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Template"
+    },
+    "notification_category": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Notification category"
+    },
+    "delay": {
+      "type": ["string", "integer"],
+      "minimum": 0,
+      "description": "If string: format [XX]d[XX]h[XX]m[XX]s e.g 1d2h30m10s(for 1day 2hours 30minutes 10sec). If integer: value in number of seconds"
+    },
+    "trigger_at": {
+      "type": "string",
+      "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
+    },
+    "data": {
+      "type": "object",
+      "description": "variables to be used in workflow. e.g replacing templates variables."
+    }
+  },
+  "required": [
+    "$insert_id",
+    "$time",
+    "list_id",
+    "template",
+    "notification_category",
+    "data"
+  ],
+  "definitions": {
+    "non_empty_string": {
+      "type": "string",
+      "minLength": 2
+    }
+  }
+}

package/dist/subscribers_list.js

@@ -0,0 +1,484 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SubscribersListBroadcast = exports.SubscribersListApi = void 0;
+
+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 _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _utils = require("./utils");
+
+var _signature = _interopRequireDefault(require("./signature"));
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var _constants = require("./constants");
+
+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; }
+
+var SubscribersListBroadcast = /*#__PURE__*/function () {
+  function SubscribersListBroadcast(body) {
+    var kwargs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    (0, _classCallCheck2["default"])(this, SubscribersListBroadcast);
+
+    if (!(body instanceof Object)) {
+      throw new _utils.SuprsendError("broadcast body must be a json/dictionary");
+    }
+
+    this.body = body;
+    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;
+  }
+
+  (0, _createClass2["default"])(SubscribersListBroadcast, [{
+    key: "get_final_json",
+    value: function get_final_json() {
+      this.body["$insert_id"] = (0, _utils.uuid)();
+      this.body["$time"] = (0, _utils.epoch_milliseconds)();
+
+      if (this.idempotency_key) {
+        this.body["$idempotency_key"] = this.idempotency_key;
+      }
+
+      if (this.brand_id) {
+        this.body["brand_id"] = this.brand_id;
+      }
+
+      this.body = (0, _utils.validate_list_broadcast_body_schema)(this.body);
+      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));
+      }
+
+      return [this.body, apparent_size];
+    }
+  }]);
+  return SubscribersListBroadcast;
+}();
+
+exports.SubscribersListBroadcast = SubscribersListBroadcast;
+
+var SubscribersListApi = /*#__PURE__*/function () {
+  function SubscribersListApi(config) {
+    (0, _classCallCheck2["default"])(this, SubscribersListApi);
+    this.config = config;
+    this.subscriber_list_url = "".concat(this.config.base_url, "v1/subscriber_list/");
+    this.broadcast_url = "".concat(this.config.base_url).concat(this.config.workspace_key, "/broadcast/");
+    this.__headers = this.__common_headers();
+    this.non_error_default_response = {
+      success: true
+    };
+  }
+
+  (0, _createClass2["default"])(SubscribersListApi, [{
+    key: "__common_headers",
+    value: function __common_headers() {
+      return {
+        "Content-Type": "application/json; charset=utf-8",
+        "User-Agent": this.config.user_agent
+      };
+    }
+  }, {
+    key: "__dynamic_headers",
+    value: function __dynamic_headers() {
+      return {
+        Date: new Date().toUTCString()
+      };
+    }
+  }, {
+    key: "_validate_list_id",
+    value: function _validate_list_id(list_id) {
+      if (typeof list_id != "string") {
+        throw new _utils.SuprsendError("list_id must be a string");
+      }
+
+      var cleaned_list_id = list_id.trim();
+
+      if (!cleaned_list_id) {
+        throw new _utils.SuprsendError("missing list_id");
+      }
+
+      return list_id;
+    }
+  }, {
+    key: "create",
+    value: function () {
+      var _create = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(payload) {
+        var list_id, headers, content_text, signature, response;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (payload) {
+                  _context.next = 2;
+                  break;
+                }
+
+                throw new _utils.SuprsendError("missing payload");
+
+              case 2:
+                list_id = payload["list_id"];
+
+                if (list_id) {
+                  _context.next = 5;
+                  break;
+                }
+
+                throw new _utils.SuprsendError("missing list_id in payload");
+
+              case 5:
+                list_id = this._validate_list_id(list_id);
+                payload["list_id"] = list_id;
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                content_text = JSON.stringify(payload);
+                signature = (0, _signature["default"])(this.subscriber_list_url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context.prev = 11;
+                _context.next = 14;
+                return _axios["default"].post(this.subscriber_list_url, content_text, {
+                  headers: headers
+                });
+
+              case 14:
+                response = _context.sent;
+                return _context.abrupt("return", response.data);
+
+              case 18:
+                _context.prev = 18;
+                _context.t0 = _context["catch"](11);
+                throw new _utils.SuprsendApiError(_context.t0);
+
+              case 21:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this, [[11, 18]]);
+      }));
+
+      function create(_x) {
+        return _create.apply(this, arguments);
+      }
+
+      return create;
+    }()
+  }, {
+    key: "cleaned_limit_offset",
+    value: function cleaned_limit_offset(limit, offset) {
+      var cleaned_limit = typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+      var cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+      return [cleaned_limit, cleaned_offset];
+    }
+  }, {
+    key: "get_all",
+    value: function () {
+      var _get_all = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+        var kwargs,
+            limit,
+            offset,
+            _this$cleaned_limit_o,
+            _this$cleaned_limit_o2,
+            cleaned_limit,
+            cleaner_offset,
+            final_url_obj,
+            url,
+            headers,
+            signature,
+            response,
+            _args2 = arguments;
+
+        return _regenerator["default"].wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                kwargs = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+                limit = kwargs === null || kwargs === void 0 ? void 0 : kwargs.limit;
+                offset = kwargs === null || kwargs === void 0 ? void 0 : kwargs.offset;
+                _this$cleaned_limit_o = this.cleaned_limit_offset(limit, offset), _this$cleaned_limit_o2 = (0, _slicedToArray2["default"])(_this$cleaned_limit_o, 2), cleaned_limit = _this$cleaned_limit_o2[0], cleaner_offset = _this$cleaned_limit_o2[1];
+                final_url_obj = new URL("".concat(this.config.base_url, "v1/subscriber_list"));
+                final_url_obj.searchParams.append("limit", cleaned_limit);
+                final_url_obj.searchParams.append("offset", cleaner_offset);
+                url = final_url_obj.href;
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context2.prev = 11;
+                _context2.next = 14;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+
+              case 14:
+                response = _context2.sent;
+                return _context2.abrupt("return", response.data);
+
+              case 18:
+                _context2.prev = 18;
+                _context2.t0 = _context2["catch"](11);
+                throw new _utils.SuprsendApiError(_context2.t0);
+
+              case 21:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this, [[11, 18]]);
+      }));
+
+      function get_all() {
+        return _get_all.apply(this, arguments);
+      }
+
+      return get_all;
+    }()
+  }, {
+    key: "__subscriber_list_detail_url",
+    value: function __subscriber_list_detail_url(list_id) {
+      return "".concat(this.config.base_url, "v1/subscriber_list/").concat(list_id, "/");
+    }
+  }, {
+    key: "get",
+    value: function () {
+      var _get = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(list_id) {
+        var cleaned_list_id, url, headers, signature, response;
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                cleaned_list_id = this._validate_list_id(list_id);
+                url = this.__subscriber_list_detail_url(cleaned_list_id);
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                signature = (0, _signature["default"])(url, "GET", "", headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context3.prev = 5;
+                _context3.next = 8;
+                return _axios["default"].get(url, {
+                  headers: headers
+                });
+
+              case 8:
+                response = _context3.sent;
+                return _context3.abrupt("return", response.data);
+
+              case 12:
+                _context3.prev = 12;
+                _context3.t0 = _context3["catch"](5);
+                throw new _utils.SuprsendApiError(_context3.t0);
+
+              case 15:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3, this, [[5, 12]]);
+      }));
+
+      function get(_x2) {
+        return _get.apply(this, arguments);
+      }
+
+      return get;
+    }()
+  }, {
+    key: "add",
+    value: function () {
+      var _add = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(list_id, distinct_ids) {
+        var cleaned_list_id, url, headers, content_text, signature, response;
+        return _regenerator["default"].wrap(function _callee4$(_context4) {
+          while (1) {
+            switch (_context4.prev = _context4.next) {
+              case 0:
+                cleaned_list_id = this._validate_list_id(list_id);
+
+                if (Array.isArray(distinct_ids)) {
+                  _context4.next = 3;
+                  break;
+                }
+
+                throw new _utils.SuprsendError("distinct_ids must be list of strings");
+
+              case 3:
+                if (!(distinct_ids.length === 0)) {
+                  _context4.next = 5;
+                  break;
+                }
+
+                return _context4.abrupt("return", this.non_error_default_response);
+
+              case 5:
+                url = "".concat(this.__subscriber_list_detail_url(cleaned_list_id), "subscriber/add");
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                content_text = JSON.stringify({
+                  distinct_ids: distinct_ids
+                });
+                signature = (0, _signature["default"])(url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context4.prev = 10;
+                _context4.next = 13;
+                return _axios["default"].post(url, content_text, {
+                  headers: headers
+                });
+
+              case 13:
+                response = _context4.sent;
+                return _context4.abrupt("return", response.data);
+
+              case 17:
+                _context4.prev = 17;
+                _context4.t0 = _context4["catch"](10);
+                throw new _utils.SuprsendApiError(_context4.t0);
+
+              case 20:
+              case "end":
+                return _context4.stop();
+            }
+          }
+        }, _callee4, this, [[10, 17]]);
+      }));
+
+      function add(_x3, _x4) {
+        return _add.apply(this, arguments);
+      }
+
+      return add;
+    }()
+  }, {
+    key: "remove",
+    value: function () {
+      var _remove = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5(list_id) {
+        var distinct_ids,
+            cleaned_list_id,
+            url,
+            headers,
+            content_text,
+            signature,
+            response,
+            _args5 = arguments;
+        return _regenerator["default"].wrap(function _callee5$(_context5) {
+          while (1) {
+            switch (_context5.prev = _context5.next) {
+              case 0:
+                distinct_ids = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : [];
+                cleaned_list_id = this._validate_list_id(list_id);
+
+                if (Array.isArray(distinct_ids)) {
+                  _context5.next = 4;
+                  break;
+                }
+
+                throw new _utils.SuprsendError("distinct_ids must be list of strings");
+
+              case 4:
+                if (!(distinct_ids.length === 0)) {
+                  _context5.next = 6;
+                  break;
+                }
+
+                return _context5.abrupt("return", this.non_error_default_response);
+
+              case 6:
+                url = "".concat(this.__subscriber_list_detail_url(cleaned_list_id), "subscriber/remove");
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                content_text = JSON.stringify({
+                  distinct_ids: distinct_ids
+                });
+                signature = (0, _signature["default"])(url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context5.prev = 11;
+                _context5.next = 14;
+                return _axios["default"].post(url, content_text, {
+                  headers: headers
+                });
+
+              case 14:
+                response = _context5.sent;
+                return _context5.abrupt("return", response.data);
+
+              case 18:
+                _context5.prev = 18;
+                _context5.t0 = _context5["catch"](11);
+                throw new _utils.SuprsendApiError(_context5.t0);
+
+              case 21:
+              case "end":
+                return _context5.stop();
+            }
+          }
+        }, _callee5, this, [[11, 18]]);
+      }));
+
+      function remove(_x5) {
+        return _remove.apply(this, arguments);
+      }
+
+      return remove;
+    }() // async broadcast(broadcast_instance) {
+    //   if (!(broadcast_instance instanceof SubscribersListBroadcast)) {
+    //     throw new SuprsendError(
+    //       "argument must be an instance of suprsend.SubscriberListBroadcast"
+    //     );
+    //   }
+    //   const [broadcast_body, body_size] = broadcast_instance.get_final_json(
+    //     this.config
+    //   );
+    //   const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    //   const content_text = JSON.stringify(broadcast_body);
+    //   const signature = get_request_signature(
+    //     this.broadcast_url,
+    //     "POST",
+    //     content_text,
+    //     headers,
+    //     this.config.workspace_secret
+    //   );
+    //   headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+    //   try {
+    //     const response = await axios.post(this.broadcast_url, content_text, {
+    //       headers,
+    //     });
+    //     const ok_response = Math.floor(response.status / 100) == 2;
+    //     if (ok_response) {
+    //       return {
+    //         success: true,
+    //         status: "success",
+    //         status_code: response.status,
+    //         message: response.statusText,
+    //       };
+    //     } else {
+    //       return {
+    //         success: false,
+    //         status: "fail",
+    //         status_code: response.status,
+    //         message: response.statusText,
+    //       };
+    //     }
+    //   } catch (err) {
+    //     return {
+    //       success: false,
+    //       status: "fail",
+    //       status_code: err.status || 500,
+    //       message: err.message,
+    //     };
+    //   }
+    // }
+
+  }]);
+  return SubscribersListApi;
+}();
+
+exports.SubscribersListApi = SubscribersListApi;

package/dist/utils.js

@@ -10,6 +10,7 @@ exports.base64Encode = base64Encode;
 exports.epoch_milliseconds = epoch_milliseconds;
 exports.get_apparent_event_size = get_apparent_event_size;
 exports.get_apparent_identity_event_size = get_apparent_identity_event_size;
+exports.get_apparent_list_broadcast_body_size = get_apparent_list_broadcast_body_size;
 exports.get_apparent_workflow_body_size = get_apparent_workflow_body_size;
 exports.has_special_char = void 0;
 exports.is_empty = is_empty;
@@ -17,6 +18,7 @@ exports.is_object = is_object;
 exports.is_string = is_string;
 exports.resolveTilde = resolveTilde;
 exports.uuid = uuid;
+exports.validate_list_broadcast_body_schema = validate_list_broadcast_body_schema;
 exports.validate_track_event_schema = validate_track_event_schema;
 exports.validate_workflow_body_schema = validate_workflow_body_schema;
 
@@ -58,6 +60,8 @@ var workflow_schema = require("./request_json/workflow.json");
 
 var event_schema = require("./request_json/event.json");
 
+var list_broadcast_schema = require("./request_json/list_broadcast.json");
+
 function base64Encode(file) {
   var body = _fs["default"].readFileSync(file);
 
@@ -215,6 +219,28 @@ function validate_track_event_schema(body) {
   }
 }
 
+function validate_list_broadcast_body_schema(body) {
+  if (!(body !== null && body !== void 0 && body.data)) {
+    body.data = {};
+  }
+
+  if (!(body.data instanceof Object)) {
+    throw new SuprsendError("data must be a object");
+  }
+
+  var schema = list_broadcast_schema;
+  var v = new _jsonschema.Validator();
+  var validated_data = v.validate(body, schema);
+
+  if (validated_data.valid) {
+    return body;
+  } else {
+    var error_obj = validated_data.errors[0];
+    var error_msg = "".concat(error_obj.property, " ").concat(error_obj.message);
+    throw new SuprsendError(error_msg);
+  }
+}
+
 function get_apparent_workflow_body_size(body, is_part_of_bulk) {
   var extra_bytes = _constants.WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES;
   var apparent_body = body;
@@ -338,6 +364,11 @@ function get_apparent_event_size(event, is_part_of_bulk) {
 }
 
 function get_apparent_identity_event_size(event) {
-  var body_size = JSON.stringify(event);
+  var body_size = JSON.stringify(event).length;
+  return body_size;
+}
+
+function get_apparent_list_broadcast_body_size(body) {
+  var body_size = JSON.stringify(body).length;
   return body_size;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {

package/src/index.js

@@ -6,6 +6,10 @@ import Event, { EventCollector } from "./event";
 import { BulkEventsFactory } from "./events_bulk";
 import SubscriberFactory from "./subscriber";
 import BulkSubscribersFactory from "./subscribers_bulk";
+import {
+  SubscribersListApi,
+  SubscribersListBroadcast,
+} from "./subscribers_list";
 import BrandsApi from "./brands";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
@@ -34,6 +38,7 @@ class Suprsend {
     this._user = new SubscriberFactory(this);
 
     this.brands = new BrandsApi(this);
+    this.subscribers_list = new SubscribersListApi(this);
 
     this._validate();
   }
@@ -126,4 +131,4 @@ class Suprsend {
   }
 }
 
-export { Suprsend, Event, Workflow };
+export { Suprsend, Event, Workflow, SubscribersListBroadcast };

package/src/request_json/list_broadcast.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://github.com/suprsend/suprsend-node-sdk/request_json/list_broadcast.json",
+  "title": "list_broadcast_request",
+  "description": "Json schema for list_broadcast request",
+  "$comment": "Json schema for list_broadcast request",
+  "type": "object",
+  "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
+    "brand_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "brand id for workflow to be run in context of a brand"
+    },
+    "$insert_id": {
+      "type": "string",
+      "minLength": 36,
+      "description": "unique uuid generated per request"
+    },
+    "$time": {
+      "type": "integer",
+      "minimum": 1640995200000,
+      "description": "Timestamp: unix epoch in milliseconds"
+    },
+    "list_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SubscriberList id"
+    },
+    "template": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Template"
+    },
+    "notification_category": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Notification category"
+    },
+    "delay": {
+      "type": ["string", "integer"],
+      "minimum": 0,
+      "description": "If string: format [XX]d[XX]h[XX]m[XX]s e.g 1d2h30m10s(for 1day 2hours 30minutes 10sec). If integer: value in number of seconds"
+    },
+    "trigger_at": {
+      "type": "string",
+      "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
+    },
+    "data": {
+      "type": "object",
+      "description": "variables to be used in workflow. e.g replacing templates variables."
+    }
+  },
+  "required": [
+    "$insert_id",
+    "$time",
+    "list_id",
+    "template",
+    "notification_category",
+    "data"
+  ],
+  "definitions": {
+    "non_empty_string": {
+      "type": "string",
+      "minLength": 2
+    }
+  }
+}

package/src/subscribers_list.js

@@ -0,0 +1,296 @@
+import {
+  SuprsendError,
+  SuprsendApiError,
+  validate_list_broadcast_body_schema,
+  get_apparent_list_broadcast_body_size,
+  uuid,
+  epoch_milliseconds,
+} from "./utils";
+import get_request_signature from "./signature";
+import axios from "axios";
+import {
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
+} from "./constants";
+
+class SubscribersListBroadcast {
+  constructor(body, kwargs = {}) {
+    if (!(body instanceof Object)) {
+      throw new SuprsendError("broadcast body must be a json/dictionary");
+    }
+    this.body = body;
+    this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
+  }
+
+  get_final_json() {
+    this.body["$insert_id"] = uuid();
+    this.body["$time"] = epoch_milliseconds();
+    if (this.idempotency_key) {
+      this.body["$idempotency_key"] = this.idempotency_key;
+    }
+    if (this.brand_id) {
+      this.body["brand_id"] = this.brand_id;
+    }
+    this.body = validate_list_broadcast_body_schema(this.body);
+    const apparent_size = get_apparent_list_broadcast_body_size(this.body);
+    if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+      throw new SuprsendError(
+        `SubscriberListBroadcast body too big - ${apparent_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+      );
+    }
+    return [this.body, apparent_size];
+  }
+}
+
+class SubscribersListApi {
+  constructor(config) {
+    this.config = config;
+    this.subscriber_list_url = `${this.config.base_url}v1/subscriber_list/`;
+    this.broadcast_url = `${this.config.base_url}${this.config.workspace_key}/broadcast/`;
+    this.__headers = this.__common_headers();
+    this.non_error_default_response = { success: true };
+  }
+
+  __common_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  __dynamic_headers() {
+    return {
+      Date: new Date().toUTCString(),
+    };
+  }
+
+  _validate_list_id(list_id) {
+    if (typeof list_id != "string") {
+      throw new SuprsendError("list_id must be a string");
+    }
+    let cleaned_list_id = list_id.trim();
+    if (!cleaned_list_id) {
+      throw new SuprsendError("missing list_id");
+    }
+    return list_id;
+  }
+
+  async create(payload) {
+    if (!payload) {
+      throw new SuprsendError("missing payload");
+    }
+    let list_id = payload["list_id"];
+    if (!list_id) {
+      throw new SuprsendError("missing list_id in payload");
+    }
+    list_id = this._validate_list_id(list_id);
+    payload["list_id"] = list_id;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(payload);
+
+    const signature = get_request_signature(
+      this.subscriber_list_url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(
+        this.subscriber_list_url,
+        content_text,
+        { headers }
+      );
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  cleaned_limit_offset(limit, offset) {
+    let cleaned_limit =
+      typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+    let cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+    return [cleaned_limit, cleaned_offset];
+  }
+
+  async get_all(kwargs = {}) {
+    let limit = kwargs?.limit;
+    let offset = kwargs?.offset;
+    const [cleaned_limit, cleaner_offset] = this.cleaned_limit_offset(
+      limit,
+      offset
+    );
+    const final_url_obj = new URL(`${this.config.base_url}v1/subscriber_list`);
+    final_url_obj.searchParams.append("limit", cleaned_limit);
+    final_url_obj.searchParams.append("offset", cleaner_offset);
+    const url = final_url_obj.href;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+
+    const signature = get_request_signature(
+      url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  __subscriber_list_detail_url(list_id) {
+    return `${this.config.base_url}v1/subscriber_list/${list_id}/`;
+  }
+
+  async get(list_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+
+    const url = this.__subscriber_list_detail_url(cleaned_list_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+
+    const signature = get_request_signature(
+      url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async add(list_id, distinct_ids) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/add`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    const signature = get_request_signature(
+      url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(url, content_text, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async remove(list_id, distinct_ids = []) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/remove`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    const signature = get_request_signature(
+      url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(url, content_text, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  // async broadcast(broadcast_instance) {
+  //   if (!(broadcast_instance instanceof SubscribersListBroadcast)) {
+  //     throw new SuprsendError(
+  //       "argument must be an instance of suprsend.SubscriberListBroadcast"
+  //     );
+  //   }
+  //   const [broadcast_body, body_size] = broadcast_instance.get_final_json(
+  //     this.config
+  //   );
+  //   const headers = { ...this.__headers, ...this.__dynamic_headers() };
+  //   const content_text = JSON.stringify(broadcast_body);
+
+  //   const signature = get_request_signature(
+  //     this.broadcast_url,
+  //     "POST",
+  //     content_text,
+  //     headers,
+  //     this.config.workspace_secret
+  //   );
+  //   headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+  //   try {
+  //     const response = await axios.post(this.broadcast_url, content_text, {
+  //       headers,
+  //     });
+  //     const ok_response = Math.floor(response.status / 100) == 2;
+  //     if (ok_response) {
+  //       return {
+  //         success: true,
+  //         status: "success",
+  //         status_code: response.status,
+  //         message: response.statusText,
+  //       };
+  //     } else {
+  //       return {
+  //         success: false,
+  //         status: "fail",
+  //         status_code: response.status,
+  //         message: response.statusText,
+  //       };
+  //     }
+  //   } catch (err) {
+  //     return {
+  //       success: false,
+  //       status: "fail",
+  //       status_code: err.status || 500,
+  //       message: err.message,
+  //     };
+  //   }
+  // }
+}
+
+export { SubscribersListApi, SubscribersListBroadcast };

package/src/utils.js

@@ -12,6 +12,7 @@ import { cloneDeep } from "lodash";
 
 const workflow_schema = require("./request_json/workflow.json");
 const event_schema = require("./request_json/event.json");
+const list_broadcast_schema = require("./request_json/list_broadcast.json");
 
 export function base64Encode(file) {
   var body = fs.readFileSync(file);
@@ -122,6 +123,25 @@ export function validate_track_event_schema(body) {
   }
 }
 
+export function validate_list_broadcast_body_schema(body) {
+  if (!body?.data) {
+    body.data = {};
+  }
+  if (!(body.data instanceof Object)) {
+    throw new SuprsendError("data must be a object");
+  }
+  const schema = list_broadcast_schema;
+  var v = new Validator();
+  const validated_data = v.validate(body, schema);
+  if (validated_data.valid) {
+    return body;
+  } else {
+    const error_obj = validated_data.errors[0];
+    const error_msg = `${error_obj.property} ${error_obj.message}`;
+    throw new SuprsendError(error_msg);
+  }
+}
+
 export function get_apparent_workflow_body_size(body, is_part_of_bulk) {
   let extra_bytes = WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES;
   let apparent_body = body;
@@ -199,6 +219,11 @@ export function get_apparent_event_size(event, is_part_of_bulk) {
 }
 
 export function get_apparent_identity_event_size(event) {
-  const body_size = JSON.stringify(event);
+  const body_size = JSON.stringify(event).length;
+  return body_size;
+}
+
+export function get_apparent_list_broadcast_body_size(body) {
+  const body_size = JSON.stringify(body).length;
   return body_size;
 }