@suprsend/node-sdk 1.8.2 → 1.9.1

package/dist/workflow.js

@@ -27,6 +27,7 @@ var Workflow = /*#__PURE__*/function () {
     }
     this.body = body;
     this.idempotency_key = kwargs === null || kwargs === void 0 ? void 0 : kwargs.idempotency_key;
+    this.tenant_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.tenant_id;
     this.brand_id = kwargs === null || kwargs === void 0 ? void 0 : kwargs.brand_id;
   }
   (0, _createClass2["default"])(Workflow, [{
@@ -62,6 +63,9 @@ var Workflow = /*#__PURE__*/function () {
       if (this.idempotency_key) {
         this.body["$idempotency_key"] = this.idempotency_key;
       }
+      if (this.tenant_id) {
+        this.body["tenant_id"] = this.tenant_id;
+      }
       if (this.brand_id) {
         this.body["brand_id"] = this.brand_id;
       }
@@ -79,6 +83,9 @@ var Workflow = /*#__PURE__*/function () {
       if (this.idempotency_key) {
         body_dict["$idempotency_key"] = this.idempotency_key;
       }
+      if (this.tenant_id) {
+        body_dict["tenant_id"] = this.tenant_id;
+      }
       if (this.brand_id) {
         body_dict["brand_id"] = this.brand_id;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/node-sdk",
-  "version": "1.8.2",
+  "version": "1.9.1",
   "description": "Suprsend Node SDK to trigger workflow from backend",
   "main": "dist/index.js",
   "scripts": {
@@ -25,7 +25,7 @@
   "types": "types/index.d.ts",
   "dependencies": {
     "@babel/runtime": "^7.16.3",
-    "axios": "^0.27.2",
+    "axios": "^1.6.0",
     "jsonschema": "^1.4.0",
     "lodash": "^4.17.21",
     "mime-types": "^2.1.34",

package/src/event.js

@@ -32,6 +32,7 @@ export default class Event {
     this.event_name = event_name;
     this.properties = properties;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.tenant_id = kwargs?.tenant_id;
     this.brand_id = kwargs?.brand_id;
 
     // default values
@@ -128,6 +129,9 @@ export default class Event {
     if (this.idempotency_key) {
       event_dict["$idempotency_key"] = this.idempotency_key;
     }
+    if (this.tenant_id) {
+      event_dict["tenant_id"] = this.tenant_id;
+    }
     if (this.brand_id) {
       event_dict["brand_id"] = this.brand_id;
     }
@@ -150,6 +154,9 @@ export default class Event {
     if (this.idempotency_key) {
       event_dict["$idempotency_key"] = this.idempotency_key;
     }
+    if (this.tenant_id) {
+      event_dict["tenant_id"] = this.tenant_id;
+    }
     if (this.brand_id) {
       event_dict["brand_id"] = this.brand_id;
     }

package/src/index.js

@@ -8,6 +8,7 @@ import SubscriberFactory from "./subscriber";
 import BulkSubscribersFactory from "./subscribers_bulk";
 import { SubscriberListsApi, SubscriberListBroadcast } from "./subscriber_list";
 import BrandsApi from "./brands";
+import TenantsApi from "./tenant";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
 const package_json = require("../package.json");
@@ -33,6 +34,8 @@ class Suprsend {
     this._user = new SubscriberFactory(this);
 
     this.brands = new BrandsApi(this);
+    this.tenants = new TenantsApi(this);
+
     this.subscriber_lists = new SubscriberListsApi(this);
 
     this._validate();

package/src/request_json/event.json

@@ -11,6 +11,11 @@
       "maxLength": 255,
       "description": "unique id provided by client for request"
     },
+    "tenant_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "tenant id for workflow to be run in context of a tenant"
+    },
     "brand_id": {
       "type": ["string", "null"],
       "maxLength": 64,

package/src/request_json/list_broadcast.json

@@ -11,6 +11,11 @@
       "maxLength": 255,
       "description": "unique id provided by client for request"
     },
+    "tenant_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "tenant id for workflow to be run in context of a tenant"
+    },
     "brand_id": {
       "type": ["string", "null"],
       "maxLength": 64,
@@ -44,7 +49,8 @@
           "whatsapp",
           "slack",
           "inbox",
-          "messenger"
+          "messenger",
+          "ms_teams"
         ]
       },
       "minItems": 0,

package/src/request_json/workflow.json

@@ -11,6 +11,11 @@
       "maxLength": 255,
       "description": "unique id provided by client for request"
     },
+    "tenant_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "tenant id for workflow to be run in context of a tenant"
+    },
     "brand_id": {
       "type": ["string", "null"],
       "maxLength": 64,
@@ -124,6 +129,40 @@
       },
       "additionalProperties": false
     },
+    "ms_teams_setting": {
+      "type": "object",
+      "properties": {
+        "tenant_id": {
+          "type": "string",
+          "description": "ms teams tenant id"
+        },
+        "service_url": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://smba.trafficmanager.net/",
+          "description": "service webhook url. e.g https://smba.trafficmanager.net/XXXXXXXXXX"
+        },
+        "conversation_id": {
+          "type": "string",
+          "description": "ms team conversation id"
+        },
+        "user_id": {
+          "type": "string",
+          "description": "ms team user id"
+        },
+        "incoming_webhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "incoming webhook url. e.g https://XXXXX.webhook.office.com/webhookb2/XXXXXXXXXX@XXXXXXXXXX/IncomingWebhook/XXXXXXXXXX/XXXXXXXXXX"
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     "androidpush_settings": {
       "type": "object",
       "properties": {
@@ -171,6 +210,10 @@
           "type": ["string", "null"],
           "description": "distinct_id: Id which uniquely identifies a user in your app"
         },
+        "$preferred_language": {
+          "type": ["string", "null"],
+          "description": "preferred_language: 2-letter language code in ISO 639-1 Alpha-2 code format. e.g en (for English)"
+        },
         "$channels": {
           "type": "array",
           "items": {
@@ -184,7 +227,8 @@
               "whatsapp",
               "slack",
               "inbox",
-              "messenger"
+              "messenger",
+              "ms_teams"
             ]
           },
           "minItems": 0,
@@ -290,6 +334,18 @@
             }
           ]
         },
+        "$ms_teams": {
+          "oneOf": [
+            { "$ref": "#/definitions/ms_teams_setting" },
+            {
+              "type": "array",
+              "uniqueItems": false,
+              "maxItems": 10,
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/ms_teams_setting" }
+            }
+          ]
+        },
         "$inbox": {
           "oneOf": [
             { "$ref": "#/definitions/non_empty_string" },
@@ -315,8 +371,7 @@
           ]
         }
       },
-      "required": [],
-      "additionalProperties": false
+      "required": []
     },
     "delivery_setting": {
       "type": "object",
@@ -349,7 +404,8 @@
               "whatsapp",
               "slack",
               "inbox",
-              "messenger"
+              "messenger",
+              "ms_teams"
             ]
           },
           "minItems": 0,

package/src/subscriber.js

@@ -208,6 +208,78 @@ export class Subscriber {
     }
   }
 
