@signalhousellc/sdk 1.0.46 → 1.0.48

package/README.md

@@ -1,38 +1,38 @@
-# @signalhouse/sdk
-
-A lightweight Node.js SDK for the Signal House platform.
-
-## Installation
-
-```bash
-npm install @signalhouse/sdk
-```
-
-Quick Start
-
-```bash
-import { SignalHouseSDK } from '@signalhouse/sdk';
-
-const sdk = new SignalHouseSDK({
-  apiKey: 'your-api-key',
-  baseUrl: 'api url'
-});
-
-const token = await sdk.auth.login({
-    email: 'youremail',
-    password: 'yourpassword'
-});
-
-console.log(token);
-```
-
-Features
-Full support for Signal House API v2
-Integrated Axios with standardized returns
-Lightweight and tree-shakeable
-
-Documentation
-For full API reference and advanced usage, visit https://api.signalhouse.io
-
-License
-ISC © Signal House
+# @signalhouse/sdk
+
+A lightweight Node.js SDK for the Signal House platform.
+
+## Installation
+
+```bash
+npm install @signalhouse/sdk
+```
+
+Quick Start
+
+```bash
+import { SignalHouseSDK } from '@signalhouse/sdk';
+
+const sdk = new SignalHouseSDK({
+  apiKey: 'your-api-key',
+  baseUrl: 'api url'
+});
+
+const token = await sdk.auth.login({
+    email: 'youremail',
+    password: 'yourpassword'
+});
+
+console.log(token);
+```
+
+Features
+Full support for Signal House API v2
+Integrated Axios with standardized returns
+Lightweight and tree-shakeable
+
+Documentation
+For full API reference and advanced usage, visit https://api.signalhouse.io
+
+License
+ISC © Signal House

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalhousellc/sdk",
-  "version": "1.0.46",
+  "version": "1.0.48",
   "description": "Signal House SDK for use with the Signal House platform",
   "type": "module",
   "main": "src/SignalHouseSDK.js",

package/src/domains/Auth.js

