@signalhousellc/sdk 1.0.47 → 1.0.49

package/package.json

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

package/src/domains/Campaigns.js

@@ -103,6 +103,17 @@ export class Campaigns {
 					const safeCampaignId = encodeURIComponent(campaignId);
 					return this.client(`/campaign/reject/${safeCampaignId}`, { method: "POST", ...options });
 				},
+				/**
+				 * Get CNP campaigns shared with Signal House
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for retrieving CNP campaigns
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Array>} The response from the server
+				 */
+				getCNPCampaigns: async ({ options = {} } = {}) => {
+					return this.client(`/campaign/cnp`, { method: "GET", ...options });
+				},
 			};
 		}
 	}
@@ -163,6 +174,23 @@ export class Campaigns {
 		return this.client(`/campaign/${safeCampaignId}`, { method: "PUT", body: campaignData, ...options });
 	}
 
+	/**
+	 * Add an internal comment/note to a campaign
+	 * @async
+	 * @roles signalhouse_admin, signalhouse_user
+	 * @param {Object} params - The parameters for adding the comment
+	 * @param {string} params.campaignId - The ID of the campaign
+	 * @param {string} params.comment - The comment/note text
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the campaignId or comment parameter is missing
+	 * @returns {Promise<Object>} The updated campaign object
+	 */
+	async addCampaignComment({ campaignId, comment, options = {} }) {
+		this.client._require({ campaignId, comment });
+		const safeCampaignId = encodeURIComponent(campaignId);
+		return this.client(`/campaign/${safeCampaignId}/comments`, { method: "POST", body: { comment }, ...options });
+	}
+
 	/**
 	 * Delete an existing campaign (mark it as EXPIRED). The campaign will still be retrievable
 	 * @async

package/src/domains/Groups.js

@@ -1,90 +1,91 @@
-export class Groups {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-
-		// Hidden Admin namespace INSIDE the domain
-		if (enableAdmin) {
-			this.admin = {
-				/**
-				 * Get a list of all groups with optional pagination parameters
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for getting groups
-				 * @param {number} [params.page] - The page number for pagination
-				 * @param {number} [params.limit] - The number of items per page
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - The list of groups returned from the server
-				 */
-				getGroups: async ({ page, limit, options = {} }) => {
-					const filters = { page, limit };
-					const queryString = this.client._getQueryString(filters);
-					return this.client(`/group${queryString}`, { method: "GET", ...options });
-				},
-
-				/**
-				 * Create a new group with the specified group data
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for creating a new group
-				 * @param {Object} params.groupData - The data for the new group, including required fields such as groupName
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the groupData parameter is missing or if required fields within groupData are missing
-				 * @returns {Promise<Object>} - The created group object returned from the server
-				 */
-				createGroup: async ({ groupData, options = {} }) => {
-					this.client._require({ groupData: groupData });
-					return this.client(`/group`, { method: "POST", body: groupData, ...options });
-				},
-
-				/**
-				 * Delete a group with the specified group ID
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for deleting a group
-				 * @param {string} params.groupId - The ID of the group to delete
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the groupId parameter is missing
-				 * @returns {Promise<Object>} - The deleted group object returned from the server
-				 */
-				deleteGroup: async ({ groupId, options = {} }) => {
-					this.client._require({ groupId });
-					const safeGroupId = encodeURIComponent(groupId);
-					return this.client(`/group/${safeGroupId}`, { method: "DELETE", ...options });
-				},
-			};
-		}
-	}
-
-	/**
-	 * Get details of a group by its ID
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting a group
-	 * @param {string} params.id - The ID of the group to retrieve
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The group object returned from the server
-	 */
-	async getGroup({ id, options = {} }) {
-		const filters = { id };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/group${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Update a group with the specified group data
-	 * @async
-	 * @roles api, admin, developer, billing
-	 * @param {Object} params - The parameters for updating a group
-	 * @param {string} params.id - The ID of the group to update
-	 * @param {Object} params.groupData - The data for the group, including required fields such as groupName
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id or groupData parameter is missing
-	 * @returns {Promise<Object>} - The updated group object returned from the server
-	 */
-	async updateGroup({ id, groupData, options = {} }) {
-		this.client._require({ id, groupData: groupData });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/group/${safeId}`, { method: "PUT", body: groupData, ...options });
-	}
-}
+export class Groups {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		// Hidden Admin namespace INSIDE the domain
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Get a list of all groups with optional pagination parameters
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for getting groups
+				 * @param {number} [params.page] - The page number for pagination
+				 * @param {number} [params.limit] - The number of items per page
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - The list of groups returned from the server
+				 */
+				getGroups: async ({ page, limit, options = {} }) => {
+					const filters = { page, limit };
+					const queryString = this.client._getQueryString(filters);
+					return this.client(`/group${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Create a new group with the specified group data
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for creating a new group
+				 * @param {Object} params.groupData - The data for the new group, including required fields such as groupName
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupData parameter is missing or if required fields within groupData are missing
+				 * @returns {Promise<Object>} - The created group object returned from the server
+				 */
+				createGroup: async ({ groupData, options = {} }) => {
+					this.client._require({ groupData: groupData });
+					return this.client(`/group`, { method: "POST", body: groupData, ...options });
+				},
+
+				/**
+				 * Delete a group with the specified group ID
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for deleting a group
+				 * @param {string} params.groupId - The ID of the group to delete
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupId parameter is missing
+				 * @returns {Promise<Object>} - The deleted group object returned from the server
+				 */
+				deleteGroup: async ({ groupId, options = {} }) => {
+					this.client._require({ groupId });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/group/${safeGroupId}`, { method: "DELETE", ...options });
+				},
+			};
+		}
+	}
+
+	/**
+	 * Get details of a group by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting a group
+	 * @param {string} params.id - The ID of the group to retrieve
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - The group object returned from the server
+	 */
+	async getGroup({ id, options = {} }) {
+		const filters = { id };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/group${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update a group with the specified group data
+	 * @async
+	 * @roles api, admin, developer, billing
+	 * @param {Object} params - The parameters for updating a group
+	 * @param {string} params.id - The ID of the group to update
+	 * @param {Object} params.groupData - The data for the group, including required fields such as groupName.
+	 *   Optional CNP fields: cspId (string|null), defaultCnpSubgroupId (string|null)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id or groupData parameter is missing
+	 * @returns {Promise<Object>} - The updated group object returned from the server
+	 */
+	async updateGroup({ id, groupData, options = {} }) {
+		this.client._require({ id, groupData: groupData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/group/${safeId}`, { method: "PUT", body: groupData, ...options });
+	}
+}

package/src/domains/Subgroups.js

@@ -1,106 +1,110 @@
-/**
- * @typedef {Object} CreateSubgroupData
- * @property {string} groupId - The ID of the parent group for the subgroup (must be at least 8 characters long and start with 'G')
- * @property {string} subgroupName - The name of the subgroup (required)
- * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
- * @property {string} [contactLastName] - The last name of the contact person for the subgroup
- * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
- * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
- * @property {string} [addressLine1] - The first line of the address for the subgroup
- * @property {string} [addressLine2] - The second line of the address for the subgroup
- * @property {string} [city] - The city for the subgroup's address
- * @property {string} [state] - The state for the subgroup's address
- * @property {string} [country] - The country for the subgroup's address
- * @property {string} [postalCode] - The postal code for the subgroup's address
- * @property {string} [phone] - The phone number for the subgroup
- */
-
-/**
- * @typedef {Object} UpdateSubgroupData
- * @property {string} [subgroupName] - The name of the subgroup
- * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
- * @property {string} [contactLastName] - The last name of the contact person for the subgroup
- * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
- * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
- * @property {string} [addressLine1] - The first line of the address for the subgroup
- * @property {string} [addressLine2] - The second line of the address for the subgroup
- * @property {string} [city] - The city for the subgroup's address
- * @property {string} [state] - The state for the subgroup's address
- * @property {string} [country] - The country for the subgroup's address
- * @property {string} [postalCode] - The postal code for the subgroup's address
- * @property {string} [phone] - The phone number for the subgroup
- * @property {string} [status] - The status of the subgroup (e.g., "active", "inactive")
- */
-
-export class Subgroups {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get a list of subgroups with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting subgroups
-	 * @param {string} [params.id] - Filter by subgroup ID
-	 * @param {string} [params.groupId] - Filter by parent group ID
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The list of subgroups returned from the server
-	 */
-	async getSubgroups({ id, groupId, page, limit, options = {} }) {
-		const filters = { id, groupId, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/subgroup${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Create a new subgroup with the specified subgroup data
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for creating a subgroup (see CreateSubgroupData typedef for details)
-	 * @param {CreateSubgroupData} params.subgroupData - The data for the subgroup to be created, including required fields such as groupId and subgroupName
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the subgroupData parameter is missing or if required fields in subgroupData are missing
-	 * @returns {Promise<Object>} - The created subgroup object returned from the server
-	 */
-	async createSubgroup({ subgroupData, options = {} }) {
-		this.client._require({ subgroupData: subgroupData });
-		return this.client(`/subgroup`, { method: "POST", body: subgroupData, ...options });
-	}
-
-	/**
-	 * Update an existing subgroup with the specified subgroup data
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for updating a subgroup (see UpdateSubgroupData typedef for details)
-	 * @param {string} params.id - The ID of the subgroup to update
-	 * @param {UpdateSubgroupData} params.updateData - The data for the subgroup to be updated, including fields such as subgroupName, contact information, and status
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id or updateData parameter is missing
-	 * @returns {Promise<Object>} - The updated subgroup object returned from the server
-	 */
-	async updateSubgroup({ id, updateData, options = {} }) {
-		this.client._require({ id, updateData });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/subgroup/${safeId}`, { method: "PUT", body: updateData, ...options });
-	}
-
-	/**
-	 * Delete a subgroup by its ID (mark as inactive)
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for deleting a subgroup
-	 * @param {string} params.id - The ID of the subgroup to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id parameter is missing
-	 * @returns {Promise<Object>} - The deleted subgroup object returned from the server
-	 */
-	async deleteSubgroup({ id, options = {} }) {
-		this.client._require({ id });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/subgroup/${safeId}`, { method: "DELETE", ...options });
-	}
-}
+/**
+ * @typedef {Object} CreateSubgroupData
+ * @property {string} groupId - The ID of the parent group for the subgroup (must be at least 8 characters long and start with 'G')
+ * @property {string} subgroupName - The name of the subgroup (required)
+ * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
+ * @property {string} [contactLastName] - The last name of the contact person for the subgroup
+ * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
+ * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
+ * @property {string} [addressLine1] - The first line of the address for the subgroup
+ * @property {string} [addressLine2] - The second line of the address for the subgroup
+ * @property {string} [city] - The city for the subgroup's address
+ * @property {string} [state] - The state for the subgroup's address
+ * @property {string} [country] - The country for the subgroup's address
+ * @property {string} [postalCode] - The postal code for the subgroup's address
+ * @property {string} [phone] - The phone number for the subgroup
+ * @property {string} [carrierIdFamily] - Optional agency-managed carrier ID selection ("Default", "ATT", "TMobile", "Verizon", "USCellular", "GoogleVoice", "ClearSky", "Interop"). Setting this field requires signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, or billing role.
+ * @property {string|null} [carrierIdRegion] - Optional ClearSky region ("PRClaro", "GuamDocomo", "GuamGTA", "GuamITE") or null; only valid when carrierIdFamily is "ClearSky". Setting this field requires signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, or billing role.
+ */
+
+/**
+ * @typedef {Object} UpdateSubgroupData
+ * @property {string} [subgroupName] - The name of the subgroup
+ * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
+ * @property {string} [contactLastName] - The last name of the contact person for the subgroup
+ * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
+ * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
+ * @property {string} [addressLine1] - The first line of the address for the subgroup
+ * @property {string} [addressLine2] - The second line of the address for the subgroup
+ * @property {string} [city] - The city for the subgroup's address
+ * @property {string} [state] - The state for the subgroup's address
+ * @property {string} [country] - The country for the subgroup's address
+ * @property {string} [postalCode] - The postal code for the subgroup's address
+ * @property {string} [phone] - The phone number for the subgroup
+ * @property {string} [status] - The status of the subgroup (e.g., "active", "inactive")
+ * @property {string} [carrierIdFamily] - Optional agency-managed carrier ID selection ("Default", "ATT", "TMobile", "Verizon", "USCellular", "GoogleVoice", "ClearSky", "Interop"). Setting this field requires signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, or billing role.
+ * @property {string|null} [carrierIdRegion] - Optional ClearSky region ("PRClaro", "GuamDocomo", "GuamGTA", "GuamITE") or null; only valid when carrierIdFamily is "ClearSky". Setting this field requires signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, or billing role.
+ */
+
+export class Subgroups {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get a list of subgroups with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting subgroups
+	 * @param {string} [params.id] - Filter by subgroup ID
+	 * @param {string} [params.groupId] - Filter by parent group ID
+	 * @param {number} [params.page] - The page number for pagination
+	 * @param {number} [params.limit] - The number of items per page for pagination
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - The list of subgroups returned from the server
+	 */
+	async getSubgroups({ id, groupId, page, limit, options = {} }) {
+		const filters = { id, groupId, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/subgroup${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Create a new subgroup with the specified subgroup data
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for creating a subgroup (see CreateSubgroupData typedef for details)
+	 * @param {CreateSubgroupData} params.subgroupData - The data for the subgroup to be created, including required fields such as groupId and subgroupName
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the subgroupData parameter is missing or if required fields in subgroupData are missing
+	 * @returns {Promise<Object>} - The created subgroup object returned from the server
+	 */
+	async createSubgroup({ subgroupData, options = {} }) {
+		this.client._require({ subgroupData: subgroupData });
+		return this.client(`/subgroup`, { method: "POST", body: subgroupData, ...options });
+	}
+
+	/**
+	 * Update an existing subgroup with the specified subgroup data
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for updating a subgroup (see UpdateSubgroupData typedef for details)
+	 * @param {string} params.id - The ID of the subgroup to update
+	 * @param {UpdateSubgroupData} params.updateData - The data for the subgroup to be updated, including fields such as subgroupName, contact information, and status
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id or updateData parameter is missing
+	 * @returns {Promise<Object>} - The updated subgroup object returned from the server
+	 */
+	async updateSubgroup({ id, updateData, options = {} }) {
+		this.client._require({ id, updateData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/subgroup/${safeId}`, { method: "PUT", body: updateData, ...options });
+	}
+
+	/**
+	 * Delete a subgroup by its ID (mark as inactive)
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for deleting a subgroup
+	 * @param {string} params.id - The ID of the subgroup to delete
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id parameter is missing
+	 * @returns {Promise<Object>} - The deleted subgroup object returned from the server
+	 */
+	async deleteSubgroup({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/subgroup/${safeId}`, { method: "DELETE", ...options });
+	}
+}