@signalhousellc/sdk 1.0.69 → 1.2.0

package/package.json

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

package/src/SignalHouseSDK.js

@@ -28,6 +28,7 @@ import { Groups } from "./domains/Groups.js";
 import { Landings } from "./domains/Landings.js";
 import { Messages } from "./domains/Messages.js";
 import { Numbers } from "./domains/Numbers.js";
+import { Registrations } from "./domains/Registrations.js";
 import { Onboarding } from "./domains/Onboarding.js";
 import { Dnc } from "./domains/Dnc.js";
 import { Shortlinks } from "./domains/Shortlinks.js";
@@ -73,6 +74,7 @@ export class SignalHouseSDK {
 		this.landings = new Landings(client, multipartClient, this.enableAdmin);
 		this.messages = new Messages(client, multipartClient, this.enableAdmin);
 		this.numbers = new Numbers(client, multipartClient, this.enableAdmin);
+		this.registrations = new Registrations(client, this.enableAdmin);
 		this.onboarding = new Onboarding(client, this.enableAdmin);
 		this.dnc = new Dnc(client, this.enableAdmin);
 		this.shortlinks = new Shortlinks(client, this.enableAdmin);

package/src/domains/Agents.js

@@ -13,6 +13,7 @@
  * @property {string} [systemPrompt] - Base system prompt composed into every conversation.
  * @property {string} [greeting] - Opening line the agent leads with.
  * @property {string} [guardrails] - Freeform guardrail instructions appended to the composed prompt.
+ * @property {string} [sendAuthority] - Default send authority: "review" or "autopilot" (defaults to "review"). Deployments may override it per subgroup.
  */
 
 /**
@@ -22,6 +23,48 @@
  * @property {string} [systemPrompt] - Base system prompt composed into every conversation.
  * @property {string} [greeting] - Opening line the agent leads with.
  * @property {string} [guardrails] - Freeform guardrail instructions appended to the composed prompt.
+ * @property {string} [sendAuthority] - Default send authority: "review" or "autopilot". Deployments may override it per subgroup.
+ */
+
+/**
+ * An agent profile as returned by the server. `publishStatus` and `publishedAt` are read-only:
+ * they change only through `publishAgentProfile` and `unpublishAgentProfile`.
+ * @typedef {Object} AgentProfile
+ * @property {string} agentProfileId - The agent profile id.
+ * @property {string} groupId - The owning group id.
+ * @property {string|null} subgroupId - The owning subgroup id; null for a group-level agent.
+ * @property {string} name - The agent's name.
+ * @property {string} status - Lifecycle status: "active" or "inactive".
+ * @property {string} [systemPrompt] - Base system prompt composed into every conversation.
+ * @property {string} [greeting] - Opening line the agent leads with.
+ * @property {string} [guardrails] - Freeform guardrail instructions appended to the composed prompt.
+ * @property {string} sendAuthority - Default send authority: "review" or "autopilot".
+ * @property {string} publishStatus - "draft" or "published" (read-only).
+ * @property {string|null} publishedAt - When the profile was last published; null while never published (read-only).
+ * @property {string} createdAt - Creation timestamp.
+ * @property {string} updatedAt - Last-update timestamp.
+ */
+
+/**
+ * The fields of a deployment of a group-level agent to a subgroup.
+ * @typedef {Object} AgentDeploymentData
+ * @property {string|null} [sendAuthorityOverride] - "review" or "autopilot" to override the profile's default for this subgroup; null clears the override so the deployment inherits the profile default.
+ * @property {boolean} [enabled] - Whether this deployment is live (defaults to true).
+ */
+
+/**
+ * A deployment of a group-level agent to a subgroup, as returned by the server.
+ * @typedef {Object} AgentDeployment
+ * @property {string} agentDeploymentId - The deployment id.
+ * @property {string} groupId - The group that owns the agent and the subgroup.
+ * @property {string} subgroupId - The subgroup the agent is deployed to.
+ * @property {string} agentProfileId - The deployed agent.
+ * @property {string|null} sendAuthorityOverride - "review", "autopilot", or null (inherit the profile default).
+ * @property {string|null} sendAuthorityChangedBy - userId of whoever last changed the override.
+ * @property {string|null} sendAuthorityChangedAt - When the override last changed.
+ * @property {boolean} enabled - Whether this deployment is live.
+ * @property {string} createdAt - Creation timestamp.
+ * @property {string} updatedAt - Last-update timestamp.
  */
 
 /**
@@ -361,6 +404,94 @@ export class Agents {
 		return this.client(`/agent/profiles/${safeId}/channels/${safeChannel}`, { method: "DELETE", ...options });
 	}
 
+	/**
+	 * List a group-level agent's deployments to subgroups.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for listing deployments.
+	 * @param {string} params.agentProfileId - The agent whose deployments to list.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentProfileId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentDeployment[]>>} - The agent's deployments returned from the server.
+	 */
+	async getAgentDeployments({ agentProfileId, options = {} }) {
+		this.client._require({ agentProfileId });
+		const safeId = encodeURIComponent(agentProfileId);
+		return this.client(`/agent/profiles/${safeId}/deployments`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Deploy a group-level agent to a subgroup, or change that deployment (upsert). One row per
+	 * (agent, subgroup); the subgroup is taken from the path, the fields from deploymentData.
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for the upsert.
+	 * @param {string} params.agentProfileId - The agent to deploy.
+	 * @param {string} params.subgroupId - The subgroup to deploy to (at least 8 characters, starts with 'S').
+	 * @param {AgentDeploymentData} [params.deploymentData] - The fields to set.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if agentProfileId or subgroupId is missing.
+	 * @returns {Promise<SdkResponse<AgentDeployment>>} - The created or updated deployment returned from the server.
+	 */
+	async upsertAgentDeployment({ agentProfileId, subgroupId, deploymentData = {}, options = {} }) {
+		this.client._require({ agentProfileId, subgroupId });
+		const safeId = encodeURIComponent(agentProfileId);
+		const safeSubgroupId = encodeURIComponent(subgroupId);
+		return this.client(`/agent/profiles/${safeId}/deployments/${safeSubgroupId}`, { method: "PUT", body: deploymentData, ...options });
+	}
+
+	/**
+	 * Remove an agent's deployment from a subgroup.
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for the delete.
+	 * @param {string} params.agentProfileId - The deployed agent.
+	 * @param {string} params.subgroupId - The subgroup to remove the deployment from.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if agentProfileId or subgroupId is missing.
+	 * @returns {Promise<SdkResponse<AgentDeployment>>} - The removed deployment returned from the server.
+	 */
+	async deleteAgentDeployment({ agentProfileId, subgroupId, options = {} }) {
+		this.client._require({ agentProfileId, subgroupId });
+		const safeId = encodeURIComponent(agentProfileId);
+		const safeSubgroupId = encodeURIComponent(subgroupId);
+		return this.client(`/agent/profiles/${safeId}/deployments/${safeSubgroupId}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * Publish an agent profile, setting its `publishStatus` to "published" and stamping
+	 * `publishedAt`. The server rejects the call with 400 when the agent has no enabled
+	 * deployment, and with 409 when the agent is inactive.
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for publishing.
+	 * @param {string} params.agentProfileId - The agent profile to publish.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentProfileId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentProfile>>} - The published agent profile returned from the server.
+	 */
+	async publishAgentProfile({ agentProfileId, options = {} }) {
+		this.client._require({ agentProfileId });
+		const safeId = encodeURIComponent(agentProfileId);
+		return this.client(`/agent/profiles/${safeId}/publish`, { method: "POST", ...options });
+	}
+
+	/**
+	 * Return an agent profile to draft, setting its `publishStatus` to "draft".
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for unpublishing.
+	 * @param {string} params.agentProfileId - The agent profile to unpublish.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentProfileId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentProfile>>} - The unpublished agent profile returned from the server.
+	 */
+	async unpublishAgentProfile({ agentProfileId, options = {} }) {
+		this.client._require({ agentProfileId });
+		const safeId = encodeURIComponent(agentProfileId);
+		return this.client(`/agent/profiles/${safeId}/unpublish`, { method: "POST", ...options });
+	}
+
 	/**
 	 * Read the tenant AI settings for a scope (group, or a subgroup within it) — brand, tone,
 	 * timezone, business hours, and after-hours message. Returns the scope's own row only (no

package/src/domains/Auth.js

@@ -63,13 +63,17 @@ export class Auth {
 	 * @param {boolean} [params.acceptedTermsOfService] - Whether the user accepted the Terms of Service
 	 * @param {string} [params.psXid] - PartnerStack click id (ps_xid) captured from a referral link
 	 * @param {string} [params.psPartnerKey] - PartnerStack partner key (ps_partner_key) captured from a referral link
+	 * @param {Object} [params.attribution] - Marketing attribution captured at signup
+	 * @param {string} [params.attribution.posthogDistinctId] - PostHog distinct id of the registering visitor
+	 * @param {Object} [params.attribution.firstTouch] - First-ever visit: utmSource, utmMedium, utmCampaign, utmTerm, utmContent, gclid, fbclid, referrer, landingUrl
+	 * @param {Object} [params.attribution.lastTouch] - Visit that registered, same keys as firstTouch
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} The response from the server (contains the JWT token)
 	 */
-	async register({ businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey, options = {} }) {
+	async register({ businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey, attribution, options = {} }) {
 		return this.client(`/auth/register`, {
 			method: "POST",
-			body: { businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey },
+			body: { businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey, attribution },
 			...options,
 		});
 	}

package/src/domains/Brands.js

@@ -140,11 +140,64 @@ export class Brands {
    * @param {number} [params.limit] - The number of items per page
    * @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", "TOLL_FREE", or "SHORT_CODE")
+   * @param {string} [params.search] - Staff-only (no id/subgroupId/groupId): case-insensitive substring over brandId, names, EIN, email, group, subgroup and reference ID
+   * @param {string} [params.sortBy] - Staff-only: createdAt, brandId, displayName, groupId, subgroupId, status, entityType or country
+   * @param {"asc"|"desc"} [params.sortOrder] - Staff-only: sort direction (default asc)
+   * @param {string} [params.entityType] - Staff-only: exact entity type filter
+   * @param {string} [params.ein] - Staff-only: EIN substring filter
+   * @param {string} [params.email] - Staff-only: support email substring filter
+   * @param {string} [params.referenceId] - Staff-only: reference ID substring filter
+   * @param {string|Array<string>} [params.groupIds] - Staff-only: restrict to these group IDs (sent comma-separated)
+   * @param {string} [params.createdFrom] - Staff-only: inclusive createdAt lower bound (ISO date)
+   * @param {string} [params.createdTo] - Staff-only: inclusive createdAt upper bound (ISO date)
+   * @param {boolean} [params.excludeDeleted] - Staff-only: hide DELETED brands when no status is given
+   * @param {boolean} [params.includeTotal] - Staff-only: with page and limit, return `{ data, total, page, limit, totalPages }` instead of the array
    * @param {RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<SdkResponse<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.
+   * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, [key: string]: any }>|{ data: Array<Object>, total: number, page: number, limit: number, totalPages: number }>>} 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. The staff-only list (no id/subgroupId/groupId) returns the `{ data, total, page, limit, totalPages }` envelope only when includeTotal is sent with page and limit.
    */
-  async getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, options = {} }) {
-    const filters = { id, subgroupId, groupId, page, limit, status, registrationType };
+  async getBrands({
+    id,
+    subgroupId,
+    groupId,
+    page,
+    limit,
+    status,
+    registrationType,
+    search,
+    sortBy,
+    sortOrder,
+    entityType,
+    ein,
+    email,
+    referenceId,
+    groupIds,
+    createdFrom,
+    createdTo,
+    excludeDeleted,
+    includeTotal,
+    options = {},
+  }) {
+    const filters = {
+      id,
+      subgroupId,
+      groupId,
+      page,
+      limit,
+      status,
+      registrationType,
+      search,
+      sortBy,
+      sortOrder,
+      entityType,
+      ein,
+      email,
+      referenceId,
+      groupIds: Array.isArray(groupIds) ? (groupIds.length ? groupIds.join(',') : undefined) : groupIds,
+      createdFrom,
+      createdTo,
+      excludeDeleted,
+      includeTotal,
+    };
     const queryString = this.client._getQueryString(filters);
     return this.client(`/brand${queryString}`, { method: 'GET', ...options });
   }

package/src/domains/Messages.js

@@ -4,6 +4,17 @@
  * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
  */
 
+/**
+ * Serialise regionScopes for the query string: an array of branches becomes JSON, a string is passed through.
+ * @param {Object} filters - Query filters that may carry regionScopes
+ * @returns {Object} - The filters with regionScopes JSON-encoded when present
+ */
+function withRegionScopes(filters) {
+	if (filters.regionScopes === undefined) return filters;
+	const regionScopes = typeof filters.regionScopes === "string" ? filters.regionScopes : JSON.stringify(filters.regionScopes);
+	return { ...filters, regionScopes };
+}
+
 export class Messages {
 	constructor(client, multipartClient, enableAdmin) {
 		this.client = client;
@@ -12,10 +23,13 @@ export class Messages {
 	}
 
 	/**
-	 * Estimate Canadian SMS/MMS retail cost; no charge or send. Requires a Ready Canadian sender and Canadian or US
-	 * recipients, and is unavailable unless Canada is enabled for the environment.
+	 * Estimate regional SMS/MMS retail cost; no charge or send. A Canadian sender requires a Ready Canadian sender and
+	 * Canadian or US recipients, and is unavailable unless Canada is enabled for the environment. A +44 (UK) sender
+	 * estimates SMS to GB mobiles only and returns region "GB"; while UK sending is disabled for the environment a UK
+	 * sender is refused with a 400. The sender may also be a READY alphanumeric sender ID (e.g. "ACME"; UK recipients,
+	 * SMS only); its estimate counts the "\nOpt out: sihou.io/o/{code}" footer the server appends to every such message.
 	 * @async
-	 * @param {Object} params - Sender, up to 100 recipients, messageBody and request options.
+	 * @param {Object} params - Sender, up to 100 recipients (10-15 digits each), messageBody and request options.
 	 * @returns {Promise<SdkResponse<any>>} - Per-recipient rates and total in microdollars; unknown carriers use the upper fallback.
 	 */
 	async estimateMessage({ senderPhoneNumber, recipientPhoneNumbers, messageBody, messageType = "SMS", options = {} }) {
@@ -32,17 +46,20 @@ export class Messages {
 	 * @param {string} [params.brandId] - Filter messages by the ID of the associated brand
 	 * @param {string} [params.subgroupId] - Filter messages by the ID of the associated subgroup
 	 * @param {string} [params.groupId] - Filter messages by the ID of the associated group
+	 * @param {string|string[]} [params.registrationId] - Filter to messages attributed to these registrations. Cannot be combined with campaignId; each id must belong to the group. Accepts a single value or an array.
 	 * @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, virtualLongCode, tollFree, shortCode, 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 {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Accepted whether or not the environment serves hourly analytics.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Accepted whether or not the environment serves hourly analytics.
 	 * @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|string[]} [params.sentimentLabel] - Filter messages by sentiment bucket. Accepts a single value or an array (e.g. ["positive", "negative"]). Allowed values: positive, neutral, negative. Applied as the sentimentScore range the ±25 label threshold produces, so unscored messages match no bucket and outbound messages (never scored) are excluded.
 	 * @param {string|string[]} [params.errorCode] - Filter FAILED messages by Signal House error code (single value or array). "OUT" is the campaign opt-out, displayed as RECIPIENT_OPTED_OUT. Carrier codes are not filterable here; they live inside successOrFailureReason.
 	 * @param {string|string[]} [params.phoneNumber] - Filter messages by a business number on either side of the message. Accepts a single value or an array; OR'd with campaignId/brandId when matchAny is true
-	 * @param {string} [params.senderPhoneNumber] - Filter messages by the sender's 5-6 digit Short Code or 10+ digit phone number
-	 * @param {string} [params.recipientPhoneNumber] - Filter messages by the recipient's phone number
+	 * @param {string} [params.senderPhoneNumber] - Filter messages by the sender's 5-6 digit Short Code or 10+ digit phone number. Use % as a wildcard for a partial match (e.g. "%1234" matches numbers ending in 1234); a plain value is an exact match. 3-15 digits required alongside any %.
+	 * @param {string} [params.recipientPhoneNumber] - Filter messages by the recipient's phone number. Use % as a wildcard for a partial match (e.g. "%1234" matches numbers ending in 1234); a plain value is an exact match. 3-15 digits required alongside any %.
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode. In "exact" mode day buckets align to the UTC offset this bound carries, so a client that sends its own midnights gets its own calendar dates back
 	 * @param {string} [params.sortField] - The field to sort the messages by (createdAt, segmentCount, status, sentimentScore)
@@ -61,6 +78,7 @@ export class Messages {
 		brandId,
 		subgroupId,
 		groupId,
+		registrationId,
 		phoneNumber,
 		senderPhoneNumber,
 		recipientPhoneNumber,
@@ -68,6 +86,8 @@ export class Messages {
 		direction,
 		messageType,
 		channel,
+		region,
+		regionScopes,
 		matchAny,
 		carrier,
 		sentimentLabel,
@@ -81,8 +101,8 @@ export class Messages {
 		dateBounds,
 		options = {},
 	}) {
-		const filters = { id, campaignId, brandId, subgroupId, groupId, phoneNumber, senderPhoneNumber, recipientPhoneNumber, status, direction, messageType, channel, matchAny, carrier, sentimentLabel, errorCode, startDate, endDate, sortField, sortOrder, page, limit, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+		const filters = { id, campaignId, brandId, subgroupId, groupId, registrationId, phoneNumber, senderPhoneNumber, recipientPhoneNumber, status, direction, messageType, channel, region, regionScopes, matchAny, carrier, sentimentLabel, errorCode, startDate, endDate, sortField, sortOrder, page, limit, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message${queryString}`, { method: "GET", ...options });
 	}
 
@@ -115,6 +135,7 @@ export class Messages {
 	 * @param {string|string[]} [params.subgroupId] - Filter analytics by the ID of the associated subgroup. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.brandId] - Filter analytics by the ID of the associated brand. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.campaignId] - Filter analytics by the ID of the associated campaign. Accepts a single value, an array, or a comma-separated string.
+	 * @param {string|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string|string[]} [params.phoneNumber] - Filter analytics by the phone number involved in the messages. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.carrier] - Filter analytics by the carrier used for sending. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.carrierFamily] - Filter analytics by the recipient's resolved carrier family (Default, ATT, TMobile, Verizon, USCellular, GoogleVoice, ClearSky, Interop, RogueMobile, P2P, Standard, IceWireless). Accepts a single value, an array, or a comma-separated string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400 -- omit the parameter unless it is wanted.
@@ -123,6 +144,8 @@ export class Messages {
 	 * @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.messageType] - Message type(s) the SENTIMENT figures are scoped to: SMS, MMS or P2P (single value, array, or comma-separated string). Omit for all scored types. Does NOT narrow the message counts, which are always returned split per type (smsInbound/mmsInbound/p2pInbound) and have no filterable type dimension.
 	 * @param {string|string[]} [params.channel] - Filter analytics by channel (tenDLC, virtualLongCode, tollFree, shortCode, 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 {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to the analytics data. Also includes inbound-message
@@ -134,9 +157,9 @@ export class Messages {
 	 * summed or re-averaged across types, rows or responses. To weight a subset of message types, pass
 	 * messageType and read sentimentScore.
 	 */
-	async getAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, messageType, matchAny, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, messageType, matchAny, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getAnalytics({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, region, regionScopes, messageType, matchAny, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, region, regionScopes, messageType, matchAny, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/analytics${queryString}`, { method: "GET", ...options });
 	}
 
@@ -149,6 +172,7 @@ export class Messages {
 	 * @param {string|string[]} [params.subgroupId] - Filter analytics by the ID of the associated subgroup. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.brandId] - Filter analytics by the ID of the associated brand. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.campaignId] - Filter analytics by the ID of the associated campaign. Accepts a single value, an array, or a comma-separated string.
+	 * @param {string|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string|string[]} [params.phoneNumber] - Filter analytics by the phone number involved in the messages. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.carrier] - Filter analytics by the carrier used for sending. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.carrierFamily] - Filter analytics by the recipient's resolved carrier family (Default, ATT, TMobile, Verizon, USCellular, GoogleVoice, ClearSky, Interop, RogueMobile, P2P, Standard, IceWireless). Accepts a single value, an array, or a comma-separated string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400 -- omit the parameter unless it is wanted.
@@ -156,6 +180,8 @@ export class Messages {
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp. At day granularity it is bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode. In "exact" mode day buckets align to the UTC offset this bound carries, so a client that sends its own midnights gets its own calendar dates back; at hour granularity it is honoured as given.
 	 * @param {(string|string[])} [params.messageType] - Message type(s) the SENTIMENT figures are scoped to: SMS, MMS or P2P (single value, array, or comma-separated string). Omit for all scored types. Does NOT narrow the message counts, which are always returned split per type (smsInbound/mmsInbound/p2pInbound) and have no filterable type dimension.
 	 * @param {string|string[]} [params.channel] - Filter analytics by channel (tenDLC, virtualLongCode, tollFree, shortCode, 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 {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {("day"|"hour")} [params.granularity] - Time-bucket grain of the byDate rows. Omit for day (each row's _id is a "YYYY-MM-DD" date). "hour" buckets by hour (each row's _id is a "YYYY-MM-DD HH:MM:SS" UTC hour) and is capped to a 7-day span. Only accepted where the environment serves hourly analytics; elsewhere any value, including "day", is rejected with a 400 -- omit the parameter unless hour grain is wanted.
 	 * @param {("carrier"|"carrierFamily")} [params.breakdown] - Adds a byBreakdown time × dimension series to the response ({ dimension, rows }: each row is one byDate bucket (_id) for one carrier or carrier family (key), over the top 50 keys by volume, 10DLC only) and caps the span at 31 days. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400 -- omit the parameter unless it is wanted.
 	 * @param {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
@@ -168,9 +194,9 @@ export class Messages {
 	 * score is divided server-side and the raw sums are never returned: a score is an average and must never be
 	 * summed or re-averaged across types, rows or responses.
 	 */
-	async getAnalyticsDetail({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, messageType, granularity, breakdown, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, messageType, granularity, breakdown, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getAnalyticsDetail({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, region, regionScopes, messageType, granularity, breakdown, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, channel, region, regionScopes, messageType, granularity, breakdown, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/analytics/detail${queryString}`, { method: "GET", ...options });
 	}
 
@@ -186,6 +212,7 @@ export class Messages {
 	 * @param {string} params.groupId - The group to scope the read to (required)
 	 * @param {string|string[]} [params.brandId] - Brand scope. Accepts a single value, an array, or a comma-separated string.
 	 * @param {string|string[]} [params.campaignId] - Campaign scope; wins over brandId. Accepts a single value, an array, or a comma-separated string.
+	 * @param {string|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). Accepts a single value or an array.
 	 * @param {string|string[]} [params.carrierFamily] - Carrier-family filter (ATT, TMobile, Verizon, USCellular, ...). Accepts a single value, an array, or a comma-separated string.
 	 * @param {string} params.startDate - ISO-8601 date or timestamp. It is bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode, then floored to the start of its hour at hour granularity and of its minute at day granularity (the cube is keyed by minute).
 	 * @param {string} params.endDate - ISO-8601 date or timestamp. At hour granularity it is honoured as given; at day granularity it is bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode. In "exact" mode day buckets align to the UTC offset this bound carries, so a client that sends its own midnights gets its own calendar dates back. The span is capped at 35 days (the retention of the per-minute data).
@@ -195,8 +222,8 @@ export class Messages {
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} - `{ totals, byDate, byCarrierFamily, byBreakdown: { dimension: "carrierFamily", rows } }`. Every row carries segments, messages, peakSegmentsPerMinute, peakMessagesPerMinute, peakMinute (UTC "YYYY-MM-DD HH:MM:SS", null when no traffic), sendingMinutes, averageSegmentsPerSendingMinute and minutesAtCeiling.
 	 */
-	async getAnalyticsThroughput({ groupId, brandId, campaignId, carrierFamily, startDate, endDate, granularity, ceiling, dateBounds, options = {} }) {
-		const filters = { groupId, brandId, campaignId, carrierFamily, startDate, endDate, granularity, ceiling, dateBounds };
+	async getAnalyticsThroughput({ groupId, brandId, campaignId, registrationId, carrierFamily, startDate, endDate, granularity, ceiling, dateBounds, options = {} }) {
+		const filters = { groupId, brandId, campaignId, registrationId, carrierFamily, startDate, endDate, granularity, ceiling, dateBounds };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/analytics/throughput${queryString}`, { method: "GET", ...options });
 	}
@@ -208,11 +235,12 @@ export class Messages {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for getting analytics filter options
 	 * @param {string} params.groupId - The ID of the group whose filter options to load
+	 * @param {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to { subgroups, brands, campaigns, phoneNumbers }
+	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to { subgroups, brands, campaigns, phoneNumbers }. Each phone number carries type (TOLL_FREE, SHORT_CODE, ALPHANUMERIC, VIRTUAL_LONG_NUMBER, ...) and country (ISO-2), null when unknown: TOLL_FREE, SHORT_CODE and ALPHANUMERIC are channels by type; any other US number is 10DLC and a non-US one is a Virtual Long Code.
 	 */
-	async getAnalyticsFilterOptions({ groupId, options = {} }) {
-		const filters = { groupId };
+	async getAnalyticsFilterOptions({ groupId, region, options = {} }) {
+		const filters = { groupId, region };
 		const queryString = this.client._getQueryString(filters);
 		return this.client(`/message/analytics/filter-options${queryString}`, { method: "GET", ...options });
 	}
@@ -227,6 +255,7 @@ export class Messages {
 	 * @param {string|string[]} [params.subgroupId]
 	 * @param {string|string[]} [params.brandId]
 	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string|string[]} [params.phoneNumber]
 	 * @param {string|string[]} [params.carrier]
 	 * @param {string|string[]} [params.carrierFamily] - Resolved carrier family of the recipient (Default, ATT, TMobile, Verizon, USCellular, GoogleVoice, ClearSky, Interop, RogueMobile, P2P, Standard, IceWireless); single value, array, or comma-separated. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400 -- omit the parameter unless it is wanted.
@@ -237,13 +266,15 @@ export class Messages {
 	 * @param {("tenDLC"|"virtualLongCode"|"tollFree"|"shortCode"|"p2p"|"both")|Array<"tenDLC"|"virtualLongCode"|"tollFree"|"shortCode"|"p2p">} [params.channel="both"] - Filter and rank rows by the stored channel column. "both" (default) means all activity. tenDLC/virtualLongCode/tollFree/shortCode/p2p (single value or array) limit to the selected channel(s).
 	 * @param {(string|string[])} [params.messageType] - Message type(s) the SENTIMENT figures are scoped to: SMS, MMS or P2P (single value, array, or comma-separated string). Omit for all scored types. Does NOT narrow the message counts, which are always returned split per type (smsInbound/mmsInbound/p2pInbound) and have no filterable type dimension.
 	 * @param {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
+	 * @param {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {RequestOptions} [params.options]
 	 * @returns {Promise<SdkResponse<any>>} - { 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).
 	 * Each row also carries that subgroup's inbound-message sentiment: `sentimentScore` (volume-weighted average of every scored inbound message in that subgroup, -100..100, null when nothing was scored), `sentimentLabel`, `sentimentScoredCount`, `sentimentPositive`, `sentimentNeutral`, `sentimentNegative`, plus the same six per message type under `smsSentiment*`, `mmsSentiment*` and `p2pSentiment*` prefixes. The score is derived server-side and must never be re-averaged across rows — combine the counts, not the scores.
 	 */
-	async getAnalyticsBySubgroup({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, messageType, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, messageType, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getAnalyticsBySubgroup({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, region, regionScopes, messageType, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, region, regionScopes, messageType, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/analytics/by-subgroup${queryString}`, { method: "GET", ...options });
 	}
 
@@ -257,6 +288,7 @@ export class Messages {
 	 * @param {string|string[]} [params.subgroupId]
 	 * @param {string|string[]} [params.brandId]
 	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string|string[]} [params.phoneNumber]
 	 * @param {string|string[]} [params.carrier]
 	 * @param {string|string[]} [params.carrierFamily] - Resolved carrier family of the recipient (Default, ATT, TMobile, Verizon, USCellular, GoogleVoice, ClearSky, Interop, RogueMobile, P2P, Standard, IceWireless); single value, array, or comma-separated. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400 -- omit the parameter unless it is wanted.
@@ -266,12 +298,14 @@ export class Messages {
 	 * @param {number} [params.limit=50] - max 50 per page
 	 * @param {("tenDLC"|"virtualLongCode"|"tollFree"|"shortCode"|"p2p"|"both")|Array<"tenDLC"|"virtualLongCode"|"tollFree"|"shortCode"|"p2p">} [params.channel="both"] - Filter and rank rows by the stored channel column. "both" (default) means every code. tenDLC/virtualLongCode/tollFree/shortCode/p2p (single value or array) limit to the selected channel(s); when one channel is selected, totalErrors reflects only that channel.
 	 * @param {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
+	 * @param {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {RequestOptions} [params.options]
 	 * @returns {Promise<SdkResponse<any>>} - { rows, totalCount, totalErrors: { sms, mms, p2p, all }, page, limit }
 	 */
-	async getAnalyticsByErrorCode({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getAnalyticsByErrorCode({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, region, regionScopes, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, carrierFamily, startDate, endDate, page, limit, channel, region, regionScopes, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/analytics/by-error-code${queryString}`, { method: "GET", ...options });
 	}
 
@@ -284,18 +318,21 @@ export class Messages {
 	 * @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|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode. In "exact" mode day buckets align to the UTC offset this bound carries, so a client that sends its own midnights gets its own calendar dates back
 	 * @param {string|string[]} [params.channel] - Filter by channel (tenDLC, virtualLongCode, tollFree, shortCode). 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 {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
+	 * @param {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to the DNC analytics data (totals, byDate, byPhoneNumber, bySenderNumber, byCampaign, bySubgroup, byType, byCarrier, byKeyword). bySenderNumber ({ senderPhoneNumber, total, sms, mms }) attributes each opt-out to the first business number that received it, so it is unchanged by later campaign moves and START replies. byCampaign ({ campaignId, ... }) counts campaign-scoped opt-outs only, by the campaign at the time of the STOP; subgroup-scoped opt-outs (non-US recipients) are never attributed to a campaign and appear under bySubgroup ({ subgroupId, ... }) instead. byType ({ messageType, total }) splits SMS/MMS. byKeyword breaks opt-outs down by the normalized keyword that revoked consent ({ optOutKeyword, total, sms, mms }); opt-outs recorded before keyword capture shipped appear as a single optOutKeyword: null bucket ("not recorded"). The distinct keyword set is open-ended (campaigns register their own keywords beyond the mandatory floor) — render top-N plus Other, never a fixed list.
 	 */
-	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, channel, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, startDate, endDate, channel, region, regionScopes, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, startDate, endDate, channel, region, regionScopes, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/dnc/analytics${queryString}`, { method: "GET", ...options });
 	}
 
@@ -308,6 +345,7 @@ export class Messages {
 	 * @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|string[]} [params.registrationId] - Filter to traffic attributed to these registrations (hourly analytics only; a 400 while hourly reads are off). A phoneNumber filter takes precedence. Accepts a single value or an array.
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; bound per dateBounds: a bare date is always that whole UTC day (inclusive); a timestamp is widened to its whole UTC day in "day" mode and bound as the instant it names, in whatever offset it was written, in "exact" mode
@@ -318,12 +356,14 @@ export class Messages {
 	 * @param {string} [params.sortOrder] - Sort direction (asc, desc)
 	 * @param {string|string[]} [params.channel] - Filter by channel (tenDLC, virtualLongCode, tollFree, shortCode). 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 {("day"|"exact")} [params.dateBounds] - Which contract binds startDate/endDate. "day": each bound is widened to its whole UTC day. "exact": a timestamp is bound as the instant it names and a bare date is its whole UTC day. Omitted: "day".
+	 * @param {string|string[]} [params.region] - ISO-2 country filter: US, GB or CA (any case of UK/GB/GBR/United Kingdom is accepted for GB); one value, an array, or a comma-separated string; omitted = every region. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
+	 * @param {Object[]|string} [params.regionScopes] - Array of OR-ed branches `{ region, channels, brandId?, campaignId?, phoneNumber? }` (channels among tenDLC, virtualLongCode, tollFree, shortCode, p2p); `[]` matches nothing. Sent as JSON unless already a string. Only accepted where the environment serves hourly analytics; elsewhere any value is rejected with a 400.
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to the paginated DNC records. Each record carries senderPhoneNumber — the first business number that received the opt-out (set once, never changed by a later STOP or a campaign move; the same value as phoneNumber) — optOutKeyword — the normalized keyword that revoked consent (e.g. "stop", "opt out"; a repeat opt-out records the most recent word), null for opt-outs recorded before keyword capture shipped — and carrierFamily, the resolved carrier family of the recipient number (Default, ATT, TMobile, Verizon, USCellular, GoogleVoice, ClearSky, Interop, RogueMobile, Standard, IceWireless), copied from the inbound message that triggered the opt-out. campaignId is null on subgroup-scoped records (non-US recipients).
 	 */
-	async getDncRecords({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel, dateBounds, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel, dateBounds };
-		const queryString = this.client._getQueryString(filters);
+	async getDncRecords({ groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel, region, regionScopes, dateBounds, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, registrationId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, channel, region, regionScopes, dateBounds };
+		const queryString = this.client._getQueryString(withRegionScopes(filters));
 		return this.client(`/message/dnc${queryString}`, { method: "GET", ...options });
 	}
 
@@ -342,7 +382,7 @@ export class Messages {
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for sending an SMS message
-	 * @param {string} params.senderPhoneNumber - The 5-6 digit Short Code or 10+ digit phone number to send the message from
+	 * @param {string} params.senderPhoneNumber - The 5-6 digit Short Code or 10+ digit phone number to send the message from, or a READY alphanumeric sender ID (e.g. "ACME"; UK recipients and SMS only). Every message from an alphanumeric sender gets "\nOpt out: sihou.io/o/{code}" appended by the server, counted in segments.
 	 * @param {string|string[]} params.recipientPhoneNumbers - The 10+ digit phone number(s) to send the message to. A Short Code sender permits exactly one recipient, and it must be a +1 (US/Canada) number; a bare 10-digit number is treated as +1. The API rejects Short Code sends with multiple recipients or a non-+1 recipient.
 	 * @param {string} params.messageBody - The body of the SMS message
 	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks

package/src/domains/Numbers.js

@@ -77,6 +77,7 @@ export class Numbers {
    * @param {Object} params - The parameters for filtering the phone numbers
    * @param {string} [params.phoneNumber] - Filter by phone number (partial match)
    * @param {string} [params.campaignId] - Filter by campaign ID
+   * @param {string} [params.registrationId] - Filter to numbers provisioned under this registration.
    * @param {string} [params.brandId] - Filter by brand ID
    * @param {string} [params.subgroupId] - Filter by subgroup ID
    * @param {string} [params.groupId] - Filter by group ID
@@ -102,8 +103,8 @@ export class Numbers {
    * or GET /campaign/health.
    * @returns {Promise<SdkResponse<any>>} A promise that resolves to the list of phone numbers
    */
-  async getPhoneNumbers({ phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
-    const filters = { phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };
+  async getPhoneNumbers({ phoneNumber, campaignId, registrationId, brandId, subgroupId, groupId, page, limit, options = {} }) {
+    const filters = { phoneNumber, campaignId, registrationId, brandId, subgroupId, groupId, page, limit };
     const queryString = this.client._getQueryString(filters);
     return this.client(`/number${queryString}`, { method: 'GET', ...options });
   }

package/src/domains/Registrations.js

@@ -0,0 +1,247 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
+/**
+ * Sender registrations for every jurisdiction and type: the catalog of what a region offers, retail quotes,
+ * customer submissions and staff review operations. `type` selects the shape of `data`
+ * (for VIRTUAL_LONG_CODE: quantity, useCases and the optional voice dossier; for GB ALPHANUMERIC_SENDER_ID: requestedSenderId,
+ * trafficOrigin, trafficType and the company details).
+ */
+export class Registrations {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Approve or reject a registration awaiting Signal House review (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for the review decision
+				 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+				 * @param {("APPROVE"|"REJECT")} params.action - The review decision
+				 * @param {string} [params.reason] - Why the registration was rejected; required when action is REJECT
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated registration
+				 */
+				reviewRegistration: async ({ registrationId, action, reason, options = {} }) => {
+					this.client._require({ registrationId, action });
+					const safeId = encodeURIComponent(registrationId);
+					return this.client(`/registration/${safeId}/review`, {
+						method: "POST",
+						body: { action, reason },
+						...options,
+					});
+				},
+
+				/**
+				 * Save corrections to the type's correctable fields for a registration the provider sent back for
+				 * more information; owner, quantity, bundle and provider order never change (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for the correction
+				 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+				 * @param {string} params.reason - Why the registration was corrected
+				 * @param {Object} params.data - The type's correctable fields (for VIRTUAL_LONG_CODE: useCases and, for SMS + Voice, voice)
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated registration
+				 */
+				correctRegistration: async ({ registrationId, reason, data, options = {} }) => {
+					this.client._require({ registrationId, reason, data });
+					const safeId = encodeURIComponent(registrationId);
+					return this.client(`/registration/${safeId}/corrections`, {
+						method: "POST",
+						body: { reason, data },
+						...options,
+					});
+				},
+
+				/**
+				 * Allocate a provider-owned number to a registration through the staff recovery path (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for the allocation
+				 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+				 * @param {string} params.phoneNumber - The E.164 number (10-15 digits, optional leading +) to allocate
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated registration
+				 */
+				addNumber: async ({ registrationId, phoneNumber, options = {} }) => {
+					this.client._require({ registrationId, phoneNumber });
+					const safeId = encodeURIComponent(registrationId);
+					return this.client(`/registration/${safeId}/numbers`, {
+						method: "POST",
+						body: { phoneNumber },
+						...options,
+					});
+				},
+
+				/**
+				 * Link an existing provider order to a registration parked in RECONCILIATION_REQUIRED (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for the reconciliation
+				 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+				 * @param {string} params.externalId - The provider's identifier for the existing order
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated registration
+				 */
+				reconcile: async ({ registrationId, externalId, options = {} }) => {
+					this.client._require({ registrationId, externalId });
+					const safeId = encodeURIComponent(registrationId);
+					return this.client(`/registration/${safeId}/reconcile`, {
+						method: "POST",
+						body: { externalId },
+						...options,
+					});
+				},
+
+				/**
+				 * Download the completed carrier application as DOCX bytes (signalhouse only)
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for the download
+				 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<ArrayBuffer>>} A promise that resolves to the DOCX document as an ArrayBuffer
+				 */
+				getApplication: async ({ registrationId, options = {} }) => {
+					this.client._require({ registrationId });
+					const safeId = encodeURIComponent(registrationId);
+					return this.client(`/registration/${safeId}/application`, {
+						method: "GET",
+						responseType: "arraybuffer",
+						...options,
+					});
+				},
+			};
+		}
+	}
+
+	/**
+	 * Get the registration types a region offers and whether each can be acquired right now
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the catalog
+	 * @param {string} params.region - ISO-2 jurisdiction (US, GB or CA; any case of UK/GB/GBR/United Kingdom is accepted for GB)
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to { region, jurisdiction, sendingRequiresRegistration, registeredThrough, provisioning, types }
+	 */
+	async getCatalog({ region, options = {} }) {
+		this.client._require({ region });
+		const queryString = this.client._getQueryString({ region });
+		return this.client(`/registration/catalog${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get retail quotes for a registration type: one quote per capability bundle with per-number setupAmount
+	 * and monthlyAmount, the totals for the quantity (integer microdollars) and etaDays. GB ALPHANUMERIC_SENDER_ID
+	 * quotes one ["SMS"] bundle (6000000 setup and 6000000 monthly by default).
+	 * Unavailable (400) while the type cannot be acquired in the region.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the quote
+	 * @param {string} params.region - ISO-2 jurisdiction (any case of UK/GB/GBR/United Kingdom is accepted for GB)
+	 * @param {string} params.type - Registration type (e.g. VIRTUAL_LONG_CODE, or ALPHANUMERIC_SENDER_ID for GB)
+	 * @param {number} [params.quantity=1] - Number of numbers to quote (1-100)
+	 * @param {string} [params.groupId] - Group to price for; staff only
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to { data: [quotes] }
+	 */
+	async getQuotes({ region, type, quantity = 1, groupId, options = {} }) {
+		this.client._require({ region, type });
+		const queryString = this.client._getQueryString({ region, type, quantity, groupId });
+		return this.client(`/registration/quotes${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * List registrations for an authorized group; staff may omit groupId to read the review queue
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} [params] - The parameters for filtering the registrations
+	 * @param {string} [params.groupId] - Filter by group ID
+	 * @param {string} [params.subgroupId] - Filter by subgroup ID
+	 * @param {string|string[]} [params.region] - Filter by one ISO-2 jurisdiction or a list
+	 * @param {string} [params.type] - Filter by registration type
+	 * @param {string} [params.kind] - Filter by kind (identity, program, sender)
+	 * @param {string|string[]} [params.status] - Filter by one registration status or a list
+	 * @param {string} [params.parentRegistrationId] - Filter by the parent registration ID
+	 * @param {string} [params.phoneNumber] - Filter to registrations holding this phone number
+	 * @param {string} [params.sortBy] - Sort field: createdAt (default), subgroupId, registrationId, region or status
+	 * @param {string} [params.sortOrder] - Sort direction: asc or desc (default)
+	 * @param {number} [params.page] - Page number (default 1)
+	 * @param {number} [params.limit] - Registrations per page (default 25, max 100)
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to { data: [registrations], totalCount, page, limit }
+	 */
+	async getRegistrations({ groupId, subgroupId, region, type, kind, status, parentRegistrationId, phoneNumber, sortBy, sortOrder, page, limit, options = {} } = {}) {
+		const queryString = this.client._getQueryString({ groupId, subgroupId, region, type, kind, status, parentRegistrationId, phoneNumber, sortBy, sortOrder, page, limit });
+		return this.client(`/registration${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a single registration with its review outcome, the type's public data and its status history
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the registration
+	 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the registration
+	 */
+	async getRegistration({ registrationId, options = {} }) {
+		this.client._require({ registrationId });
+		const safeId = encodeURIComponent(registrationId);
+		return this.client(`/registration/${safeId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Cancel a registration. Allowed from SIGNAL_HOUSE_REVIEW, SIGNAL_HOUSE_APPROVED, PENDING_PROVIDER, NEEDS_INFORMATION,
+	 * PAYMENT_REQUIRED and APPROVED (409 otherwise). Numbers already allocated stay on the account and stop sending.
+	 * @async
+	 * @roles api, admin, developer, user
+	 * @param {Object} params - The parameters for cancelling the registration
+	 * @param {string} params.registrationId - The registration ID (e.g. GB8T9GTD5AZY)
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the cancelled registration
+	 */
+	async cancelRegistration({ registrationId, options = {} }) {
+		this.client._require({ registrationId });
+		const safeId = encodeURIComponent(registrationId);
+		return this.client(`/registration/${safeId}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * Submit a registration. `type` selects the shape of `data`: for VIRTUAL_LONG_CODE it is { quantity (1-100),
+	 * useCases (1-10 descriptions), voice? } where voice is required exactly when capabilities include VOICE. For GB
+	 * ALPHANUMERIC_SENDER_ID (capabilities ["SMS"]) it is { requestedSenderId (3-11 letters/digits/space/dot/dash,
+	 * at least one letter), trafficOrigin (LOCAL | INTERNATIONAL), trafficType (TRANSACTIONAL | PROMOTIONAL),
+	 * companyName, companyCountry, companyWebsite, industry, messageExample, senderRelationship? } where
+	 * senderRelationship is required when requestedSenderId differs from companyName; quantity is always 1 and
+	 * data.phoneNumbers carries the granted sender (e.g. ["ACME"]) once APPROVED.
+	 * Reuse the same clientRequestId only when retrying an identical payload (409 otherwise).
+	 * Unavailable (400) while the type cannot be acquired in the region.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the registration
+	 * @param {string} params.region - ISO-2 jurisdiction (any case of UK/GB/GBR/United Kingdom is accepted for GB)
+	 * @param {string} params.type - Registration type (e.g. VIRTUAL_LONG_CODE, or ALPHANUMERIC_SENDER_ID for GB)
+	 * @param {string} params.subgroupId - Subgroup that will own the registration and any allocated numbers
+	 * @param {string} params.clientRequestId - Idempotency key (UUID)
+	 * @param {string[]} params.capabilities - One of the type's bundles, e.g. ["SMS"] or ["SMS", "VOICE"]
+	 * @param {Object} params.data - The type's submission fields
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the created registration
+	 */
+	async createRegistration({ region, type, subgroupId, clientRequestId, capabilities, data, options = {} }) {
+		this.client._require({ region, type, subgroupId, clientRequestId, capabilities, data });
+		return this.client("/registration", {
+			method: "POST",
+			body: { region, type, subgroupId, clientRequestId, capabilities, data },
+			...options,
+		});
+	}
+}

package/src/domains/Shortlinks.js

@@ -25,6 +25,36 @@ export class Shortlinks {
 		return this.client(`/shortlink/redirect/${safeShortlinkId}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get the recipient opt-out details behind an alphanumeric-sender opt-out link (sihou.io/o/{code})
+	 * @async
+	 * @roles public
+	 * @param {Object} params - The parameters for getting the opt-out details
+	 * @param {string} params.code - The opt-out code from the link
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ code, senderName, maskedRecipient, optedOut }`
+	 */
+	async getOptOut({ code, options = {} }) {
+		this.client._require({ code });
+		const safeCode = encodeURIComponent(code);
+		return this.client(`/shortlink/optout/${safeCode}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Confirm the recipient opt-out behind an alphanumeric-sender opt-out link; idempotent
+	 * @async
+	 * @roles public
+	 * @param {Object} params - The parameters for confirming the opt-out
+	 * @param {string} params.code - The opt-out code from the link
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ code, senderName, maskedRecipient, optedOut: true }`
+	 */
+	async confirmOptOut({ code, options = {} }) {
+		this.client._require({ code });
+		const safeCode = encodeURIComponent(code);
+		return this.client(`/shortlink/optout/${safeCode}`, { method: "POST", ...options });
+	}
+
 	/**
 	 * Get details of a shortlink by its ID, with optional filters
 	 * @async