@@ -1,54 +1,54 @@
-export class Auth {
-	constructor(client, enableAdmin) {
-		this.client = client;
-        this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Login with email and password
-	 * @async
-	 * @roles public
-	 * @param {Object} params
-	 * @param {string} params.email - The user's email address
-	 * @param {string} params.password - The user's password
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async login({ email, password, options = {} }) {
-		return this.client(`/auth`, { method: "POST", body: { email, password }, ...options });
-	}
-
-	/**
-	 * Reset a user's password
-	 * @async
-	 * @roles api, admin, self
-	 * @param {Object} params
-	 * @param {string} params.userId - The id of the user
-	 * @param {string} params.newPassword - The new password to set for the user
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async resetPassword({ userId, newPassword, options = {} }) {
-        this.client._require({ userId, newPassword });
-		const safeUserId = encodeURIComponent(userId);
-		return this.client(`/auth/resetpassword/${safeUserId}`, { method: "PUT", body: { newPassword }, ...options });
-	}
-
-	/**
-	 * Get token login history for a group or user
-	 * @async
-	 * @roles signalhouse_admin, signalhouse_api, signalhouse_user, admin, api (groupId query); self (userId query)
-	 * @param {Object} params
-	 * @param {string} [params.groupId] - Returns history for all users in the group (one of groupId/userId required)
-	 * @param {string} [params.userId] - Returns history for a specific user (one of groupId/userId required)
-	 * @param {number} [params.page] - Page number (min 1, default 1)
-	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 20)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async getAuthHistory({ groupId, userId, page, limit, options = {} }) {
-		this.client._require({ "groupId or userId": groupId ?? userId });
-		const queryString = this.client._getQueryString({ groupId, userId, page, limit });
-		return this.client(`/auth/history${queryString}`, { method: "GET", ...options });
-	}
-}
+export class Auth {
+	constructor(client, enableAdmin) {
+		this.client = client;
+        this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Login with email and password
+	 * @async
+	 * @roles public
+	 * @param {Object} params
+	 * @param {string} params.email - The user's email address
+	 * @param {string} params.password - The user's password
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async login({ email, password, options = {} }) {
+		return this.client(`/auth`, { method: "POST", body: { email, password }, ...options });
+	}
+
+	/**
+	 * Reset a user's password
+	 * @async
+	 * @roles api, admin, self
+	 * @param {Object} params
+	 * @param {string} params.userId - The id of the user
+	 * @param {string} params.newPassword - The new password to set for the user
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async resetPassword({ userId, newPassword, options = {} }) {
+        this.client._require({ userId, newPassword });
+		const safeUserId = encodeURIComponent(userId);
+		return this.client(`/auth/resetpassword/${safeUserId}`, { method: "PUT", body: { newPassword }, ...options });
+	}
+
+	/**
+	 * Get token login history for a group or user
+	 * @async
+	 * @roles signalhouse_admin, signalhouse_api, signalhouse_user, admin, api (groupId query); self (userId query)
+	 * @param {Object} params
+	 * @param {string} [params.groupId] - Returns history for all users in the group (one of groupId/userId required)
+	 * @param {string} [params.userId] - Returns history for a specific user (one of groupId/userId required)
+	 * @param {number} [params.page] - Page number (min 1, default 1)
+	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 20)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getAuthHistory({ groupId, userId, page, limit, options = {} }) {
+		this.client._require({ "groupId or userId": groupId ?? userId });
+		const queryString = this.client._getQueryString({ groupId, userId, page, limit });
+		return this.client(`/auth/history${queryString}`, { method: "GET", ...options });
+	}
+}

package/src/domains/Billing.js

@@ -73,6 +73,26 @@ export class Billing {
 		return this.client(`/billing/wallet/transactionHistory${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get payment history (wallet recharge transactions) with server-side pagination
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering payment history
+	 * @param {string} params.groupId - The ID of the group to filter by
+	 * @param {string} params.startDate - Start date in YYYY-MM-DD format (inclusive)
+	 * @param {string} params.endDate - End date in YYYY-MM-DD format (inclusive)
+	 * @param {number} [params.page=1] - Page number (positive integer)
+	 * @param {number} [params.limit=10] - Results per page (positive integer, max 10000)
+	 * @param {string} [params.timezone] - IANA timezone (default: "UTC")
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<{data: Array<Object>, pagination: {page: number, limit: number, totalRecords: number, totalPages: number, totalAmount: number}}>}
+	 */
+	async getPaymentHistory({ groupId, startDate, endDate, page, limit, timezone, options = {} }) {
+		const filters = { groupId, startDate, endDate, page, limit, timezone };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/wallet/paymentHistory${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Get the wallet information for a specific group
 	 * @async

package/src/domains/Campaigns.js

@@ -163,6 +163,23 @@ export class Campaigns {
 		return this.client(`/campaign/${safeCampaignId}`, { method: "PUT", body: campaignData, ...options });
 	}
 
+	/**
+	 * Add an internal comment/note to a campaign
+	 * @async
+	 * @roles signalhouse_admin, signalhouse_user
+	 * @param {Object} params - The parameters for adding the comment
+	 * @param {string} params.campaignId - The ID of the campaign
+	 * @param {string} params.comment - The comment/note text
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the campaignId or comment parameter is missing
+	 * @returns {Promise<Object>} The updated campaign object
+	 */
+	async addCampaignComment({ campaignId, comment, options = {} }) {
+		this.client._require({ campaignId, comment });
+		const safeCampaignId = encodeURIComponent(campaignId);
+		return this.client(`/campaign/${safeCampaignId}/comments`, { method: "POST", body: { comment }, ...options });
+	}
+
 	/**
 	 * Delete an existing campaign (mark it as EXPIRED). The campaign will still be retrievable
 	 * @async

package/src/domains/Groups.js

@@ -1,90 +1,90 @@
-export class Groups {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-
-		// Hidden Admin namespace INSIDE the domain
-		if (enableAdmin) {
-			this.admin = {
-				/**
-				 * Get a list of all groups with optional pagination parameters
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for getting groups
-				 * @param {number} [params.page] - The page number for pagination
-				 * @param {number} [params.limit] - The number of items per page
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - The list of groups returned from the server
-				 */
-				getGroups: async ({ page, limit, options = {} }) => {
-					const filters = { page, limit };
-					const queryString = this.client._getQueryString(filters);
-					return this.client(`/group${queryString}`, { method: "GET", ...options });
-				},
-
-				/**
-				 * Create a new group with the specified group data
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for creating a new group
-				 * @param {Object} params.groupData - The data for the new group, including required fields such as groupName
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the groupData parameter is missing or if required fields within groupData are missing
-				 * @returns {Promise<Object>} - The created group object returned from the server
-				 */
-				createGroup: async ({ groupData, options = {} }) => {
-					this.client._require({ groupData: groupData });
-					return this.client(`/group`, { method: "POST", body: groupData, ...options });
-				},
-
-				/**
-				 * Delete a group with the specified group ID
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for deleting a group
-				 * @param {string} params.groupId - The ID of the group to delete
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the groupId parameter is missing
-				 * @returns {Promise<Object>} - The deleted group object returned from the server
-				 */
-				deleteGroup: async ({ groupId, options = {} }) => {
-					this.client._require({ groupId });
-					const safeGroupId = encodeURIComponent(groupId);
-					return this.client(`/group/${safeGroupId}`, { method: "DELETE", ...options });
-				},
-			};
-		}
-	}
-
-	/**
-	 * Get details of a group by its ID
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting a group
-	 * @param {string} params.id - The ID of the group to retrieve
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The group object returned from the server
-	 */
-	async getGroup({ id, options = {} }) {
-		const filters = { id };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/group${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Update a group with the specified group data
-	 * @async
-	 * @roles api, admin, developer, billing
-	 * @param {Object} params - The parameters for updating a group
-	 * @param {string} params.id - The ID of the group to update
-	 * @param {Object} params.groupData - The data for the group, including required fields such as groupName
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id or groupData parameter is missing
-	 * @returns {Promise<Object>} - The updated group object returned from the server
-	 */
-	async updateGroup({ id, groupData, options = {} }) {
-		this.client._require({ id, groupData: groupData });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/group/${safeId}`, { method: "PUT", body: groupData, ...options });
-	}
-}
+export class Groups {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		// Hidden Admin namespace INSIDE the domain
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Get a list of all groups with optional pagination parameters
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for getting groups
+				 * @param {number} [params.page] - The page number for pagination
+				 * @param {number} [params.limit] - The number of items per page
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - The list of groups returned from the server
+				 */
+				getGroups: async ({ page, limit, options = {} }) => {
+					const filters = { page, limit };
+					const queryString = this.client._getQueryString(filters);
+					return this.client(`/group${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Create a new group with the specified group data
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for creating a new group
+				 * @param {Object} params.groupData - The data for the new group, including required fields such as groupName
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupData parameter is missing or if required fields within groupData are missing
+				 * @returns {Promise<Object>} - The created group object returned from the server
+				 */
+				createGroup: async ({ groupData, options = {} }) => {
+					this.client._require({ groupData: groupData });
+					return this.client(`/group`, { method: "POST", body: groupData, ...options });
+				},
+
+				/**
+				 * Delete a group with the specified group ID
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for deleting a group
+				 * @param {string} params.groupId - The ID of the group to delete
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupId parameter is missing
+				 * @returns {Promise<Object>} - The deleted group object returned from the server
+				 */
+				deleteGroup: async ({ groupId, options = {} }) => {
+					this.client._require({ groupId });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/group/${safeGroupId}`, { method: "DELETE", ...options });
+				},
+			};
+		}
+	}
+
+	/**
+	 * Get details of a group by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting a group
+	 * @param {string} params.id - The ID of the group to retrieve
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - The group object returned from the server
+	 */
+	async getGroup({ id, options = {} }) {
+		const filters = { id };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/group${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update a group with the specified group data
+	 * @async
+	 * @roles api, admin, developer, billing
+	 * @param {Object} params - The parameters for updating a group
+	 * @param {string} params.id - The ID of the group to update
+	 * @param {Object} params.groupData - The data for the group, including required fields such as groupName
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id or groupData parameter is missing
+	 * @returns {Promise<Object>} - The updated group object returned from the server
+	 */
+	async updateGroup({ id, groupData, options = {} }) {
+		this.client._require({ id, groupData: groupData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/group/${safeId}`, { method: "PUT", body: groupData, ...options });
+	}
+}