@signalhousellc/sdk 1.0.67 → 1.0.69

package/src/domains/Numbers.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Numbers {
   constructor(client, multipartClient, enableAdmin) {
     this.client = client;
@@ -14,8 +20,8 @@ export class Numbers {
          * @param {string} params.portingId - The _id of the port-in request
          * @param {string} params.status - The new status (PENDING, IN_PROGRESS, REJECTED)
          * @param {string} [params.description] - Optional description for the status change
-         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-         * @returns {Promise<Object>} A promise that resolves to the updated port-in request
+         * @param {RequestOptions} [params.options] - Additional options for the request
+         * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated port-in request
          */
         changePortingStatus: async ({ portingId, status, description, options = {} }) => {
           this.client._require({ portingId, status });
@@ -33,8 +39,8 @@ export class Numbers {
          * @roles signalhouse
          * @param {Object} params - The parameters for approving the request
          * @param {string} params.portingId - The _id of the port-in request
-         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-         * @returns {Promise<Object>} A promise that resolves to the updated port-in request
+         * @param {RequestOptions} [params.options] - Additional options for the request
+         * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated port-in request
          */
         approvePortRequest: async ({ portingId, options = {} }) => {
           this.client._require({ portingId });
@@ -53,8 +59,8 @@ export class Numbers {
          * @param {string} [params.search] - Request or associated identifier search.
          * @param {number} [params.page] - One-based page number.
          * @param {number} [params.limit] - Page size.
-         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options.
-         * @returns {Promise<Object>} Paginated acquisition requests.
+         * @param {RequestOptions} [params.options] - Additional options.
+         * @returns {Promise<SdkResponse<any>>} Paginated acquisition requests.
          */
         getShortCodeAcquisitionRequests: async ({ status, search, page, limit, options = {} } = {}) => {
           const queryString = this.client._getQueryString({ status, search, page, limit });
@@ -76,7 +82,7 @@ export class Numbers {
    * @param {string} [params.groupId] - Filter by group ID
    * @param {number} [params.page] - The page number for pagination (default: 1)
    * @param {number} [params.limit] - The number of items per page for pagination (default: 20)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    *
    * Every record carries a `sentiment` object -- trailing 7-day and 30-day inbound reply sentiment,
    * refreshed periodically from analytics rather than computed per request: `{ sevenDay, thirtyDay,
@@ -94,7 +100,7 @@ export class Numbers {
    * in the window; the volumes say how much traffic sits behind it. A campaign's figure is scored from the
    * campaign's own summed counters, never averaged from its numbers. For a live figure use GET /number/health
    * or GET /campaign/health.
-   * @returns {Promise<Object>} A promise that resolves to the list of phone numbers
+   * @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 };
@@ -108,9 +114,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for reading number health
    * @param {string} params.phoneNumber - Owned phone number to score (11 digits, no + prefix)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumber parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to `{ phoneNumber, groupId, sevenDay, thirtyDay }`
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ phoneNumber, groupId, sevenDay, thirtyDay }`
    */
   async getNumberHealth({ phoneNumber, options = {} }) {
     this.client._require({ phoneNumber });
@@ -128,14 +134,14 @@ export class Numbers {
    * @param {boolean} [params.voiceEnabled] - Filter for phone numbers that are voice enabled
    * @param {string} [params.country] - Filter by country code (e.g., "US")
    * @param {string} [params.state] - Filter by state code (e.g., "CA")
-   * @param {string} [params.city] - City prefix; requires country US/CA and state/province.
+   * @param {string} [params.city] - City prefix; requires country US and state.
    * @param {string} [params.npa] - Filter by NPA (area code)
    * @param {string} [params.nxx] - Filter by NXX (central office code) - the first three digits of the local phone number after the area code
    * @param {string} [params.phoneNumber] - Filter by phone number
    * @param {number} [params.limit] - The number of items per page for pagination
    * @param {number} [params.page] - The page number for pagination
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to the list of available phone numbers
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the list of available phone numbers
    */
   async getAvailablePhoneNumbers({
     smsEnabled,
@@ -166,10 +172,10 @@ export class Numbers {
    * @param {Object} params - The parameters for purchasing phone numbers
    * @param {string[]} params.phoneNumbers - The list of phone numbers to purchase
    * @param {string} params.subgroupId - The ID of the subgroup to assign the purchased phone numbers to
-   * @param {'US'|'CA'} [params.country='US'] - ISO-2 purchase country. Toll-Free always uses the shared registry.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {string} [params.country='US'] - ISO-2 purchase country; US.
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumbers or subgroupId parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to `{ message }` once the request is queued.
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ message }` once the request is queued.
    */
   async purchasePhoneNumber({ phoneNumbers, subgroupId, country = 'US', options = {} }) {
     this.client._require({ phoneNumbers, subgroupId });
@@ -187,10 +193,10 @@ export class Numbers {
    * @param {Object} params - The parameters for purchasing toll-free numbers
    * @param {number} params.quantity - The number of toll-free numbers to purchase (1-10)
    * @param {string} params.subgroupId - The subgroup the purchased numbers are assigned to
-   * @param {'US'|'CA'} [params.country='US'] - ISO-2 purchase country. Toll-Free always uses the shared registry.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {string} [params.country='US'] - ISO-2 purchase country; US.
+   * @param {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, orderId }` once the request is queued.
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ message, orderId }` once the request is queued.
    */
   async purchaseTollFreeNumbers({ quantity, subgroupId, country = 'US', options = {} }) {
     this.client._require({ quantity, subgroupId });
@@ -213,9 +219,9 @@ export class Numbers {
    * @param {string} [params.actualCode] - Required customer-owned five- or six-digit code for EXTERNAL_LEASE.
    * @param {string} [params.orderId] - Required Registry order ID for EXTERNAL_LEASE.
   * @param {string|Date} [params.leaseEndDate] - Required future Registry lease end date for EXTERNAL_LEASE. A YYYY-MM-DD value expires at 23:59:59 UTC.
-  * @param {Buffer|Blob|File} [params.leaseReceiptFile] - Required PNG, JPEG, or PDF lease receipt for EXTERNAL_LEASE.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
-   * @returns {Promise<Object>} A pending acquisition request or pending external-lease number.
+  * @param {Blob|File} [params.leaseReceiptFile] - Required PNG, JPEG, or PDF lease receipt for EXTERNAL_LEASE.
+   * @param {RequestOptions} [params.options] - Additional options for the request.
+   * @returns {Promise<SdkResponse<any>>} A pending acquisition request or pending external-lease number.
    */
   async requestShortCodeAcquisition({
     subgroupId,
@@ -254,9 +260,9 @@ export class Numbers {
    * @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
+   * @param {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[] }`.
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ orderId, counts: { ready, provisioning, failed }, failures: [{ reason }], numbers: string[] }`.
    */
   async getTollFreeOrderStatus({ orderId, options = {} }) {
     this.client._require({ orderId });
@@ -274,9 +280,9 @@ export class Numbers {
    * @param {string} [params.updateData.friendlyName] - An optional friendly name for the phone number
    * @param {string|null} [params.updateData.primaryInboundWebhookUrl] - Primary inbound voice webhook URL (http/https). When set, inbound calls to this number are driven by the SHML your webhook returns (programmable call control). Pass null or an empty string to clear.
    * @param {string|null} [params.updateData.secondaryInboundWebhookUrl] - Secondary inbound voice webhook URL (http/https), used for failover when the primary returns an error. Pass null or an empty string to clear.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumber or updateData parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to the updated phone number object
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated phone number object
    */
   async updatePhoneNumber({ phoneNumber, updateData, options = {} }) {
     this.client._require({ phoneNumber, updateData });
@@ -297,9 +303,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for the port-in request
    * @param {Object} params.numberData - The port-in request data including owner info, address, phone numbers, and signature
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the numberData parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to the created port-in request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the created port-in request
    */
   async portInPhoneNumber({ numberData, options = {} }) {
     this.client._require({ numberData });
@@ -316,8 +322,8 @@ 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 {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to the paginated list of port-in requests
+   * @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 };
@@ -331,8 +337,8 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for getting the port request
    * @param {string} params.id - The _id of the port-in request
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to the port-in request object
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the port-in request object
    */
   async getPortRequestById({ id, options = {} }) {
     this.client._require({ id });
@@ -348,8 +354,8 @@ export class Numbers {
    * @param {string} [params.portingId] - If provided, fetches a single port request by ID
    * @param {number} [params.page] - Page number for pagination (used when listing)
    * @param {number} [params.limit] - Items per page (used when listing)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to the port-in request(s)
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the port-in request(s)
    */
   async getPortingRequests({ portingId, page, limit, options = {} } = {}) {
     if (portingId) {
@@ -369,9 +375,9 @@ export class Numbers {
    * @param {Object} params - The parameters for assigning phone numbers to a campaign
    * @param {string} params.campaignId - The ID of the campaign to assign phone numbers to
    * @param {string[]} params.phoneNumbers - The list of phone numbers to assign to the campaign
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the campaignId or phoneNumbers parameter is missing, if none of the phone numbers exist in the account, or if the campaign is not found or in a terminal state
-   * @returns {Promise<Object>} A promise that resolves to `{ Message, queued, skipped }` - `queued` numbers were sent for assignment; `skipped` numbers were rejected (not found, RELEASED, currently being released, already assigned to a campaign, cross-DCA mismatch, or over the 49-number limit).
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to `{ Message, queued, skipped }` - `queued` numbers were sent for assignment; `skipped` numbers were rejected (not found, RELEASED, currently being released, already assigned to a campaign, cross-DCA mismatch, or over the 49-number limit).
    */
   async assignPhoneNumberToCampaign({ campaignId, phoneNumbers, options = {} }) {
     this.client._require({ campaignId, phoneNumbers });
@@ -385,9 +391,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for unassigning phone numbers from campaigns
    * @param {string[]} params.phoneNumbers - The list of phone numbers to unassign from campaigns
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to the result of the unassignment operation
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the result of the unassignment operation
    */
   async unassignPhoneNumbersFromCampaigns({ phoneNumbers, options = {} }) {
     this.client._require({ phoneNumbers });
@@ -400,9 +406,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for deleting phone numbers
    * @param {string[]} params.phoneNumbers - The list of phone numbers to delete
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to the result of the deletion operation
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the result of the deletion operation
    */
   async deletePhoneNumbers({ phoneNumbers, options = {} }) {
     this.client._require({ phoneNumbers });
@@ -415,9 +421,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for deactivating phone numbers
    * @param {string[]} params.phoneNumbers - The list of phone numbers to deactivate
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to an array of updated phone number objects
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to an array of updated phone number objects
    */
   async deactivatePhoneNumbers({ phoneNumbers, options = {} }) {
     this.client._require({ phoneNumbers });
@@ -430,9 +436,9 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for reactivating phone numbers
    * @param {string[]} params.phoneNumbers - The list of phone numbers to reactivate
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the phoneNumbers parameter is missing
-   * @returns {Promise<Object>} A promise that resolves to an array of updated phone number objects
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to an array of updated phone number objects
    */
   async reactivatePhoneNumbers({ phoneNumbers, options = {} }) {
     this.client._require({ phoneNumbers });
@@ -445,8 +451,8 @@ export class Numbers {
    * @param {Object} params - The parameters for transferring phone numbers
    * @param {string[]} params.phoneNumbers - The list of phone numbers to transfer
    * @param {string} params.newSubgroupId - The ID of the new subgroup to transfer the phone numbers to
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to the result of the transfer operation
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to the result of the transfer operation
    */
   async transferPhoneNumbers({ phoneNumbers, newSubgroupId, options = {} }) {
     this.client._require({ phoneNumbers, newSubgroupId });
@@ -465,8 +471,8 @@ export class Numbers {
    * @param {string} [params.city] - Filter by city name (prefix match, case-insensitive; requires country and state)
    * @param {string} [params.npa] - Area code filter (1-3 digits; optional country, no state/city)
    * @param {string} [params.nxx] - Central office code filter (1-3 digits; optional country, no state/city)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to matching NPA/NXX records or unique NPA/NXX arrays
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to matching NPA/NXX records or unique NPA/NXX arrays
    */
   async searchNpaNxx({ country, state, city, npa, nxx, options = {} }) {
     const queryString = this.client._getQueryString({ country, state, city, npa, nxx });
@@ -479,8 +485,8 @@ export class Numbers {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for the lookup
    * @param {Array<{npa: string, nxx: string}>} params.entries - NPA/NXX pairs to look up (max 50)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to an array of {npa, nxx, city, state} objects
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to an array of {npa, nxx, city, state} objects
    */
   async lookupLocations({ entries, options = {} }) {
     return this.client('/number/lookup/location', { method: 'POST', body: { entries }, ...options });
@@ -494,8 +500,8 @@ export class Numbers {
    * @param {string} [params.phoneNumber] - The phone number to migrate
    * @param {string} [params.campaignId] - Campaign ID to migrate all numbers for
    * @param {string} [params.groupId] - Group ID to migrate all numbers for
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Object>} A promise that resolves to a confirmation with count of queued numbers
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<any>>} A promise that resolves to a confirmation with count of queued numbers
    */
   async migratePhoneNumberToV2({ phoneNumber, campaignId, groupId, options = {} }) {
     return this.client(`/number/migrate`, { method: 'POST', body: { phoneNumber, campaignId, groupId }, ...options });

package/src/domains/Onboarding.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Onboarding {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -11,8 +17,8 @@ export class Onboarding {
 				 * @async
 				 * @roles signalhouse
 				 * @param {Object} [params] - Optional parameters
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - Array of onboarding records
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - Array of onboarding records
 				 */
 				getOnboardings: async ({ options = {} } = {}) => {
 					return this.client(`/group/onboarding`, { method: "GET", ...options });
@@ -24,9 +30,9 @@ export class Onboarding {
 				 * @roles signalhouse
 				 * @param {Object} params
 				 * @param {string} params.groupId - The group ID whose onboarding record to retrieve
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the groupId parameter is missing
-				 * @returns {Promise<Object>} - The onboarding record
+				 * @returns {Promise<SdkResponse<any>>} - The onboarding record
 				 */
 				getOnboarding: async ({ groupId, options = {} }) => {
 					this.client._require({ groupId });
@@ -46,8 +52,8 @@ export class Onboarding {
 	 * record rather than an error, so callers never have to special-case them.
 	 * @async
 	 * @param {Object} [params] - Optional parameters
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - `{ acceptedTermsOfService: boolean, emailVerified: boolean, products: string[], estimatedVolume: string|null, pendingExternalLink: "ghl"|"shopify"|null }`
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} - `{ acceptedTermsOfService: boolean, emailVerified: boolean, products: string[], estimatedVolume: string|null, pendingExternalLink: "ghl"|"shopify"|null }`
 	 */
 	async getMyOnboarding({ options = {} } = {}) {
 		return this.client(`/group/onboarding/my`, { method: "GET", ...options });
@@ -57,8 +63,8 @@ export class Onboarding {
 	 * Accept the Terms of Service for the caller's active group.
 	 * @async
 	 * @param {Object} [params] - Optional parameters
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - `{ acceptedTermsOfService: true }`
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} - `{ acceptedTermsOfService: true }`
 	 */
 	async acceptTermsOfService({ options = {} } = {}) {
 		return this.client(`/group/onboarding/my/accept-terms`, {

package/src/domains/Shortlinks.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Shortlinks {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -10,8 +16,8 @@ export class Shortlinks {
 	 * @roles public
 	 * @param {Object} params - The parameters for getting the shortlink redirect
 	 * @param {string} params.shortlinkId - The ID of the shortlink
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the redirect URL for the shortlink
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the redirect URL for the shortlink
 	 */
 	async getShortlinkRedirect({ shortlinkId, options = {} }) {
 		this.client._require({ shortlinkId });
@@ -33,8 +39,8 @@ export class Shortlinks {
 	 * @param {string} [params.groupId] - Filter by associated group ID
 	 * @param {number} [params.page] - The page number for pagination
 	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the shortlink details
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} A promise that resolves to the shortlink details
 	 */
 	async getShortlink({ shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
 		const filters = { shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };

package/src/domains/Subgroups.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 /**
  * @typedef {Object} CreateSubgroupData
  * @property {string} groupId - The ID of the parent group for the subgroup (must be at least 8 characters long and start with 'G')
@@ -51,8 +57,8 @@ export class Subgroups {
 	 * @param {string} [params.groupId] - Filter by parent group ID
 	 * @param {number} [params.page] - The page number for pagination
 	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The list of subgroups returned from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} - The list of subgroups returned from the server
 	 */
 	async getSubgroups({ id, groupId, page, limit, options = {} }) {
 		const filters = { id, groupId, page, limit };
@@ -70,8 +76,8 @@ export class Subgroups {
 	 * @param {string} [params.subgroupId] - Restrict results to a subgroup.
 	 * @param {number} [params.limit] - Maximum rows to return.
 	 * @param {number} [params.offset] - Rows to skip; requires limit.
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
-	 * @returns {Promise<Object>} - Subgroup-level resource count rows.
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @returns {Promise<SdkResponse<any>>} - Subgroup-level resource count rows.
 	 */
 	async getSubgroupCounts({ groupId, subgroupId, limit, offset, options = {} } = {}) {
 		const queryString = this.client._getQueryString({ groupId, subgroupId, limit, offset });
@@ -84,9 +90,9 @@ export class Subgroups {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for creating a subgroup (see CreateSubgroupData typedef for details)
 	 * @param {CreateSubgroupData} params.subgroupData - The data for the subgroup to be created, including required fields such as groupId and subgroupName
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the subgroupData parameter is missing or if required fields in subgroupData are missing
-	 * @returns {Promise<Object>} - The created subgroup object returned from the server
+	 * @returns {Promise<SdkResponse<any>>} - The created subgroup object returned from the server
 	 */
 	async createSubgroup({ subgroupData, options = {} }) {
 		this.client._require({ subgroupData: subgroupData });
@@ -100,9 +106,9 @@ export class Subgroups {
 	 * @param {Object} params - The parameters for updating a subgroup (see UpdateSubgroupData typedef for details)
 	 * @param {string} params.id - The ID of the subgroup to update
 	 * @param {UpdateSubgroupData} params.updateData - The data for the subgroup to be updated, including fields such as subgroupName, contact information, and status
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the id or updateData parameter is missing
-	 * @returns {Promise<Object>} - The updated subgroup object returned from the server
+	 * @returns {Promise<SdkResponse<any>>} - The updated subgroup object returned from the server
 	 */
 	async updateSubgroup({ id, updateData, options = {} }) {
 		this.client._require({ id, updateData });
@@ -116,9 +122,9 @@ export class Subgroups {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for deleting a subgroup
 	 * @param {string} params.id - The ID of the subgroup to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the id parameter is missing
-	 * @returns {Promise<Object>} - The deleted subgroup object returned from the server
+	 * @returns {Promise<SdkResponse<any>>} - The deleted subgroup object returned from the server
 	 */
 	async deleteSubgroup({ id, options = {} }) {
 		this.client._require({ id });

package/src/domains/Subscriptions.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Subscriptions {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -11,8 +17,8 @@ export class Subscriptions {
 				 * @roles signalhouse
 				 * @param {Object} params - The parameters for getting subscription templates
 				 * @param {string} [params.templateId] - The ID of a specific template to retrieve (optional)
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - The subscription templates returned from the server
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - The subscription templates returned from the server
 				 */
 				getTemplates: async ({ templateId, options = {} }) => {
 					const filters = { templateId };
@@ -26,9 +32,9 @@ export class Subscriptions {
 				 * @roles signalhouse
 				 * @param {Object} params - The parameters for creating a subscription template
 				 * @param {Object} params.templateData - The data for the new subscription template, including required fields such as templateName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the templateData parameter is missing or if required fields within templateData are missing
-				 * @returns {Promise<Object>} - The created subscription template object returned from the server
+				 * @returns {Promise<SdkResponse<any>>} - The created subscription template object returned from the server
 				 */
 				createTemplate: async ({ templateData, options = {} }) => {
 					this.client._require({ templateData: templateData });
@@ -42,9 +48,9 @@ export class Subscriptions {
 				 * @param {Object} params - The parameters for updating a subscription template
 				 * @param {string} params.templateId - The ID of the subscription template to update
 				 * @param {Object} params.templateData - The data for the subscription template, including fields such as templateName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the templateId or templateData parameter is missing
-				 * @returns {Promise<Object>} - The updated subscription template object returned from the server
+				 * @returns {Promise<SdkResponse<any>>} - The updated subscription template object returned from the server
 				 */
 				updateTemplate: async ({ templateId, templateData, options = {} }) => {
 					this.client._require({ templateId, templateData });
@@ -58,9 +64,9 @@ export class Subscriptions {
 				 * @roles signalhouse
 				 * @param {Object} params - The parameters for deleting a subscription template
 				 * @param {string} params.templateId - The ID of the subscription template to delete
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the templateId parameter is missing
-				 * @returns {Promise<Object>} - The deleted subscription template object returned from the server
+				 * @returns {Promise<SdkResponse<any>>} - The deleted subscription template object returned from the server
 				 */
 				deleteTemplate: async ({ templateId, options = {} }) => {
 					this.client._require({ templateId });
@@ -75,9 +81,9 @@ export class Subscriptions {
 				 * @param {Object} params - The parameters for creating a custom subscription
 				 * @param {string} params.groupId - The ID of the group to create the custom subscription for
 				 * @param {Object} params.subscriptionData - The data for the custom subscription, including required fields such as subscriptionName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the groupId or subscriptionData parameter is missing or if required fields within subscriptionData are missing
-				 * @returns {Promise<Object>} - The created custom subscription object returned from the server
+				 * @returns {Promise<SdkResponse<any>>} - The created custom subscription object returned from the server
 				 */
 				createCustomSubscription: async ({ groupId, subscriptionData, options = {} }) => {
 					this.client._require({ groupId, subscriptionData });
@@ -95,8 +101,8 @@ export class Subscriptions {
 	 * @param {Object} params - The parameters for getting subscription history
 	 * @param {string} params.groupId - The ID of the group to get subscription history for
 	 * @param {boolean} [params.onlyActive] - Whether to only include active subscriptions
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The subscription history returned from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} - The subscription history returned from the server
 	 */
 	async getSubscriptions({ groupId, onlyActive, options = {} }) {
 		const filters = { groupId, onlyActive };
@@ -111,9 +117,9 @@ export class Subscriptions {
 	 * @param {Object} params - The parameters for subscribing a group to a template
 	 * @param {string} params.groupId - The ID of the group to subscribe
 	 * @param {string} params.templateId - The ID of the template to subscribe the group to
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the groupId or templateId parameter is missing
-	 * @returns {Promise<Object>} - The subscription object returned from the server
+	 * @returns {Promise<SdkResponse<any>>} - The subscription object returned from the server
 	 */
 	async subscribe({ groupId, templateId, options = {} }) {
 		this.client._require({ groupId, templateId });
@@ -128,9 +134,9 @@ export class Subscriptions {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for unsubscribing a group from a template
 	 * @param {string} params.groupId - The ID of the group to unsubscribe
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @param {RequestOptions} [params.options] - Additional options for the request
 	 * @throws {Error} Throws an error if the groupId parameter is missing
-	 * @returns {Promise<Object>} - The subscription object returned from the server
+	 * @returns {Promise<SdkResponse<any>>} - The subscription object returned from the server
 	 */
 	async unsubscribe({ groupId, options = {} }) {
 		this.client._require({ groupId });

package/src/domains/Tickets.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Tickets {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -11,8 +17,8 @@ export class Tickets {
 				 * @async
 				 * @roles signalhouse
 				 * @param {Object} [params] - Optional parameters
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - Jira form metadata
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - Jira form metadata
 				 */
 				getJiraMetadata: async ({ options = {} } = {}) => {
 					return this.client(`/admin/ticket/jira/metadata`, { method: "GET", ...options });
@@ -24,8 +30,8 @@ export class Tickets {
 				 * @roles signalhouse
 				 * @param {Object} [params]
 				 * @param {string} [params.query] - Optional epic summary/key filter
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - `{ epics: Array<{ id, key, summary }> }`
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - `{ epics: Array<{ id, key, summary }> }`
 				 */
 				searchJiraEpics: async ({ query, options = {} } = {}) => {
 					const queryString = this.client._getQueryString({ query });
@@ -38,8 +44,8 @@ export class Tickets {
 				 * @roles signalhouse
 				 * @param {Object} [params]
 				 * @param {string} [params.query] - Optional issue summary/key filter
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - `{ issues: Array<{ id, key, summary }> }`
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - `{ issues: Array<{ id, key, summary }> }`
 				 */
 				searchJiraParentIssues: async ({ query, options = {} } = {}) => {
 					const queryString = this.client._getQueryString({ query });
@@ -52,8 +58,8 @@ export class Tickets {
 				 * @roles signalhouse
 				 * @param {Object} [params]
 				 * @param {string} [params.query] - Partial name or email
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - `{ users: Array<{ accountId, displayName, emailAddress }> }`
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - `{ users: Array<{ accountId, displayName, emailAddress }> }`
 				 */
 				searchJiraAssignees: async ({ query, options = {} } = {}) => {
 					const queryString = this.client._getQueryString({ query });
@@ -66,8 +72,8 @@ export class Tickets {
 				 * @roles signalhouse
 				 * @param {Object} [params]
 				 * @param {string} [params.query] - Partial label text
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - `{ labels: string[] }`
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} - `{ labels: string[] }`
 				 */
 				searchJiraLabels: async ({ query, options = {} } = {}) => {
 					const queryString = this.client._getQueryString({ query });
@@ -80,9 +86,9 @@ export class Tickets {
 				 * @roles signalhouse
 				 * @param {Object} params
 				 * @param {Object} params.data - Create payload (groupId, issueTypeId, priorityId, summary required)
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @param {RequestOptions} [params.options] - Additional options for the request
 				 * @throws {Error} Throws an error if the data parameter is missing
-				 * @returns {Promise<Object>} - Created ticket summary (key, browseUrl, reporter, etc.)
+				 * @returns {Promise<SdkResponse<any>>} - Created ticket summary (key, browseUrl, reporter, etc.)
 				 */
 				createJiraTicket: async ({ data, options = {} }) => {
 					this.client._require({ data });