@signalhousellc/sdk 1.0.0

package/README.md

@@ -0,0 +1,38 @@
+# @signalhouse/sdk
+
+A lightweight Node.js SDK for the Signal House platform.
+
+## Installation
+
+```bash
+npm install @signalhouse/sdk
+```
+
+Quick Start
+
+```bash
+import { SignalHouseSDK } from '@signalhouse/sdk';
+
+const sdk = new SignalHouseSDK({
+  apiKey: 'your-api-key',
+  baseUrl: 'api url'
+});
+
+const token = await sdk.auth.login({
+    email: 'youremail',
+    password: 'yourpassword'
+});
+
+console.log(token);
+```
+
+Features
+Full support for Signal House API v2
+Integrated Axios with standardized returns
+Lightweight and tree-shakeable
+
+Documentation
+For full API reference and advanced usage, visit https://api.signalhouse.io
+
+License
+ISC © Signal House

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@signalhousellc/sdk",
+  "version": "1.0.0",
+  "description": "Signal House SDK for use with the Signal House platform",
+  "type": "module",
+  "main": "src/SignalHouseSDK.js",
+  "exports": {
+    ".": "./src/SignalHouseSDK.js"
+  },
+  "files": [
+    "src/",
+    "README.md"
+  ],
+  "author": "Signal House LLC",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.13.5"
+  }
+}

package/src/SignalHouseSDK.js

@@ -0,0 +1,144 @@
+import axios from "axios";
+
+/**
+ * @typedef {Object} RequestOptions
+ * @property {string} [token] - An optional bearer token to include in the request for authentication
+ * @property {object} [headers] - Additional headers to include in the request
+ */
+
+// Main SDK Class (SignalHouseSDK.js)
+import { Auth } from "./domains/Auth.js";
+import { Billing } from "./domains/Billing.js";
+import { Brands } from "./domains/Brands.js";
+import { Campaigns } from "./domains/Campaigns.js";
+import { Groups } from "./domains/Groups.js";
+import { Landings } from "./domains/Landings.js";
+import { Messages } from "./domains/Messages.js";
+import { Numbers } from "./domains/Numbers.js";
+import { Shortlinks } from "./domains/Shortlinks.js";
+import { Subgroups } from "./domains/Subgroups.js";
+import { Subscriptions } from "./domains/Subscriptions.js";
+import { Users } from "./domains/Users.js";
+import { Webhooks } from "./domains/Webhooks.js";
+
+export class SignalHouseSDK {
+	/**
+	 * Initialize the SignalHouseSDK with the required configuration
+	 * @param {Object} config - The configuration object for initializing the SDK
+	 * @param {string} config.apiKey - The API key for authenticating requests to the SignalHouse API
+	 * @param {string} config.baseUrl - The base URL for the SignalHouse API (e.g., "https://api.signalhouse.com")
+	 * @throws {Error} Throws an error if the API key or base URL is missing from the configuration
+	 * @returns {SignalHouseSDK} An instance of the SignalHouseSDK
+	 */
+	constructor(config = {}) {
+		// Validate required config parameters
+		if (!config.apiKey) {
+			throw new Error("API key is required to initialize SignalHouseSDK");
+		}
+		if (!config.baseUrl) {
+			throw new Error("Base URL is required to initialize SignalHouseSDK");
+		}
+
+		// Set instance properties
+		this.baseUrl = config.baseUrl;
+		this.apiKey = config.apiKey;
+		this.enableAdmin = config.enableAdmin || false;
+
+		// Shared internal request helper
+		const client = this._createClient(false);
+		const multipartClient = this._createClient(true);
+
+		// API Domains
+		this.auth = new Auth(client, this.enableAdmin);
+		this.billing = new Billing(client, this.enableAdmin);
+		this.brands = new Brands(client, this.enableAdmin);
+		this.campaigns = new Campaigns(client, this.enableAdmin);
+		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.shortlinks = new Shortlinks(client, this.enableAdmin);
+		this.subgroups = new Subgroups(client, this.enableAdmin);
+		this.subscriptions = new Subscriptions(client, this.enableAdmin);
+		this.users = new Users(client, this.enableAdmin);
+		this.webhooks = new Webhooks(client, this.enableAdmin);
+	}
+
+	/**
+	 * Client for API requests
+	 * @private
+	 * @param {boolean} isMultipart - Whether to set the Content-Type header for multipart requests
+	 * @throws {Error} Throws an error if the API key or base URL is missing
+	 * @returns {Function} A function to make API requests
+	 */
+	_createClient(isMultipart = false) {
+		// Create an Axios instance with the base URL and default headers
+		const instance = axios.create({ baseURL: this.baseUrl, headers: isMultipart ? {} : { "Content-Type": "application/json" } });
+
+		// Add a request interceptor to include the API key in the Authorization header
+		instance.interceptors.request.use((config) => {
+			const token = config.headers.token || this.apiKey;
+			config.headers.Authorization = `Bearer ${token}`;
+			return config;
+		});
+
+		const client = async (url, options = {}) => {
+			try {
+				// Extract the body from options and keep the rest as axios config
+				const { body, ...axiosConfig } = options;
+				const response = await instance({ url, data: body, ...axiosConfig });
+				return response.data;
+			} catch (error) {
+				if (error.response) {
+					// Create a custom error object so the user sees the code and message clearly
+					const apiError = new Error(error.response.data?.message || "API Error");
+					apiError.status = error.response.status;
+					apiError.data = error.response.data;
+					throw apiError;
+				}
+
+				// If it's a network error or some other issue, rethrow it
+				throw error;
+			}
+		};
+
+		// Attach helpers to the client
+		client._getQueryString = this._getQueryString.bind(this);
+		client._require = this._require.bind(this);
+
+		return client;
+	}
+
+	/**
+	 * Helper method to convert an object to a query string, excluding undefined values and the 'options' key
+	 * @private
+	 * @param {Object} obj - The object to convert to a query string
+	 * @returns {string} The query string
+	 */
+	_getQueryString(obj) {
+		const params = new URLSearchParams();
+		Object.entries(obj).forEach(([key, value]) => {
+			if (value !== undefined && key !== "options") {
+				params.append(key, value);
+			}
+		});
+		return params.toString() ? `?${params.toString()}` : "";
+	}
+
+	/**
+	 * Helper method to validate required fields necessary for a request parameter
+	 * @private
+	 * @param {Object} fields - An object where keys are field names and values are the corresponding values to check
+	 * @throws {Error} Throws an error if any required field is missing or empty
+	 */
+	_require(fields) {
+		for(const [name, value] of Object.entries(fields)) {
+			if(value === undefined || value === null || value === "") {
+				const error = new Error(`Missing required parameter: ${name}`);
+				error.name = "SignalHouseValidationError";
+				error.status = 400; // Match API validation code
+				throw error;
+			}
+		}
+	}
+}

