@suprsend/node-sdk 1.5.0 → 1.6.0

package/dist/request_json/workflow.json

@@ -84,6 +84,20 @@
     "slack_setting": {
       "type": "object",
       "properties": {
+        "access_token": {
+          "type": "string",
+          "pattern": "^xox",
+          "description": "Bot User OAuth Access Token with prefix xoxb-"
+        },
+        "channel_id": {
+          "type": "string",
+          "pattern": "^[cC][a-zA-Z0-9]+$",
+          "description": "slack channel id. the bot must be part of it",
+          "message": {
+            "required": "",
+            "pattern": "Slack Channel id format: CXXXXXXXXX"
+          }
+        },
         "user_id": {
           "type": "string",
           "pattern": "^[uUwW][a-zA-Z0-9]+$",
@@ -93,7 +107,20 @@
             "pattern": "Slack Member id format: [U|W]XXXXXXXXX"
           }
         },
-        "email": { "$ref": "#/definitions/email_pattern" }
+        "email": {
+          "$ref": "#/definitions/email_pattern"
+        },
+        "incoming_webhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https://hooks.slack.com/",
+              "description": "incoming webhook url. e.g https://hooks.slack.com/TXXXXX/BXXXXX/XXXXXXXXXX"
+            }
+          }
+        }
       },
       "additionalProperties": false
     },
@@ -136,10 +163,13 @@
     "user_setting": {
       "type": "object",
       "properties": {
+        "is_transient": {
+          "type": ["boolean", "null"],
+          "description": "indicates whether this is a transient user. Profiles are not created for such users."
+        },
         "distinct_id": {
-          "type": "string",
-          "minLength": 1,
-          "description": "distinct_id: Id which uniquely identify a user in your app"
+          "type": ["string", "null"],
+          "description": "distinct_id: Id which uniquely identifies a user in your app"
         },
         "$channels": {
           "type": "array",
@@ -285,7 +315,7 @@
           ]
         }
       },
-      "required": ["distinct_id"],
+      "required": [],
       "additionalProperties": false
     },
     "delivery_setting": {
@@ -299,7 +329,7 @@
         "success": {
           "type": "string",
           "default": "seen",
-          "description": "possible values: seen/interaction/<user_defined_event>."
+          "description": "possible values: delivered/seen/interaction/<user_defined_event>."
         },
         "time_to_live": {
           "type": "string",
@@ -323,7 +353,7 @@
             ]
           },
           "minItems": 0,
-          "description": "e.g ['email', 'sms']. Used if smart=true, notification on these channels must be sent, independent of success metric outcome"
+          "description": "e.g ['email', 'sms']. Used if smart=true, notification on these channels must be sent, irrespective of success metric outcome"
         }
       },
       "required": [],

package/dist/subscriber.js

