@signalhousellc/sdk 1.2.0 → 1.3.1

package/package.json

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

package/src/SignalHouseSDK.js

@@ -4,6 +4,7 @@ import axios from "axios";
  * @typedef {Object} RequestOptions
  * @property {string} [token] - An optional bearer token to include in the request for authentication
  * @property {object} [headers] - Additional headers to include in the request
+ * @property {string} [idempotencyKey] - Sent as the Idempotency-Key header; a retry with the same key and request replays the first response instead of repeating it
  */
 
 /**
@@ -103,10 +104,12 @@ export class SignalHouseSDK {
 		const instance = axios.create({ baseURL: this.baseUrl, headers: isMultipart ? {} : { "Content-Type": "application/json" } });
 
 		// Add a request interceptor to include the API key in the Authorization header
-		instance.interceptors.request.use((/** @type {import('axios').InternalAxiosRequestConfig & { token?: string }} */ config) => {
+		instance.interceptors.request.use((/** @type {import('axios').InternalAxiosRequestConfig & { token?: string, idempotencyKey?: string }} */ config) => {
 			const token = config.token || this.apiKey;
 			config.headers.Authorization = `Bearer ${token}`;
+			if (config.idempotencyKey) config.headers["Idempotency-Key"] = config.idempotencyKey;
 			delete config.token; // Remove token from config to avoid sending it as a header
+			delete config.idempotencyKey;
 			return config;
 		});
 

package/src/domains/Agents.js

@@ -67,6 +67,57 @@
  * @property {string} updatedAt - Last-update timestamp.
  */
 
+/**
+ * The fields of an endpoint binding: which agent answers a number.
+ * @typedef {Object} AgentEndpointData
+ * @property {string} agentProfileId - The agent that answers the number (required). It must be active, in the number's group, and either belong to the number's subgroup or be a group-level agent with an enabled deployment there.
+ * @property {string} [answerMode] - Which inbound messages the agent answers: "all_inbound" (the only mode, and the default).
+ */
+
+/**
+ * An endpoint binding (which agent answers a number), as returned by the server.
+ * @typedef {Object} AgentEndpoint
+ * @property {string} agentEndpointId - The binding id ("AEP..." prefix).
+ * @property {string} groupId - The group that owns the binding.
+ * @property {string|null} subgroupId - The subgroup the number belongs to.
+ * @property {string} channel - The channel; "sms" in v1.
+ * @property {string} endpointType - The endpoint kind; "sms_number" in v1.
+ * @property {string} endpointValue - The phone number: digits only, country code included, no "+".
+ * @property {string} agentProfileId - The agent that answers the number.
+ * @property {string} answerMode - Which inbound messages the agent answers ("all_inbound").
+ * @property {Object|null} overrides - Free-form per-endpoint overrides; null when none.
+ * @property {boolean} enabled - Whether the binding is live.
+ * @property {string} createdAt - Creation timestamp.
+ * @property {string} updatedAt - Last-update timestamp.
+ */
+
+/**
+ * A reply an SMS agent wrote but did not send, held for a person to approve or reject (the
+ * Pending Replies queue), as returned by the server.
+ * @typedef {Object} AgentReplyDraft
+ * @property {string} agentReplyDraftId - The draft id ("ARD..." prefix).
+ * @property {string} groupId - The group that owns the draft.
+ * @property {string|null} subgroupId - The subgroup whose number the reply goes out from.
+ * @property {string} agentProfileId - The agent that wrote the reply.
+ * @property {string|null} conversationId - The conversation the reply belongs to.
+ * @property {string} channel - The channel; "sms".
+ * @property {string} endpointValue - The agent's number the reply is sent from, digits only.
+ * @property {string} contactPhoneNumber - The contact the reply is sent to, digits only.
+ * @property {string} inboundText - The contact message the agent was answering.
+ * @property {string} draftText - The reply as the agent wrote it.
+ * @property {string|null} sentText - The text actually sent; differs from draftText when edited.
+ * @property {string} reason - Why it was held: "review_mode", "escalation", "fallback" or "guardrail".
+ * @property {string} status - "pending", "sending", "sent", "rejected" or "failed" (the send path accepted nothing, e.g. the contact opted out).
+ * @property {string|null} decidedBy - The user who approved or rejected it.
+ * @property {string|null} decidedAt - When it was approved or rejected.
+ * @property {string|null} sentMessageId - The outbound message id once sent (for an external delivery, the id you reported).
+ * @property {string|null} claimId - The current claim's id (set when a decision claims the draft); complete and release must name it.
+ * @property {string|null} deliveredBy - Who delivers an approved reply: "signalhouse" (approveAgentReplyDraft) or "external" (claimAgentReplyDraft); null until decided.
+ * @property {string|null} failureReason - "delivery_unconfirmed" when an external claim was never completed or released; otherwise null.
+ * @property {string} createdAt - Creation timestamp.
+ * @property {string} updatedAt - Last-update timestamp.
+ */
+
 /**
  * The per-channel settings for one agent. Model, voice and sampling settings live here rather
  * than on the profile: each channel is served by a different runtime, and the model catalogues
@@ -458,6 +509,186 @@ export class Agents {
 		return this.client(`/agent/profiles/${safeId}/deployments/${safeSubgroupId}`, { method: "DELETE", ...options });
 	}
 
+	/**
+	 * List the endpoint bindings (which agent answers which number) in a group.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for listing endpoint bindings.
+	 * @param {string} params.groupId - The group whose bindings to list (required).
+	 * @param {string} [params.subgroupId] - Narrow to one subgroup's bindings.
+	 * @param {string} [params.agentProfileId] - Narrow to one agent's bindings.
+	 * @param {string} [params.channel] - Narrow to one channel ("sms").
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the groupId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentEndpoint[]>>} - The bindings, ordered by number, returned from the server.
+	 */
+	async getAgentEndpoints({ groupId, subgroupId, agentProfileId, channel, options = {} }) {
+		this.client._require({ groupId });
+		const queryString = this.client._getQueryString({ groupId, subgroupId, agentProfileId, channel });
+		return this.client(`/agent/endpoints${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Assign an agent to answer a number (upsert keyed by channel + number). Assigning again
+	 * replaces the previous agent, so a number has one agent per channel. v1 binds SMS numbers only.
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for the upsert.
+	 * @param {string} params.channel - The channel to bind; must be "sms".
+	 * @param {string} params.endpointValue - The phone number: 10 to 15 digits, country code included, no "+".
+	 * @param {AgentEndpointData} params.endpointData - The agent to assign and its answer mode.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if channel, endpointValue, or endpointData.agentProfileId is missing.
+	 * @returns {Promise<SdkResponse<AgentEndpoint>>} - The created or updated binding returned from the server.
+	 */
+	async upsertAgentEndpoint({ channel, endpointValue, endpointData, options = {} }) {
+		this.client._require({ channel, endpointValue, agentProfileId: endpointData?.agentProfileId });
+		const safeChannel = encodeURIComponent(channel);
+		const safeEndpointValue = encodeURIComponent(endpointValue);
+		return this.client(`/agent/endpoints/${safeChannel}/${safeEndpointValue}`, { method: "PUT", body: endpointData, ...options });
+	}
+
+	/**
+	 * Remove the agent assigned to a number.
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for the delete.
+	 * @param {string} params.channel - The bound channel; must be "sms".
+	 * @param {string} params.endpointValue - The phone number: digits only, country code included, no "+".
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if channel or endpointValue is missing.
+	 * @returns {Promise<SdkResponse<AgentEndpoint>>} - The removed binding returned from the server.
+	 */
+	async deleteAgentEndpoint({ channel, endpointValue, options = {} }) {
+		this.client._require({ channel, endpointValue });
+		const safeChannel = encodeURIComponent(channel);
+		const safeEndpointValue = encodeURIComponent(endpointValue);
+		return this.client(`/agent/endpoints/${safeChannel}/${safeEndpointValue}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * List held agent replies (the Pending Replies queue) in a group, newest first.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for listing drafts.
+	 * @param {string} params.groupId - The group whose drafts to list (required).
+	 * @param {string} [params.subgroupId] - Narrow to one subgroup.
+	 * @param {string} [params.agentProfileId] - Narrow to one agent.
+	 * @param {string} [params.status] - Narrow to one status, e.g. "pending".
+	 * @param {number} [params.page] - Page number for pagination.
+	 * @param {number} [params.limit] - Items per page (default 25, max 500).
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the groupId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft[]>>} - The drafts returned from the server.
+	 */
+	async getAgentReplyDrafts({ groupId, subgroupId, agentProfileId, status, page, limit, options = {} }) {
+		this.client._require({ groupId });
+		const queryString = this.client._getQueryString({ groupId, subgroupId, agentProfileId, status, page, limit });
+		return this.client(`/agent/drafts${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Approve a held agent reply and send it from the agent's number, optionally with edited text.
+	 * It goes through the normal SMS send path, so opt-out and billing apply; the draft comes back
+	 * "failed" when the send path accepted nothing. A draft that is no longer pending returns 409.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the approval.
+	 * @param {string} params.agentReplyDraftId - The draft to approve.
+	 * @param {string} [params.text] - Replacement text when a person edited the reply.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentReplyDraftId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft>>} - The draft, now sent (or failed), returned from the server.
+	 */
+	async approveAgentReplyDraft({ agentReplyDraftId, text, options = {} }) {
+		this.client._require({ agentReplyDraftId });
+		const safeId = encodeURIComponent(agentReplyDraftId);
+		const body = text === undefined ? {} : { text };
+		return this.client(`/agent/drafts/${safeId}/approve`, { method: "POST", body, ...options });
+	}
+
+	/**
+	 * Reject a held agent reply so it is never sent. A draft that is no longer pending returns 409.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the rejection.
+	 * @param {string} params.agentReplyDraftId - The draft to reject.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentReplyDraftId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft>>} - The rejected draft returned from the server.
+	 */
+	async rejectAgentReplyDraft({ agentReplyDraftId, options = {} }) {
+		this.client._require({ agentReplyDraftId });
+		const safeId = encodeURIComponent(agentReplyDraftId);
+		return this.client(`/agent/drafts/${safeId}/reject`, { method: "POST", ...options });
+	}
+
+	/**
+	 * Claim a held agent reply for delivery through your own channel instead of Signal House's send path.
+	 * Nothing is sent: the draft becomes "sending" with `deliveredBy: "external"`, `sentText` and a new
+	 * `claimId` set, and you then report the outcome with `completeAgentReplyDraft` or `releaseAgentReplyDraft`,
+	 * passing that `claimId`. The claim
+	 * means two approvals can never both deliver. A draft that is no longer pending returns 409; one whose
+	 * number has left its subgroup returns 400 and is closed as failed.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the claim.
+	 * @param {string} params.agentReplyDraftId - The draft to claim.
+	 * @param {string} [params.text] - Replacement text when a person edited the reply.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentReplyDraftId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft>>} - The claimed draft returned from the server.
+	 */
+	async claimAgentReplyDraft({ agentReplyDraftId, text, options = {} }) {
+		this.client._require({ agentReplyDraftId });
+		const safeId = encodeURIComponent(agentReplyDraftId);
+		const body = text === undefined ? {} : { text };
+		return this.client(`/agent/drafts/${safeId}/claim`, { method: "POST", body, ...options });
+	}
+
+	/**
+	 * Mark a claimed agent reply sent once your channel accepted it. Only the claim named by `claimId` can be
+	 * completed (anything else returns 409). It is also accepted after an unfinished claim was closed as
+	 * "failed" with `failureReason: "delivery_unconfirmed"`, which it turns into "sent".
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the completion.
+	 * @param {string} params.agentReplyDraftId - The claimed draft.
+	 * @param {string} params.claimId - The claim being completed, as returned by `claimAgentReplyDraft`.
+	 * @param {string} [params.externalMessageId] - Your channel's id for the sent message, stored as `sentMessageId`.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentReplyDraftId or claimId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft>>} - The draft, now sent, returned from the server.
+	 */
+	async completeAgentReplyDraft({ agentReplyDraftId, claimId, externalMessageId, options = {} }) {
+		this.client._require({ agentReplyDraftId, claimId });
+		const safeId = encodeURIComponent(agentReplyDraftId);
+		const body = externalMessageId === undefined ? { claimId } : { claimId, externalMessageId };
+		return this.client(`/agent/drafts/${safeId}/complete`, { method: "POST", body, ...options });
+	}
+
+	/**
+	 * Give back a claim whose reply certainly did not go out: the draft returns to "pending", or with
+	 * `permanent` is closed as "failed". If you cannot tell whether it went out, do not release it; a claim
+	 * left unfinished for 30 minutes is closed as failed with `failureReason: "delivery_unconfirmed"`.
+	 * Only the claim named by `claimId` can be released; anything else returns 409.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the release.
+	 * @param {string} params.agentReplyDraftId - The claimed draft.
+	 * @param {string} params.claimId - The claim being released, as returned by `claimAgentReplyDraft`.
+	 * @param {boolean} [params.permanent] - True closes the draft as failed instead of returning it to pending.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the agentReplyDraftId or claimId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentReplyDraft>>} - The draft, pending again or failed, returned from the server.
+	 */
+	async releaseAgentReplyDraft({ agentReplyDraftId, claimId, permanent, options = {} }) {
+		this.client._require({ agentReplyDraftId, claimId });
+		const safeId = encodeURIComponent(agentReplyDraftId);
+		const body = permanent === undefined ? { claimId } : { claimId, permanent };
+		return this.client(`/agent/drafts/${safeId}/release`, { method: "POST", body, ...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

package/src/domains/Auth.js

@@ -65,8 +65,11 @@ export class Auth {
 	 * @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.firstTouch] - First-ever visit: utmSource, utmMedium, utmCampaign, utmTerm, utmContent, gclid, gbraid, wbraid, fbclid, msclkid, referrer, landingUrl, timestamp
 	 * @param {Object} [params.attribution.lastTouch] - Visit that registered, same keys as firstTouch
+	 * @param {string} [params.attribution.shLanding] - Marketing-site landing page passed on the register link (sh_landing)
+	 * @param {string} [params.attribution.shCta] - Marketing-site CTA that sent the visitor (sh_cta)
+	 * @param {string} [params.attribution.shGuide] - Marketing-site guide the CTA was on (sh_guide)
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<any>>} The response from the server (contains the JWT token)
 	 */

package/src/domains/Messages.js

@@ -183,7 +183,7 @@ export class Messages {
 	 * @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 {("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, excluding P2P) 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".
 	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<SdkResponse<Array>>} - A promise that resolves to an array of analytics snapshot records. cardTotals and
@@ -229,7 +229,7 @@ export class Messages {
 	}
 
 	/**
-	 * Get filter dropdown options (subgroups, brands, campaigns, phone numbers) for the Analytics page,
+	 * Get filter dropdown options (subgroups, brands, campaigns, phone numbers, carriers) for the Analytics page,
 	 * scoped to a single group. Sourced from ClickHouse — only items with at least one message are returned.
 	 * @async
 	 * @roles api, admin, developer, billing, user
@@ -237,7 +237,7 @@ export class Messages {
 	 * @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 }. 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.
+	 * @returns {Promise<SdkResponse<any>>} - A promise that resolves to { subgroups, brands, campaigns, phoneNumbers, carriers }. 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. `carriers` is a plain array of carrier name strings.
 	 */
 	async getAnalyticsFilterOptions({ groupId, region, options = {} }) {
 		const filters = { groupId, region };

package/src/domains/Numbers.js

@@ -323,11 +323,12 @@ export class Numbers {
    * @param {string} [params.status] - Filter by status (PENDING, IN_PROGRESS, COMPLETED, REJECTED, CANCELLED)
    * @param {number} [params.page] - The page number for pagination (default: 1)
    * @param {number} [params.limit] - The number of items per page (default: 20)
+   * @param {boolean} [params.excludeDocuments] - When true, leave signatureUrl and billingUrl out of each request (the inline LOA signature and billing statement). Fetch one request with getPortRequestById to read them.
    * @param {RequestOptions} [params.options] - Additional options for the request
    * @returns {Promise<SdkResponse<any>>} A promise that resolves to the paginated list of port-in requests
    */
-  async getPortRequests({ groupId, phoneNumber, status, page, limit, options = {} } = {}) {
-    const filters = { groupId, phoneNumber, status, page, limit };
+  async getPortRequests({ groupId, phoneNumber, status, page, limit, excludeDocuments, options = {} } = {}) {
+    const filters = { groupId, phoneNumber, status, page, limit, excludeDocuments };
     const queryString = this.client._getQueryString(filters);
     return this.client(`/number/portin${queryString}`, { method: 'GET', ...options });
   }

package/src/domains/Onboarding.js

@@ -39,6 +39,40 @@ export class Onboarding {
 					const safeGroupId = encodeURIComponent(groupId);
 					return this.client(`/group/onboarding/${safeGroupId}`, { method: "GET", ...options });
 				},
+
+				/**
+				 * Add an internal comment/note to a group's admin Pricing editor. Staff-only.
+				 * @async
+				 * @roles signalhouse_admin, signalhouse_user
+				 * @param {Object} params
+				 * @param {string} params.groupId - The group ID to comment on
+				 * @param {string} params.comment - The comment/note text
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupId or comment parameter is missing
+				 * @returns {Promise<SdkResponse<any>>} - The updated onboarding record
+				 */
+				addPricingComment: async ({ groupId, comment, options = {} }) => {
+					this.client._require({ groupId, comment });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/group/onboarding/${safeGroupId}/pricing-comments`, { method: "POST", body: { comment }, ...options });
+				},
+
+				/**
+				 * Add an internal comment/note to a group's admin Credits page. Staff-only.
+				 * @async
+				 * @roles signalhouse_admin, signalhouse_user
+				 * @param {Object} params
+				 * @param {string} params.groupId - The group ID to comment on
+				 * @param {string} params.comment - The comment/note text
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupId or comment parameter is missing
+				 * @returns {Promise<SdkResponse<any>>} - The updated onboarding record
+				 */
+				addCreditComment: async ({ groupId, comment, options = {} }) => {
+					this.client._require({ groupId, comment });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/group/onboarding/${safeGroupId}/credit-comments`, { method: "POST", body: { comment }, ...options });
+				},
 			};
 		}
 	}

package/src/domains/Registrations.js

@@ -222,7 +222,7 @@ export class Registrations {
 	 * 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).
+	 * Pass options.idempotencyKey to make a retry safe: an identical retry with the same key replays the first response.
 	 * Unavailable (400) while the type cannot be acquired in the region.
 	 * @async
 	 * @roles api, admin, developer, billing, user
@@ -230,17 +230,16 @@ export class Registrations {
 	 * @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 });
+	async createRegistration({ region, type, subgroupId, capabilities, data, options = {} }) {
+		this.client._require({ region, type, subgroupId, capabilities, data });
 		return this.client("/registration", {
 			method: "POST",
-			body: { region, type, subgroupId, clientRequestId, capabilities, data },
+			body: { region, type, subgroupId, capabilities, data },
 			...options,
 		});
 	}