@signalhousellc/sdk 1.0.31 → 1.0.33

package/package.json

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

package/src/SignalHouseSDK.js

@@ -1,154 +1,154 @@
-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 { Notifications } from "./domains/Notifications.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, multipartClient, 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.notifications = new Notifications(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.token || this.apiKey;
-			config.headers.Authorization = `Bearer ${token}`;
-			delete config.token; // Remove token from config to avoid sending it as a header
-			return config;
-		});
-
-		// Standardize responses
-		instance.interceptors.response.use(
-			// Standard 2xx responses
-			(response) => {
-				return { success: true, data: response.data, status: response.status };
-			},
-
-			// Non-2xx responses
-			(error) => {
-				return {
-					success: false,
-					error: error.response?.data?.message || error.response?.data || error.message || 500,
-					status: error.response?.status || error.response?.data || null,
-				};
-			},
-		);
-
-		const client = async (url, options = {}) => {
-			// Extract the body from options and keep the rest as axios config
-			const { body, ...axiosConfig } = options;
-			return instance({ url, data: body, ...axiosConfig });
-		};
-
-		// 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") {
-				if (Array.isArray(value)) {
-					value.forEach((v) => params.append(key, v));
-				} else {
-					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;
-			}
-		}
-	}
-}
+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 { Notifications } from "./domains/Notifications.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, multipartClient, 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.notifications = new Notifications(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.token || this.apiKey;
+			config.headers.Authorization = `Bearer ${token}`;
+			delete config.token; // Remove token from config to avoid sending it as a header
+			return config;
+		});
+
+		// Standardize responses
+		instance.interceptors.response.use(
+			// Standard 2xx responses
+			(response) => {
+				return { success: true, data: response.data, status: response.status };
+			},
+
+			// Non-2xx responses
+			(error) => {
+				return {
+					success: false,
+					error: error.response?.data?.message || error.response?.data || error.message || 500,
+					status: error.response?.status || error.response?.data || null,
+				};
+			},
+		);
+
+		const client = async (url, options = {}) => {
+			// Extract the body from options and keep the rest as axios config
+			const { body, ...axiosConfig } = options;
+			return instance({ url, data: body, ...axiosConfig });
+		};
+
+		// 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") {
+				if (Array.isArray(value)) {
+					value.forEach((v) => params.append(key, v));
+				} else {
+					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;
+			}
+		}
+	}
+}