+  set(key, value) {
+    const caller = "set";
+    if (!is_string(key) && !is_object(key)) {
+      this.__errors.push(`[${caller}] arg1 must be either string or a dict`);
+      return;
+    }
+    if (is_string(key)) {
+      if (value === null || value === undefined) {
+        this.__errors.push(
+          `[${caller}] if arg1 is a string, then arg2 must be passed`
+        );
+        return;
+      } else {
+        this._helper._set_kv(key, value, {}, caller);
+        this._collect_event();
+      }
+    } else {
+      for (let item in key) {
+        this._helper._set_kv(item, key[item], key, caller);
+      }
+      this._collect_event();
+    }
+  }
+
+  set_once(key, value) {
+    const caller = "set_once";
+    if (!is_string(key) && !is_object(key)) {
+      this.__errors.push(`[${caller}] arg1 must be either string or a dict`);
+      return;
+    }
+    if (is_string(key)) {
+      if (value === null || value === undefined) {
+        this.__errors.push(
+          `[${caller}] if arg1 is a string, then arg2 must be passed`
+        );
+        return;
+      } else {
+        this._helper._set_once_kv(key, value, {}, caller);
+        this._collect_event();
+      }
+    } else {
+      for (let item in key) {
+        this._helper._set_once_kv(item, key[item], key, caller);
+      }
+      this._collect_event();
+    }
+  }
+
+  increment(key, value) {
+    const caller = "increment";
+    if (!is_string(key) && !is_object(key)) {
+      this.__errors.push(`[${caller}] arg1 must be either string or a dict`);
+      return;
+    }
+    if (is_string(key)) {
+      if (value === null || value === undefined) {
+        this.__errors.push(
+          `[${caller}] if arg1 is a string, then arg2 must be passed`
+        );
+        return;
+      } else {
+        this._helper._increment_kv(key, value, {}, caller);
+        this._collect_event();
+      }
+    } else {
+      for (let item in key) {
+        this._helper._increment_kv(item, key[item], key, caller);
+      }
+      this._collect_event();
+    }
+  }
+
   remove(key, value) {
     const caller = "remove";
     if (!is_string(key) && !is_object(key)) {
@@ -339,6 +411,18 @@ export class Subscriber {
     this._collect_event();
   }
 
+  add_ms_teams(value) {
+    const caller = "add_ms_teams";
+    this._helper._add_ms_teams(value, caller);
+    this._collect_event();
+  }
+
+  remove_ms_teams(value) {
+    const caller = "remove_ms_teams";
+    this._helper._remove_ms_teams(value, caller);
+    this._collect_event();
+  }
+
   add_slack_email(value) {
     console.warn(
       "add_slack_email() method has been deprecated. use add_slack() instead"

package/src/subscriber_helper.js

@@ -16,6 +16,7 @@ const IDENT_KEY_IOSPUSH = "$iospush";
 const IDENT_KEY_WHATSAPP = "$whatsapp";
 const IDENT_KEY_WEBPUSH = "$webpush";
 const IDENT_KEY_SLACK = "$slack";
+const IDENT_KEY_MS_TEAMS = "$ms_teams";
 
 const IDENT_KEYS_ALL = [
   IDENT_KEY_EMAIL,
@@ -25,6 +26,7 @@ const IDENT_KEYS_ALL = [
   IDENT_KEY_WHATSAPP,
   IDENT_KEY_WEBPUSH,
   IDENT_KEY_SLACK,
+  IDENT_KEY_MS_TEAMS,
 ];
 
 const KEY_PUSHVENDOR = "$pushvendor";
@@ -81,6 +83,10 @@ export default class _SubscriberInternalHelper {
 
     this.__dict_set = {};
 
+    this.__dict_set_once = {};
+
+    this.__dict_increment = {};
+
     this.__dict_append = {};
 
     this.__dict_remove = {};
@@ -93,6 +99,8 @@ export default class _SubscriberInternalHelper {
 
   reset() {
     this.__dict_set = {};
+    this.__dict_set_once = {};
+    this.__dict_increment = {};
     this.__dict_append = {};
     this.__dict_remove = {};
     this.__list_unset = [];
@@ -116,6 +124,12 @@ export default class _SubscriberInternalHelper {
     if (!is_empty(this.__dict_set)) {
       event["$set"] = this.__dict_set;
     }
+    if (!is_empty(this.__dict_set_once)) {
+      event["$set_once"] = this.__dict_set_once;
+    }
+    if (!is_empty(this.__dict_increment)) {
+      event["$add"] = this.__dict_increment;
+    }
     if (!is_empty(this.__dict_append)) {
       event["$append"] = this.__dict_append;
     }
@@ -174,6 +188,42 @@ export default class _SubscriberInternalHelper {
     }
   }
 
+  _set_kv(key, value, args = {}, caller = "set") {
+    const [validated_key, is_k_valid] = this.__validate_key_basic(key, caller);
+    if (!is_k_valid) {
+      return;
+    } else {
+      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
+      if (is_k_valid) {
+        this.__dict_set[validated_key] = value;
+      }
+    }
+  }
+
+  _set_once_kv(key, value, args = {}, caller = "set_once") {
+    const [validated_key, is_k_valid] = this.__validate_key_basic(key, caller);
+    if (!is_k_valid) {
+      return;
+    } else {
+      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
+      if (is_k_valid) {
+        this.__dict_set_once[validated_key] = value;
+      }
+    }
+  }
+
+  _increment_kv(key, value, args = {}, caller = "increment") {
+    const [validated_key, is_k_valid] = this.__validate_key_basic(key, caller);
+    if (!is_k_valid) {
+      return;
+    } else {
+      const is_k_valid = this.__validate_key_prefix(validated_key, caller);
+      if (is_k_valid) {
+        this.__dict_increment[validated_key] = value;
+      }
+    }
+  }
+
   _remove_kv(key, value, args = {}, caller = "remove") {
     const [validated_key, is_k_valid] = this.__validate_key_basic(key, caller);
     if (!is_k_valid) {
@@ -229,6 +279,9 @@ export default class _SubscriberInternalHelper {
       case IDENT_KEY_SLACK:
         this._add_slack(value, caller);
         break;
+      case IDENT_KEY_MS_TEAMS:
+        this._add_ms_teams(value, caller);
+        break;
       default:
         break;
     }
@@ -258,6 +311,9 @@ export default class _SubscriberInternalHelper {
       case IDENT_KEY_SLACK:
         this._remove_slack(val, caller);
         break;
+      case IDENT_KEY_MS_TEAMS:
+        this._remove_ms_teams(val, caller);
+        break;
       default:
         break;
     }
@@ -540,4 +596,36 @@ export default class _SubscriberInternalHelper {
     }
     this.__dict_remove[IDENT_KEY_SLACK] = validated_value;
   }
+
+  __check_ms_teams_dict(value, caller) {
+    const msg = "value must be a valid dict/json with proper keys";
+    if (!(value && value instanceof Object)) {
+      this.__errors.push(`[${caller}] ${msg}`);
+      return [value, false];
+    } else {
+      return [value, true];
+    }
+  }
+
+  _add_ms_teams(value, caller) {
+    const [validated_value, is_valid] = this.__check_ms_teams_dict(
+      value,
+      caller
+    );
+    if (!is_valid) {
+      return;
+    }
+    this.__dict_append[IDENT_KEY_MS_TEAMS] = validated_value;
+  }
+
+  _remove_ms_teams(value, caller) {
+    const [validated_value, is_valid] = this.__check_ms_teams_dict(
+      value,
+      caller
+    );
+    if (!is_valid) {
+      return;
+    }
+    this.__dict_remove[IDENT_KEY_MS_TEAMS] = validated_value;
+  }
 }