@suprsend/node-sdk 1.8.1 → 1.9.0

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;
+  }
 }

package/src/subscriber_list.js

@@ -22,6 +22,7 @@ class SubscriberListBroadcast {
     }
     this.body = body;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.tenant_id = kwargs?.tenant_id;
     this.brand_id = kwargs?.brand_id;
   }
 
@@ -64,6 +65,9 @@ class SubscriberListBroadcast {
     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;
     }
@@ -82,6 +86,9 @@ class SubscriberListBroadcast {
     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;
     }
@@ -235,7 +242,7 @@ class SubscriberListsApi {
 
     const url = `${this.__subscriber_list_detail_url(
       cleaned_list_id
-    )}subscriber/add`;
+    )}subscriber/add/`;
     const headers = { ...this.__headers, ...this.__dynamic_headers() };
     const content_text = JSON.stringify({ distinct_ids: distinct_ids });
 
@@ -267,7 +274,7 @@ class SubscriberListsApi {
 
     const url = `${this.__subscriber_list_detail_url(
       cleaned_list_id
-    )}subscriber/remove`;
+    )}subscriber/remove/`;
     const headers = { ...this.__headers, ...this.__dynamic_headers() };
     const content_text = JSON.stringify({ distinct_ids: distinct_ids });
 
@@ -288,6 +295,31 @@ class SubscriberListsApi {
     }
   }
 
