@signalhousellc/sdk 1.0.45 → 1.0.47

package/package.json

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

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
@@ -201,6 +221,25 @@ export class Billing {
 		return this.client(`/billing/invoiceDetails${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get ledger-backed invoice summary from raw ClickHouse transactions
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.groupId - The ID of the group to filter by
+	 * @param {string} [params.subgroupId] - The ID of the subgroup 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 {string} [params.timezone] - IANA timezone (default: "UTC")
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array<{entryType: string, transactionType: string, unitPrice: number, quantity: number, amount: number}>>}
+	 */
+	async getInvoiceLedger({ groupId, subgroupId, startDate, endDate, timezone, options = {} }) {
+		const filters = { groupId, subgroupId, startDate, endDate, timezone };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/invoiceDetails/ledger${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Get the fee schedule for a specific group
 	 * @async

package/src/domains/Messages.js

@@ -17,7 +17,7 @@ export class Messages {
 	 * @param {string} [params.groupId] - Filter messages by the ID of the associated group
 	 * @param {string} [params.status] - Filter messages by their status (ENQUEUED, DEQUEUED, SENT, FAILED, DELIVERED)
 	 * @param {string} [params.direction] - Filter messages by their direction (INBOUND, OUTBOUND)
-	 * @param {string} [params.messageType] - Filter messages by their type (SMS, MMS)
+	 * @param {string|string[]} [params.messageType] - Filter messages by their type. Accepts a single value or an array (e.g. ["SMS", "MMS"]). Allowed values: SMS, MMS, RCS, WHATSAPP, VIBER, P2P. When omitted, defaults to all non-P2P types.
 	 * @param {string} [params.carrier] - Filter messages by the carrier used for sending
 	 * @param {string} [params.senderPhoneNumber] - Filter messages by the sender's phone number
 	 * @param {string} [params.recipientPhoneNumber] - Filter messages by the recipient's phone number
@@ -116,6 +116,58 @@ export class Messages {
 		return this.client(`/message/analytics/filter-options${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get a paginated breakdown of message metrics grouped by subgroup. Each row carries the
+	 * full set of sms/mms/p2p metric columns so the caller can apply channel toggles client-side.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.groupId - The Group ID
+	 * @param {string|string[]} [params.subgroupId]
+	 * @param {string|string[]} [params.brandId]
+	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.phoneNumber]
+	 * @param {string|string[]} [params.carrier]
+	 * @param {string} [params.startDate]
+	 * @param {string} [params.endDate]
+	 * @param {number} [params.page=1]
+	 * @param {number} [params.limit=50] - max 50 per page
+	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + row inclusion. "tenDLC" excludes rows with no SMS/MMS activity; "p2p" excludes rows with no P2P activity; "both" returns rows with any activity.
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
+	 * @returns {Promise<Object>} - { rows, totalCount, page, limit }. Each row carries sms/mms/p2p metric columns plus `smsOptOuts` and `mmsOptOuts` from the DNC analytics MV (P2P has no opt-outs).
+	 */
+	async getAnalyticsBySubgroup({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics/by-subgroup${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a paginated breakdown of failed messages grouped by error code.
+	 * Each row contains per-channel (sms/mms/p2p) error counts plus an enriched description.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.groupId - The Group ID
+	 * @param {string|string[]} [params.subgroupId]
+	 * @param {string|string[]} [params.brandId]
+	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.phoneNumber]
+	 * @param {string|string[]} [params.carrier]
+	 * @param {string} [params.startDate]
+	 * @param {string} [params.endDate]
+	 * @param {number} [params.page=1]
+	 * @param {number} [params.limit=50] - max 50 per page
+	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + totalCount. "tenDLC" excludes rows with no SMS/MMS errors; "p2p" excludes rows with no P2P errors; "both" returns rows with any error.
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
+	 * @returns {Promise<Object>} - { rows, totalCount, totalErrors: { sms, mms, p2p, all }, page, limit }
+	 */
+	async getAnalyticsByErrorCode({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics/by-error-code${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Get aggregated DNC (Do Not Contact) opt-out analytics with optional filters
 	 * @async