@signalhousellc/sdk 1.0.25 → 1.0.27

package/package.json

@@ -1,19 +1,19 @@
-{
-  "name": "@signalhousellc/sdk",
-  "version": "1.0.25",
-  "description": "Signal House SDK for use with the Signal House platform",
-  "type": "module",
-  "main": "src/SignalHouseSDK.js",
-  "exports": {
-    ".": "./src/SignalHouseSDK.js"
-  },
-  "files": [
-    "src/",
-    "README.md"
-  ],
-  "author": "Signal House LLC",
-  "license": "ISC",
-  "dependencies": {
-    "axios": "^1.13.5"
-  }
-}
+{
+  "name": "@signalhousellc/sdk",
+  "version": "1.0.27",
+  "description": "Signal House SDK for use with the Signal House platform",
+  "type": "module",
+  "main": "src/SignalHouseSDK.js",
+  "exports": {
+    ".": "./src/SignalHouseSDK.js"
+  },
+  "files": [
+    "src/",
+    "README.md"
+  ],
+  "author": "Signal House LLC",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.13.5"
+  }
+}

package/src/domains/Numbers.js

@@ -1,202 +1,232 @@
-export class Numbers {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get a list of phone numbers with optional filters such as campaignId, brandId, subgroupId, groupId, and pagination parameters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for filtering the phone numbers
-	 * @param {string} [params.phoneNumber] - Filter by phone number (partial match)
-	 * @param {string} [params.campaignId] - Filter by campaign ID
-	 * @param {string} [params.brandId] - Filter by brand ID
-	 * @param {string} [params.subgroupId] - Filter by subgroup ID
-	 * @param {string} [params.groupId] - Filter by group ID
-	 * @param {number} [params.page] - The page number for pagination (default: 1)
-	 * @param {number} [params.limit] - The number of items per page for pagination (default: 20)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the list of phone numbers
-	 */
-	async getPhoneNumbers({ phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
-		const filters = { phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/number${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get a list of available phone numbers for purchase with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for filtering the available phone numbers
-	 * @param {boolean} [params.smsEnabled] - Filter for phone numbers that are SMS enabled
-	 * @param {boolean} [params.mmsEnabled] - Filter for phone numbers that are MMS enabled
-	 * @param {boolean} [params.voiceEnabled] - Filter for phone numbers that are voice enabled
-	 * @param {string} [params.country] - Filter by country code (e.g., "US")
-	 * @param {string} [params.state] - Filter by state code (e.g., "CA")
-	 * @param {string} [params.npa] - Filter by NPA (area code)
-	 * @param {string} [params.nxx] - Filter by NXX (central office code) - the first three digits of the local phone number after the area code
-	 * @param {string} [params.phoneNumber] - Filter by phone number
-	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the list of available phone numbers
-	 */
-	async getAvailablePhoneNumbers({ smsEnabled, mmsEnabled, voiceEnabled, country, state, npa, nxx, phoneNumber, limit, page, options = {} }) {
-		const filters = { smsEnabled, mmsEnabled, voiceEnabled, country, state, npa, nxx, phoneNumber, limit, page };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/number/available${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Purchase phone numbers by providing a list of phone numbers and the subgroup ID to assign them to
-	 * @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
-	 * @returns {Promise<Object>} A promise that resolves to the result of the purchase operation
-	 */
-	async purchasePhoneNumber({ phoneNumbers, subgroupId, options = {} }) {
-		this.client._require({ phoneNumbers, subgroupId });
-		return this.client(`/number`, { method: "POST", body: { phoneNumbers, subgroupId }, ...options });
-	}
-
-	/**
-	 * Update an existing phone number's details (e.g., setting a friendly name)
-	 * @async
-	 * @roles api, admin, developer, user
-	 * @param {Object} params - The parameters for updating the phone number
-	 * @param {string} params.phoneNumber - The phone number to update
-	 * @param {Object} params.updateData - The data to update for the phone number
-	 * @param {string} [params.updateData.friendlyName] - An optional friendly name for the phone number
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the phoneNumber or updateData parameter is missing
-	 * @returns {Promise<Object>} A promise that resolves to the updated phone number object
-	 */
-	async updatePhoneNumber({ phoneNumber, updateData, options = {} }) {
-		this.client._require({ phoneNumber, updateData });
-		
-		// Safely encode the phone number for the URL path
-		const safePhoneNumber = encodeURIComponent(phoneNumber);
-		
-		return this.client(`/number/${safePhoneNumber}`, { 
-			method: "PUT", 
-			body: updateData, 
-			...options 
-		});
-	}
-	
-	/**
-	 * Port in a phone number by providing the necessary information for porting. Note: This operation is not currently supported and will throw an error if called.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for porting in a phone number
-	 * @param {Object} params.numberData - The data for the phone number to be ported
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error indicating that porting is not supported
-	 * @returns {Promise<Object>} A promise that would resolve to the result of the porting operation if it were supported
-	 */
-	async portInPhoneNumber({ numberData, options = {} }) {
-		throw new Error("Porting phone numbers is not currently supported. Please contact support for assistance.");
-		// this.client._require({ numberData });
-		// return this.client(`/number/portin`, { method: "POST", body: numberData, ...options });
-	}
-
-	/**
-	 * Assign phone numbers to a campaign by providing the campaign ID and a list of phone numbers to assign
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for assigning phone numbers to a campaign
-	 * @param {string} params.campaignId - The ID of the campaign to assign phone numbers to
-	 * @param {string[]} params.phoneNumbers - The list of phone numbers to assign to the campaign
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignId or phoneNumbers parameter is missing
-	 * @returns {Promise<Object>} A promise that resolves to the result of the assignment operation
-	 */
-	async assignPhoneNumberToCampaign({ campaignId, phoneNumbers, options = {} }) {
-		this.client._require({ campaignId, phoneNumbers });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/number/assign/${safeCampaignId}`, { method: "POST", body: { phoneNumbers }, ...options });
-	}
-
-	/**
-	 * Unassign phone numbers from a campaign by providing a list of phone numbers to unassign. Note: This operation will unassign the specified phone numbers from any campaign they are currently assigned to.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for unassigning phone numbers from campaigns
-	 * @param {string[]} params.phoneNumbers - The list of phone numbers to unassign from campaigns
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-	 * @returns {Promise<Object>} A promise that resolves to the result of the unassignment operation
-	 */
-	async unassignPhoneNumbersFromCampaigns({ phoneNumbers, options = {} }) {
-		this.client._require({ phoneNumbers });
-		return this.client(`/number/unassign`, { method: "POST", body: { phoneNumbers }, ...options });
-	}
-
-	/**
-	 * Delete a list of phone numbers (mark them as RELEASED). The phone numbers will no longer be active or usable but they will still be visible in the system with a status of "RELEASED". Note: This operation is irreversible and should be used with caution.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for deleting phone numbers
-	 * @param {string[]} params.phoneNumbers - The list of phone numbers to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-	 * @returns {Promise<Object>} A promise that resolves to the result of the deletion operation
-	 */
-	async deletePhoneNumbers({ phoneNumbers, options = {} }) {
-		this.client._require({ phoneNumbers });
-		return this.client(`/number`, { method: "DELETE", body: { phoneNumbers }, ...options });
-	}
-
-	/**
-	 * Transfer unassigned phone numbers from one subgroup to another.
-	 * @async
-	 * @param {Object} params - The parameters for transferring phone numbers
-	 * @param {string[]} params.phoneNumbers - The list of phone numbers to transfer
-	 * @param {string} params.newSubgroupId - The ID of the new subgroup to transfer the phone numbers to
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the result of the transfer operation
-	 */
-	async transferPhoneNumbers({ phoneNumbers, newSubgroupId, options = {} }) {
-		this.client._require({ phoneNumbers, newSubgroupId });
-		return this.client(`/number/transfer`, { method: "POST", body: { phoneNumbers, newSubgroupId }, ...options });
-	}
-
-	/**
-	 * Search NPA/NXX lookup data with optional filters.
-	 * At least one search parameter is required.
-	 * Location filters (country, state, city) cannot be combined with NPA/NXX filters.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for searching NPA/NXX data
-	 * @param {string} [params.country] - Filter by country code
-	 * @param {string} [params.state] - Filter by state code (2 characters)
-	 * @param {string} [params.city] - Filter by city name (prefix match, case-insensitive; requires country and state)
-	 * @param {string} [params.npa] - Area code filter (1-3 digits; cannot combine with location filters)
-	 * @param {string} [params.nxx] - Central office code filter (1-3 digits; cannot combine with location filters)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to matching NPA/NXX records or unique NPA/NXX arrays
-	 */
-	async searchNpaNxx({ country, state, city, npa, nxx, options = {} }) {
-		const queryString = this.client._getQueryString({ country, state, city, npa, nxx });
-		return this.client(`/number/lookup${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Batch lookup city/state for NPA/NXX pairs
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for the lookup
-	 * @param {Array<{npa: string, nxx: string}>} params.entries - NPA/NXX pairs to look up (max 50)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to an array of {npa, nxx, city, state} objects
-	 */
-	async lookupLocations({ entries, options = {} }) {
-		return this.client("/number/lookup/location", { method: "POST", body: { entries }, ...options });
-	}
+export class Numbers {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get a list of phone numbers with optional filters such as campaignId, brandId, subgroupId, groupId, and pagination parameters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the phone numbers
+	 * @param {string} [params.phoneNumber] - Filter by phone number (partial match)
+	 * @param {string} [params.campaignId] - Filter by campaign ID
+	 * @param {string} [params.brandId] - Filter by brand ID
+	 * @param {string} [params.subgroupId] - Filter by subgroup ID
+	 * @param {string} [params.groupId] - Filter by group ID
+	 * @param {number} [params.page] - The page number for pagination (default: 1)
+	 * @param {number} [params.limit] - The number of items per page for pagination (default: 20)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the list of phone numbers
+	 */
+	async getPhoneNumbers({ phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
+		const filters = { phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/number${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a list of available phone numbers for purchase with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the available phone numbers
+	 * @param {boolean} [params.smsEnabled] - Filter for phone numbers that are SMS enabled
+	 * @param {boolean} [params.mmsEnabled] - Filter for phone numbers that are MMS enabled
+	 * @param {boolean} [params.voiceEnabled] - Filter for phone numbers that are voice enabled
+	 * @param {string} [params.country] - Filter by country code (e.g., "US")
+	 * @param {string} [params.state] - Filter by state code (e.g., "CA")
+	 * @param {string} [params.npa] - Filter by NPA (area code)
+	 * @param {string} [params.nxx] - Filter by NXX (central office code) - the first three digits of the local phone number after the area code
+	 * @param {string} [params.phoneNumber] - Filter by phone number
+	 * @param {number} [params.limit] - The number of items per page for pagination
+	 * @param {number} [params.page] - The page number for pagination
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the list of available phone numbers
+	 */
+	async getAvailablePhoneNumbers({ smsEnabled, mmsEnabled, voiceEnabled, country, state, npa, nxx, phoneNumber, limit, page, options = {} }) {
+		const filters = { smsEnabled, mmsEnabled, voiceEnabled, country, state, npa, nxx, phoneNumber, limit, page };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/number/available${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Purchase phone numbers by providing a list of phone numbers and the subgroup ID to assign them to
+	 * @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
+	 * @returns {Promise<Object>} A promise that resolves to the result of the purchase operation
+	 */
+	async purchasePhoneNumber({ phoneNumbers, subgroupId, options = {} }) {
+		this.client._require({ phoneNumbers, subgroupId });
+		return this.client(`/number`, { method: "POST", body: { phoneNumbers, subgroupId }, ...options });
+	}
+
+	/**
+	 * Update an existing phone number's details (e.g., setting a friendly name)
+	 * @async
+	 * @roles api, admin, developer, user
+	 * @param {Object} params - The parameters for updating the phone number
+	 * @param {string} params.phoneNumber - The phone number to update
+	 * @param {Object} params.updateData - The data to update for the phone number
+	 * @param {string} [params.updateData.friendlyName] - An optional friendly name for the phone number
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumber or updateData parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to the updated phone number object
+	 */
+	async updatePhoneNumber({ phoneNumber, updateData, options = {} }) {
+		this.client._require({ phoneNumber, updateData });
+		
+		// Safely encode the phone number for the URL path
+		const safePhoneNumber = encodeURIComponent(phoneNumber);
+		
+		return this.client(`/number/${safePhoneNumber}`, { 
+			method: "PUT", 
+			body: updateData, 
+			...options 
+		});
+	}
+	
+	/**
+	 * Port in a phone number by providing the necessary information for porting. Note: This operation is not currently supported and will throw an error if called.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for porting in a phone number
+	 * @param {Object} params.numberData - The data for the phone number to be ported
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error indicating that porting is not supported
+	 * @returns {Promise<Object>} A promise that would resolve to the result of the porting operation if it were supported
+	 */
+	async portInPhoneNumber({ numberData, options = {} }) {
+		throw new Error("Porting phone numbers is not currently supported. Please contact support for assistance.");
+		// this.client._require({ numberData });
+		// return this.client(`/number/portin`, { method: "POST", body: numberData, ...options });
+	}
+
+	/**
+	 * Assign phone numbers to a campaign by providing the campaign ID and a list of phone numbers to assign
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for assigning phone numbers to a campaign
+	 * @param {string} params.campaignId - The ID of the campaign to assign phone numbers to
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to assign to the campaign
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the campaignId or phoneNumbers parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to the result of the assignment operation
+	 */
+	async assignPhoneNumberToCampaign({ campaignId, phoneNumbers, options = {} }) {
+		this.client._require({ campaignId, phoneNumbers });
+		const safeCampaignId = encodeURIComponent(campaignId);
+		return this.client(`/number/assign/${safeCampaignId}`, { method: "POST", body: { phoneNumbers }, ...options });
+	}
+
+	/**
+	 * Unassign phone numbers from a campaign by providing a list of phone numbers to unassign. Note: This operation will unassign the specified phone numbers from any campaign they are currently assigned to.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for unassigning phone numbers from campaigns
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to unassign from campaigns
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to the result of the unassignment operation
+	 */
+	async unassignPhoneNumbersFromCampaigns({ phoneNumbers, options = {} }) {
+		this.client._require({ phoneNumbers });
+		return this.client(`/number/unassign`, { method: "POST", body: { phoneNumbers }, ...options });
+	}
+
+	/**
+	 * Delete a list of phone numbers (mark them as RELEASED). The phone numbers will no longer be active or usable but they will still be visible in the system with a status of "RELEASED". Note: This operation is irreversible and should be used with caution.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for deleting phone numbers
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to delete
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to the result of the deletion operation
+	 */
+	async deletePhoneNumbers({ phoneNumbers, options = {} }) {
+		this.client._require({ phoneNumbers });
+		return this.client(`/number`, { method: "DELETE", body: { phoneNumbers }, ...options });
+	}
+
+	/**
+	 * Deactivate one or more phone numbers. Numbers must be in READY status to be deactivated. Deactivated numbers will not be able to send or receive messages but will remain assigned to their subgroup and campaign.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for deactivating phone numbers
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to deactivate
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to an array of updated phone number objects
+	 */
+	async deactivatePhoneNumbers({ phoneNumbers, options = {} }) {
+		this.client._require({ phoneNumbers });
+		return this.client(`/number/deactivate`, { method: "POST", body: { phoneNumbers }, ...options });
+	}
+
+	/**
+	 * Reactivate one or more previously deactivated phone numbers. Numbers must be in DEACTIVATED status to be reactivated. Reactivated numbers will return to PENDING or IN_PROGRESS status depending on their campaign assignment.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for reactivating phone numbers
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to reactivate
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumbers parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to an array of updated phone number objects
+	 */
+	async reactivatePhoneNumbers({ phoneNumbers, options = {} }) {
+		this.client._require({ phoneNumbers });
+		return this.client(`/number/reactivate`, { method: "POST", body: { phoneNumbers }, ...options });
+	}
+
+	/**
+	 * Transfer unassigned phone numbers from one subgroup to another.
+	 * @async
+	 * @param {Object} params - The parameters for transferring phone numbers
+	 * @param {string[]} params.phoneNumbers - The list of phone numbers to transfer
+	 * @param {string} params.newSubgroupId - The ID of the new subgroup to transfer the phone numbers to
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the result of the transfer operation
+	 */
+	async transferPhoneNumbers({ phoneNumbers, newSubgroupId, options = {} }) {
+		this.client._require({ phoneNumbers, newSubgroupId });
+		return this.client(`/number/transfer`, { method: "POST", body: { phoneNumbers, newSubgroupId }, ...options });
+	}
+
+	/**
+	 * Search NPA/NXX lookup data with optional filters.
+	 * At least one search parameter is required.
+	 * Location filters (country, state, city) cannot be combined with NPA/NXX filters.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for searching NPA/NXX data
+	 * @param {string} [params.country] - Filter by country code
+	 * @param {string} [params.state] - Filter by state code (2 characters)
+	 * @param {string} [params.city] - Filter by city name (prefix match, case-insensitive; requires country and state)
+	 * @param {string} [params.npa] - Area code filter (1-3 digits; cannot combine with location filters)
+	 * @param {string} [params.nxx] - Central office code filter (1-3 digits; cannot combine with location filters)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to matching NPA/NXX records or unique NPA/NXX arrays
+	 */
+	async searchNpaNxx({ country, state, city, npa, nxx, options = {} }) {
+		const queryString = this.client._getQueryString({ country, state, city, npa, nxx });
+		return this.client(`/number/lookup${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Batch lookup city/state for NPA/NXX pairs
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the lookup
+	 * @param {Array<{npa: string, nxx: string}>} params.entries - NPA/NXX pairs to look up (max 50)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to an array of {npa, nxx, city, state} objects
+	 */
+	async lookupLocations({ entries, options = {} }) {
+		return this.client("/number/lookup/location", { method: "POST", body: { entries }, ...options });
+	}
 }