@suprsend/node-sdk 1.1.1 → 1.2.0

package/src/brands.js

@@ -0,0 +1,120 @@
+import get_request_signature from "./signature";
+import { SuprsendApiError } from "./utils";
+import axios from "axios";
+
+class BrandsApi {
+  constructor(config) {
+    this.config = config;
+    this.list_url = this.__list_url();
+    this.__headers = this.__common_headers();
+  }
+
+  __list_url() {
+    const list_uri_template = `${this.config.base_url}v1/brand/`;
+    return list_uri_template;
+  }
+
+  __common_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  cleaned_limit_offset(limit, offset) {
+    let cleaned_limit =
+      typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+    let cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+    return [cleaned_limit, cleaned_offset];
+  }
+
+  __dynamic_headers() {
+    return {
+      Date: new Date().toUTCString(),
+    };
+  }
+
+  async list(kwargs = {}) {
+    const limit = kwargs?.limit;
+    const offset = kwargs?.offset;
+    const [cleaned_limit, cleaner_offset] = this.cleaned_limit_offset(
+      limit,
+      offset
+    );
+    const final_url_obj = new URL(this.list_url);
+    final_url_obj.searchParams.append("limit", cleaned_limit);
+    final_url_obj.searchParams.append("offset", cleaner_offset);
+    const final_url_string = final_url_obj.href;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+
+    const signature = get_request_signature(
+      final_url_string,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(final_url_string, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  detail_url(brand_id = "") {
+    const cleaned_brand_id = brand_id.toString().trim();
+    const brand_id_encoded = encodeURI(cleaned_brand_id);
+    const url = `${this.list_url}${brand_id_encoded}/`;
+    return url;
+  }
+
+  async get(brand_id = "") {
+    const url = this.detail_url(brand_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_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(brand_id = "", brand_payload = {}) {
+    const url = this.detail_url(brand_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(brand_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);
+    }
+  }
+}
+
+export default BrandsApi;

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.brand_id = kwargs?.brand_id;
     // --- validate
     this.__validate_distinct_id();
     this.__validate_event_name();
@@ -107,6 +108,9 @@ export default class Event {
     if (this.idempotency_key) {
       event_dict["$idempotency_key"] = this.idempotency_key;
     }
+    if (this.brand_id) {
+      event_dict["brand_id"] = this.brand_id;
+    }
     event_dict = validate_track_event_schema(event_dict);
     const apparent_size = get_apparent_event_size(event_dict, is_part_of_bulk);
     if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {

package/src/index.js

@@ -6,6 +6,11 @@ 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 BrandsApi from "./brands";
 import { DEFAULT_UAT_URL, DEFAULT_URL } from "./constants";
 
 const package_json = require("../package.json");
@@ -31,6 +36,10 @@ class Suprsend {
     this._bulk_users = new BulkSubscribersFactory(this);
 
     this._user = new SubscriberFactory(this);
+
+    this.brands = new BrandsApi(this);
+    this.subscribers_list = new SubscribersListApi(this);
+
     this._validate();
   }
 
@@ -122,4 +131,4 @@ class Suprsend {
   }
 }
 
-export { Suprsend, Event, Workflow };
+export { Suprsend, Event, Workflow, SubscribersListBroadcast };

package/src/request_json/event.json

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

package/src/request_json/list_broadcast.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://github.com/suprsend/suprsend-node-sdk/request_json/list_broadcast.json",
+  "title": "list_broadcast_request",
+  "description": "Json schema for list_broadcast request",
+  "$comment": "Json schema for list_broadcast request",
+  "type": "object",
+  "properties": {
+    "$idempotency_key": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "unique id provided by client for request"
+    },
+    "brand_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "brand id for workflow to be run in context of a brand"
+    },
+    "$insert_id": {
+      "type": "string",
+      "minLength": 36,
+      "description": "unique uuid generated per request"
+    },
+    "$time": {
+      "type": "integer",
+      "minimum": 1640995200000,
+      "description": "Timestamp: unix epoch in milliseconds"
+    },
+    "list_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SubscriberList id"
+    },
+    "template": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Template"
+    },
+    "notification_category": {
+      "$ref": "#/definitions/non_empty_string",
+      "description": "slug of Notification category"
+    },
+    "delay": {
+      "type": ["string", "integer"],
+      "minimum": 0,
+      "description": "If string: format [XX]d[XX]h[XX]m[XX]s e.g 1d2h30m10s(for 1day 2hours 30minutes 10sec). If integer: value in number of seconds"
+    },
+    "trigger_at": {
+      "type": "string",
+      "description": "timestamp in ISO-8601 format. e.g 2021-08-27T20:14:51.643Z"
+    },
+    "data": {
+      "type": "object",
+      "description": "variables to be used in workflow. e.g replacing templates variables."
+    }
+  },
+  "required": [
+    "$insert_id",
+    "$time",
+    "list_id",
+    "template",
+    "notification_category",
+    "data"
+  ],
+  "definitions": {
+    "non_empty_string": {
+      "type": "string",
+      "minLength": 2
+    }
+  }
+}

package/src/request_json/workflow.json

@@ -11,6 +11,11 @@
       "maxLength": 64,
       "description": "unique id provided by client for request"
     },
