@signalhousellc/sdk 1.0.52 → 1.0.54

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@signalhousellc/sdk",
-  "version": "1.0.52",
+  "version": "1.0.54",
   "description": "Signal House SDK for use with the Signal House platform",
   "type": "module",
   "main": "src/SignalHouseSDK.js",
   "exports": {
-    ".": "./src/SignalHouseSDK.js"
+    ".": "./src/SignalHouseSDK.js",
+    "./voice-browser": "./src/domains/voice/browser/index.js"
   },
   "files": [
     "src/",
@@ -15,5 +16,13 @@
   "license": "ISC",
   "dependencies": {
     "axios": "^1.13.5"
+  },
+  "peerDependencies": {
+    "jssip": "^3.13.0"
+  },
+  "peerDependenciesMeta": {
+    "jssip": {
+      "optional": true
+    }
   }
 }

package/src/SignalHouseSDK.js

@@ -22,6 +22,7 @@ import { Subscriptions } from "./domains/Subscriptions.js";
 import { Users } from "./domains/Users.js";
 import { Notifications } from "./domains/Notifications.js";
 import { Webhooks } from "./domains/Webhooks.js";
+import { Voice } from "./domains/Voice.js";
 
 export class SignalHouseSDK {
 	/**
@@ -29,6 +30,7 @@ export class SignalHouseSDK {
 	 * @param {Object} config - The configuration object for initializing the SDK
 	 * @param {string} config.apiKey - The API key for authenticating requests to the SignalHouse API
 	 * @param {string} config.baseUrl - The base URL for the SignalHouse API (e.g., "https://api.signalhouse.com")
+	 * @param {boolean} [config.enableAdmin=false] - Enable admin-scoped behaviors on domains that support them.
 	 * @throws {Error} Throws an error if the API key or base URL is missing from the configuration
 	 * @returns {SignalHouseSDK} An instance of the SignalHouseSDK
 	 */
@@ -66,6 +68,9 @@ export class SignalHouseSDK {
 		this.users = new Users(client, this.enableAdmin);
 		this.notifications = new Notifications(client, this.enableAdmin);
 		this.webhooks = new Webhooks(client, this.enableAdmin);
+		// Voice domain targets the voice-backend service under /voice. Available
+		// like any other domain; gating (if any) will be decided later.
+		this.voice = new Voice(client, this.enableAdmin);
 	}
 
 	/**

package/src/domains/Auth.js

@@ -58,6 +58,37 @@ export class Auth {
 		return this.client(`/auth/verify-email`, { method: "POST", body: { token }, ...options });
 	}
 
+	/**
+	 * Request a password-reset link be emailed to the given address (public). Always resolves
+	 * successfully regardless of whether an account exists for the email, so it cannot be used to
+	 * enumerate registered emails.
+	 * @async
+	 * @roles public
+	 * @param {Object} params
+	 * @param {string} params.email - The email address to send a reset link to
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server ({ success: true })
+	 */
+	async forgotPassword({ email, options = {} }) {
+		this.client._require({ email });
+		return this.client(`/auth/forgot-password`, { method: "POST", body: { email }, ...options });
+	}
+
+	/**
+	 * Reset a password using the single-use token from a password-reset email link (public)
+	 * @async
+	 * @roles public
+	 * @param {Object} params
+	 * @param {string} params.token - The single-use reset token from the email link
+	 * @param {string} params.password - The new password to set (min 8 characters)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server ({ success: true })
+	 */
+	async resetPasswordWithToken({ token, password, options = {} }) {
+		this.client._require({ token, password });
+		return this.client(`/auth/reset-password`, { method: "POST", body: { token, password }, ...options });
+	}
+
 	/**
 	 * Resend the account verification email to the authenticated caller
 	 * @async
@@ -115,4 +146,19 @@ export class Auth {
 	async logoutAll({ options = {} } = {}) {
 		return this.client(`/auth/logout-all`, { method: "POST", ...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.
+	 * @async
+	 * @roles admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.product - The external system to link to ("ghl" or "shopify")
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server ({ token })
+	 */
+	async requestExternalLinkToken({ product, options = {} }) {
+		this.client._require({ product });
+		return this.client(`/auth/external-link-token`, { method: "POST", body: { product }, ...options });
+	}
 }

package/src/domains/Brands.js

@@ -198,6 +198,29 @@ export class Brands {
 		return this.client(`/brand/externalvetting/${safeBrandId}`, { method: "POST", ...options });
 	}
 