package/src/domains/Auth.js

@@ -0,0 +1,36 @@
+export class Auth {
+	constructor(client, enableAdmin) {
+		this.client = client;
+        this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Login with email and password
+	 * @async
+	 * @roles public
+	 * @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
+	 */
+	async login({ email, password, options = {} }) {
+		return this.client(`/auth`, { method: "POST", body: { email, password }, ...options });
+	}
+
+	/**
+	 * Reset a user's password
+	 * @async
+	 * @roles api, admin, self
+	 * @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
+	 */
+	async resetPassword({ userId, newPassword, options = {} }) {
+        this.client._require({ userId, newPassword });
+		const safeUserId = encodeURIComponent(userId);
+		return this.client(`/auth/resetpassword/${safeUserId}`, { method: "POST", body: { newPassword }, ...options });
+	}
+}

package/src/domains/Billing.js

@@ -0,0 +1,154 @@
+export class Billing {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get transaction history with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the transaction history
+	 * @param {string} [params.groupId] - The ID of the group to filter by
+	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+	 * @param {string} [params.entryType] - The type of entry to filter by
+	 * @param {string} [params.transactionType] - The type of transaction to filter by
+	 * @param {string} [params.startDate] - The start date for the filter
+	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getTransactionHistory({ groupId, subgroupId, entryType, transactionType, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, entryType, transactionType, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/wallet/transactionHistory${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get the wallet information for a specific group
+	 * @async
+	 * @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
+	 * @throws {Error} Throws an error if the groupId parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getWallet({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/${safeGroupId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update the wallet settings for a specific group
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for updating the wallet settings
+	 * @param {string} params.groupId - The ID of the group to update the wallet settings for
+	 * @param {boolean} [params.autoRechargeEnabled] - Whether auto-recharge is enabled for the wallet
+	 * @param {number} [params.autoRechargeThreshold] - The threshold amount for auto-recharge to trigger
+	 * @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
+	 * @throws {Error} Throws an error if the groupId parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async updateWallet({ groupId, autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/${safeGroupId}`, {
+			method: "PUT",
+			body: { autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId },
+			...options,
+		});
+	}
+
+	/**
+	 * Get the payment methods for a specific group
+	 * @async
+	 * @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
+	 * @throws {Error} Throws an error if the groupId parameter is missing
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getPaymentMethods({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/paymentmethods/${safeGroupId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Add funds to a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for adding funds
+	 * @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
+	 * @throws {Error} Throws an error if the groupId or amount parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async addFunds({ groupId, amount, paymentMethodId = undefined, options = {} }) {
+		this.client._require({ groupId, amount });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/addfunds/${safeGroupId}`, { method: "POST", body: { amount, paymentMethodId }, ...options });
+	}
+
+	/**
+	 * Add a payment method to a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @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
+	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async addPaymentMethod({ groupId, paymentMethodId, options = {} }) {
+		this.client._require({ groupId, paymentMethodId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/paymentmethods/${safeGroupId}`, { method: "POST", body: { paymentMethodId }, ...options });
+	}
+
+	/**
+	 * Remove a payment method from a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @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
+	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async removePaymentMethod({ groupId, paymentMethodId, options = {} }) {
+		this.client._require({ groupId, paymentMethodId });
+		const safeGroupId = encodeURIComponent(groupId);
+		const safePaymentMethodId = encodeURIComponent(paymentMethodId);
+		return this.client(`/billing/wallet/paymentmethods/${safeGroupId}/${safePaymentMethodId}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * Get invoice details with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the invoice details
+	 * @param {string} [params.groupId] - The ID of the group to filter by
+	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+	 * @param {string} [params.startDate] - The start date for the filter
+	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getInvoiceDetails({ groupId, subgroupId, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/invoiceDetails${queryString}`, { method: "GET", ...options });
+	}
+}

package/src/domains/Brands.js

@@ -0,0 +1,196 @@
+/**
+ * @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, enableAdmin) {
+		this.client = client;
+		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, "brandData.subgroupId": brandData.subgroupId });
+		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: "POST", ...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 });
+	}
+}