@signalhousellc/sdk 1.0.56 → 1.0.62

package/package.json

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

package/src/SignalHouseSDK.js

@@ -61,7 +61,7 @@ export class SignalHouseSDK {
 		this.groups = new Groups(client, this.enableAdmin);
 		this.landings = new Landings(client, multipartClient, this.enableAdmin);
 		this.messages = new Messages(client, multipartClient, this.enableAdmin);
-		this.numbers = new Numbers(client, this.enableAdmin);
+		this.numbers = new Numbers(client, multipartClient, this.enableAdmin);
 		this.onboarding = new Onboarding(client, this.enableAdmin);
 		this.shortlinks = new Shortlinks(client, this.enableAdmin);
 		this.subgroups = new Subgroups(client, this.enableAdmin);

package/src/domains/Auth.js

@@ -33,13 +33,15 @@ export class Auth {
 	 * @param {string} [params.volume] - Estimated monthly message volume
 	 * @param {string[]} [params.products] - Products the account intends to integrate
 	 * @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)
 	 */
-	async register({ businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, options = {} }) {
+	async register({ businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey, options = {} }) {
 		return this.client(`/auth/register`, {
 			method: "POST",
-			body: { businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService },
+			body: { businessName, fullName, email, password, phone, dialCode, country, volume, products, acceptedTermsOfService, psXid, psPartnerKey },
 			...options,
 		});
 	}

package/src/domains/Brands.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {string} BrandLookupId - Carrier Brand ID (B… or TFNB…), Mongo `_id`, or internal reference UUID.
+ * @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`
  * in read/create responses — poll `GET /brand?id=<Mongo _id>` until a carrier Brand ID is assigned.
  */
@@ -59,7 +59,7 @@
  * @property {string} [altBusinessIdType] - The type of the alternative business identifier ("NONE", "DUNS", "LEI", "GIIN")
  * @property {string} [brandRelationship] - Not in use - reserved for future use
  * @property {string} [businessContactEmail] - The email address of the business contact for the brand (required if entityType is PUBLIC_PROFIT or NON_PROFIT)
- * @property {Object} [tollFree] - Toll-Free editable fields, used when updating a Toll-Free brand. Optional sub-fields: legalEntityType, businessRegistrationType, taxId, countryCode, supportPhone, taxIdIssuingCountry, businessDBA. (Toll-Free brands sync to Infobip; only DCA_PENDING/DCA_ACTIVE brands are editable and subgroupId is immutable.)
+ * @property {Object} [tollFree] - Toll-Free editable fields, used when updating a Toll-Free brand. Optional sub-fields: legalEntityType, businessRegistrationType, taxId, countryCode, supportPhone, taxIdIssuingCountry, businessDBA, businessWebsite. (Toll-Free brands sync to Infobip; only DCA_PENDING/DCA_ACTIVE brands are editable and subgroupId is immutable.)
  */
 
 /**
@@ -71,6 +71,7 @@
  * @property {string} supportPhone - The customer-support phone number (required, at most 20 characters)
  * @property {string} [taxIdIssuingCountry] - The country that issued the tax ID (optional, 2-letter ISO code)
  * @property {string} [businessDBA] - The business "doing business as" name (optional, at most 255 characters)
+ * @property {string} [businessWebsite] - The customer's real website, sent to Infobip for brand verification (optional, valid URL, at most 255 characters; distinct from the top-level website / landing URL)
  */
 
 /**
@@ -97,221 +98,289 @@
  * @property {string} [country] - The country code of the primary contact for the brand (optional, 2-letter code; when "US", state must be a valid 2-letter US state code)
  */
 
+/**
+ * @typedef {Object} CreateShortCodeBrandData
+ * @property {string} subgroupId - The ID of the subgroup to create the brand under.
+ * @property {string} displayName - The Short Code brand display name.
+ * @property {string} companyName - The official company name.
+ * @property {string} street - The street address.
+ * @property {string} city - The city.
+ * @property {string} state - The state or province.
+ * @property {string} postalCode - The postal code.
+ * @property {string} country - The 2-letter country code.
+ * @property {string} email - The support email address.
+ * @property {string} firstName - The contact's first name.
+ * @property {string} lastName - The contact's last name.
+ * @property {string} website - The company website URL.
+ * @property {{ businessRegistrationType: string, legalEntityType: string, taxId: string, countryCode: string, supportPhone: string }} shortCode - Short Code registration details.
+ */
+
 export class Brands {
-	constructor(client, multipartClient, enableAdmin) {
-		this.client = client;
-		this.multipartClient = multipartClient;
-		this.enableAdmin = enableAdmin;
-	}
+  constructor(client, multipartClient, enableAdmin) {
+    this.client = client;
+    this.multipartClient = multipartClient;
+    this.enableAdmin = enableAdmin;
+  }
+
+  /**
+   * Get a list of brands with optional filters
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for filtering the brands
+   * @param {string} [params.id] - Brand lookup id (carrier Brand ID, Mongo _id, or internal reference)
+   * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+   * @param {string} [params.groupId] - The ID of the group to filter by
+   * @param {number} [params.page] - The page number for pagination
+   * @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.
+   */
+  async getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, options = {} }) {
+    const filters = { id, subgroupId, groupId, page, limit, status, registrationType };
+    const queryString = this.client._getQueryString(filters);
+    return this.client(`/brand${queryString}`, { method: 'GET', ...options });
+  }
+
+  /**
+   * Get external vetting information for a brand
+   * @async
+   * @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
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async getExternalVetting({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/externalvetting/${safeBrandId}`, { method: 'GET', ...options });
+  }
+
+  /**
+   * Create a new brand
+   * @async
+   * @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
+   * @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.
+   */
+  async createBrand({ brandData, options = {} }) {
+    this.client._require({ brandData: brandData });
+    return this.client(`/brand`, { method: 'POST', body: brandData, ...options });
+  }
 