+	/**
+	 * Import an existing external vetting record for a brand
+	 *
+	 * Unlike createExternalVetting (which orders a new, billable vetting), this attaches a vetting the
+	 * brand already completed directly with the provider, using the provider-issued vettingId and
+	 * vettingToken. It is synchronous and not billable.
+	 * @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 {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)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if brandId, vettingProviderId, or vettingId is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async importExternalVetting({ brandId, vettingProviderId, vettingId, vettingToken, options = {} }) {
+		this.client._require({ brandId, vettingProviderId, vettingId });
+		const safeBrandId = encodeURIComponent(brandId);
+		return this.client(`/brand/externalvetting/import/${safeBrandId}`, { method: "POST", body: { vettingProviderId, vettingId, vettingToken }, ...options });
+	}
+
 	/**
 	 * Update a brand's information
 	 * @async

package/src/domains/Campaigns.js

@@ -64,7 +64,7 @@
  * @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, additionalInformation (≤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 (≤500), exampleMessage, customerCareEmail, optInImageURLs, optIns, multiNumberReason (≤500)). Phone numbers cannot be changed via update — Toll-Free numbers are locked to their campaign.
  */
 
 /**
@@ -87,7 +87,7 @@
  * @property {TollFreeOptIn} [optIns.web] - Online (web) opt-in details
  * @property {TollFreeOptIn} [optIns.keyword] - Keyword opt-in details
  * @property {TollFreeOptIn} [optIns.interactiveVoiceResponse] - IVR opt-in details
- * @property {string} [additionalInformation] - Free-text justification sent upstream to the carrier (optional, at most 500 characters). Required when more than one phone number is assigned to the campaign.
+ * @property {string} [multiNumberReason] - Internally-stored reason the customer requested more than one Toll-Free number on the campaign (optional, at most 500 characters). Required when more than one phone number is assigned; captured for Signal House review only and never sent to the carrier.
  */
 
 /**
@@ -196,7 +196,7 @@ export class Campaigns {
 	/**
 	 * Create a new Toll-Free (TFN) campaign and submit it for Signal House review
 	 * @async
-	 * @roles api, admin, developer, billing, user
+	 * @roles api, admin, developer, user
 	 * @param {Object} params - The parameters for creating the toll-free campaign
 	 * @param {CreateTollFreeCampaignData} params.campaignData - The data for the toll-free campaign to be created (see CreateTollFreeCampaignData typedef for details)
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request

package/src/domains/Groups.js

@@ -52,6 +52,30 @@ export class Groups {
 					const safeGroupId = encodeURIComponent(groupId);
 					return this.client(`/group/${safeGroupId}`, { method: "DELETE", ...options });
 				},
+
+				/**
+				 * Link an external tenant (GHL/Shopify) to a V2 group (server-to-server). Exchanges a
+				 * single-use link token for a canonical group, adopting an empty portal group, repointing
+				 * to an existing group, or flagging for manual review.
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for linking an external account
+				 * @param {string} params.linkToken - The single-use external-link token minted by the portal user
+				 * @param {string} params.externalSystem - The external system ("ghl" or "shopify")
+				 * @param {string} params.externalId - The external tenant identifier
+				 * @param {string} [params.existingGroupId] - An existing V2 group ID to repoint to, if any
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if linkToken, externalSystem, or externalId is missing
+				 * @returns {Promise<Object>} - The link outcome ({ status, canonicalGroupId, ... })
+				 */
+				linkExternal: async ({ linkToken, externalSystem, externalId, existingGroupId, options = {} }) => {
+					this.client._require({ linkToken, externalSystem, externalId });
+					return this.client(`/group/link-external`, {
+						method: "POST",
+						body: { linkToken, externalSystem, externalId, ...(existingGroupId ? { existingGroupId } : {}) },
+						...options,
+					});
+				},
 			};
 		}
 	}

package/src/domains/Numbers.js

