@signalhousellc/sdk 1.0.29 → 1.0.30

package/package.json

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

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,
+					});
+				},
+			};
+		}
 	}
 
 	/**
@@ -124,6 +167,39 @@ export class Numbers {
 		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 });
+	}
+
 	/**
 	 * Assign phone numbers to a campaign by providing the campaign ID and a list of phone numbers to assign
 	 * @async