@suprsend/node-sdk 1.11.0 → 1.12.0

package/src/users_api.js

@@ -0,0 +1,121 @@
+import get_request_signature from "./signature";
+import { SuprsendApiError } from "./utils";
+import axios from "axios";
+
+export default class UsersApi {
+  constructor(config) {
+    this.config = config;
+    this.list_url = `${this.config.base_url}v1/user/`;
+  }
+
+  get_headers() {
+    return {
+      "Content-Type": "application/json; charset=utf-8",
+      "User-Agent": this.config.user_agent,
+      Date: new Date().toISOString(), // Adjust to your header date format
+    };
+  }
+
+  validate_distinct_id(distinct_id) {
+    if (!distinct_id || distinct_id.trim() === "") {
+      throw new Error("missing distinct_id");
+    }
+    return distinct_id.trim();
+  }
+
+  detail_url(distinct_id) {
+    return `${this.list_url}${encodeURIComponent(distinct_id)}/`;
+  }
+
+  async get(distinct_id) {
+    const validated_distinct_id = this.validate_distinct_id(distinct_id);
+    const url = this.detail_url(validated_distinct_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 delete(distinct_id) {
+    const validated_distinct_id = this.validate_distinct_id(distinct_id);
+    const url = this.detail_url(validated_distinct_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 get_objects_subscribed_to(distinct_id, options = {}) {
+    const validated_distinct_id = this.validate_distinct_id(distinct_id);
+    const params = new URLSearchParams(options).toString();
+    const url = this.detail_url(validated_distinct_id);
+    const subscription_url = `${url}subscribed_to/object/?${params}`;
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      subscription_url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(subscription_url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+
+  async get_lists_subscribed_to(distinct_id, options = {}) {
+    const validated_distinct_id = this.validate_distinct_id(distinct_id);
+    const params = new URLSearchParams(options).toString();
+    const url = this.detail_url(validated_distinct_id);
+    const subscription_url = `${url}subscribed_to/list/?${params}`;
+    const headers = this.get_headers();
+    const signature = get_request_signature(
+      subscription_url,
+      "GET",
+      "",
+      headers,
+      this.config.workspace_secret
+    );
+    headers["Authorization"] = `${this.config.workspace_key}:${signature}`;
+
+    try {
+      const response = await axios.get(subscription_url, { headers });
+      return response.data;
+    } catch (err) {
+      throw new SuprsendApiError(err);
+    }
+  }
+}

package/types/index.d.ts

@@ -238,31 +238,63 @@ declare namespace suprsend {
 
   // objects
   interface ObjectsApi {
-    list(object_type: string, options?: {}): Promise<Dictionary>;
+    list(
+      object_type: string,
+      options?: { limit?: number; after?: string; before?: string }
+    ): Promise<Dictionary>;
 
     get(object_type: string, object_id: string): Promise<Dictionary>;
 
-    upsert(object_type: string, object_id: string, object_payload?: Dictionary): Promise<Dictionary>;
+    upsert(
+      object_type: string,
+      object_id: string,
+      payload?: Dictionary
+    ): Promise<Dictionary>;
 
-    edit(object_type: string, object_id: string, edit_payload?: Dictionary): Promise<Dictionary>;
+    edit(instance: ObjectEdit): Promise<Dictionary>;
+
+    edit(
+      object_type: string,
+      object_id: string,
+      payload?: Dictionary
+    ): Promise<Dictionary>;
 
     delete(object_type: string, object_id: string): Promise<Dictionary>;
 
-    bulk_delete(object_type: string, payload?: Dictionary): Promise<Dictionary>;
+    bulk_delete(
+      object_type: string,
+      payload: { object_ids: string[] }
+    ): Promise<Dictionary>;
+
+    get_subscriptions(
+      object_type: string,
+      object_id: string,
+      options?: { limit?: number; after?: string; before?: string }
+    ): Promise<Dictionary>;
 
-    get_subscriptions(object_type: string, object_id: string, options?: {}): Promise<Dictionary>;
+    create_subscriptions(
+      object_type: string,
+      object_id: string,
+      payload: Dictionary
+    ): Promise<Dictionary>;
 
-    create_subscriptions(object_type: string, object_id: string, subscriptions?: Dictionary): Promise<Dictionary>;
+    delete_subscriptions(
+      object_type: string,
+      object_id: string,
+      payload: Dictionary
+    ): Promise<Dictionary>;
 
-    delete_subscriptions(object_type: string, object_id: string, subscriptions?: Dictionary): Promise<Dictionary>;
+    get_objects_subscribed_to(
+      object_type: string,
+      object_id: string,
+      options?: { limit?: number; after?: string; before?: string }
+    ): Promise<Dictionary>;
 
-    get_instance(object_type: string, object_id: string): Object;
+    get_instance(object_type: string, object_id: string): ObjectEdit;
   }
 
   // subscribers
-  interface Object {
-    save(): Promise<SResponse>;
-
+  interface ObjectEdit {
     append(key: string | Dictionary, value?: any): void;
     set(key: string | Dictionary, value?: any): void;
     set_once(key: string | Dictionary, value?: any): void;
@@ -298,6 +330,22 @@ declare namespace suprsend {
     remove_ms_teams(value: Dictionary): void;
   }
 
+  interface UsersApi {
+    get(distinct_id: string): Promise<Dictionary>;
+
+    delete(distinct_id: string): Promise<Dictionary>;
+
+    get_objects_subscribed_to(
+      distinct_id: string,
+      options?: { limit?: number; after?: string; before?: string }
+    ): Promise<Dictionary>;
+
+    get_lists_subscribed_to(
+      distinct_id: string,
+      options?: { limit?: number; after?: string; before?: string }
+    ): Promise<Dictionary>;
+  }
+
   interface Suprsend {
     new (
       workspace_env: string,
@@ -323,6 +371,8 @@ declare namespace suprsend {
 
     objects: ObjectsApi;
 
+    users: UsersApi;
+
     add_attachment(
       body: Dictionary,
       file_path: string,