@@ -115,7 +115,8 @@ export class Numbers {
 	 * Purchase one or more Toll-Free numbers via the asynchronous resource-request flow.
 	 *
 	 * Toll-Free numbers are ordered by quantity (not picked individually) and provisioned asynchronously;
-	 * per-number completion is delivered via webhook/polling, not in this response.
+	 * per-number completion is delivered via webhook/polling, not in this response. The returned `orderId`
+	 * can be polled with {@link Numbers#getTollFreeOrderStatus} for the order's outcome.
 	 * @async
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for purchasing toll-free numbers
@@ -123,13 +124,33 @@ export class Numbers {
 	 * @param {string} params.subgroupId - The subgroup the purchased numbers are assigned to
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the quantity or subgroupId parameter is missing
-	 * @returns {Promise<Object>} A promise that resolves to `{ message }` once the request is queued.
+	 * @returns {Promise<Object>} A promise that resolves to `{ message, orderId }` once the request is queued.
 	 */
 	async purchaseTollFreeNumbers({ quantity, subgroupId, options = {} }) {
 		this.client._require({ quantity, subgroupId });
 		return this.client(`/number/toll-free`, { method: "POST", body: { quantity, subgroupId }, ...options });
 	}
 
+	/**
+	 * Read the outcome of a Toll-Free number purchase by the `orderId` returned from
+	 * {@link Numbers#purchaseTollFreeNumbers}. Reports per-number status as ready / provisioning / failed
+	 * counts (plus failure reasons) so a client can poll until the order reaches a terminal state, and
+	 * returns the provisioned phone numbers for the order so a client can act on exactly those numbers.
+	 * `numbers` is empty until each number is provisioned (it fills in as the order completes).
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for reading the order status
+	 * @param {string} params.orderId - The order id returned by `purchaseTollFreeNumbers`
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the orderId parameter is missing
+	 * @returns {Promise<Object>} A promise that resolves to `{ orderId, counts: { ready, provisioning, failed }, failures: [{ reason }], numbers: string[] }`.
+	 */
+	async getTollFreeOrderStatus({ orderId, options = {} }) {
+		this.client._require({ orderId });
+		const safeOrderId = encodeURIComponent(orderId);
+		return this.client(`/number/toll-free/order/${safeOrderId}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Update an existing phone number's details (e.g., setting a friendly name)
 	 * @async

package/src/domains/Voice.js

@@ -0,0 +1,26 @@
+import { SipTrunks } from "./voice/SipTrunks.js";
+import { SipProfiles } from "./voice/SipProfiles.js";
+import { Calls } from "./voice/Calls.js";
+import { Tokens } from "./voice/Tokens.js";
+
+/**
+ * Voice domain — wraps the voice-backend service (mounted under /voice on the
+ * platform host). Groups all voice-service sub-resources under a single
+ * namespace, accessed via `sdk.voice.*`.
+ *
+ * Sub-resources:
+ * - `sdk.voice.sipTrunks`   — SIP trunk (peer-to-peer connections to PBX/carrier).
+ * - `sdk.voice.sipProfiles` — SIP profile / endpoint (single registerable UA).
+ * - `sdk.voice.calls`       — Outbound call origination + call log queries.
+ * - `sdk.voice.tokens`      — Mint ephemeral SIP credentials for the browser voice SDK.
+ */
+export class Voice {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+		this.sipTrunks = new SipTrunks(client, enableAdmin);
+		this.sipProfiles = new SipProfiles(client, enableAdmin);
+		this.calls = new Calls(client, enableAdmin);
+		this.tokens = new Tokens(client, enableAdmin);
+	}
+}

package/src/domains/voice/Calls.js

@@ -0,0 +1,112 @@
+/**
+ * @typedef {Object} CreateCallData
+ * @property {string} to - Destination phone number in E.164 format (e.g. "+15551234567") or SIP URI.
+ * @property {string} from - Caller ID to present on the outbound leg. Must be an account-owned phone number when not using a SIP trunk.
+ * @property {string} [sip_trunk_id] - Route via a configured SIP trunk. Mutually exclusive with `sip_profile_id` and `to_identity` for the trunk path.
+ * @property {string} [sip_profile_id] - Two-leg-with-bridge: ring this persistent SIP profile first, then dial `to` and bridge. Mutually exclusive with `to_identity`.
+ * @property {string} [to_identity] - Two-leg-with-bridge: ring the SDK-registered identity by logical name (the value passed to `tokens.create({identity})`), then dial `to` and bridge. Mutually exclusive with `sip_profile_id`.
+ * @property {string} [answer_url] - Webhook URL fetched on call answer; returns call-control instructions.
+ * @property {"GET"|"POST"} [answer_method] - HTTP method for `answer_url`. Defaults to POST.
+ * @property {string} [status_callback] - Webhook URL for call status updates (QUEUED, RINGING, ANSWERED, COMPLETED, FAILED).
+ * @property {"GET"|"POST"} [status_callback_method] - HTTP method for `status_callback`. Defaults to POST.
+ * @property {boolean} [recording_enabled] - Record both legs of the call. Defaults to false.
+ * @property {boolean} [transcription_enabled] - Transcribe the recording. Defaults to false.
+ * @property {string} [ivr_flow_id] - Route the call into an AI IVR flow on answer instead of webhook control.
+ * @property {Object} [metadata] - Free-form metadata persisted on the call log.
+ */
+
+/**
+ * @typedef {Object} ListCallsFilters
+ * @property {number} [page] - Page number (1-indexed). Defaults to 1.
+ * @property {number} [limit] - Page size (1-100). Defaults to 20.
+ * @property {"QUEUED"|"RINGING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"BUSY"|"NO_ANSWER"|"CANCELED"} [status] - Filter by call status.
+ * @property {"INBOUND"|"OUTBOUND"} [direction] - Filter by call direction.
+ * @property {string} [from] - Filter by caller number.
+ * @property {string} [to] - Filter by destination number.
+ * @property {string} [date_from] - ISO-8601 lower bound on start_time.
+ * @property {string} [date_to] - ISO-8601 upper bound on start_time.
+ */
+
+/**
+ * Voice calls. REST API for placing outbound calls and inspecting call logs.
+ * Wraps voice-backend's `/voice/v1/calls` surface. Accessed via `sdk.voice.calls`.
+ *
+ * Origination modes:
+ * - **Single-leg** (no trunk/profile/identity): Twilio-style direct outbound — dial `to` from caller-ID `from`. Customer's `from` must be an account-owned number.
+ * - **SIP trunk** (`sip_trunk_id`): Route via a configured trunk; the trunk's auth/ACL governs caller-ID rules.
+ * - **Two-leg-with-bridge** (`sip_profile_id` OR `to_identity`): Ring the SDK-registered endpoint first, then dial `to` and bridge. `to_identity` resolves to the most recently-minted unexpired ephemeral identity for that name.
+ */
+export class Calls {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Create an outbound call.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {CreateCallData} params.callData - The call to place.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If callData is missing.
+	 * @returns {Promise<Object>} The created call: `{ call_id, status, direction, from, to, created_at }`.
+	 */
+	async create({ callData, options = {} }) {
+		this.client._require({ callData });
+		return this.client(`/voice/v1/calls`, { method: "POST", body: callData, ...options });
+	}
+
+	/**
+	 * List call logs for the current account, paginated and filterable.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} [params] - Request parameters.
+	 * @param {ListCallsFilters} [params.filters] - Optional filters.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @returns {Promise<Object>} `{ calls: [...], total, page, limit }`.
+	 */
+	async list({ filters = {}, options = {} } = {}) {
+		const query = new URLSearchParams();
+		for (const [k, v] of Object.entries(filters)) {
+			if (v !== undefined && v !== null && v !== "") query.set(k, String(v));
+		}
+		const qs = query.toString();
+		const path = qs ? `/voice/v1/calls?${qs}` : `/voice/v1/calls`;
+		return this.client(path, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a single call log by ID.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The call log UUID (the value returned as `call_id` from `create`).
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id is missing.
+	 * @returns {Promise<Object>} The call log.
+	 */
+	async get({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/v1/calls/${safeId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Hang up an in-progress call.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The call log UUID.
+	 * @param {"NORMAL"|"BUSY"|"NO_ANSWER"|"REJECTED"} [params.reason] - Hangup reason recorded on the call log. Defaults to NORMAL.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id is missing.
+	 * @returns {Promise<Object>} `{ success: boolean, message: string }`.
+	 */
+	async hangup({ id, reason, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		const body = reason ? { reason } : {};
+		return this.client(`/voice/v1/calls/${safeId}/hangup`, { method: "POST", body, ...options });
+	}
+}

package/src/domains/voice/SipProfiles.js

@@ -0,0 +1,191 @@
+/**
+ * @typedef {Object} CreateSipProfileData
+ * @property {string} name - Profile name (required).
+ * @property {boolean} [recordingAllowed] - Permit call recording on this endpoint.
+ * @property {boolean} [transcriptionEnabled] - Permit transcription on calls to/from this endpoint.
+ * @property {boolean} [sentimentFlag] - Permit sentiment analysis on this endpoint.
+ */
+
+/**
+ * @typedef {Object} UpdateSipProfileData
+ * @property {string} [name] - Profile name.
+ * @property {string} [sipUsername] - SIP username override.
+ * @property {string} [password] - New password (also the way to "regenerate" — pass a fresh value).
+ * @property {"UDP"|"TCP"|"TLS"} [transport] - SIP transport.
+ * @property {boolean} [recordingAllowed] - Permit call recording.
+ * @property {boolean} [transcriptionEnabled] - Permit transcription.
+ * @property {boolean} [sentimentFlag] - Permit sentiment analysis.
+ */
+
+/**
+ * SIP Profile / endpoint management. A SIP profile is a single registerable
+ * UA — a desk phone, a softphone, a SIP-capable device — that registers to
+ * Signal House with a username and password. Distinct from a SIP trunk,
+ * which represents a peer-to-peer link to another PBX or carrier.
+ *
+ * Calls the voice-backend service mounted under /voice. Accessed via
+ * `sdk.voice.sipProfiles`.
+ */
+export class SipProfiles {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * List all SIP profiles belonging to the current account.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} [params] - Request parameters.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @returns {Promise<Object>} `{ sipProfiles: [...] }`.
+	 */
+	async list({ options = {} } = {}) {
+		return this.client(`/voice/sip-profiles`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a single SIP profile by ID. NOTE: response does NOT include the
+	 * password — use `getPassword({ id })` to retrieve it.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id is missing.
+	 * @returns {Promise<Object>} `{ sipProfile: {...} }`.
+	 */
+	async get({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get the password for a SIP profile. The password is generated by the
+	 * server on create and stored; this endpoint returns the stored value
+	 * (it is NOT one-time-visible like the create response — calling getPassword
+	 * later still returns the password as long as it has not been replaced).
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id is missing.
+	 * @returns {Promise<Object>} `{ password: string|null }`.
+	 */
+	async getPassword({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}/password`, { method: "GET", ...options });
+	}
+
+	/**
+	 * List valid SIP transports + their address/port per region from the DB.
+	 * Used by edit-profile UI to populate transport selectors.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} [params] - Request parameters.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @returns {Promise<Object>} `{ transports: [{ transport, address, port }, ...] }`.
+	 */
+	async getTransports({ options = {} } = {}) {
+		return this.client(`/voice/sip-profiles/transports`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Create a new SIP profile. The server generates the SIP username and
+	 * password; the password is returned on the create response at the top
+	 * level (NOT nested inside `sipProfile`) and is the only chance to surface
+	 * it without an explicit `getPassword` lookup.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {CreateSipProfileData} params.profileData - The SIP profile to create.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If profileData is missing.
+	 * @returns {Promise<Object>} `{ sipProfile: {...}, password: string, sipServer: string, message: string }`.
+	 */
+	async create({ profileData, options = {} }) {
+		this.client._require({ profileData });
+		return this.client(`/voice/sip-profiles`, { method: "POST", body: profileData, ...options });
+	}
+
+	/**
+	 * Update an existing SIP profile. To rotate the password, pass a new
+	 * `password` value here — there is no dedicated regenerate endpoint.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {UpdateSipProfileData} params.updateData - Fields to update.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id or updateData is missing.
+	 * @returns {Promise<Object>} `{ sipProfile: {...} }`.
+	 */
+	async update({ id, updateData, options = {} }) {
+		this.client._require({ id, updateData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}`, { method: "PATCH", body: updateData, ...options });
+	}
+
+	/**
+	 * Delete a SIP profile by ID. Unassigns any linked numbers and frees the
+	 * extension as a side-effect.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id is missing.
+	 * @returns {Promise<Object>} `{ message: string }`.
+	 */
+	async delete({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * Assign a phone number to this SIP profile (routes inbound calls on that
+	 * number to the endpoint).
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {string} params.phoneNumberId - The phone number UUID to assign.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id or phoneNumberId is missing.
+	 * @returns {Promise<Object>} `{ sipProfile: {...} }`.
+	 */
+	async assignNumber({ id, phoneNumberId, options = {} }) {
+		this.client._require({ id, phoneNumberId });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}/assign-number`, {
+			method: "POST",
+			body: { phoneNumberId },
+			...options,
+		});
+	}
+
+	/**
+	 * Unassign a phone number from this SIP profile.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - Request parameters.
+	 * @param {string} params.id - The SIP profile UUID.
+	 * @param {string} params.phoneNumberId - The phone number UUID to unassign.
+	 * @param {import('../../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} If id or phoneNumberId is missing.
+	 * @returns {Promise<Object>} `{ sipProfile: {...} }`.
+	 */
+	async unassignNumber({ id, phoneNumberId, options = {} }) {
+		this.client._require({ id, phoneNumberId });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/voice/sip-profiles/${safeId}/unassign-number`, {
+			method: "POST",
+			body: { phoneNumberId },
+			...options,
+		});
+	}
+}