@signalhousellc/sdk 1.0.27 → 1.0.29

package/package.json

@@ -1,19 +1,19 @@
-{
-  "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"
-  }
-}
+{
+  "name": "@signalhousellc/sdk",
+  "version": "1.0.29",
+  "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/SignalHouseSDK.js

@@ -52,7 +52,7 @@ export class SignalHouseSDK {
 		// API Domains
 		this.auth = new Auth(client, this.enableAdmin);
 		this.billing = new Billing(client, this.enableAdmin);
-		this.brands = new Brands(client, this.enableAdmin);
+		this.brands = new Brands(client, multipartClient, this.enableAdmin);
 		this.campaigns = new Campaigns(client, this.enableAdmin);
 		this.groups = new Groups(client, this.enableAdmin);
 		this.landings = new Landings(client, multipartClient, this.enableAdmin);

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/Brands.js

@@ -56,8 +56,9 @@
  */
 
 export class Brands {
-	constructor(client, enableAdmin) {
+	constructor(client, multipartClient, enableAdmin) {
 		this.client = client;
+		this.multipartClient = multipartClient;
 		this.enableAdmin = enableAdmin;
 	}
 
@@ -193,4 +194,43 @@ export class Brands {
 		const safeBrandId = encodeURIComponent(brandId);
 		return this.client(`/brand/${safeBrandId}`, { method: "DELETE", ...options });
 	}
+
+	/**
+	 * Get appeal history for a brand
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the appeal history
+	 * @param {string} params.brandId - The ID of the brand to get appeal history for
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the brandId parameter is missing
+	 * @returns {Promise<Array>} Array of BrandAppeal objects
+	 */
+	async getAppealHistory({ brandId, options = {} }) {
+		this.client._require({ brandId });
+		const safeBrandId = encodeURIComponent(brandId);
+		return this.client(`/brand/appeal/${safeBrandId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Submit a brand identity status appeal with supporting documentation
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for submitting the appeal
+	 * @param {string} params.brandId - The ID of the brand to appeal
+	 * @param {Array<string>} params.appealCategories - Array of appeal categories (VERIFY_TAX_ID, VERIFY_NON_PROFIT, VERIFY_GOVERNMENT)
+	 * @param {string} params.explanation - Required explanation justifying the appeal
+	 * @param {File|Blob} params.file - The supporting document file
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if required parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async submitAppeal({ brandId, appealCategories, explanation, file, options = {} }) {
+		this.client._require({ brandId, appealCategories, explanation, file });
+		const safeBrandId = encodeURIComponent(brandId);
+		const formData = new FormData();
+		formData.append("appealCategories", JSON.stringify(appealCategories));
+		formData.append("explanation", explanation);
+		formData.append("file", file);
+		return this.multipartClient(`/brand/appeal/${safeBrandId}`, { method: "POST", body: formData, ...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/Numbers.js

@@ -91,19 +91,37 @@ 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 });
 	}
 
 	/**