+    "brand_id": {
+      "type": ["string", "null"],
+      "maxLength": 64,
+      "description": "brand id for workflow to be run in context of a brand"
+    },
     "name": {
       "$ref": "#/definitions/non_empty_string",
       "description": "name of workflow"

package/src/signature.js

@@ -12,17 +12,18 @@ export default function get_request_signature(
   headers,
   secret
 ) {
-  if (http_verb === "GET") {
-    return "";
+  let content_md5 = "";
+  let content_type = headers["Content-Type"] || "";
+  if (content) {
+    content_md5 = crypto.createHash("md5").update(content).digest("hex");
   }
-  const content_md5 = crypto.createHash("md5").update(content).digest("hex");
   const request_uri = get_path(url);
   const sign_string =
     http_verb +
     "\n" +
     content_md5 +
     "\n" +
-    headers["Content-Type"] +
+    content_type +
     "\n" +
     headers["Date"] +
     "\n" +

package/src/subscribers_list.js

@@ -0,0 +1,296 @@
+import {
+  SuprsendError,
+  SuprsendApiError,
+  validate_list_broadcast_body_schema,
+  get_apparent_list_broadcast_body_size,
+  uuid,
+  epoch_milliseconds,
+} from "./utils";
+import get_request_signature from "./signature";
+import axios from "axios";
+import {
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES,
+  SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE,
+} from "./constants";
+
+class SubscribersListBroadcast {
+  constructor(body, kwargs = {}) {
+    if (!(body instanceof Object)) {
+      throw new SuprsendError("broadcast body must be a json/dictionary");
+    }
+    this.body = body;
+    this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
+  }
+
+  get_final_json() {
+    this.body["$insert_id"] = uuid();
+    this.body["$time"] = epoch_milliseconds();
+    if (this.idempotency_key) {
+      this.body["$idempotency_key"] = this.idempotency_key;
+    }
+    if (this.brand_id) {
+      this.body["brand_id"] = this.brand_id;
+    }
+    this.body = validate_list_broadcast_body_schema(this.body);
+    const apparent_size = get_apparent_list_broadcast_body_size(this.body);
+    if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
+      throw new SuprsendError(
+        `SubscriberListBroadcast body too big - ${apparent_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
+      );
+    }
+    return [this.body, apparent_size];
+  }
+}
+
+class SubscribersListApi {
+  constructor(config) {
+    this.config = config;
+    this.subscriber_list_url = `${this.config.base_url}v1/subscriber_list/`;
+    this.broadcast_url = `${this.config.base_url}${this.config.workspace_key}/broadcast/`;
+    this.__headers = this.__common_headers();
+    this.non_error_default_response = { success: true };
+  }
+
+  __common_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+    };
+  }
+
+  __dynamic_headers() {
+    return {
+      Date: new Date().toUTCString(),
+    };
+  }
+
+  _validate_list_id(list_id) {
+    if (typeof list_id != "string") {
+      throw new SuprsendError("list_id must be a string");
+    }
+    let cleaned_list_id = list_id.trim();
+    if (!cleaned_list_id) {
+      throw new SuprsendError("missing list_id");
+    }
+    return list_id;
+  }
+
+  async create(payload) {
+    if (!payload) {
+      throw new SuprsendError("missing payload");
+    }
+    let list_id = payload["list_id"];
+    if (!list_id) {
+      throw new SuprsendError("missing list_id in payload");
+    }
+    list_id = this._validate_list_id(list_id);
+    payload["list_id"] = list_id;
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(payload);
+
+    const signature = get_request_signature(
+      this.subscriber_list_url,
+      "POST",
+      content_text,
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.post(
+        this.subscriber_list_url,
+        content_text,
+        { headers }
+      );
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  cleaned_limit_offset(limit, offset) {
+    let cleaned_limit =
+      typeof limit === "number" && limit > 0 && limit <= 1000 ? limit : 20;
+    let cleaned_offset = typeof offset === "number" && offset >= 0 ? offset : 0;
+    return [cleaned_limit, cleaned_offset];
+  }
+
+  async get_all(kwargs = {}) {
+    let limit = kwargs?.limit;
+    let offset = kwargs?.offset;
+    const [cleaned_limit, cleaner_offset] = this.cleaned_limit_offset(
+      limit,
+      offset
+    );
+    const final_url_obj = new URL(`${this.config.base_url}v1/subscriber_list`);
+    final_url_obj.searchParams.append("limit", cleaned_limit);
+    final_url_obj.searchParams.append("offset", cleaner_offset);
+    const url = final_url_obj.href;
+
+    const headers = { ...this.__headers, ...this.__dynamic_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);
+    }
+  }
+
+  __subscriber_list_detail_url(list_id) {
+    return `${this.config.base_url}v1/subscriber_list/${list_id}/`;
+  }
+
+  async get(list_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+
+    const url = this.__subscriber_list_detail_url(cleaned_list_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_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 add(list_id, distinct_ids) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/add`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    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 remove(list_id, distinct_ids = []) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    if (!Array.isArray(distinct_ids)) {
+      throw new SuprsendError("distinct_ids must be list of strings");
+    }
+    if (distinct_ids.length === 0) {
+      return this.non_error_default_response;
+    }
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}subscriber/remove`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({ distinct_ids: distinct_ids });
+
+    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 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,
+  //     };
+  //   }
+  // }
+}
+
+export { SubscribersListApi, SubscribersListBroadcast };

package/src/utils.js

@@ -12,6 +12,7 @@ import { cloneDeep } from "lodash";
 
 const workflow_schema = require("./request_json/workflow.json");
 const event_schema = require("./request_json/event.json");
+const list_broadcast_schema = require("./request_json/list_broadcast.json");
 
 export function base64Encode(file) {
   var body = fs.readFileSync(file);
@@ -44,6 +45,19 @@ export class SuprsendConfigError extends Error {
   }
 }
 
+export class SuprsendApiError extends Error {
+  constructor(error) {
+    let message;
+    if (error.response) {
+      message = `${error.response.status}: ${error.response.data.message}`;
+    } else {
+      message = error.message;
+    }
+    super(message);
+    this.name = "SuprsendApiError";
+  }
+}
+
 export function is_string(value) {
   return typeof value === "string";
 }
@@ -109,6 +123,25 @@ export function validate_track_event_schema(body) {
   }
 }
 
+export function validate_list_broadcast_body_schema(body) {
+  if (!body?.data) {
+    body.data = {};
+  }
+  if (!(body.data instanceof Object)) {
+    throw new SuprsendError("data must be a object");
+  }
+  const schema = list_broadcast_schema;
+  var v = new Validator();
+  const validated_data = v.validate(body, schema);
+  if (validated_data.valid) {
+    return body;
+  } else {
+    const error_obj = validated_data.errors[0];
+    const error_msg = `${error_obj.property} ${error_obj.message}`;
+    throw new SuprsendError(error_msg);
+  }
+}
+
 export function get_apparent_workflow_body_size(body, is_part_of_bulk) {
   let extra_bytes = WORKFLOW_RUNTIME_KEYS_POTENTIAL_SIZE_IN_BYTES;
   let apparent_body = body;
@@ -186,6 +219,11 @@ export function get_apparent_event_size(event, is_part_of_bulk) {
 }
 
 export function get_apparent_identity_event_size(event) {
-  const body_size = JSON.stringify(event);
+  const body_size = JSON.stringify(event).length;
+  return body_size;
+}
+
+export function get_apparent_list_broadcast_body_size(body) {
+  const body_size = JSON.stringify(body).length;
   return body_size;
 }

package/src/workflow.js

@@ -18,6 +18,7 @@ export default class Workflow {
     }
     this.body = body;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.brand_id = kwargs?.brand_id;
   }
 
   add_attachment(file_path = "", kwargs = {}) {
@@ -46,6 +47,9 @@ export default class Workflow {
     if (this.idempotency_key) {
       this.body["$idempotency_key"] = this.idempotency_key;
     }
+    if (this.brand_id) {
+      this.body["brand_id"] = this.brand_id;
+    }
     this.body = validate_workflow_body_schema(this.body);
     const apparent_size = get_apparent_workflow_body_size(
       this.body,