@signalhousellc/sdk 1.0.39 → 1.0.42

package/package.json

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

package/src/SignalHouseSDK.js

@@ -15,6 +15,7 @@ import { Groups } from "./domains/Groups.js";
 import { Landings } from "./domains/Landings.js";
 import { Messages } from "./domains/Messages.js";
 import { Numbers } from "./domains/Numbers.js";
+import { Onboarding } from "./domains/Onboarding.js";
 import { Shortlinks } from "./domains/Shortlinks.js";
 import { Subgroups } from "./domains/Subgroups.js";
 import { Subscriptions } from "./domains/Subscriptions.js";
@@ -58,6 +59,7 @@ export class SignalHouseSDK {
 		this.landings = new Landings(client, multipartClient, this.enableAdmin);
 		this.messages = new Messages(client, multipartClient, this.enableAdmin);
 		this.numbers = new Numbers(client, this.enableAdmin);
+		this.onboarding = new Onboarding(client, this.enableAdmin);
 		this.shortlinks = new Shortlinks(client, this.enableAdmin);
 		this.subgroups = new Subgroups(client, this.enableAdmin);
 		this.subscriptions = new Subscriptions(client, this.enableAdmin);

package/src/domains/Billing.js

@@ -62,8 +62,8 @@ export class Billing {
 	 * @param {string} [params.campaignId] - The campaign ID to filter by
 	 * @param {string} [params.entryType] - The type of entry to filter by
 	 * @param {string} [params.transactionType] - The type of transaction to filter by
-	 * @param {string} [params.startDate] - The start date for the filter
-	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Array>} The response from the server
 	 */
@@ -190,8 +190,8 @@ export class Billing {
 	 * @param {Object} params - The parameters for filtering the invoice details
 	 * @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] - The start date for the filter
-	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} The response from the server
 	 */

package/src/domains/Messages.js

@@ -21,8 +21,8 @@ export class Messages {
 	 * @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
-	 * @param {string} [params.startDate] - Filter messages by their start date
-	 * @param {string} [params.endDate] - Filter messages by their end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {string} [params.sortField] - The field to sort the messages by
 	 * @param {string} [params.sortOrder] - The order to sort the messages (asc, desc)
 	 * @param {number} [params.page] - The page number for pagination
@@ -67,8 +67,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
-	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the analytics data
 	 */
@@ -89,8 +89,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
-	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Array>} - A promise that resolves to an array of analytics snapshot records
 	 */
@@ -111,8 +111,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the DNC analytics data (totals, byDate, byPhoneNumber, byCarrier)
 	 */
@@ -133,8 +133,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {number} [params.page] - Page number for pagination
 	 * @param {number} [params.limit] - Number of records per page
 	 * @param {string} [params.sortField] - Field to sort by
@@ -197,7 +197,7 @@ export class Messages {
 		images,
 		options = {},
 	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers });
 
 		const formData = new FormData();
 
@@ -210,7 +210,7 @@ export class Messages {
 		formData.append("senderPhoneNumber", senderPhoneNumber);
 
 		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
+		if (messageBody) formData.append("messageBody", messageBody);
 
 		if (mediaUrls && mediaUrls.length > 0) {
 			formData.append("mediaUrls", JSON.stringify(mediaUrls));
@@ -253,7 +253,7 @@ export class Messages {
 		images,
 		options = {},
 	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers });
 
 		const formData = new FormData();
 
@@ -266,7 +266,7 @@ export class Messages {
 		formData.append("senderPhoneNumber", senderPhoneNumber);
 
 		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
+		if (messageBody) formData.append("messageBody", messageBody);
 
 		if (mediaUrls && mediaUrls.length > 0) {
 			formData.append("mediaUrls", JSON.stringify(mediaUrls));

package/src/domains/Numbers.js

@@ -95,17 +95,16 @@ export class Numbers {
 	/**
 	 * Purchase phone numbers by providing a list of phone numbers and the subgroup ID to assign them to.
 	 *
-	 * Numbers already owned (by this subgroup or another) are skipped; only the remaining numbers are queued
-	 * for purchase and the response `message` names each skipped number and its reason. The request fails
-	 * with an error ONLY when every requested number is already owned.
+	 * Each requested number is queued and processed independently. Per-number success or failure is
+	 * delivered via `NUMBER_PURCHASE_SUCCESSFUL` / `NUMBER_PURCHASE_FAILED` webhooks — not in this response.
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for purchasing phone numbers
 	 * @param {string[]} params.phoneNumbers - The list of phone numbers to purchase
 	 * @param {string} params.subgroupId - The ID of the subgroup to assign the purchased phone numbers to
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the phoneNumbers or subgroupId parameter is missing, or if every requested number is already owned
-	 * @returns {Promise<Object>} A promise that resolves to `{ message }`. The message describes any skipped numbers when some requested numbers were already owned.
+	 * @throws {Error} Throws an error if the phoneNumbers or subgroupId parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to `{ message }` once the request is queued.
 	 */
 	async purchasePhoneNumber({ phoneNumbers, subgroupId, options = {} }) {
 		this.client._require({ phoneNumbers, subgroupId });

package/src/domains/Onboarding.js

@@ -0,0 +1,39 @@
+export class Onboarding {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		// Hidden Admin namespace INSIDE the domain
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Get all onboarding records (one per group). Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} [params] - Optional parameters
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - Array of onboarding records
+				 */
+				getOnboardings: async ({ options = {} } = {}) => {
+					return this.client(`/group/onboarding`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Get a single onboarding record by group ID. Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params
+				 * @param {string} params.groupId - The group ID whose onboarding record to retrieve
+				 * @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 onboarding record
+				 */
+				getOnboarding: async ({ groupId, options = {} }) => {
+					this.client._require({ groupId });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/group/onboarding/${safeGroupId}`, { method: "GET", ...options });
+				},
+			};
+		}
+	}
+}