-	/**
-	 * Get a list of brands with optional filters
-	 * @async
-	 * @roles api, admin, developer, user
-	 * @param {Object} params - The parameters for filtering the brands
-	 * @param {string} [params.id] - Brand lookup id (carrier Brand ID, Mongo _id, or internal reference)
-	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
-	 * @param {string} [params.groupId] - The ID of the group to filter by
-	 * @param {number} [params.page] - The page number for pagination
-	 * @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" or "TOLL_FREE")
-	 * @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.
-	 */
-	async getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, options = {} }) {
-		const filters = { id, subgroupId, groupId, page, limit, status, registrationType };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/brand${queryString}`, { method: "GET", ...options });
-	}
+  /**
+   * Create a new Toll-Free (TFN) brand
+   * @async
+   * @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
+   * @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.
+   */
+  async createTollFreeBrand({ brandData, options = {} }) {
+    this.client._require({ brandData });
+    return this.client(`/brand/toll-free`, { method: 'POST', body: brandData, ...options });
+  }
 
-	/**
-	 * Get external vetting information for a brand
-	 * @async
-	 * @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
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async getExternalVetting({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/externalvetting/${safeBrandId}`, { method: "GET", ...options });
-	}
+  /**
+   * Create a local Short Code brand for manual Signal House review.
+   * @async
+   * @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.
+   */
+  async createShortCodeBrand({ brandData, options = {} }) {
+    this.client._require({ brandData });
+    return this.client(`/brand/short-code`, { method: 'POST', body: brandData, ...options });
+  }
 
