@suprsend/node-sdk 1.3.0 → 1.5.0

package/README.md

@@ -19,4 +19,4 @@ const supr_client = new Suprsend("workspace_key", "workspace_secret");
 ```
 
 ### License
-MIT © [https://github.com/suprsend](https://github.com/https://github.com/suprsend)
+MIT © [https://github.com/suprsend](https://github.com/suprsend)

package/dist/index.js

@@ -13,10 +13,10 @@ Object.defineProperty(exports, "Event", {
     return _event["default"];
   }
 });
-Object.defineProperty(exports, "SubscribersListBroadcast", {
+Object.defineProperty(exports, "SubscriberListBroadcast", {
   enumerable: true,
   get: function get() {
-    return _subscribers_list.SubscribersListBroadcast;
+    return _subscriber_list.SubscriberListBroadcast;
   }
 });
 exports.Suprsend = void 0;
@@ -47,7 +47,7 @@ var _subscriber = _interopRequireDefault(require("./subscriber"));
 
 var _subscribers_bulk = _interopRequireDefault(require("./subscribers_bulk"));
 
-var _subscribers_list = require("./subscribers_list");
+var _subscriber_list = require("./subscriber_list");
 
 var _brands = _interopRequireDefault(require("./brands"));
 
@@ -75,7 +75,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.subscriber_lists = new _subscriber_list.SubscriberListsApi(this);
 
     this._validate();
   }

package/dist/request_json/list_broadcast.json

@@ -31,6 +31,25 @@
       "minLength": 1,
       "description": "SubscriberList id"
     },
+    "channels": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "androidpush",
+          "iospush",
+          "webpush",
+          "email",
+          "sms",
+          "whatsapp",
+          "slack",
+          "inbox",
+          "messenger"
+        ]
+      },
+      "minItems": 0,
+      "description": "channels on which notification to be broadcast. e.g ['androidpush', 'iospush']"
+    },
     "template": {
       "$ref": "#/definitions/non_empty_string",
       "description": "slug of Template"

package/dist/{subscribers_list.js → subscriber_list.js}

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SubscribersListBroadcast = exports.SubscribersListApi = void 0;
+exports.SubscriberListsApi = exports.SubscriberListBroadcast = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -31,10 +31,10 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 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 SubscriberListBroadcast = /*#__PURE__*/function () {
+  function SubscriberListBroadcast(body) {
     var kwargs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    (0, _classCallCheck2["default"])(this, SubscribersListBroadcast);
+    (0, _classCallCheck2["default"])(this, SubscriberListBroadcast);
 
     if (!(body instanceof Object)) {
       throw new _utils.SuprsendError("broadcast body must be a json/dictionary");
@@ -45,7 +45,7 @@ var SubscribersListBroadcast = /*#__PURE__*/function () {
     this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id;
   }
 
-  (0, _createClass2["default"])(SubscribersListBroadcast, [{
+  (0, _createClass2["default"])(SubscriberListBroadcast, [{
     key: "get_final_json",
     value: function get_final_json() {
       this.body["$insert_id"] = (0, _utils.uuid)();
@@ -69,14 +69,14 @@ var SubscribersListBroadcast = /*#__PURE__*/function () {
       return [this.body, apparent_size];
     }
   }]);
-  return SubscribersListBroadcast;
+  return SubscriberListBroadcast;
 }();
 
-exports.SubscribersListBroadcast = SubscribersListBroadcast;
+exports.SubscriberListBroadcast = SubscriberListBroadcast;
 
-var SubscribersListApi = /*#__PURE__*/function () {
-  function SubscribersListApi(config) {
-    (0, _classCallCheck2["default"])(this, SubscribersListApi);
+var SubscriberListsApi = /*#__PURE__*/function () {
+  function SubscriberListsApi(config) {
+    (0, _classCallCheck2["default"])(this, SubscriberListsApi);
     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/");
@@ -86,7 +86,7 @@ var SubscribersListApi = /*#__PURE__*/function () {
     };
   }
 
-  (0, _createClass2["default"])(SubscribersListApi, [{
+  (0, _createClass2["default"])(SubscriberListsApi, [{
     key: "__common_headers",
     value: function __common_headers() {
       return {
@@ -428,57 +428,90 @@ var SubscribersListApi = /*#__PURE__*/function () {
       }
 
       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,
-    //     };
-    //   }
-    // }
+    }()
+  }, {
+    key: "broadcast",
+    value: function () {
+      var _broadcast = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee6(broadcast_instance) {
+        var _broadcast_instance$g, _broadcast_instance$g2, broadcast_body, body_size, headers, content_text, signature, response, ok_response;
+
+        return _regenerator["default"].wrap(function _callee6$(_context6) {
+          while (1) {
+            switch (_context6.prev = _context6.next) {
+              case 0:
+                if (broadcast_instance instanceof SubscriberListBroadcast) {
+                  _context6.next = 2;
+                  break;
+                }
+
+                throw new _utils.SuprsendError("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];
+                headers = _objectSpread(_objectSpread({}, this.__headers), this.__dynamic_headers());
+                content_text = JSON.stringify(broadcast_body);
+                signature = (0, _signature["default"])(this.broadcast_url, "POST", content_text, headers, this.config.workspace_secret);
+                headers["Authorization"] = "".concat(this.config.workspace_key, ":").concat(signature);
+                _context6.prev = 7;
+                _context6.next = 10;
+                return _axios["default"].post(this.broadcast_url, content_text, {
+                  headers: headers
+                });
+
+              case 10:
+                response = _context6.sent;
+                ok_response = Math.floor(response.status / 100) == 2;
+
+                if (!ok_response) {
+                  _context6.next = 16;
+                  break;
+                }
+
+                return _context6.abrupt("return", {
+                  success: true,
+                  status: "success",
+                  status_code: response.status,
+                  message: response.statusText
+                });
+
+              case 16:
+                return _context6.abrupt("return", {
+                  success: false,
+                  status: "fail",
+                  status_code: response.status,
+                  message: response.statusText
+                });
+
+              case 17:
+                _context6.next = 22;
+                break;
+
+              case 19:
+                _context6.prev = 19;
+                _context6.t0 = _context6["catch"](7);
+                return _context6.abrupt("return", {
+                  success: false,
+                  status: "fail",
+                  status_code: _context6.t0.status || 500,
+                  message: _context6.t0.message
+                });
 
+              case 22:
+              case "end":
+                return _context6.stop();
+            }
+          }
+        }, _callee6, this, [[7, 19]]);
+      }));
+
+      function broadcast(_x6) {
+        return _broadcast.apply(this, arguments);
+      }
+
+      return broadcast;
+    }()
   }]);
-  return SubscribersListApi;
+  return SubscriberListsApi;
 }();
 
-exports.SubscribersListApi = SubscribersListApi;
+exports.SubscriberListsApi = SubscriberListsApi;

package/dist/subscribers_bulk.js

@@ -333,7 +333,7 @@ var BulkSubscribers = /*#__PURE__*/function () {
   }, {
     key: "trigger",
     value: function trigger() {
-      this.save();
+      return this.save();
     }
   }, {
     key: "save",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {
@@ -22,6 +22,7 @@
   "publishConfig": {
     "access": "public"
   },
+  "types": "types/index.d.ts",
   "dependencies": {
     "@babel/runtime": "^7.16.3",
     "axios": "^0.27.2",

package/src/index.js

@@ -6,10 +6,7 @@ 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 { SubscriberListsApi, SubscriberListBroadcast } from "./subscriber_list";
 import BrandsApi from "./brands";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
@@ -36,7 +33,7 @@ class Suprsend {
     this._user = new SubscriberFactory(this);
 
     this.brands = new BrandsApi(this);
-    this.subscribers_list = new SubscribersListApi(this);
+    this.subscriber_lists = new SubscriberListsApi(this);
 
     this._validate();
   }
@@ -129,4 +126,4 @@ class Suprsend {
   }
 }
 
-export { Suprsend, Event, Workflow, SubscribersListBroadcast };
+export { Suprsend, Event, Workflow, SubscriberListBroadcast };

package/src/request_json/list_broadcast.json

@@ -31,6 +31,25 @@
       "minLength": 1,
       "description": "SubscriberList id"
     },
+    "channels": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "androidpush",
+          "iospush",
+          "webpush",
+          "email",
+          "sms",
+          "whatsapp",
+          "slack",
+          "inbox",
+          "messenger"
+        ]
+      },
+      "minItems": 0,
+      "description": "channels on which notification to be broadcast. e.g ['androidpush', 'iospush']"
+    },
     "template": {
       "$ref": "#/definitions/non_empty_string",
       "description": "slug of Template"

package/src/{subscribers_list.js → subscriber_list.js}

@@ -13,7 +13,7 @@ import {
   SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
 } from "./constants";
 
-class SubscribersListBroadcast {
+class SubscriberListBroadcast {
   constructor(body, kwargs = {}) {
     if (!(body instanceof Object)) {
       throw new SuprsendError("broadcast body must be a json/dictionary");
@@ -43,7 +43,7 @@ class SubscribersListBroadcast {
   }
 }
 
-class SubscribersListApi {
+class SubscriberListsApi {
   constructor(config) {
     this.config = config;
     this.subscriber_list_url = `${this.config.base_url}v1/subscriber_list/`;
@@ -241,56 +241,56 @@ class SubscribersListApi {
     }
   }
 
-  // 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,
-  //     };
-  //   }
-  // }
+  async broadcast(broadcast_instance) {
+    if (!(broadcast_instance instanceof SubscriberListBroadcast)) {
+      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 };
+export { SubscriberListsApi, SubscriberListBroadcast };

package/src/subscribers_bulk.js

@@ -204,7 +204,7 @@ class BulkSubscribers {
   }
 
   trigger() {
-    this.save();
+    return this.save();
   }
 
   async save() {

package/types/index.d.ts

@@ -0,0 +1,194 @@
+declare namespace suprsend {
+  interface Dictionary {
+    [key: string]: any;
+  }
+
+  interface SResponse {
+    success: boolean;
+    status: string;
+    status_code: number;
+    message: string;
+  }
+
+  interface SBulkResponse {
+    status: string;
+    failed_records: Dictionary[];
+    total: number;
+    success: number;
+    failure: number;
+    warnings: string[];
+  }
+
+  interface Workflow {
+    new (
+      body: Dictionary,
+      kwargs?: { idempotency_key?: string; brand_id?: string }
+    ): Workflow;
+
+    add_attachment(
+      file_path: string,
+      kwargs?: { file_name?: string; ignore_if_error?: boolean }
+    ): void;
+  }
+
+  interface BulkWorkflows {
+    append(...workflows: Workflow[]): void;
+
+    trigger(): Promise<SBulkResponse>;
+  }
+
+  interface BulkWorkflowsFactory {
+    new_instance(): BulkWorkflows;
+  }
+
+  // Events
+  interface Event {
+    new (
+      distinct_id: any,
+      event_name: string,
+      properties?: Dictionary,
+      kwargs?: { idempotency_key?: string; brand_id?: string }
+    ): Event;
+
+    add_attachment(
+      file_path: string,
+      kwargs?: { file_name?: string; ignore_if_error?: boolean }
+    ): void;
+  }
+
+  interface BulkEvents {
+    append(...events: Event[]): void;
+
+    trigger(): Promise<SBulkResponse>;
+  }
+
+  interface BulkEventsFactory {
+    new_instance(): BulkEvents;
+  }
+
+  // subscribers
+  interface Subscriber {
+    save(): Promise<SResponse>;
+
+    append(key: string | Dictionary, value?: any): void;
+    remove(key: string | Dictionary, value?: any): void;
+    unset(keys: string | string[]): void;
+
+    set_preferred_language(lang_code: string): void;
+
+    add_email(email: string): void;
+    remove_email(email: string): void;
+
+    add_sms(mobile_no: string): void;
+    remove_sms(mobile_no: string): void;
+
+    add_whatsapp(mobile_no: string): void;
+    remove_whatsapp(mobile_no: string): void;
+
+    add_androidpush(push_token: string, provider?: string): void;
+    remove_androidpush(push_token: string, provider?: string): void;
+
+    add_iospush(push_token: string, provider?: string): void;
+    remove_iospush(push_token: string, provider?: string): void;
+
+    add_webpush(push_token: Dictionary, provider?: string): void;
+    remove_webpush(push_token: Dictionary, provider?: string): void;
+
+    add_slack_email(email: string): void;
+    remove_slack_email(email: string): void;
+
+    add_slack_userid(user_id: any): void;
+    remove_slack_userid(user_id: any): void;
+  }
+
+  interface SubscriberFactory {
+    new_user(distinct_id: any): Subscriber;
+
+    get_instance(distinct_id: any): Subscriber;
+  }
+
+  interface BulkSubscribersFactory {
+    new_instance(): BulkSubscribers;
+  }
+
+  interface BulkSubscribers {
+    append(...subscribers: Subscriber[]): void;
+
+    trigger(): Promise<SBulkResponse>;
+
+    save(): Promise<SBulkResponse>;
+  }
+
+  // brands
+  interface BrandsApi {
+    list(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
+
+    get(brand_id: any): Promise<Dictionary>;
+
+    upsert(brand_id: any, brand_payload?: Dictionary): Promise<Dictionary>;
+  }
+
+  // lists
+  interface SubscriberListBroadcast {
+    new (
+      body: Dictionary,
+      kwargs?: { idempotency_key?: string; brand_id?: string }
+    ): SubscriberListBroadcast;
+  }
+
+  interface SubscriberListsApi {
+    create(payload: Dictionary): Promise<Dictionary>;
+
+    get_all(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
+
+    get(list_id: string): Promise<Dictionary>;
+
+    add(list_id: string, distinct_ids: string[]): Promise<Dictionary>;
+
+    remove(list_id: string, distinct_ids: string[]): Promise<Dictionary>;
+
+    broadcast(broadcast_instance: SubscriberListBroadcast): Promise<SResponse>;
+  }
+
+  interface Suprsend {
+    new (
+      workspace_env: string,
+      workspace_secret: string,
+      config: { is_staging: boolean }
+    ): Suprsend;
+
+    get bulk_workflows(): BulkWorkflowsFactory;
+
+    get bulk_events(): BulkEventsFactory;
+
+    get user(): SubscriberFactory;
+
+    get bulk_users(): BulkSubscribersFactory;
+
+    brands: BrandsApi;
+
+    subscriber_lists: SubscriberListsApi;
+
+    add_attachment(
+      body: Dictionary,
+      file_path: string,
+      kwargs?: { file_name?: string; ignore_if_error?: boolean }
+    ): Dictionary;
+
+    trigger_workflow(body: Workflow | Dictionary): Promise<SResponse>;
+
+    track(
+      distinct_id: any,
+      event_name: string,
+      properties?: Dictionary,
+      kwargs?: { idempotency_key?: string; brand_id?: string }
+    ): Promise<SResponse>;
+
+    track_event(event: Event): Promise<SResponse>;
+  }
+}
+
+export const Suprsend: suprsend.Suprsend;
+export const Event: suprsend.Event;
+export const Workflow: suprsend.Workflow;
+export const SubscriberListBroadcast: suprsend.SubscriberListBroadcast;