@signalhousellc/sdk 1.0.28 → 1.0.30

package/package.json

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

package/src/domains/Billing.js

@@ -11,6 +11,8 @@ export class Billing {
 	 * @param {Object} params - The parameters for filtering the transaction history
 	 * @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.brandId] - The brand ID to filter by
+	 * @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
@@ -18,8 +20,8 @@ export class Billing {
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Array>} The response from the server
 	 */
-	async getTransactionHistory({ groupId, subgroupId, entryType, transactionType, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, entryType, transactionType, startDate, endDate };
+	async getTransactionHistory({ groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/billing/wallet/transactionHistory${queryString}`, { method: "GET", ...options });
 	}

package/src/domains/Campaigns.js

@@ -175,4 +175,36 @@ export class Campaigns {
 		const safeCampaignId = encodeURIComponent(campaignId);
 		return this.client(`/campaign/${safeCampaignId}`, { method: "DELETE", ...options });
 	}
+
+	/**
+	 * Appeal a DCA-rejected campaign
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for appealing the campaign rejection
+	 * @param {string} params.campaignId - The ID of the campaign to appeal
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request (body should include { reason })
+	 * @throws {Error} Throws an error if the campaignId parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async appealDcaRejection({ campaignId, options = {} }) {
+		this.client._require({ campaignId: campaignId });
+		const safeCampaignId = encodeURIComponent(campaignId);
+		return this.client(`/campaign/appealDcaRejection/${safeCampaignId}`, { method: "POST", ...options });
+	}
+
+	/**
+	 * Nudge a connectivity partner to prioritize review of a campaign in PENDING_DCA_APPROVAL status
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for nudging the campaign
+	 * @param {string} params.campaignId - The ID of the campaign to nudge
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the campaignId parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async nudgeDcaForCampaign({ campaignId, options = {} }) {
+		this.client._require({ campaignId: campaignId });
+		const safeCampaignId = encodeURIComponent(campaignId);
+		return this.client(`/campaign/nudge/${safeCampaignId}`, { method: "POST", ...options });
+	}
 }

package/src/domains/Messages.js

@@ -73,6 +73,54 @@ export class Messages {
 		return this.client(`/message/analytics${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get aggregated DNC (Do Not Contact) opt-out analytics with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting DNC analytics
+	 * @param {string} [params.groupId] - Filter by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
+	 * @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 {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)
+	 */
+	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/dnc/analytics${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get paginated Do Not Call records with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting DNC records
+	 * @param {string} [params.groupId] - Filter by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
+	 * @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 {number} [params.page] - Page number for pagination
+	 * @param {number} [params.limit] - Number of records per page
+	 * @param {string} [params.sortField] - Field to sort by
+	 * @param {string} [params.sortOrder] - Sort direction (asc, desc)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the paginated DNC records
+	 */
+	async getDncRecords({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/dnc${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Send an SMS message to one or more recipient phone numbers
 	 * @async

package/src/domains/Numbers.js

@@ -2,6 +2,49 @@ export class Numbers {
 	constructor(client, enableAdmin) {
 		this.client = client;
 		this.enableAdmin = enableAdmin;
+
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Update a port-in request's status (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for updating the status
+				 * @param {string} params.portingId - The _id of the port-in request
+				 * @param {string} params.status - The new status (PENDING, IN_PROGRESS, REJECTED)
+				 * @param {string} [params.description] - Optional description for the status change
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} A promise that resolves to the updated port-in request
+				 */
+				changePortingStatus: async ({ portingId, status, description, options = {} }) => {
+					this.client._require({ portingId, status });
+					const safeId = encodeURIComponent(portingId);
+					return this.client(`/number/portin/${safeId}/status`, {
+						method: "PUT",
+						body: { status, description },
+						...options,
+					});
+				},
+
+				/**
+				 * Approve a port-in request, setting its status to SUCCESS (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for approving the request
+				 * @param {string} params.portingId - The _id of the port-in request
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} A promise that resolves to the updated port-in request
+				 */
+				approvePortRequest: async ({ portingId, options = {} }) => {
+					this.client._require({ portingId });
+					const safeId = encodeURIComponent(portingId);
+					return this.client(`/number/portin/${safeId}/approve`, {
+						method: "POST",
+						...options,
+					});
+				},
+			};
+		}
 	}
 
 	/**
@@ -91,19 +134,70 @@ export class Numbers {
 	}
 	
 	/**
-	 * 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.
+	 * Submit a port-in request for one or more phone numbers from another provider
 	 * @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 {Object} params - The parameters for the port-in request
+	 * @param {Object} params.numberData - The port-in request data including owner info, address, phone numbers, and signature
 	 * @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
+	 * @throws {Error} Throws an error if the numberData parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to the created port-in request
 	 */
 	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 });
+		this.client._require({ numberData });
+		return this.client(`/number/portin`, { method: "POST", body: numberData, ...options });
+	}
+
+	/**
+	 * Get port-in requests with optional filters. Signal House staff can view all requests; regular users see only their group's requests.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} [params] - The parameters for filtering port-in requests
+	 * @param {string} [params.groupId] - Filter by group ID
+	 * @param {string} [params.phoneNumber] - Filter by phone number
+	 * @param {string} [params.status] - Filter by status (PENDING, IN_PROGRESS, COMPLETED, REJECTED, CANCELLED)
+	 * @param {number} [params.page] - The page number for pagination (default: 1)
+	 * @param {number} [params.limit] - The number of items per page (default: 20)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the paginated list of port-in requests
+	 */
+	async getPortRequests({ groupId, phoneNumber, status, page, limit, options = {} } = {}) {
+		const filters = { groupId, phoneNumber, status, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/number/portin${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a single port-in request by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the port request
+	 * @param {string} params.id - The _id of the port-in request
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the port-in request object
+	 */
+	async getPortRequestById({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/number/portin/${safeId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get porting requests - fetches a single request by portingId, or delegates to getPortRequests for listing
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters
+	 * @param {string} [params.portingId] - If provided, fetches a single port request by ID
+	 * @param {number} [params.page] - Page number for pagination (used when listing)
+	 * @param {number} [params.limit] - Items per page (used when listing)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the port-in request(s)
+	 */
+	async getPortingRequests({ portingId, page, limit, options = {} } = {}) {
+		if (portingId) {
+			return this.getPortRequestById({ id: portingId, options });
+		}
+		return this.getPortRequests({ page, limit, options });
 	}
 
 	/**