@signalhousellc/sdk 1.0.67 → 1.0.68

package/src/domains/Auth.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Auth {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -13,9 +19,9 @@ export class Auth {
 				 * @roles signalhouse
 				 * @param {Object} params - The parameters for forcing a group logout
 				 * @param {string} params.groupId - The ID of the group whose users should be force-logged-out
-				 * @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 response containing loggedOutCount
+				 * @returns {Promise<SdkResponse<any>>} - The response containing loggedOutCount
 				 */
 				forceLogoutGroupUsers: async ({ groupId, options = {} }) => {
 					this.client._require({ groupId });
@@ -33,8 +39,8 @@ export class Auth {
 	 * @param {Object} params
 	 * @param {string} params.email - The user's email address
 	 * @param {string} params.password - The user's password
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async login({ email, password, options = {} }) {
 		return this.client(`/auth`, { method: "POST", body: { email, password }, ...options });
@@ -57,8 +63,8 @@ export class Auth {
 	 * @param {boolean} [params.acceptedTermsOfService] - Whether the user accepted the Terms of Service
 	 * @param {string} [params.psXid] - PartnerStack click id (ps_xid) captured from a referral link
 	 * @param {string} [params.psPartnerKey] - PartnerStack partner key (ps_partner_key) captured from a referral link
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server (contains the JWT token)
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server (contains the JWT token)
 	 */
 	async register({ businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey, options = {} }) {
 		return this.client(`/auth/register`, {
@@ -83,8 +89,8 @@ export class Auth {
 	 * @roles public
 	 * @param {Object} params
 	 * @param {string} params.token - The verification token from the email link
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server ({ verified: true, token?: string })
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server ({ verified: true, token?: string })
 	 */
 	async verifyEmail({ token, options = {} }) {
 		this.client._require({ token });
@@ -99,8 +105,8 @@ export class Auth {
 	 * @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 })
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server ({ success: true })
 	 */
 	async forgotPassword({ email, options = {} }) {
 		this.client._require({ email });
@@ -114,8 +120,8 @@ export class Auth {
 	 * @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 })
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server ({ success: true })
 	 */
 	async resetPasswordWithToken({ token, password, options = {} }) {
 		this.client._require({ token, password });
@@ -129,8 +135,8 @@ export class Auth {
 	 * @async
 	 * @roles admin, developer, billing, user
 	 * @param {Object} [params]
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server ({ sent: true })
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server ({ sent: true })
 	 */
 	async sendVerificationEmail({ options = {} } = {}) {
 		return this.client(`/auth/send-verification-email`, { method: "POST", ...options });
@@ -143,8 +149,8 @@ export class Auth {
 	 * @param {Object} params
 	 * @param {string} params.userId - The id of the user
 	 * @param {string} params.newPassword - The new password to set for the user
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async resetPassword({ userId, newPassword, options = {} }) {
         this.client._require({ userId, newPassword });
@@ -161,8 +167,8 @@ export class Auth {
 	 * @param {string} [params.userId] - Returns history for a specific user (one of groupId/userId required)
 	 * @param {number} [params.page] - Page number (min 1, default 1)
 	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 20)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async getAuthHistory({ groupId, userId, page, limit, options = {} }) {
 		this.client._require({ "groupId or userId": groupId ?? userId });
@@ -175,8 +181,8 @@ export class Auth {
 	 * @async
 	 * @roles admin
 	 * @param {Object} [params]
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response containing loggedOutCount
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response containing loggedOutCount
 	 */
 	async logoutAll({ options = {} } = {}) {
 		return this.client(`/auth/logout-all`, { method: "POST", ...options });
@@ -188,8 +194,8 @@ export class Auth {
 	 * @async
 	 * @roles admin, developer, billing, user, api
 	 * @param {Object} [params]
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response containing { groupId }
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response containing { groupId }
 	 */
 	async getGroupId({ options = {} } = {}) {
 		return this.client(`/auth/group-id`, { method: "GET", ...options });
@@ -202,8 +208,8 @@ export class Auth {
 	 * @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 })
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server ({ token })
 	 */
 	async requestExternalLinkToken({ product, options = {} }) {
 		this.client._require({ product });

package/src/domains/Billing.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 export class Billing {
 	constructor(client, enableAdmin) {
 		this.client = client;
@@ -14,8 +20,8 @@ export class Billing {
 				 * @param {number} params.amount - Amount in microdollars
 				 * @param {string} params.transactionType - Type of credit (e.g. "Goodwill Credit", "Billing Correction")
 				 * @param {string} params.description - Reason for the credit (1-500 characters)
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} The created transaction object
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} The created transaction object
 				 */
 				issueCredit: async ({ groupId, amount, transactionType, description, options = {} }) => {
 					this.client._require({ groupId, amount, transactionType, description });
@@ -35,8 +41,8 @@ export class Billing {
 				 * @param {string} params.groupId - The group ID to update fees for
 				 * @param {Object} params.fees - Object of fee field names to microdollar values
 				 * @param {boolean} [params.overrideActiveSubscription=false] - If true, also update the active subscription fees
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} The updated fee schedule
+				 * @param {RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<SdkResponse<any>>} The updated fee schedule
 				 */
 				updateFees: async ({ groupId, fees, overrideActiveSubscription, options = {} }) => {
 					this.client._require({ groupId, fees });
@@ -64,8 +70,8 @@ export class Billing {
 	 * @param {string} [params.transactionType] - The type of transaction to filter by
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<Array>>} The response from the server
 	 */
 	async getTransactionHistory({ groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate, options = {} }) {
 		const filters = { groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate };
@@ -84,8 +90,8 @@ export class Billing {
 	 * @param {number} [params.page=1] - Page number (positive integer)
 	 * @param {number} [params.limit=10] - Results per page (positive integer, max 10000)
 	 * @param {string} [params.timezone] - IANA timezone (default: "UTC")
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<{data: Array<Object>, pagination: {page: number, limit: number, totalRecords: number, totalPages: number, totalAmount: number}}>}
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<{data: Array<Object>, pagination: {page: number, limit: number, totalRecords: number, totalPages: number, totalAmount: number}}>>}
 	 */
 	async getPaymentHistory({ groupId, startDate, endDate, page, limit, timezone, options = {} }) {
 		const filters = { groupId, startDate, endDate, page, limit, timezone };
@@ -99,9 +105,9 @@ export class Billing {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for getting the wallet information
 	 * @param {string} params.groupId - The ID of the group to get the wallet information for
-	 * @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 response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async getWallet({ groupId, options = {} }) {
 		this.client._require({ groupId });
@@ -120,9 +126,9 @@ export class Billing {
 	 * @param {number} [params.autoRechargeToAmount] - The amount to recharge to when auto-recharge is triggered
 	 * @param {string} [params.primaryPaymentMethodId] - The ID of the primary payment method to use for auto-recharge
 	 * @param {string} [params.secondaryPaymentMethodId] - The ID of the secondary payment method to use for auto-recharge if the primary method fails
-	 * @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 response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async updateWallet({ groupId, autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId, options = {} }) {
 		this.client._require({ groupId });
@@ -140,9 +146,9 @@ export class Billing {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for getting the payment methods
 	 * @param {string} params.groupId - The ID of the group to get the payment methods for
-	 * @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<Array>} The response from the server
+	 * @returns {Promise<SdkResponse<Array>>} The response from the server
 	 */
 	async getPaymentMethods({ groupId, options = {} }) {
 		this.client._require({ groupId });
@@ -158,9 +164,9 @@ export class Billing {
 	 * @param {string} params.groupId - The ID of the group to add funds to
 	 * @param {number} params.amount - The amount to add to the group's wallet in microdollars (e.g., $10 would be 10000000)
 	 * @param {string} [params.paymentMethodId] - The ID of the payment method to use for adding funds
-	 * @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 amount parameters are missing
-	 * @returns {Promise<Object>} The response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async addFunds({ groupId, amount, paymentMethodId = undefined, options = {} }) {
 		this.client._require({ groupId, amount });
@@ -175,9 +181,9 @@ export class Billing {
 	 * @param {Object} params - The parameters for adding a payment method
 	 * @param {string} params.groupId - The ID of the group to add the payment method to
 	 * @param {string} params.paymentMethodId - The ID of the payment method to add
-	 * @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 paymentMethodId parameters are missing
-	 * @returns {Promise<Object>} The response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async addPaymentMethod({ groupId, paymentMethodId, options = {} }) {
 		this.client._require({ groupId, paymentMethodId });
@@ -192,9 +198,9 @@ export class Billing {
 	 * @param {Object} params - The parameters for removing a payment method
 	 * @param {string} params.groupId - The ID of the group to remove the payment method from
 	 * @param {string} params.paymentMethodId - The ID of the payment method to remove
-	 * @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 paymentMethodId parameters are missing
-	 * @returns {Promise<Object>} The response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async removePaymentMethod({ groupId, paymentMethodId, options = {} }) {
 		this.client._require({ groupId, paymentMethodId });
@@ -212,8 +218,8 @@ export class Billing {
 	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
 	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
 	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async getInvoiceDetails({ groupId, subgroupId, startDate, endDate, options = {} }) {
 		const filters = { groupId, subgroupId, startDate, endDate };
@@ -231,8 +237,8 @@ export class Billing {
 	 * @param {string} params.startDate - Start date in YYYY-MM-DD format (inclusive)
 	 * @param {string} params.endDate - End date in YYYY-MM-DD format (inclusive)
 	 * @param {string} [params.timezone] - IANA timezone (default: "UTC")
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array<{entryType: string, transactionType: string, unitPrice: number, quantity: number, amount: number}>>}
+	 * @param {RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<SdkResponse<Array<{entryType: string, transactionType: string, unitPrice: number, quantity: number, amount: number}>>>}
 	 */
 	async getInvoiceLedger({ groupId, subgroupId, startDate, endDate, timezone, options = {} }) {
 		const filters = { groupId, subgroupId, startDate, endDate, timezone };
@@ -246,9 +252,9 @@ export class Billing {
 	 * @roles api, admin, developer, billing, user
 	 * @param {Object} params - The parameters for getting the fees
 	 * @param {string} params.groupId - The ID of the group to get fees for
-	 * @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 response from the server
+	 * @returns {Promise<SdkResponse<any>>} The response from the server
 	 */
 	async getFees({ groupId, options = {} }) {
 		this.client._require({ groupId });

package/src/domains/Brands.js

@@ -1,3 +1,9 @@
+/** @typedef {import('../SignalHouseSDK.js').RequestOptions} RequestOptions */
+/**
+ * @template T
+ * @typedef {import('../SignalHouseSDK.js').SdkResponse<T>} SdkResponse
+ */
+
 /**
  * @typedef {string} BrandLookupId - Carrier Brand ID (B…, TFNB…, or SCB…), Mongo `_id`, or internal reference UUID.
  * Use on update, delete, revet, vetting, appeal, and transfer routes. Pending brands return `brandId: null`
@@ -134,8 +140,8 @@ export class Brands {
    * @param {number} [params.limit] - The number of items per page
    * @param {string} [params.status] - The status of the brand to filter by (PENDING_CREATION, PENDING_APPROVAL, UNVERIFIED, VERIFIED, VETTED_VERIFIED, PENDING_DELETE, DELETED)
    * @param {string} [params.registrationType] - Filter by registration type ("TEN_DLC", "TOLL_FREE", or "SHORT_CODE")
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, [key: string]: any }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned.
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, [key: string]: any }>>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned.
    */
   async getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, options = {} }) {
     const filters = { id, subgroupId, groupId, page, limit, status, registrationType };
@@ -149,9 +155,9 @@ export class Brands {
    * @roles api, admin, developer, user
    * @param {Object} params - The parameters for getting the external vetting information
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async getExternalVetting({ brandId, options = {} }) {
     this.client._require({ brandId });
@@ -165,9 +171,9 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for creating the brand (see CreateBrandData typedef for details)
    * @param {CreateBrandData} params.brandData - The data for the brand to be created
-   * @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 brandData parameter is missing or if required fields in brandData are missing
-   * @returns {Promise<Object>} Brand entity. `brandId` is `null` until the carrier assigns a Brand ID — use `_id` to poll status.
+   * @returns {Promise<SdkResponse<any>>} Brand entity. `brandId` is `null` until the carrier assigns a Brand ID — use `_id` to poll status.
    */
   async createBrand({ brandData, options = {} }) {
     this.client._require({ brandData: brandData });
@@ -180,9 +186,9 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for creating the toll-free brand
    * @param {CreateTollFreeBrandData} params.brandData - The data for the toll-free brand to be created (see CreateTollFreeBrandData typedef for details; TFN-specific fields live under brandData.tollFree, and registrationType is forced server-side by the route)
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandData parameter is missing
-   * @returns {Promise<Object>} Brand entity. For Toll-Free, `brandId` is a TFNB-prefixed id when assigned; otherwise `null` — use `_id` to poll.
+   * @returns {Promise<SdkResponse<any>>} Brand entity. For Toll-Free, `brandId` is a TFNB-prefixed id when assigned; otherwise `null` — use `_id` to poll.
    */
   async createTollFreeBrand({ brandData, options = {} }) {
     this.client._require({ brandData });
@@ -195,8 +201,8 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The creation parameters.
    * @param {CreateShortCodeBrandData} params.brandData - The Short Code brand data. The route forces registrationType server-side.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
-   * @returns {Promise<Object>} A 201-created Short Code brand with a stable SCB-prefixed ID and PENDING_APPROVAL status.
+   * @param {RequestOptions} [params.options] - Additional options for the request.
+   * @returns {Promise<SdkResponse<any>>} A 201-created Short Code brand with a stable SCB-prefixed ID and PENDING_APPROVAL status.
    */
   async createShortCodeBrand({ brandData, options = {} }) {
     this.client._require({ brandData });
@@ -209,8 +215,8 @@ export class Brands {
    * @roles signalhouse_admin
    * @param {Object} params - The approval parameters.
    * @param {BrandLookupId} params.brandId - The pending Short Code brand lookup ID.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
-   * @returns {Promise<Object>} The verified Short Code brand.
+   * @param {RequestOptions} [params.options] - Additional options for the request.
+   * @returns {Promise<SdkResponse<any>>} The verified Short Code brand.
    */
   async approveShortCodeBrand({ brandId, options = {} }) {
     this.client._require({ brandId });
@@ -224,8 +230,8 @@ export class Brands {
    * @param {Object} params - The rejection parameters.
    * @param {BrandLookupId} params.brandId - The pending Short Code brand lookup ID.
    * @param {string} params.internalRejectionReason - Required customer-visible rejection reason.
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request.
-   * @returns {Promise<Object>} The rejected Short Code brand.
+   * @param {RequestOptions} [params.options] - Additional options for the request.
+   * @returns {Promise<SdkResponse<any>>} The rejected Short Code brand.
    */
   async rejectShortCodeBrand({ brandId, internalRejectionReason, options = {} }) {
     this.client._require({ brandId, internalRejectionReason });
@@ -243,9 +249,9 @@ export class Brands {
    * @param {Object} params - The parameters for transferring the brands
    * @param {string} params.subgroupId - The ID of the subgroup to transfer the brands to
    * @param {BrandLookupId[]} params.brandIds - Brand lookup ids to transfer (carrier id, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the subgroupId or brandIds parameters are missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async transferBrand({ subgroupId, brandIds, options = {} }) {
     this.client._require({ subgroupId, brandIds });
@@ -259,14 +265,19 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for creating external vetting
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-   * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Object>} The response from the server
+   * @param {string} params.vettingProviderId - The external vetting provider: AEGIS or WMC
+   * @param {string} params.vettingClass - The vetting class: STANDARD, ENHANCED, AUTHPLUS, or RCS (AEGIS accepts all four; WMC accepts STANDARD only)
+   * @param {Object} [params.additionalData] - Provider-specific additional data forwarded to TCR
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the brandId, vettingProviderId, or vettingClass parameter is missing
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
-  async createExternalVetting({ brandId, options = {} }) {
-    this.client._require({ brandId });
+  async createExternalVetting({ brandId, vettingProviderId, vettingClass, additionalData, options = {} }) {
+    this.client._require({ brandId, vettingProviderId, vettingClass });
     const safeBrandId = encodeURIComponent(brandId);
-    return this.client(`/brand/externalvetting/${safeBrandId}`, { method: 'POST', ...options });
+    const body = { vettingProviderId, vettingClass };
+    if (additionalData !== undefined) body.additionalData = additionalData;
+    return this.client(`/brand/externalvetting/${safeBrandId}`, { method: 'POST', body, ...options });
   }
 
   /**
@@ -282,9 +293,9 @@ export class Brands {
    * @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
+   * @param {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
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async importExternalVetting({ brandId, vettingProviderId, vettingId, vettingToken, options = {} }) {
     this.client._require({ brandId, vettingProviderId, vettingId });
@@ -303,9 +314,9 @@ export class Brands {
    * @param {Object} params - The parameters for updating the brand (see UpdateBrandData typedef for details)
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
    * @param {UpdateBrandData} params.brandData - The data for the brand to be updated
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async updateBrand({ brandId, brandData, options = {} }) {
     this.client._require({ brandId });
@@ -319,9 +330,9 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for reverting the brand
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async revetBrand({ brandId, options = {} }) {
     this.client._require({ brandId });
@@ -335,9 +346,9 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for deleting the brand
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async deleteBrand({ brandId, options = {} }) {
     this.client._require({ brandId });
@@ -351,9 +362,9 @@ export class Brands {
    * @roles api, admin, developer, billing, user
    * @param {Object} params - The parameters for getting the appeal history
    * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the brandId parameter is missing
-   * @returns {Promise<Array>} Array of BrandAppeal objects
+   * @returns {Promise<SdkResponse<Array>>} Array of BrandAppeal objects
    */
   async getAppealHistory({ brandId, options = {} }) {
     this.client._require({ brandId });
@@ -370,9 +381,9 @@ export class Brands {
    * @param {Array<string>} params.appealCategories - Array of appeal categories (VERIFY_TAX_ID, VERIFY_NON_PROFIT, VERIFY_GOVERNMENT)
    * @param {string} params.explanation - Required explanation justifying the appeal
    * @param {File|Blob} params.file - The supporting document file
-   * @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 required parameters are missing
-   * @returns {Promise<Object>} The response from the server
+   * @returns {Promise<SdkResponse<any>>} The response from the server
    */
   async submitAppeal({ brandId, appealCategories, explanation, file, options = {} }) {
     this.client._require({ brandId, appealCategories, explanation, file });