@@ -461,8 +461,27 @@ var Subscriber = /*#__PURE__*/function () {
       this._collect_event();
     }
   }, {
+    key: "add_slack",
+    value: function add_slack(value) {
+      var caller = "add_slack";
+
+      this._helper._add_slack(value, caller);
+
+      this._collect_event();
+    }
+  }, {
+    key: "remove_slack",
+    value: function remove_slack(value) {
+      var caller = "remove_slack";
+
+      this._helper._remove_slack(value, caller);
+
+      this._collect_event();
+    }
+  }, {
     key: "add_slack_email",
     value: function add_slack_email(value) {
+      console.warn("add_slack_email() method has been deprecated. use add_slack() instead");
       var caller = "add_slack_email";
 
       this._helper._add_slack({
@@ -474,6 +493,7 @@ var Subscriber = /*#__PURE__*/function () {
   }, {
     key: "remove_slack_email",
     value: function remove_slack_email(value) {
+      console.warn("remove_slack_email() method has been deprecated. use remove_slack() instead");
       var caller = "remove_slack_email";
 
       this._helper._remove_slack({
@@ -485,6 +505,7 @@ var Subscriber = /*#__PURE__*/function () {
   }, {
     key: "add_slack_userid",
     value: function add_slack_userid(value) {
+      console.warn("add_slack_userid() method has been deprecated. use add_slack() instead");
       var caller = "add_slack_userid";
 
       this._helper._add_slack({
@@ -496,6 +517,7 @@ var Subscriber = /*#__PURE__*/function () {
   }, {
     key: "remove_slack_userid",
     value: function remove_slack_userid(value) {
+      console.warn("remove_slack_userid() method has been deprecated. use remove_slack() instead");
       var caller = "remove_slack_userid";
 
       this._helper._remove_slack({

package/dist/subscriber_helper.js

@@ -663,76 +663,17 @@ var _SubscriberInternalHelper = /*#__PURE__*/function () {
       this.__dict_remove[IDENT_KEY_WEBPUSH] = value;
       this.__dict_remove[KEY_PUSHVENDOR] = vendor;
     }
-  }, {
-    key: "__validate_slack_userid",
-    value: function __validate_slack_userid(userid, caller) {
-      var _this$__check_ident_v9 = this.__check_ident_val_string(userid, caller),
-          _this$__check_ident_v10 = (0, _slicedToArray2["default"])(_this$__check_ident_v9, 2),
-          validated_userid = _this$__check_ident_v10[0],
-          is_valid = _this$__check_ident_v10[1];
-
-      if (!is_valid) {
-        return [validated_userid, false];
-      }
-
-      validated_userid = validated_userid.toUpperCase();
-
-      if (!validated_userid.startsWith("U") && !validated_userid.startsWith("W")) {
-        this.__errors.push("[".concat(caller, "] invalid value ").concat(validated_userid, ". Slack user/member_id starts with a U or W"));
-
-        return [validated_userid, false];
-      }
-
-      return [validated_userid, true];
-    }
   }, {
     key: "__check_slack_dict",
     value: function __check_slack_dict(value, caller) {
-      var msg = "value must be a valid dict/json with one of these keys: [email, user_id]";
+      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];
-      }
-
-      var user_id = value.user_id;
-      var email = value.email;
-
-      if (user_id && user_id.trim()) {
-        user_id = user_id.trim();
-
-        var _this$__validate_slac = this.__validate_slack_userid(user_id, caller),
-            _this$__validate_slac2 = (0, _slicedToArray2["default"])(_this$__validate_slac, 2),
-            validated_user_id = _this$__validate_slac2[0],
-            is_valid = _this$__validate_slac2[1];
-
-        if (!is_valid) {
-          return [value, false];
-        } else {
-          return [{
-            user_id: validated_user_id
-          }, true];
-        }
-      } else if (email && email.trim()) {
-        email = email.trim();
-
-        var _this$__validate_emai5 = this.__validate_email(email, caller),
-            _this$__validate_emai6 = (0, _slicedToArray2["default"])(_this$__validate_emai5, 2),
-            validated_email = _this$__validate_emai6[0],
-            _is_valid = _this$__validate_emai6[1];
-
-        if (!_is_valid) {
-          return [value, false];
-        } else {
-          return [{
-            email: validated_email
-          }, true];
-        }
       } else {
-        this.__errors.push("[".concat(caller, "] ").concat(msg));
-
-        return [value, false];
+        return [value, true];
       }
     }
   }, {

package/package.json

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

package/src/request_json/workflow.json

@@ -84,6 +84,20 @@
     "slack_setting": {
       "type": "object",
       "properties": {
+        "access_token": {
+          "type": "string",
+          "pattern": "^xox",
+          "description": "Bot User OAuth Access Token with prefix xoxb-"
+        },
+        "channel_id": {
+          "type": "string",
+          "pattern": "^[cC][a-zA-Z0-9]+$",
+          "description": "slack channel id. the bot must be part of it",
+          "message": {
+            "required": "",
+            "pattern": "Slack Channel id format: CXXXXXXXXX"
+          }
+        },
         "user_id": {
           "type": "string",
           "pattern": "^[uUwW][a-zA-Z0-9]+$",
@@ -93,7 +107,20 @@
             "pattern": "Slack Member id format: [U|W]XXXXXXXXX"
           }
         },
-        "email": { "$ref": "#/definitions/email_pattern" }
+        "email": {
+          "$ref": "#/definitions/email_pattern"
+        },
+        "incoming_webhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https://hooks.slack.com/",
+              "description": "incoming webhook url. e.g https://hooks.slack.com/TXXXXX/BXXXXX/XXXXXXXXXX"
+            }
+          }
+        }
       },
       "additionalProperties": false
     },
@@ -136,10 +163,13 @@
     "user_setting": {
       "type": "object",
       "properties": {
+        "is_transient": {
+          "type": ["boolean", "null"],
+          "description": "indicates whether this is a transient user. Profiles are not created for such users."
+        },
         "distinct_id": {
-          "type": "string",
-          "minLength": 1,
-          "description": "distinct_id: Id which uniquely identify a user in your app"
+          "type": ["string", "null"],
+          "description": "distinct_id: Id which uniquely identifies a user in your app"
         },
         "$channels": {
           "type": "array",
@@ -285,7 +315,7 @@
           ]
         }
       },
-      "required": ["distinct_id"],
+      "required": [],
       "additionalProperties": false
     },
     "delivery_setting": {
@@ -299,7 +329,7 @@
         "success": {
           "type": "string",
           "default": "seen",
-          "description": "possible values: seen/interaction/<user_defined_event>."
+          "description": "possible values: delivered/seen/interaction/<user_defined_event>."
         },
         "time_to_live": {
           "type": "string",
@@ -323,7 +353,7 @@
             ]
           },
           "minItems": 0,
-          "description": "e.g ['email', 'sms']. Used if smart=true, notification on these channels must be sent, independent of success metric outcome"
+          "description": "e.g ['email', 'sms']. Used if smart=true, notification on these channels must be sent, irrespective of success metric outcome"
         }
       },
       "required": [],

package/src/subscriber.js

@@ -315,25 +315,49 @@ export class Subscriber {
     this._collect_event();
   }
 
+  add_slack(value) {
+    const caller = "add_slack";
+    this._helper._add_slack(value, caller);
+    this._collect_event();
+  }
+
+  remove_slack(value) {
+    const caller = "remove_slack";
+    this._helper._remove_slack(value, caller);
+    this._collect_event();
+  }
+
   add_slack_email(value) {
+    console.warn(
+      "add_slack_email() method has been deprecated. use add_slack() instead"
+    );
     const caller = "add_slack_email";
     this._helper._add_slack({ email: value }, caller);
     this._collect_event();
   }
 
   remove_slack_email(value) {
+    console.warn(
+      "remove_slack_email() method has been deprecated. use remove_slack() instead"
+    );
     const caller = "remove_slack_email";
     this._helper._remove_slack({ email: value }, caller);
     this._collect_event();
   }
 
   add_slack_userid(value) {
+    console.warn(
+      "add_slack_userid() method has been deprecated. use add_slack() instead"
+    );
     const caller = "add_slack_userid";
     this._helper._add_slack({ user_id: value }, caller);
     this._collect_event();
   }
 
   remove_slack_userid(value) {
+    console.warn(
+      "remove_slack_userid() method has been deprecated. use remove_slack() instead"
+    );
     const caller = "remove_slack_userid";
     this._helper._remove_slack({ user_id: value }, caller);
     this._collect_event();

package/src/subscriber_helper.js

@@ -515,58 +515,13 @@ export default class _SubscriberInternalHelper {
     this.__dict_remove[KEY_PUSHVENDOR] = vendor;
   }
 
-  __validate_slack_userid(userid, caller) {
-    let [validated_userid, is_valid] = this.__check_ident_val_string(
-      userid,
-      caller
-    );
-    if (!is_valid) {
-      return [validated_userid, false];
-    }
-    validated_userid = validated_userid.toUpperCase();
-    if (
-      !validated_userid.startsWith("U") &&
-      !validated_userid.startsWith("W")
-    ) {
-      this.__errors.push(
-        `[${caller}] invalid value ${validated_userid}. Slack user/member_id starts with a U or W`
-      );
-      return [validated_userid, false];
-    }
-    return [validated_userid, true];
-  }
-
   __check_slack_dict(value, caller) {
-    const msg =
-      "value must be a valid dict/json with one of these keys: [email, user_id]";
+    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];
-    }
-    let user_id = value.user_id;
-    let email = value.email;
-    if (user_id && user_id.trim()) {
-      user_id = user_id.trim();
-      let [validated_user_id, is_valid] = this.__validate_slack_userid(
-        user_id,
-        caller
-      );
-      if (!is_valid) {
-        return [value, false];
-      } else {
-        return [{ user_id: validated_user_id }, true];
-      }
-    } else if (email && email.trim()) {
-      email = email.trim();
-      let [validated_email, is_valid] = this.__validate_email(email, caller);
-      if (!is_valid) {
-        return [value, false];
-      } else {
-        return [{ email: validated_email }, true];
-      }
     } else {
-      this.__errors.push(`[${caller}] ${msg}`);
-      return [value, false];
+      return [value, true];
     }
   }
 

package/types/index.d.ts

@@ -94,6 +94,9 @@ declare namespace suprsend {
     add_webpush(push_token: Dictionary, provider?: string): void;
     remove_webpush(push_token: Dictionary, provider?: string): void;
 
+    add_slack(value: Dictionary): void;
+    remove_slack(value: Dictionary): void;
+
     add_slack_email(email: string): void;
     remove_slack_email(email: string): void;
 
@@ -154,7 +157,7 @@ declare namespace suprsend {
     new (
       workspace_env: string,
       workspace_secret: string,
-      config: { is_staging: boolean }
+      config?: { is_staging?: boolean }
     ): Suprsend;
 
     get bulk_workflows(): BulkWorkflowsFactory;