-	/**
-	 * Create a new brand
-	 * @async
-	 * @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
-	 * @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.
-	 */
-	async createBrand({ brandData, options = {} }) {
-		this.client._require({ brandData: brandData });
-		return this.client(`/brand`, { method: "POST", body: brandData, ...options });
-	}
+  /**
+   * Approve a pending Short Code brand.
+   * @async
+   * @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.
+   */
+  async approveShortCodeBrand({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    return this.client(`/brand/approve/${encodeURIComponent(brandId)}`, { method: 'POST', ...options });
+  }
 
-	/**
-	 * Create a new Toll-Free (TFN) brand
-	 * @async
-	 * @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
-	 * @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.
-	 */
-	async createTollFreeBrand({ brandData, options = {} }) {
-		this.client._require({ brandData });
-		return this.client(`/brand/toll-free`, { method: "POST", body: brandData, ...options });
-	}
+  /**
+   * Reject a pending Short Code brand with a customer-visible reason.
+   * @async
+   * @roles signalhouse_admin
+   * @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.
+   */
+  async rejectShortCodeBrand({ brandId, internalRejectionReason, options = {} }) {
+    this.client._require({ brandId, internalRejectionReason });
+    return this.client(`/brand/reject/${encodeURIComponent(brandId)}`, {
+      method: 'POST',
+      body: { internalRejectionReason },
+      ...options,
+    });
+  }
 
-	/**
-	 * Transfer one or more brands to a different subgroup
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @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
-	 * @throws {Error} Throws an error if the subgroupId or brandIds parameters are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async transferBrand({ subgroupId, brandIds, options = {} }) {
-		this.client._require({ subgroupId, brandIds });
-		const safeSubgroupId = encodeURIComponent(subgroupId);
-		return this.client(`/brand/transfer/${safeSubgroupId}`, { method: "POST", body: { brandIds }, ...options });
-	}
+  /**
+   * Transfer one or more brands to a different subgroup
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @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
+   * @throws {Error} Throws an error if the subgroupId or brandIds parameters are missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async transferBrand({ subgroupId, brandIds, options = {} }) {
+    this.client._require({ subgroupId, brandIds });
+    const safeSubgroupId = encodeURIComponent(subgroupId);
+    return this.client(`/brand/transfer/${safeSubgroupId}`, { method: 'POST', body: { brandIds }, ...options });
+  }
 
-	/**
-	 * Create external vetting for a brand
-	 * @async
-	 * @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
-	 */
-	async createExternalVetting({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/externalvetting/${safeBrandId}`, { method: "POST", ...options });
-	}
+  /**
+   * Create external vetting for a brand
+   * @async
+   * @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
+   */
+  async createExternalVetting({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/externalvetting/${safeBrandId}`, { method: 'POST', ...options });
+  }
 
-	/**
-	 * Import an existing external vetting record for a brand
-	 *
-	 * Unlike createExternalVetting (which orders a new, billable vetting), this attaches a vetting the
-	 * brand already completed directly with the provider, using the provider-issued vettingId and
-	 * vettingToken. It is synchronous and not billable.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for importing external vetting
-	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-	 * @param {string} params.vettingProviderId - The external vetting provider (AEGIS, WMC, CV)
-	 * @param {string} params.vettingId - The provider-issued vetting / transaction ID to import
-	 * @param {string} [params.vettingToken] - The provider-issued vetting token (required by some providers, e.g. AEGIS)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if brandId, vettingProviderId, or vettingId is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async importExternalVetting({ brandId, vettingProviderId, vettingId, vettingToken, options = {} }) {
-		this.client._require({ brandId, vettingProviderId, vettingId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/externalvetting/import/${safeBrandId}`, { method: "POST", body: { vettingProviderId, vettingId, vettingToken }, ...options });
-	}
+  /**
+   * Import an existing external vetting record for a brand
+   *
+   * Unlike createExternalVetting (which orders a new, billable vetting), this attaches a vetting the
+   * brand already completed directly with the provider, using the provider-issued vettingId and
+   * vettingToken. It is synchronous and not billable.
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for importing external vetting
+   * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
+   * @param {string} params.vettingProviderId - The external vetting provider (AEGIS, WMC, CV)
+   * @param {string} params.vettingId - The provider-issued vetting / transaction ID to import
+   * @param {string} [params.vettingToken] - The provider-issued vetting token (required by some providers, e.g. AEGIS)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if brandId, vettingProviderId, or vettingId is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async importExternalVetting({ brandId, vettingProviderId, vettingId, vettingToken, options = {} }) {
+    this.client._require({ brandId, vettingProviderId, vettingId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/externalvetting/import/${safeBrandId}`, {
+      method: 'POST',
+      body: { vettingProviderId, vettingId, vettingToken },
+      ...options,
+    });
+  }
 
-	/**
-	 * Update a brand's information
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @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
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async updateBrand({ brandId, brandData, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/${safeBrandId}`, { method: "PUT", body: brandData, ...options });
-	}
+  /**
+   * Update a brand's information
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @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
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async updateBrand({ brandId, brandData, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/${safeBrandId}`, { method: 'PUT', body: brandData, ...options });
+  }
 
-	/**
-	 * Revet a brand that is in UNVERIFIED status due to an update afer it was previously VERIFIED or VETTED_VERIFIED
-	 * @async
-	 * @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
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async revetBrand({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/revet/${safeBrandId}`, { method: "PUT", ...options });
-	}
+  /**
+   * Revet a brand that is in UNVERIFIED status due to an update afer it was previously VERIFIED or VETTED_VERIFIED
+   * @async
+   * @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
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async revetBrand({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/revet/${safeBrandId}`, { method: 'PUT', ...options });
+  }
 
-	/**
-	 * Delete a brand (mark it as DELETED). The brand will still be retrievable
-	 * @async
-	 * @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
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async deleteBrand({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/${safeBrandId}`, { method: "DELETE", ...options });
-	}
+  /**
+   * Delete a brand (mark it as DELETED). The brand will still be retrievable
+   * @async
+   * @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
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async deleteBrand({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/${safeBrandId}`, { method: 'DELETE', ...options });
+  }
 
-	/**
-	 * Get appeal history for a brand
-	 * @async
-	 * @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
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Array>} Array of BrandAppeal objects
-	 */
-	async getAppealHistory({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/brand/appeal/${safeBrandId}`, { method: "GET", ...options });
-	}
+  /**
+   * Get appeal history for a brand
+   * @async
+   * @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
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Array>} Array of BrandAppeal objects
+   */
+  async getAppealHistory({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    const safeBrandId = encodeURIComponent(brandId);
+    return this.client(`/brand/appeal/${safeBrandId}`, { method: 'GET', ...options });
+  }
 
-	/**
-	 * Submit a brand identity status appeal with supporting documentation
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for submitting the appeal
-	 * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
-	 * @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
-	 * @throws {Error} Throws an error if required parameters are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async submitAppeal({ brandId, appealCategories, explanation, file, options = {} }) {
-		this.client._require({ brandId, appealCategories, explanation, file });
-		const safeBrandId = encodeURIComponent(brandId);
-		const formData = new FormData();
-		formData.append("appealCategories", JSON.stringify(appealCategories));
-		formData.append("explanation", explanation);
-		formData.append("file", file);
-		return this.multipartClient(`/brand/appeal/${safeBrandId}`, { method: "POST", body: formData, ...options });
-	}
+  /**
+   * Submit a brand identity status appeal with supporting documentation
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for submitting the appeal
+   * @param {BrandLookupId} params.brandId - Brand lookup id (carrier Brand ID, Mongo `_id`, or internal reference).
+   * @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
+   * @throws {Error} Throws an error if required parameters are missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async submitAppeal({ brandId, appealCategories, explanation, file, options = {} }) {
+    this.client._require({ brandId, appealCategories, explanation, file });
+    const safeBrandId = encodeURIComponent(brandId);
+    const formData = new FormData();
+    formData.append('appealCategories', JSON.stringify(appealCategories));
+    formData.append('explanation', explanation);
+    formData.append('file', file);
+    return this.multipartClient(`/brand/appeal/${safeBrandId}`, { method: 'POST', body: formData, ...options });
+  }
 }