+  async delete(list_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const content_text = JSON.stringify({});
+
+    const url = `${this.__subscriber_list_detail_url(cleaned_list_id)}delete/`;
+
+    const headers = { ...this.__headers, ...this.__dynamic_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 broadcast(broadcast_instance) {
     if (!(broadcast_instance instanceof SubscriberListBroadcast)) {
       throw new InputValueError(
@@ -338,6 +370,200 @@ class SubscriberListsApi {
       };
     }
   }
+
+  async start_sync(list_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+
+    const url = `${this.__subscriber_list_detail_url(
+      cleaned_list_id
+    )}start_sync/`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({});
+
+    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);
+    }
+  }
+
+  _validate_version_id(version_id) {
+    if (typeof version_id != "string") {
+      throw new SuprsendError("version_id must be a string");
+    }
+    let cleaned_version_id = version_id.trim();
+    if (!cleaned_version_id) {
+      throw new SuprsendError("missing version_id");
+    }
+    return version_id;
+  }
+
+  __subscriber_list_url_with_version(list_id, version_id) {
+    return `${this.config.base_url}v1/subscriber_list/${list_id}/version/${version_id}/`;
+  }
+
+  async get_version(list_id, version_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const cleaned_version_id = this._validate_version_id(version_id);
+
+    const url = this.__subscriber_list_url_with_version(
+      cleaned_list_id,
+      cleaned_version_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_to_version(list_id, version_id, distinct_ids) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const cleaned_version_id = this._validate_version_id(version_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_url_with_version(
+      cleaned_list_id,
+      cleaned_version_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_from_version(list_id, version_id, distinct_ids = []) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const cleaned_version_id = this._validate_version_id(version_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_url_with_version(
+      cleaned_list_id,
+      cleaned_version_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 finish_sync(list_id, version_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const cleaned_version_id = this._validate_version_id(version_id);
+
+    const url = `${this.__subscriber_list_url_with_version(
+      cleaned_list_id,
+      cleaned_version_id
+    )}finish_sync/`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({});
+
+    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_version(list_id, version_id) {
+    const cleaned_list_id = this._validate_list_id(list_id);
+    const cleaned_version_id = this._validate_version_id(version_id);
+
+    const url = `${this.__subscriber_list_url_with_version(
+      cleaned_list_id,
+      cleaned_version_id
+    )}delete/`;
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify({});
+
+    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);
+    }
+  }
 }
 
 export { SubscriberListsApi, SubscriberListBroadcast };

package/src/tenant.js

@@ -0,0 +1,120 @@
+import get_request_signature from "./signature";
+import { SuprsendApiError } from "./utils";
+import axios from "axios";
+
+class TenantsApi {
+  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/tenant/`;
+    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(tenant_id = "") {
+    const cleaned_tenant_id = tenant_id.toString().trim();
+    const tenant_id_encoded = encodeURI(cleaned_tenant_id);
+    const url = `${this.list_url}${tenant_id_encoded}/`;
+    return url;
+  }
+
+  async get(tenant_id = "") {
+    const url = this.detail_url(tenant_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(tenant_id = "", tenant_payload = {}) {
+    const url = this.detail_url(tenant_id);
+
+    const headers = { ...this.__headers, ...this.__dynamic_headers() };
+    const content_text = JSON.stringify(tenant_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 TenantsApi;

package/src/workflow.js

@@ -19,6 +19,7 @@ export default class Workflow {
     }
     this.body = body;
     this.idempotency_key = kwargs?.idempotency_key;
+    this.tenant_id = kwargs?.tenant_id;
     this.brand_id = kwargs?.brand_id;
   }
 
@@ -56,6 +57,9 @@ export default class Workflow {
     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;
     }
@@ -77,6 +81,9 @@ export default class Workflow {
     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/types/index.d.ts

@@ -22,7 +22,11 @@ declare namespace suprsend {
   interface Workflow {
     new (
       body: Dictionary,
-      kwargs?: { idempotency_key?: string; brand_id?: string }
+      kwargs?: {
+        idempotency_key?: string;
+        tenant_id?: string;
+        brand_id?: string;
+      }
     ): Workflow;
 
     add_attachment(
@@ -47,7 +51,11 @@ declare namespace suprsend {
       distinct_id: any,
       event_name: string,
       properties?: Dictionary,
-      kwargs?: { idempotency_key?: string; brand_id?: string }
+      kwargs?: {
+        idempotency_key?: string;
+        tenant_id?: string;
+        brand_id?: string;
+      }
     ): Event;
 
     add_attachment(
@@ -71,6 +79,9 @@ declare namespace suprsend {
     save(): Promise<SResponse>;
 
     append(key: string | Dictionary, value?: any): void;
+    set(key: string | Dictionary, value?: any): void;
+    set_once(key: string | Dictionary, value?: any): void;
+    increment(key: string | Dictionary, value?: number): void;
     remove(key: string | Dictionary, value?: any): void;
     unset(keys: string | string[]): void;
 
@@ -97,6 +108,9 @@ declare namespace suprsend {
     add_slack(value: Dictionary): void;
     remove_slack(value: Dictionary): void;
 
+    add_ms_teams(value: Dictionary): void;
+    remove_ms_teams(value: Dictionary): void;
+
     add_slack_email(email: string): void;
     remove_slack_email(email: string): void;
 
@@ -122,6 +136,15 @@ declare namespace suprsend {
     save(): Promise<SBulkResponse>;
   }
 
+  // tenants
+  interface TenantsApi {
+    list(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
+
+    get(tenant_id: any): Promise<Dictionary>;
+
+    upsert(tenant_id: any, brand_payload?: Dictionary): Promise<Dictionary>;
+  }
+
   // brands
   interface BrandsApi {
     list(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
@@ -135,7 +158,11 @@ declare namespace suprsend {
   interface SubscriberListBroadcast {
     new (
       body: Dictionary,
-      kwargs?: { idempotency_key?: string; brand_id?: string }
+      kwargs?: {
+        idempotency_key?: string;
+        tenant_id?: string;
+        brand_id?: string;
+      }
     ): SubscriberListBroadcast;
 
     add_attachment(
@@ -155,7 +182,29 @@ declare namespace suprsend {
 
     remove(list_id: string, distinct_ids: string[]): Promise<Dictionary>;
 
+    delete(list_id: string): Promise<Dictionary>;
+
     broadcast(broadcast_instance: SubscriberListBroadcast): Promise<SResponse>;
+
+    start_sync(list_id: string): Promise<Dictionary>;
+
+    get_version(list_id: string, version_id: string): Promise<Dictionary>;
+
+    add_to_version(
+      list_id: string,
+      version_id: string,
+      distinct_ids: string[]
+    ): Promise<Dictionary>;
+
+    remove_from_version(
+      list_id: string,
+      version_id: string,
+      distinct_ids: string[]
+    ): Promise<Dictionary>;
+
+    finish_sync(list_id: string, version_id: string): Promise<Dictionary>;
+
+    delete_version(list_id: string, version_id: string): Promise<Dictionary>;
   }
 
   interface Suprsend {
@@ -173,6 +222,8 @@ declare namespace suprsend {
 
     get bulk_users(): BulkSubscribersFactory;
 
+    tenants: TenantsApi;
+
     brands: BrandsApi;
 
     subscriber_lists: SubscriberListsApi;
@@ -189,7 +240,11 @@ declare namespace suprsend {
       distinct_id: any,
       event_name: string,
       properties?: Dictionary,
-      kwargs?: { idempotency_key?: string; brand_id?: string }
+      kwargs?: {
+        idempotency_key?: string;
+        tenant_id?: string;
+        brand_id?: string;
+      }
     ): Promise<SResponse>;
 
     track_event(event: Event): Promise<SResponse>;