@signalhousellc/sdk 1.0.66 → 1.0.68

package/README.md

@@ -55,3 +55,13 @@ For full API reference and advanced usage, visit https://api.signalhouse.io
 
 License
 ISC © Signal House
+
+
+### Geographic availability search
+
+The availability path supports optional `city` as a case-insensitive prefix within an explicit `country` (`CA` or `US`) and `state` (province/state code). City must be supplied with both country and state. Example: `getAvailablePhoneNumbers({ country: "CA", state: "QC", city: "Charny", npa: "367", nxx: "883", limit: 10 })`. Canadian province, city, NPA and NXX matches are checked before the result limit; unrelated substring matches are excluded. Availability may change before purchase.
+
+
+Canadian message estimates return per-recipient `phoneNumber`, `rate`, `amount` and `fallback`, plus segment count and total in microdollars. They use cached carrier information without exposing carrier names or making a paid lookup. Rates remain 75,500 for standard carriers and 81,000 for Ice Wireless/Iristel or unresolved carriers; MMS/group MMS use one segment per recipient.
+
+Available-number searches return `{ numbers, numberCount? }`. `numberCount` is omitted when the total is unknown, including Canadian geographic and US city searches; the page length is not a total. These filtered searches have a 20-second discovery deadline and return HTTP 503 when incomplete. Narrow the location/NPA/NXX or retry later. Successful Infobip samples may be cached for 15 seconds across pages; purchase rechecks availability.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalhousellc/sdk",
-  "version": "1.0.66",
+  "version": "1.0.68",
   "description": "Signal House SDK for use with the Signal House platform",
   "type": "module",
   "main": "src/SignalHouseSDK.js",
@@ -19,7 +19,9 @@
   },
   "scripts": {
     "postinstall": "node scripts/install-skills.mjs",
-    "sync-skills": "node scripts/sync-skills.mjs"
+    "sync-skills": "node scripts/sync-skills.mjs",
+    "build:types": "tsc -p tsconfig.json",
+    "check:types": "tsc -p tsconfig.json --noEmit"
   },
   "agents": {
     "skills": "./skills"
@@ -36,5 +38,10 @@
     "jssip": {
       "optional": true
     }
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.3",
+    "jssip": "^3.13.8",
+    "typescript": "^5.9.3"
   }
 }

package/skills/signalhouse-10dlc/references/tcr-rejection-causes.md

@@ -42,13 +42,10 @@ Two distinct real causes share this code.
 
 **`Invalid sub-usecases: SOCIAL`.** `SOCIAL` is not a valid sub-use-case under any parent,
 neither `LOW_VOLUME` nor `MIXED`. Valid sub-use-cases for `LOW_VOLUME` are
-`ACCOUNT_NOTIFICATION`, `CUSTOMER_CARE`, `DELIVERY_NOTIFICATION`, `MARKETING`. Resubmit with
-`SOCIAL` removed.
-
-⚠️ **Known platform bug, tracked as SHGHL-2943.** Signal House validates `subUsecases` against
-the *use-case* enum, so `SOCIAL` is selectable as a sub-use-case even though the registry always
-rejects it. **Delete this subsection when SHGHL-2943 ships.** It documents a defect, and a
-workaround left in a skill becomes permanent.
+`ACCOUNT_NOTIFICATION`, `CUSTOMER_CARE`, `DELIVERY_NOTIFICATION`, `MARKETING`. Signal House's own
+validation now rejects `SOCIAL` as a `subUsecases` value with an immediate 400 before the request
+ever reaches TCR (SHGHL-2943), so this specific 501 should no longer be reachable through the
+API — `SOCIAL` is still a valid top-level `usecase`, just never a sub-use-case.
 
 **Punctuation in a tag.** A tag of `maria-answers` was rejected for containing a hyphen. The
 campaign content was fine. Fix the tag (`mariaanswers`), then the campaign has to be

package/src/SignalHouseSDK.js

@@ -6,6 +6,19 @@ import axios from "axios";
  * @property {object} [headers] - Additional headers to include in the request
  */
 
