@signalhousellc/sdk 1.0.54 → 1.0.56

package/package.json

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

package/src/SignalHouseSDK.js

@@ -19,6 +19,7 @@ import { Onboarding } from "./domains/Onboarding.js";
 import { Shortlinks } from "./domains/Shortlinks.js";
 import { Subgroups } from "./domains/Subgroups.js";
 import { Subscriptions } from "./domains/Subscriptions.js";
+import { Tickets } from "./domains/Tickets.js";
 import { Users } from "./domains/Users.js";
 import { Notifications } from "./domains/Notifications.js";
 import { Webhooks } from "./domains/Webhooks.js";
@@ -56,7 +57,7 @@ export class SignalHouseSDK {
 		this.auth = new Auth(client, this.enableAdmin);
 		this.billing = new Billing(client, this.enableAdmin);
 		this.brands = new Brands(client, multipartClient, this.enableAdmin);
-		this.campaigns = new Campaigns(client, this.enableAdmin);
+		this.campaigns = new Campaigns(client, multipartClient, this.enableAdmin);
 		this.groups = new Groups(client, this.enableAdmin);
 		this.landings = new Landings(client, multipartClient, this.enableAdmin);
 		this.messages = new Messages(client, multipartClient, this.enableAdmin);
@@ -65,6 +66,7 @@ export class SignalHouseSDK {
 		this.shortlinks = new Shortlinks(client, this.enableAdmin);
 		this.subgroups = new Subgroups(client, this.enableAdmin);
 		this.subscriptions = new Subscriptions(client, this.enableAdmin);
+		this.tickets = new Tickets(client, this.enableAdmin);
 		this.users = new Users(client, this.enableAdmin);
 		this.notifications = new Notifications(client, this.enableAdmin);
 		this.webhooks = new Webhooks(client, this.enableAdmin);

package/src/domains/Auth.js

@@ -147,6 +147,19 @@ export class Auth {
 		return this.client(`/auth/logout-all`, { method: "POST", ...options });
 	}
 
+	/**
+	 * Get the Group ID associated with the caller's JWT (the caller's active group). Useful for
+	 * discovering your own groupId, which is required on most other API requests.
+	 * @async
+	 * @roles admin, developer, billing, user, api
+	 * @param {Object} [params]
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response containing { groupId }
+	 */
+	async getGroupId({ options = {} } = {}) {
+		return this.client(`/auth/group-id`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Mint a single-use, short-lived external-link token for the authenticated caller. The token is
 	 * handed to the GHL/Shopify backend so it can link the caller's existing V2 group to its tenant.

package/src/domains/Brands.js

@@ -1,3 +1,9 @@
+/**
+ * @typedef {string} BrandLookupId - Carrier Brand ID (B… or TFNB…), Mongo `_id`, or internal reference UUID.
+ * Use on update, delete, revet, vetting, appeal, and transfer routes. Pending brands return `brandId: null`
+ * in read/create responses — poll `GET /brand?id=<Mongo _id>` until a carrier Brand ID is assigned.
+ */
+
 /**
  * @typedef {Object} CreateBrandData
  * @property {string} subgroupId - The ID of the subgroup to create the brand under
@@ -103,7 +109,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, user
 	 * @param {Object} params - The parameters for filtering the brands
-	 * @param {string} [params.id] - The ID of the brand to filter by
+	 * @param {string} [params.id] - Brand lookup id (carrier Brand ID, Mongo _id, or internal reference)
 	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
 	 * @param {string} [params.groupId] - The ID of the group to filter by
 	 * @param {number} [params.page] - The page number for pagination
@@ -111,7 +117,7 @@ export class Brands {
 	 * @param {string} [params.status] - The status of the brand to filter by (PENDING_CREATION, PENDING_APPROVAL, UNVERIFIED, VERIFIED, VETTED_VERIFIED, PENDING_DELETE, DELETED)
 	 * @param {string} [params.registrationType] - Filter by registration type ("TEN_DLC" or "TOLL_FREE")
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
+	 * @returns {Promise<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, [key: string]: any }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned.
 	 */
 	async getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, options = {} }) {
 		const filters = { id, subgroupId, groupId, page, limit, status, registrationType };
@@ -124,7 +130,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, user
 	 * @param {Object} params - The parameters for getting the external vetting information
-	 * @param {string} params.brandId - The ID of the brand to get the external vetting information for
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandId parameter is missing
 	 * @returns {Promise<Object>} The response from the server
@@ -143,7 +149,7 @@ export class Brands {
 	 * @param {CreateBrandData} params.brandData - The data for the brand to be created
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandData parameter is missing or if required fields in brandData are missing
-	 * @returns {Promise<Object>} The response from the server
+	 * @returns {Promise<Object>} Brand entity. `brandId` is `null` until the carrier assigns a Brand ID — use `_id` to poll status.
 	 */
 	async createBrand({ brandData, options = {} }) {
 		this.client._require({ brandData: brandData });
@@ -158,7 +164,7 @@ export class Brands {
 	 * @param {CreateTollFreeBrandData} params.brandData - The data for the toll-free brand to be created (see CreateTollFreeBrandData typedef for details; TFN-specific fields live under brandData.tollFree, and registrationType is forced server-side by the route)
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandData parameter is missing
-	 * @returns {Promise<Object>} The response from the server
+	 * @returns {Promise<Object>} Brand entity. For Toll-Free, `brandId` is a TFNB-prefixed id when assigned; otherwise `null` — use `_id` to poll.
 	 */
 	async createTollFreeBrand({ brandData, options = {} }) {
 		this.client._require({ brandData });
@@ -171,7 +177,7 @@ export class Brands {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for transferring the brands
 	 * @param {string} params.subgroupId - The ID of the subgroup to transfer the brands to
-	 * @param {Array<string>} params.brandIds - The IDs of the brands to be transferred
+	 * @param {BrandLookupId[]} params.brandIds - Brand lookup ids to transfer (carrier id, Mongo `_id`, or internal reference).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the subgroupId or brandIds parameters are missing
 	 * @returns {Promise<Object>} The response from the server
@@ -187,7 +193,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for creating external vetting
-	 * @param {string} params.brandId - The ID of the brand to create external vetting for
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandId parameter is missing
 	 * @returns {Promise<Object>} The response from the server
@@ -207,7 +213,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for importing external vetting
-	 * @param {string} params.brandId - The ID of the brand to import external vetting for
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {string} params.vettingProviderId - The external vetting provider (AEGIS, WMC, CV)
 	 * @param {string} params.vettingId - The provider-issued vetting / transaction ID to import
 	 * @param {string} [params.vettingToken] - The provider-issued vetting token (required by some providers, e.g. AEGIS)
@@ -226,7 +232,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for updating the brand (see UpdateBrandData typedef for details)
-	 * @param {string} params.brandId - The ID of the brand to update
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {UpdateBrandData} params.brandData - The data for the brand to be updated
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandId parameter is missing
@@ -243,7 +249,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for reverting the brand
-	 * @param {string} params.brandId - The ID of the brand to revert
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandId parameter is missing
 	 * @returns {Promise<Object>} The response from the server
@@ -259,7 +265,7 @@ export class Brands {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for deleting the brand
-	 * @param {string} params.brandId - The ID of the brand to delete
+	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the brandId parameter is missing
 	 * @returns {Promise<Object>} The response from the server
@@ -275,7 +281,7 @@ export class Brands {
 	 * @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 {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @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
@@ -291,7 +297,7 @@ export class Brands {
 	 * @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 {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
 	 * @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

package/src/domains/Campaigns.js

@@ -64,12 +64,12 @@
  * @property {string} [privacyPolicyLink] - A URL linking to the privacy policy for the campaign (optional, must be at most 2048 characters if provided)
  * @property {string} [termsAndConditionsLink] - A URL linking to the terms and conditions for the campaign (optional, must be at most 2048 characters if provided)
  * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters if provided)
- * @property {Object} [tollFree] - Toll-Free editable fields, used when updating a Toll-Free campaign. Mirrors the CreateTollFreeCampaignData `tollFree` object with every field optional (useCase, messageVolume, programSummary (≤500), exampleMessage, customerCareEmail, optInImageURLs, optIns, multiNumberReason (≤500)). Phone numbers cannot be changed via update — Toll-Free numbers are locked to their campaign.
+ * @property {Object} [tollFree] - Toll-Free editable fields, used when updating a Toll-Free campaign. Mirrors the CreateTollFreeCampaignData `tollFree` object with every field optional (useCase, messageVolume, programSummary (40-500), exampleMessage, customerCareEmail, optInImageURLs, optIns, multiNumberReason (≤500)). Phone numbers cannot be changed via update — Toll-Free numbers are locked to their campaign.
  */
 
 /**
  * @typedef {Object} TollFreeOptIn
- * @property {string} [callToAction] - The opt-in call-to-action text for this channel (optional, at most 2048 characters)
+ * @property {string} [callToAction] - The opt-in call-to-action text for this channel (optional, 20-1024 characters when provided)
  * @property {string} [url] - The opt-in web URL (web channel only, optional, at most 2048 characters)
  * @property {Array<string>} [keywords] - The opt-in keywords (keyword channel only, optional)
  */
@@ -78,7 +78,7 @@
  * @typedef {Object} TollFreeCampaignDetails
  * @property {string} useCase - The Toll-Free use case (required, e.g. TWO_FA, GENERAL_MARKETING, HEALTHCARE, MIXED — one of the Toll-Free use-case values)
  * @property {string} messageVolume - The estimated monthly message volume tier (required, one of TEN, HUNDRED, THOUSAND, TEN_THOUSAND, HUNDRED_THOUSAND, TWO_HUNDRED_FIFTY_THOUSAND, FIVE_HUNDRED_THOUSAND, SEVEN_HUNDRED_FIFTY_THOUSAND, ONE_MILLION, FIVE_MILLION, TEN_MILLION_PLUS)
- * @property {string} programSummary - A summary of the messaging program (required, at most 500 characters)
+ * @property {string} programSummary - A summary of the messaging program (required, 40-500 characters)
  * @property {string} exampleMessage - An example message (required, at most 4096 characters; stored verbatim, no STOP/HELP appended by the server)
  * @property {string} customerCareEmail - A customer-care contact email (required, valid email)
  * @property {Array<string>} optInImageURLs - URLs to opt-in proof images (required, at least one, each at most 2048 characters)
@@ -102,8 +102,9 @@
  */
 
 export class Campaigns {
-	constructor(client, enableAdmin) {
+	constructor(client, multipartClient, enableAdmin) {
 		this.client = client;
+		this.multipartClient = multipartClient;
 		this.enableAdmin = enableAdmin;
 
 		if (enableAdmin) {
@@ -178,6 +179,22 @@ export class Campaigns {
 		return this.client(`/campaign${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get aggregated campaign health (7-day and 30-day windows) for a campaign.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Parameters for reading campaign health
+	 * @param {string} params.campaignId - Campaign identifier
+	 * @param {boolean} [params.includeNumbers=false] - When true, include per-number health entries
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional request options
+	 * @returns {Promise<Object>} A promise that resolves to `{ campaignId, sevenDay, thirtyDay, numbers? }`
+	 */
+	async getCampaignHealth({ campaignId, includeNumbers = false, options = {} }) {
+		this.client._require({ campaignId });
+		const queryString = this.client._getQueryString({ campaignId, includeNumbers });
+		return this.client(`/campaign/health${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Create a new campaign
 	 * @async
@@ -208,6 +225,40 @@ export class Campaigns {
 		return this.client(`/campaign/toll-free`, { method: "POST", body: campaignData, ...options });
 	}
 
+	/**
+	 * Upload an opt-in proof image to be hosted on-platform, returning a publicly-fetchable URL suitable for a
+	 * Toll-Free campaign's optInImageURLs
+	 * @async
+	 * @roles api, admin, developer, user
+	 * @param {Object} params - The parameters for uploading the opt-in image
+	 * @param {Buffer|Blob|File} params.file - The image file to upload, provided as a Buffer/Blob/File
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the file parameter is missing
+	 * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
+	 */
+	async uploadOptInImage({ file, options = {} }) {
+		this.client._require({ file });
+		const formData = new FormData();
+		formData.append("file", file);
+		return this.multipartClient(`/campaign/opt-in-image`, { method: "POST", body: formData, ...options });
+	}
+
+	/**
+	 * Auto-capture an opt-in proof image from a brand's generated landing page and host it on-platform,
+	 * returning a publicly-fetchable URL suitable for a Toll-Free campaign's optInImageURLs
+	 * @async
+	 * @roles api, admin, developer, user
+	 * @param {Object} params - The parameters for capturing the opt-in image
+	 * @param {string} params.brandId - The ID of the brand whose generated landing page should be captured
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the brandId parameter is missing
+	 * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
+	 */
+	async captureOptInImageFromLanding({ brandId, options = {} }) {
+		this.client._require({ brandId });
+		return this.client(`/campaign/opt-in-image/from-landing`, { method: "POST", body: { brandId }, ...options });
+	}
+
 	/**
 	 * Update an existing campaign
 	 * @async

package/src/domains/Messages.js

@@ -18,6 +18,8 @@ export class Messages {
 	 * @param {string} [params.status] - Filter messages by their status (ENQUEUED, DEQUEUED, SENT, FAILED, DELIVERED)
 	 * @param {string} [params.direction] - Filter messages by their direction (INBOUND, OUTBOUND)
 	 * @param {string|string[]} [params.messageType] - Filter messages by their type. Accepts a single value or an array (e.g. ["SMS", "MMS"]). Allowed values: SMS, MMS, RCS, WHATSAPP, VIBER, P2P. When omitted, defaults to all non-P2P types.
+	 * @param {string|string[]} [params.channel] - Filter messages by channel. Accepts a single value or an array. Allowed values: tenDLC, tollFree, p2p. Each message records its channel when it is saved, and this filters on that stored value; older messages from before this feature have no channel and count as tenDLC. Ignored when matchAny is true (matchAny takes precedence).
+	 * @param {boolean} [params.matchAny] - When true, the provided campaignId/brandId/phoneNumber filters are OR'd (a message matches ANY of them) instead of the default most-specific-single behavior. subgroupId stays an AND scope. Opt-in/additive.
 	 * @param {string} [params.carrier] - Filter messages by the carrier used for sending
 	 * @param {string} [params.senderPhoneNumber] - Filter messages by the sender's phone number
 	 * @param {string} [params.recipientPhoneNumber] - Filter messages by the recipient's phone number
@@ -42,6 +44,8 @@ export class Messages {
 		status,
 		direction,
 		messageType,
+		channel,
+		matchAny,
 		carrier,
 		startDate,
 		endDate,
@@ -51,7 +55,7 @@ export class Messages {
 		limit,
 		options = {},
 	}) {
-		const filters = { id, campaignId, brandId, subgroupId, groupId, phoneNumber, senderPhoneNumber, recipientPhoneNumber, status, direction, messageType, carrier, startDate, endDate, sortField, sortOrder, page, limit };
+		const filters = { id, campaignId, brandId, subgroupId, groupId, phoneNumber, senderPhoneNumber, recipientPhoneNumber, status, direction, messageType, channel, matchAny, carrier, startDate, endDate, sortField, sortOrder, page, limit };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message${queryString}`, { method: "GET", ...options });
 	}
@@ -89,11 +93,13 @@ export class Messages {
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
+	 * @param {boolean} [params.matchAny] - When true, the provided campaignId/brandId/phoneNumber filters are OR'd (match ANY) instead of the default most-specific-single behavior. subgroupId stays an AND scope. Opt-in/additive.
+	 * @param {string|string[]} [params.channel] - Filter analytics by channel (tenDLC, tollFree, p2p). Filters on the stored channel column; a tenDLC selection also includes older messages that have no channel, and p2p is a real channel here (matched by carrier). Accepts a single value or an array. Ignored when matchAny is true (matchAny takes precedence).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the analytics data
 	 */
-	async getAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+	async getAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, matchAny, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, matchAny };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/analytics${queryString}`, { method: "GET", ...options });
 	}
@@ -111,11 +117,12 @@ export class Messages {
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
+	 * @param {string|string[]} [params.channel] - Filter analytics by channel (tenDLC, tollFree, p2p). Filters on the stored channel column; a tenDLC selection also includes older messages that have no channel, and p2p is a real channel here. Accepts a single value or an array.
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Array>} - A promise that resolves to an array of analytics snapshot records
 	 */
-	async getAnalyticsDetail({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+	async getAnalyticsDetail({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/analytics/detail${queryString}`, { method: "GET", ...options });
 	}
@@ -152,7 +159,7 @@ export class Messages {
 	 * @param {string} [params.endDate]
 	 * @param {number} [params.page=1]
 	 * @param {number} [params.limit=50] - max 50 per page
-	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + row inclusion. "tenDLC" excludes rows with no SMS/MMS activity; "p2p" excludes rows with no P2P activity; "both" returns rows with any activity.
+	 * @param {("tenDLC"|"tollFree"|"p2p"|"both")|Array<"tenDLC"|"tollFree"|"p2p">} [params.channel="both"] - Filter and rank rows by the stored channel column. "both" (default) means all activity. tenDLC/tollFree/p2p (single value or array) limit to the selected channel(s); toll-free is kept separate from 10DLC using the stored channel column.
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
 	 * @returns {Promise<Object>} - { rows, totalCount, page, limit }. Each row carries sms/mms/p2p metric columns plus `smsOptOuts` and `mmsOptOuts` from the DNC analytics MV (P2P has no opt-outs).
 	 */
@@ -178,7 +185,7 @@ export class Messages {
 	 * @param {string} [params.endDate]
 	 * @param {number} [params.page=1]
 	 * @param {number} [params.limit=50] - max 50 per page
-	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + totalCount. "tenDLC" excludes rows with no SMS/MMS errors; "p2p" excludes rows with no P2P errors; "both" returns rows with any error.
+	 * @param {("tenDLC"|"tollFree"|"p2p"|"both")|Array<"tenDLC"|"tollFree"|"p2p">} [params.channel="both"] - Filter and rank rows by the stored channel column. "both" (default) means every code. tenDLC/tollFree/p2p (single value or array) limit to the selected channel(s); when one channel is selected, totalErrors reflects only that channel.
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
 	 * @returns {Promise<Object>} - { rows, totalCount, totalErrors: { sms, mms, p2p, all }, page, limit }
 	 */
@@ -201,11 +208,12 @@ export class Messages {
 	 * @param {string} [params.carrier] - Filter by the carrier
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
+	 * @param {string|string[]} [params.channel] - Filter by channel (tenDLC, tollFree). Opt-outs are A2P-only, so p2p applies no filter. Filters on the stored channel column; a tenDLC selection also includes older opt-outs that have no channel.
 	 * @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 };
+	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/dnc/analytics${queryString}`, { method: "GET", ...options });
 	}
@@ -227,11 +235,12 @@ export class Messages {
 	 * @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 {string|string[]} [params.channel] - Filter by channel (tenDLC, tollFree). Opt-outs are A2P-only, so p2p applies no filter. Filters on the stored channel column; a tenDLC selection also includes older opt-outs that have no channel.
 	 * @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 };
+	async getDncRecords({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/dnc${queryString}`, { method: "GET", ...options });
 	}
@@ -267,13 +276,17 @@ export class Messages {
 	 * @param {string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
 	 * @param {string} params.messageBody - The body of the P2P message
 	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
+	 * @param {boolean} [params.useSignalHouseShortlinks] - When false, SignalHouse applies no link-shortening
+	 *   or text-spin and your pre-spun links/content are sent verbatim (bring-your-own spinner). Defaults to
+	 *   true server-side (the SignalHouse shortlink system, which mints unique per-recipient links).
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
 	 */
-	async sendP2P({ recipientPhoneNumbers, messageBody, statusCallbackUrl, options = {} }) {
+	async sendP2P({ recipientPhoneNumbers, messageBody, statusCallbackUrl, useSignalHouseShortlinks, options = {} }) {
 		this.client._require({ recipientPhoneNumbers, messageBody });
 		const body = { recipientPhoneNumber: recipientPhoneNumbers, messageBody };
 		if (statusCallbackUrl) body.statusCallbackUrl = statusCallbackUrl;
+		if (typeof useSignalHouseShortlinks === "boolean") body.useSignalHouseShortlinks = useSignalHouseShortlinks;
 		return this.client(`/message/p2p`, {
 			method: "POST",
 			body,

package/src/domains/Numbers.js

@@ -68,6 +68,22 @@ export class Numbers {
 		return this.client(`/number${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get the portal-parity health score (1–10) for an owned phone number over 7-day and 30-day windows
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for reading number health
+	 * @param {string} params.phoneNumber - Owned phone number to score (11 digits, no + prefix)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the phoneNumber parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to `{ phoneNumber, groupId, sevenDay, thirtyDay }`
+	 */
+	async getNumberHealth({ phoneNumber, options = {} }) {
+		this.client._require({ phoneNumber });
+		const queryString = this.client._getQueryString({ phoneNumber });
+		return this.client(`/number/health${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Get a list of available phone numbers for purchase with optional filters
 	 * @async

package/src/domains/Tickets.js

@@ -0,0 +1,80 @@
+export class Tickets {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		// Hidden Admin namespace INSIDE the domain (staff-only customer ticket → Jira)
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Load Jira form metadata (issue types, priorities, active sprint, field IDs). Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} [params] - Optional parameters
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - Jira form metadata
+				 */
+				getJiraMetadata: async ({ options = {} } = {}) => {
+					return this.client(`/admin/ticket/jira/metadata`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Search open SHGHL epics for the parent picker. Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} [params]
+				 * @param {string} [params.query] - Optional epic summary/key filter
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - `{ epics: Array<{ id, key, summary }> }`
+				 */
+				searchJiraEpics: async ({ query, options = {} } = {}) => {
+					const queryString = this.client._getQueryString({ query });
+					return this.client(`/admin/ticket/jira/epics${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Search assignable Jira users for the assignee picker. Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} [params]
+				 * @param {string} [params.query] - Partial name or email
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - `{ users: Array<{ accountId, displayName, emailAddress }> }`
+				 */
+				searchJiraAssignees: async ({ query, options = {} } = {}) => {
+					const queryString = this.client._getQueryString({ query });
+					return this.client(`/admin/ticket/jira/assignees${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Suggest Jira labels matching a query. Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} [params]
+				 * @param {string} [params.query] - Partial label text
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - `{ labels: string[] }`
+				 */
+				searchJiraLabels: async ({ query, options = {} } = {}) => {
+					const queryString = this.client._getQueryString({ query });
+					return this.client(`/admin/ticket/jira/labels${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Create a Jira ticket from the admin customer ticket form. Staff-only.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params
+				 * @param {Object} params.data - Create payload (groupId, issueTypeId, priorityId, summary required)
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the data parameter is missing
+				 * @returns {Promise<Object>} - Created ticket summary (key, browseUrl, reporter, etc.)
+				 */
+				createJiraTicket: async ({ data, options = {} }) => {
+					this.client._require({ data });
+					return this.client(`/admin/ticket/jira`, { method: "POST", body: data, ...options });
+				},
+			};
+		}
+	}
+}