@signalhousellc/sdk 1.0.31 → 1.0.32

package/src/domains/Brands.js

@@ -1,236 +1,236 @@
-/**
- * @typedef {Object} CreateBrandData
- * @property {string} subgroupId - The ID of the subgroup to create the brand under
- * @property {string} entityType - The type of entity for the brand (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT)
- * @property {string} displayName - The display name for the brand
- * @property {string} companyName - The company name for the brand
- * @property {string} ein - The EIN (Employer Identification Number) for the brand
- * @property {string} [einIssuingCountry] - The country that issued the EIN for the brand
- * @property {string} [altBusinessId] - An alternative business identifier for the brand (e.g., DUNS number)
- * @property {string} [altBusinessIdType] - The type of the alternative business identifier ("NONE", "DUNS", "LEI", "GIIN")
- * @property {string} [firstName] - The first name of the primary contact for the brand
- * @property {string} [lastName] - The last name of the primary contact for the brand
- * @property {string} phone - The phone number of the primary contact for the brand
- * @property {string} street - The street address of the primary contact for the brand
- * @property {string} city - The city of the primary contact for the brand
- * @property {string} state - The state of the primary contact for the brand
- * @property {string} postalCode - The postal code of the primary contact for the brand
- * @property {string} country - The country code of the primary contact for the brand (e.g., "US")
- * @property {string} email - The email address of the primary contact for the brand
- * @property {string} [mobilePhone] - The mobile phone number of the primary contact for the brand
- * @property {string} [stockSymbol] - The stock symbol for the brand if it is a publicly traded company
- * @property {string} [stockExchange] - The stock exchange where the brand is listed if it is a publicly traded company
- * @property {string} [website] - The website URL for the brand
- * @property {string} vertical - The vertical for the brand (PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY, ENTERTAINMENT, RETAIL, TRANSPORTATION, AGRICULTURE, INSURANCE, POSTAL, EDUCATION, HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION)
- * @property {string} [referenceId] - A unique reference for the brand
- * @property {Array<string>} [tag] - An array of tags to associate with the brand
- * @property {boolean} [mock] - Whether to create the brand in the mock environment (for testing purposes only)
- * @property {string} [businessContactEmail] - The email address of the business contact for the brand (required if entityType is PUBLIC_PROFIT or NON_PROFIT)
- */
-
-/**
- * @typedef {Object} UpdateBrandData
- * @property {string} [companyName] - The company name for the brand
- * @property {string} [ein] - The EIN (Employer Identification Number) for the brand
- * @property {string} [einIssuingCountry] - The country that issued the EIN for the brand
- * @property {string} [entityType] - The type of entity for the brand (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT)
- * @property {string} [firstName] - The first name of the primary contact for the brand
- * @property {string} [lastName] - The last name of the primary contact for the brand
- * @property {string} [displayName] - The display name for the brand
- * @property {string} [website] - The website URL for the brand
- * @property {string} [street] - The street address of the primary contact for the brand
- * @property {string} [city] - The city of the primary contact for the brand
- * @property {string} [state] - The state of the primary contact for the brand
- * @property {string} [postalCode] - The postal code of the primary contact for the brand
- * @property {string} [country] - The country code of the primary contact for the brand (e.g., "US")
- * @property {string} [email] - The email address of the primary contact for the brand
- * @property {string} [referenceId] - A unique reference for the brand
- * @property {string} [phone] - The phone number of the primary contact for the brand
- * @property {string} [vertical] - The vertical for the brand (PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY, ENTERTAINMENT, RETAIL, TRANSPORTATION, AGRICULTURE, INSURANCE, POSTAL, EDUCATION, HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION)
- * @property {string} [stockSymbol] - The stock symbol for the brand if it is a publicly traded company
- * @property {string} [stockExchange] - The stock exchange where the brand is listed if it is a publicly traded company
- * @property {string} [altBusinessId] - An alternative business identifier for the brand (e.g., DUNS number)
- * @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)
- */
-
-export class Brands {
-	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] - The ID of the brand to filter by
-	 * @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 {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
-	 */
-	async getBrands({ id, subgroupId, groupId, page, limit, status, options = {} }) {
-		const filters = { id, subgroupId, groupId, page, limit, status };
-		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 {string} params.brandId - The ID of the brand to get the external vetting information for
-	 * @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>} The response from the server
-	 */
-	async createBrand({ brandData, options = {} }) {
-		this.client._require({ brandData: brandData });
-		return this.client(`/brand`, { method: "POST", body: brandData, ...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 {Array<string>} params.brandIds - The IDs of the brands to be transferred
-	 * @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 {string} params.brandId - The ID of the brand to create external vetting for
-	 * @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 });
-	}
-
-	/**
-	 * 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 {string} params.brandId - The ID of the brand to update
-	 * @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 {string} params.brandId - The ID of the brand to revert
-	 * @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 {string} params.brandId - The ID of the brand to delete
-	 * @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 {string} params.brandId - The ID of the brand to get appeal history for
-	 * @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 {string} params.brandId - The ID of the brand to appeal
-	 * @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 });
-	}
-}
+/**
+ * @typedef {Object} CreateBrandData
+ * @property {string} subgroupId - The ID of the subgroup to create the brand under
+ * @property {string} entityType - The type of entity for the brand (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT)
+ * @property {string} displayName - The display name for the brand
+ * @property {string} companyName - The company name for the brand
+ * @property {string} ein - The EIN (Employer Identification Number) for the brand
+ * @property {string} [einIssuingCountry] - The country that issued the EIN for the brand
+ * @property {string} [altBusinessId] - An alternative business identifier for the brand (e.g., DUNS number)
+ * @property {string} [altBusinessIdType] - The type of the alternative business identifier ("NONE", "DUNS", "LEI", "GIIN")
+ * @property {string} [firstName] - The first name of the primary contact for the brand
+ * @property {string} [lastName] - The last name of the primary contact for the brand
+ * @property {string} phone - The phone number of the primary contact for the brand
+ * @property {string} street - The street address of the primary contact for the brand
+ * @property {string} city - The city of the primary contact for the brand
+ * @property {string} state - The state of the primary contact for the brand
+ * @property {string} postalCode - The postal code of the primary contact for the brand
+ * @property {string} country - The country code of the primary contact for the brand (e.g., "US")
+ * @property {string} email - The email address of the primary contact for the brand
+ * @property {string} [mobilePhone] - The mobile phone number of the primary contact for the brand
+ * @property {string} [stockSymbol] - The stock symbol for the brand if it is a publicly traded company
+ * @property {string} [stockExchange] - The stock exchange where the brand is listed if it is a publicly traded company
+ * @property {string} [website] - The website URL for the brand
+ * @property {string} vertical - The vertical for the brand (PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY, ENTERTAINMENT, RETAIL, TRANSPORTATION, AGRICULTURE, INSURANCE, POSTAL, EDUCATION, HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION)
+ * @property {string} [referenceId] - A unique reference for the brand
+ * @property {Array<string>} [tag] - An array of tags to associate with the brand
+ * @property {boolean} [mock] - Whether to create the brand in the mock environment (for testing purposes only)
+ * @property {string} [businessContactEmail] - The email address of the business contact for the brand (required if entityType is PUBLIC_PROFIT or NON_PROFIT)
+ */
+
+/**
+ * @typedef {Object} UpdateBrandData
+ * @property {string} [companyName] - The company name for the brand
+ * @property {string} [ein] - The EIN (Employer Identification Number) for the brand
+ * @property {string} [einIssuingCountry] - The country that issued the EIN for the brand
+ * @property {string} [entityType] - The type of entity for the brand (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT)
+ * @property {string} [firstName] - The first name of the primary contact for the brand
+ * @property {string} [lastName] - The last name of the primary contact for the brand
+ * @property {string} [displayName] - The display name for the brand
+ * @property {string} [website] - The website URL for the brand
+ * @property {string} [street] - The street address of the primary contact for the brand
+ * @property {string} [city] - The city of the primary contact for the brand
+ * @property {string} [state] - The state of the primary contact for the brand
+ * @property {string} [postalCode] - The postal code of the primary contact for the brand
+ * @property {string} [country] - The country code of the primary contact for the brand (e.g., "US")
+ * @property {string} [email] - The email address of the primary contact for the brand
+ * @property {string} [referenceId] - A unique reference for the brand
+ * @property {string} [phone] - The phone number of the primary contact for the brand
+ * @property {string} [vertical] - The vertical for the brand (PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY, ENTERTAINMENT, RETAIL, TRANSPORTATION, AGRICULTURE, INSURANCE, POSTAL, EDUCATION, HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION)
+ * @property {string} [stockSymbol] - The stock symbol for the brand if it is a publicly traded company
+ * @property {string} [stockExchange] - The stock exchange where the brand is listed if it is a publicly traded company
+ * @property {string} [altBusinessId] - An alternative business identifier for the brand (e.g., DUNS number)
+ * @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)
+ */
+
+export class Brands {
+	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] - The ID of the brand to filter by
+	 * @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 {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getBrands({ id, subgroupId, groupId, page, limit, status, options = {} }) {
+		const filters = { id, subgroupId, groupId, page, limit, status };
+		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 {string} params.brandId - The ID of the brand to get the external vetting information for
+	 * @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>} The response from the server
+	 */
+	async createBrand({ brandData, options = {} }) {
+		this.client._require({ brandData: brandData });
+		return this.client(`/brand`, { method: "POST", body: brandData, ...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 {Array<string>} params.brandIds - The IDs of the brands to be transferred
+	 * @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 {string} params.brandId - The ID of the brand to create external vetting for
+	 * @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 });
+	}
+
+	/**
+	 * 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 {string} params.brandId - The ID of the brand to update
+	 * @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 {string} params.brandId - The ID of the brand to revert
+	 * @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 {string} params.brandId - The ID of the brand to delete
+	 * @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 {string} params.brandId - The ID of the brand to get appeal history for
+	 * @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 {string} params.brandId - The ID of the brand to appeal
+	 * @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 });
+	}
+}