+/**
+ * @typedef {Object} SignalHouseSDKConfig
+ * @property {string} apiKey - The API key for authenticating requests to the SignalHouse API
+ * @property {string} baseUrl - The base URL for the SignalHouse API (e.g., "https://api.signalhouse.com")
+ * @property {boolean} [enableAdmin=false] - Enable admin-scoped behaviors on domains that support them
+ */
+
+/**
+ * The envelope every domain method resolves to. Non-2xx responses never reject; check `success` first.
+ * @template T
+ * @typedef {{ success: true, data: T, status: number } | { success: false, error: string|Object, status: number|null }} SdkResponse
+ */
+
 // Main SDK Class (SignalHouseSDK.js)
 import { Auth } from "./domains/Auth.js";
 import { Billing } from "./domains/Billing.js";
@@ -24,23 +37,20 @@ import { Users } from "./domains/Users.js";
 import { Notifications } from "./domains/Notifications.js";
 import { Webhooks } from "./domains/Webhooks.js";
 import { Voice } from "./domains/Voice.js";
+import { Agents } from "./domains/Agents.js";
 
 export class SignalHouseSDK {
 	/**
 	 * Initialize the SignalHouseSDK with the required configuration
-	 * @param {Object} config - The configuration object for initializing the SDK
-	 * @param {string} config.apiKey - The API key for authenticating requests to the SignalHouse API
-	 * @param {string} config.baseUrl - The base URL for the SignalHouse API (e.g., "https://api.signalhouse.com")
-	 * @param {boolean} [config.enableAdmin=false] - Enable admin-scoped behaviors on domains that support them.
+	 * @param {SignalHouseSDKConfig} config - The configuration object for initializing the SDK
 	 * @throws {Error} Throws an error if the API key or base URL is missing from the configuration
-	 * @returns {SignalHouseSDK} An instance of the SignalHouseSDK
 	 */
-	constructor(config = {}) {
+	constructor(config) {
 		// Validate required config parameters
-		if (!config.apiKey) {
+		if (!config?.apiKey) {
 			throw new Error("API key is required to initialize SignalHouseSDK");
 		}
-		if (!config.baseUrl) {
+		if (!config?.baseUrl) {
 			throw new Error("Base URL is required to initialize SignalHouseSDK");
 		}
 
@@ -73,6 +83,8 @@ export class SignalHouseSDK {
 		// Voice domain targets the voice-backend service under /voice. Available
 		// like any other domain; gating (if any) will be decided later.
 		this.voice = new Voice(client, this.enableAdmin);
+		// AI Agents domain — customer-facing agent config under /agent.
+		this.agents = new Agents(client, this.enableAdmin);
 	}
 
 	/**
@@ -87,19 +99,21 @@ export class SignalHouseSDK {
 		const instance = axios.create({ baseURL: this.baseUrl, headers: isMultipart ? {} : { "Content-Type": "application/json" } });
 
 		// Add a request interceptor to include the API key in the Authorization header
-		instance.interceptors.request.use((config) => {
+		instance.interceptors.request.use((/** @type {import('axios').InternalAxiosRequestConfig & { token?: string }} */ config) => {
 			const token = config.token || this.apiKey;
 			config.headers.Authorization = `Bearer ${token}`;
 			delete config.token; // Remove token from config to avoid sending it as a header
 			return config;
 		});
 
-		// Standardize responses
+		// Standardize responses. The fulfilled handler deliberately replaces the AxiosResponse with the
+		// SdkResponse envelope, which axios's interceptor typing does not model; the cast keeps that intent visible.
 		instance.interceptors.response.use(
 			// Standard 2xx responses
-			(response) => {
+			/** @type {(response: import('axios').AxiosResponse) => any} */
+			((response) => {
 				return { success: true, data: response.data, status: response.status };
-			},
+			}),
 
 			// Non-2xx responses
 			(error) => {
@@ -153,7 +167,7 @@ export class SignalHouseSDK {
 	_require(fields) {
 		for (const [name, value] of Object.entries(fields)) {
 			if (value === undefined || value === null || value === "") {
-				const error = new Error(`Missing required parameter: ${name}`);
+				const error = /** @type {Error & { status?: number }} */ (new Error(`Missing required parameter: ${name}`));
 				error.name = "SignalHouseValidationError";
 				error.status = 400; // Match API validation code
 				throw error;