@suprsend/node-sdk 1.11.1 → 1.13.0

package/src/objects_api.js

@@ -0,0 +1,320 @@
+import { is_string, InputValueError, SuprsendApiError } from "./utils";
+import get_request_signature from "./signature";
+import axios from "axios";
+import ObjectEdit from "./object_edit";
+
+export default class ObjectsApi {
+  constructor(config) {
+    this.config = config;
+    this.list_url = `${this.config.base_url}v1/object/`;
+    this.bulk_url = `${this.config.base_url}v1/bulk/object/`;
+  }
+
+  __get_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+      Date: new Date().toISOString(),
+    };
+  }
+
+  _validate_object_type(object_type) {
+    if (!object_type || !is_string(object_type) || !object_type.trim()) {
+      throw new InputValueError("missing object_type");
+    }
+    return object_type.trim();
+  }
+
+  _validate_object_id(object_id) {
+    if (!object_id || !is_string(object_id) || !object_id.trim()) {
+      throw new InputValueError("missing object_id");
+    }
+    return object_id.trim();
+  }
+
+  async list(object_type, options) {
+    object_type = this._validate_object_type(object_type);
+    const object_type_encoded = encodeURIComponent(object_type);
+    const encoded_options = options
+      ? new URLSearchParams(options).toString()
+      : "";
+
+    const url = `${this.list_url}${object_type_encoded}/${
+      encoded_options ? `?${encoded_options}` : ""
+    }`;
+    const headers = this.__get_headers();
+    const sig = get_request_signature(
+      url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${sig}`;
+
+    try {
+      const response = await axios.get(url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  detail_url(object_type, object_id) {
+    object_type = this._validate_object_type(object_type);
+    const object_type_encoded = encodeURIComponent(object_type);
+
+    object_id = this._validate_object_id(object_id);
+    const object_id_encoded = encodeURIComponent(object_id);
+
+    return `${this.list_url}${object_type_encoded}/${object_id_encoded}/`;
+  }
+
+  async get(object_type, object_id) {
+    const url = this.detail_url(object_type, object_id);
+    const headers = this.__get_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 upsert(object_type, object_id, payload = {}) {
+    const url = this.detail_url(object_type, object_id);
+    payload = payload || {};
+    const headers = this.__get_headers();
+    const content_text = JSON.stringify(payload || {});
+    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 edit(edit_ins_or_object_type, object_id, edit_payload) {
+    let payload, url;
+
+    if (edit_ins_or_object_type instanceof ObjectEdit) {
+      const edit_ins = edit_ins_or_object_type;
+      edit_ins.validate_body();
+      payload = edit_ins.get_payload();
+      url = this.detail_url(edit_ins.object_type, edit_ins.object_id);
+    } else {
+      const object_type = edit_ins_or_object_type;
+      payload = edit_payload || {};
+      url = this.detail_url(object_type, object_id);
+    }
+
+    const content_text = JSON.stringify(payload || {});
+    const headers = this.__get_headers();
+    const signature = get_request_signature(
+      url,
+      "PATCH",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.patch(url, content_text, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async delete(object_type, object_id) {
+    const url = this.detail_url(object_type, object_id);
+    const headers = this.__get_headers();
+    const signature = get_request_signature(
+      url,
+      "DELETE",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(url, { headers });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async bulk_delete(object_type, payload) {
+    object_type = this._validate_object_type(object_type);
+    const object_type_encoded = encodeURIComponent(object_type);
+    const url = `${this.bulk_url}${object_type_encoded}/`;
+    payload = payload || {};
+    const headers = this.__get_headers();
+    const content_text = JSON.stringify(payload);
+    const signature = get_request_signature(
+      url,
+      "DELETE",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(url, {
+        headers: headers,
+        data: content_text,
+      });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async get_subscriptions(object_type, object_id, options) {
+    const encoded_options = options
+      ? new URLSearchParams(options).toString()
+      : "";
+    const _detail_url = this.detail_url(object_type, object_id);
+    const url = `${_detail_url}subscription/${
+      encoded_options ? `?${encoded_options}` : ""
+    }`;
+    const headers = this.__get_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 create_subscriptions(object_type, object_id, payload) {
+    const _detail_url = this.detail_url(object_type, object_id);
+    const url = `${_detail_url}subscription/`;
+    payload = payload || {};
+    const content_text = JSON.stringify(payload);
+    const headers = this.__get_headers();
+
+    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 delete_subscriptions(object_type, object_id, payload) {
+    const _detail_url = this.detail_url(object_type, object_id);
+    const url = `${_detail_url}subscription/`;
+    payload = payload || {};
+    const content_text = JSON.stringify(payload);
+    const headers = this.__get_headers();
+    const signature = get_request_signature(
+      url,
+      "DELETE",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.delete(url, {
+        headers: headers,
+        data: content_text,
+      });
+      if (response.status >= 200 && response.status < 300) {
+        return { success: true, status_code: response.status };
+      } else {
+        throw new SuprsendApiError(response.statusText);
+      }
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async get_objects_subscribed_to(object_type, object_id, options = null) {
+    const encoded_options = options
+      ? new URLSearchParams(options).toString()
+      : "";
+    const _detail_url = this.detail_url(object_type, object_id);
+    const url = `${_detail_url}subscribed_to/object/${
+      encoded_options ? `?${encoded_options}` : ""
+    }`;
+    const headers = this.__get_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);
+    }
+  }
+
+  get_instance(object_type, object_id) {
+    object_type = this._validate_object_type(object_type);
+    object_id = this._validate_object_id(object_id);
+    return new ObjectEdit(this.config, object_type, object_id);
+  }
+
+  get_edit_instance(object_type, object_id) {
+    object_type = this._validate_object_type(object_type);
+    object_id = this._validate_object_id(object_id);
+    return new ObjectEdit(this.config, object_type, object_id);
+  }
+}

package/src/request_json/workflow.json

@@ -51,7 +51,6 @@
       "type": "array",
       "items": { "$ref": "#/definitions/user_setting" },
       "minItems": 1,
-      "maxItems": 100,
       "description": "user object to run workflow for. At least 1 user is required"
     },
     "data": {
@@ -65,27 +64,6 @@
       "type": "string",
       "minLength": 2
     },
-    "mobile_number_pattern": {
-      "type": "string",
-      "minLength": 8,
-      "pattern": "^\\+[0-9\\s]+",
-      "message": {
-        "required": "Either a mobile-number or an array of mobile-numbers. e.g [\"+41446681800\"]",
-        "pattern": "number must start with + and must contain country code. e.g. +41446681800"
-      }
-    },
-    "email_pattern": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^\\S+@\\S+\\.\\S+$",
-      "description": "email of an user",
-      "minLength": 6,
-      "maxLength": 127,
-      "message": {
-        "required": "",
-        "pattern": "value in email format required. e.g. user@example.com"
-      }
-    },
     "slack_setting": {
       "type": "object",
       "properties": {
@@ -113,7 +91,7 @@
           }
         },
         "email": {
-          "$ref": "#/definitions/email_pattern"
+          "$ref": "#/definitions/non_empty_string"
         },
         "incoming_webhook": {
           "type": "object",
@@ -240,25 +218,25 @@
         },
         "$email": {
           "oneOf": [
-            { "$ref": "#/definitions/email_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/email_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$sms": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
@@ -304,13 +282,13 @@
         },
         "$whatsapp": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },

package/src/request_json/workflow_trigger.json

@@ -36,7 +36,6 @@
         ]
       },
       "minItems": 1,
-      "maxItems": 100,
       "description": "list of recipient id/object to run workflow for. At least 1 user is required"
     },
     "data": {
@@ -60,27 +59,6 @@
       "type": "string",
       "minLength": 1
     },
-    "mobile_number_pattern": {
-      "type": "string",
-      "minLength": 8,
-      "pattern": "^\\+[0-9\\s]+",
-      "message": {
-        "required": "Either a mobile-number or an array of mobile-numbers. e.g [\"+41446681800\"]",
-        "pattern": "number must start with + and must contain country code. e.g. +41446681800"
-      }
-    },
-    "email_pattern": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^\\S+@\\S+\\.\\S+$",
-      "description": "email of an user",
-      "minLength": 6,
-      "maxLength": 127,
-      "message": {
-        "required": "",
-        "pattern": "value in email format required. e.g. user@example.com"
-      }
-    },
     "slack_setting": {
       "type": "object",
       "properties": {
@@ -108,7 +86,7 @@
           }
         },
         "email": {
-          "$ref": "#/definitions/email_pattern"
+          "$ref": "#/definitions/non_empty_string"
         },
         "incoming_webhook": {
           "type": "object",
@@ -235,25 +213,25 @@
         },
         "$email": {
           "oneOf": [
-            { "$ref": "#/definitions/email_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/email_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
         "$sms": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },
@@ -283,13 +261,13 @@
         },
         "$whatsapp": {
           "oneOf": [
-            { "$ref": "#/definitions/mobile_number_pattern" },
+            { "$ref": "#/definitions/non_empty_string" },
             {
               "type": "array",
               "uniqueItems": false,
               "maxItems": 10,
               "minItems": 1,
-              "items": { "$ref": "#/definitions/mobile_number_pattern" }
+              "items": { "$ref": "#/definitions/non_empty_string" }
             }
           ]
         },

package/src/subscriber.js

@@ -1,6 +1,5 @@
 import {
   is_object,
-  SuprsendError,
   epoch_milliseconds,
   uuid,
   is_empty,
@@ -44,8 +43,7 @@ export class Subscriber {
   constructor(config, distinct_id) {
     this.config = config;
     this.distinct_id = distinct_id;
-    this.__url = this.__get_url();
-    this.__super_props = this.__super_properties();
+    this.__url = `${this.config.base_url}event/`;
 
     this.__errors = [];
     this.__info = [];
@@ -54,10 +52,6 @@ export class Subscriber {
     this.__warnings_list = [];
   }
 
-  __get_url() {
-    return `${this.config.base_url}event/`;
-  }
-
   __get_headers() {
     return {
       "Content-Type": "application/json; charset=utf-8",
@@ -66,12 +60,6 @@ export class Subscriber {
     };
   }
 
-  __super_properties() {
-    return {
-      $ss_sdk_version: this.config.user_agent,
-    };
-  }
-
   get_events() {
     return {
       $schema: "2",
@@ -80,7 +68,7 @@ export class Subscriber {
       env: this.config.workspace_key,
       distinct_id: this.distinct_id,
       $user_operations: this.user_operations,
-      properties: this.__super_props,
+      properties: { $ss_sdk_version: this.config.user_agent },
     };
   }
 
@@ -120,7 +108,8 @@ export class Subscriber {
       if (is_part_of_bulk) {
         console.log(err_msg);
       } else {
-        throw new InputValueError(err_msg);
+        // throw new InputValueError(err_msg);
+        console.log(err_msg);
       }
     }
     return this.__warnings_list;
@@ -369,37 +358,37 @@ export class Subscriber {
     this._collect_event();
   }
 
-  add_androidpush(push_token, provider = "fcm") {
+  add_androidpush(push_token, provider) {
     const caller = "add_androidpush";
     this._helper._add_androidpush(push_token, provider, caller);
     this._collect_event();
   }
 
-  remove_androidpush(push_token, provider = "fcm") {
+  remove_androidpush(push_token, provider) {
     const caller = "remove_androidpush";
     this._helper._remove_androidpush(push_token, provider, caller);
     this._collect_event();
   }
 
-  add_iospush(push_token, provider = "apns") {
+  add_iospush(push_token, provider) {
     const caller = "add_iospush";
     this._helper._add_iospush(push_token, provider, caller);
     this._collect_event();
   }
 
-  remove_iospush(push_token, provider = "apns") {
+  remove_iospush(push_token, provider) {
     const caller = "remove_iospush";
     this._helper._remove_iospush(push_token, provider, caller);
     this._collect_event();
   }
 
-  add_webpush(push_token, provider = "vapid") {
+  add_webpush(push_token, provider) {
     const caller = "add_webpush";
     this._helper._add_webpush(push_token, provider, caller);
     this._collect_event();
   }
 
-  remove_webpush(push_token, provider = "vapid") {
+  remove_webpush(push_token, provider) {
     const caller = "remove_webpush";
     this._helper._remove_webpush(push_token, provider, caller);
     this._collect_event();