@suprsend/node-sdk 1.8.2 → 1.9.0

package/dist/event.js

@@ -27,6 +27,7 @@ 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.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;
 
     // default values
@@ -120,6 +121,9 @@ var Event = /*#__PURE__*/function () {
       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;
       }
@@ -141,6 +145,9 @@ var Event = /*#__PURE__*/function () {
       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/dist/index.js

@@ -36,6 +36,7 @@ var _subscriber = _interopRequireDefault(require("./subscriber"));
 var _subscribers_bulk = _interopRequireDefault(require("./subscribers_bulk"));
 var _subscriber_list = require("./subscriber_list");
 var _brands = _interopRequireDefault(require("./brands"));
+var _tenant = _interopRequireDefault(require("./tenant"));
 var _constants = require("./constants");
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -56,6 +57,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.tenants = new _tenant["default"](this);
     this.subscriber_lists = new _subscriber_list.SubscriberListsApi(this);
     this._validate();
   }

package/dist/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/dist/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/dist/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": {
@@ -184,7 +223,8 @@
               "whatsapp",
               "slack",
               "inbox",
-              "messenger"
+              "messenger",
+              "ms_teams"
             ]
           },
           "minItems": 0,
@@ -290,6 +330,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" },
@@ -349,7 +401,8 @@
               "whatsapp",
               "slack",
               "inbox",
-              "messenger"
+              "messenger",
+              "ms_teams"
             ]
           },
           "minItems": 0,

package/dist/subscriber.js

@@ -236,6 +236,75 @@ var Subscriber = /*#__PURE__*/function () {
         this._collect_event();
       }
     }
+  }, {
+    key: "set",
+    value: function set(key, value) {
+      var caller = "set";
+      if (!(0, _utils.is_string)(key) && !(0, _utils.is_object)(key)) {
+        this.__errors.push("[".concat(caller, "] arg1 must be either string or a dict"));
+        return;
+      }
+      if ((0, _utils.is_string)(key)) {
+        if (value === null || value === undefined) {
+          this.__errors.push("[".concat(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 (var item in key) {
+          this._helper._set_kv(item, key[item], key, caller);
+        }
+        this._collect_event();
+      }
+    }
+  }, {
+    key: "set_once",
+    value: function set_once(key, value) {
+      var caller = "set_once";
+      if (!(0, _utils.is_string)(key) && !(0, _utils.is_object)(key)) {
+        this.__errors.push("[".concat(caller, "] arg1 must be either string or a dict"));
+        return;
+      }
+      if ((0, _utils.is_string)(key)) {
+        if (value === null || value === undefined) {
+          this.__errors.push("[".concat(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 (var item in key) {
+          this._helper._set_once_kv(item, key[item], key, caller);
+        }
+        this._collect_event();
+      }
+    }
+  }, {
+    key: "increment",
+    value: function increment(key, value) {
+      var caller = "increment";
+      if (!(0, _utils.is_string)(key) && !(0, _utils.is_object)(key)) {
+        this.__errors.push("[".concat(caller, "] arg1 must be either string or a dict"));
+        return;
+      }
+      if ((0, _utils.is_string)(key)) {
+        if (value === null || value === undefined) {
+          this.__errors.push("[".concat(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 (var item in key) {
+          this._helper._increment_kv(item, key[item], key, caller);
+        }
+        this._collect_event();
+      }
+    }
   }, {
     key: "remove",
     value: function remove(key, value) {
@@ -397,6 +466,20 @@ var Subscriber = /*#__PURE__*/function () {
       this._helper._remove_slack(value, caller);
       this._collect_event();
     }
+  }, {
+    key: "add_ms_teams",
+    value: function add_ms_teams(value) {
+      var caller = "add_ms_teams";
+      this._helper._add_ms_teams(value, caller);
+      this._collect_event();
+    }
+  }, {
+    key: "remove_ms_teams",
+    value: function remove_ms_teams(value) {
+      var caller = "remove_ms_teams";
+      this._helper._remove_ms_teams(value, caller);
+      this._collect_event();
+    }
   }, {
     key: "add_slack_email",
     value: function add_slack_email(value) {

package/dist/subscriber_helper.js

@@ -18,7 +18,8 @@ var IDENT_KEY_IOSPUSH = "$iospush";
 var IDENT_KEY_WHATSAPP = "$whatsapp";
 var IDENT_KEY_WEBPUSH = "$webpush";
 var IDENT_KEY_SLACK = "$slack";
-var IDENT_KEYS_ALL = [IDENT_KEY_EMAIL, IDENT_KEY_SMS, IDENT_KEY_ANDROIDPUSH, IDENT_KEY_IOSPUSH, IDENT_KEY_WHATSAPP, IDENT_KEY_WEBPUSH, IDENT_KEY_SLACK];
+var IDENT_KEY_MS_TEAMS = "$ms_teams";
+var IDENT_KEYS_ALL = [IDENT_KEY_EMAIL, IDENT_KEY_SMS, IDENT_KEY_ANDROIDPUSH, IDENT_KEY_IOSPUSH, IDENT_KEY_WHATSAPP, IDENT_KEY_WEBPUSH, IDENT_KEY_SLACK, IDENT_KEY_MS_TEAMS];
 var KEY_PUSHVENDOR = "$pushvendor";
 var KEY_PREFERRED_LANGUAGE = "$preferred_language";
 var OTHER_RESERVED_KEYS = ["$messenger", "$inbox", KEY_PUSHVENDOR, "$device_id", "$insert_id", "$time", "$set", "$set_once", "$add", "$append", "$remove", "$unset", "$identify", "$anon_id", "$identified_id", KEY_PREFERRED_LANGUAGE, "$notification_delivered", "$notification_dismiss", "$notification_clicked"];
@@ -32,6 +33,8 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
     this.distinct_id = distinct_id;
     this.workspace_key = workspace_key;
     this.__dict_set = {};
+    this.__dict_set_once = {};
+    this.__dict_increment = {};
     this.__dict_append = {};
     this.__dict_remove = {};
     this.__list_unset = [];
@@ -42,6 +45,8 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
     key: "reset",
     value: function reset() {
       this.__dict_set = {};
+      this.__dict_set_once = {};
+      this.__dict_increment = {};
       this.__dict_append = {};
       this.__dict_remove = {};
       this.__list_unset = [];
@@ -67,6 +72,12 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
       if (!(0, _utils.is_empty)(this.__dict_set)) {
         event["$set"] = this.__dict_set;
       }
+      if (!(0, _utils.is_empty)(this.__dict_set_once)) {
+        event["$set_once"] = this.__dict_set_once;
+      }
+      if (!(0, _utils.is_empty)(this.__dict_increment)) {
+        event["$add"] = this.__dict_increment;
+      }
       if (!(0, _utils.is_empty)(this.__dict_append)) {
         event["$append"] = this.__dict_append;
       }
@@ -130,22 +141,76 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
       }
     }
   }, {
-    key: "_remove_kv",
-    value: function _remove_kv(key, value) {
+    key: "_set_kv",
+    value: function _set_kv(key, value) {
       var args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-      var caller = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "remove";
+      var caller = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "set";
       var _this$__validate_key_3 = this.__validate_key_basic(key, caller),
         _this$__validate_key_4 = (0, _slicedToArray2["default"])(_this$__validate_key_3, 2),
         validated_key = _this$__validate_key_4[0],
         is_k_valid = _this$__validate_key_4[1];
       if (!is_k_valid) {
         return;
+      } else {
+        var _is_k_valid2 = this.__validate_key_prefix(validated_key, caller);
+        if (_is_k_valid2) {
+          this.__dict_set[validated_key] = value;
+        }
+      }
+    }
+  }, {
+    key: "_set_once_kv",
+    value: function _set_once_kv(key, value) {
+      var args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var caller = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "set_once";
+      var _this$__validate_key_5 = this.__validate_key_basic(key, caller),
+        _this$__validate_key_6 = (0, _slicedToArray2["default"])(_this$__validate_key_5, 2),
+        validated_key = _this$__validate_key_6[0],
+        is_k_valid = _this$__validate_key_6[1];
+      if (!is_k_valid) {
+        return;
+      } else {
+        var _is_k_valid3 = this.__validate_key_prefix(validated_key, caller);
+        if (_is_k_valid3) {
+          this.__dict_set_once[validated_key] = value;
+        }
+      }
+    }
+  }, {
+    key: "_increment_kv",
+    value: function _increment_kv(key, value) {
+      var args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var caller = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "increment";
+      var _this$__validate_key_7 = this.__validate_key_basic(key, caller),
+        _this$__validate_key_8 = (0, _slicedToArray2["default"])(_this$__validate_key_7, 2),
+        validated_key = _this$__validate_key_8[0],
+        is_k_valid = _this$__validate_key_8[1];
+      if (!is_k_valid) {
+        return;
+      } else {
+        var _is_k_valid4 = this.__validate_key_prefix(validated_key, caller);
+        if (_is_k_valid4) {
+          this.__dict_increment[validated_key] = value;
+        }
+      }
+    }
+  }, {
+    key: "_remove_kv",
+    value: function _remove_kv(key, value) {
+      var args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var caller = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "remove";
+      var _this$__validate_key_9 = this.__validate_key_basic(key, caller),
+        _this$__validate_key_10 = (0, _slicedToArray2["default"])(_this$__validate_key_9, 2),
+        validated_key = _this$__validate_key_10[0],
+        is_k_valid = _this$__validate_key_10[1];
+      if (!is_k_valid) {
+        return;
       }
       if (this.__is_identity_key(validated_key)) {
         this.__remove_identity(validated_key, value, args, caller);
       } else {
-        var _is_k_valid2 = this.__validate_key_prefix(validated_key, caller);
-        if (_is_k_valid2) {
+        var _is_k_valid5 = this.__validate_key_prefix(validated_key, caller);
+        if (_is_k_valid5) {
           this.__dict_remove[validated_key] = value;
         }
       }
@@ -154,10 +219,10 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
     key: "_unset_k",
     value: function _unset_k(key) {
       var caller = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unset";
-      var _this$__validate_key_5 = this.__validate_key_basic(key, caller),
-        _this$__validate_key_6 = (0, _slicedToArray2["default"])(_this$__validate_key_5, 2),
-        validated_key = _this$__validate_key_6[0],
-        is_k_valid = _this$__validate_key_6[1];
+      var _this$__validate_key_11 = this.__validate_key_basic(key, caller),
+        _this$__validate_key_12 = (0, _slicedToArray2["default"])(_this$__validate_key_11, 2),
+        validated_key = _this$__validate_key_12[0],
+        is_k_valid = _this$__validate_key_12[1];
       if (!is_k_valid) {
         return;
       }
@@ -198,6 +263,9 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
         case IDENT_KEY_SLACK:
           this._add_slack(value, caller);
           break;
+        case IDENT_KEY_MS_TEAMS:
+          this._add_ms_teams(value, caller);
+          break;
         default:
           break;
       }
@@ -228,6 +296,9 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
         case IDENT_KEY_SLACK:
           this._remove_slack(val, caller);
           break;
+        case IDENT_KEY_MS_TEAMS:
+          this._remove_ms_teams(val, caller);
+          break;
         default:
           break;
       }
@@ -570,6 +641,41 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
       }
       this.__dict_remove[IDENT_KEY_SLACK] = validated_value;
     }
+  }, {
+    key: "__check_ms_teams_dict",
+    value: function __check_ms_teams_dict(value, caller) {
+      var msg = "value must be a valid dict/json with proper keys";
+      if (!(value && value instanceof Object)) {
+        this.__errors.push("[".concat(caller, "] ").concat(msg));
+        return [value, false];
+      } else {
+        return [value, true];
+      }
+    }
+  }, {
+    key: "_add_ms_teams",
+    value: function _add_ms_teams(value, caller) {
+      var _this$__check_ms_team = this.__check_ms_teams_dict(value, caller),
+        _this$__check_ms_team2 = (0, _slicedToArray2["default"])(_this$__check_ms_team, 2),
+        validated_value = _this$__check_ms_team2[0],
+        is_valid = _this$__check_ms_team2[1];
+      if (!is_valid) {
+        return;
+      }
+      this.__dict_append[IDENT_KEY_MS_TEAMS] = validated_value;
+    }
+  }, {
+    key: "_remove_ms_teams",
+    value: function _remove_ms_teams(value, caller) {
+      var _this$__check_ms_team3 = this.__check_ms_teams_dict(value, caller),
+        _this$__check_ms_team4 = (0, _slicedToArray2["default"])(_this$__check_ms_team3, 2),
+        validated_value = _this$__check_ms_team4[0],
+        is_valid = _this$__check_ms_team4[1];
+      if (!is_valid) {
+        return;
+      }
+      this.__dict_remove[IDENT_KEY_MS_TEAMS] = validated_value;
+    }
   }]);
   return _SubscriberInternalHelper;
 }();