@signalhousellc/sdk 1.0.49 → 1.0.50

package/README.md

@@ -1,38 +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
+# @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

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

package/src/domains/Auth.js

@@ -1,54 +1,66 @@
-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: "PUT", body: { newPassword }, ...options });
-	}
-
-	/**
-	 * Get token login history for a group or user
-	 * @async
-	 * @roles signalhouse_admin, signalhouse_api, signalhouse_user, admin, api (groupId query); self (userId query)
-	 * @param {Object} params
-	 * @param {string} [params.groupId] - Returns history for all users in the group (one of groupId/userId required)
-	 * @param {string} [params.userId] - Returns history for a specific user (one of groupId/userId required)
-	 * @param {number} [params.page] - Page number (min 1, default 1)
-	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 20)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async getAuthHistory({ groupId, userId, page, limit, options = {} }) {
-		this.client._require({ "groupId or userId": groupId ?? userId });
-		const queryString = this.client._getQueryString({ groupId, userId, page, limit });
-		return this.client(`/auth/history${queryString}`, { method: "GET", ...options });
-	}
-}
+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: "PUT", body: { newPassword }, ...options });
+	}
+
+	/**
+	 * Get token login history for a group or user
+	 * @async
+	 * @roles signalhouse_admin, signalhouse_api, signalhouse_user, admin, api (groupId query); self (userId query)
+	 * @param {Object} params
+	 * @param {string} [params.groupId] - Returns history for all users in the group (one of groupId/userId required)
+	 * @param {string} [params.userId] - Returns history for a specific user (one of groupId/userId required)
+	 * @param {number} [params.page] - Page number (min 1, default 1)
+	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 20)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getAuthHistory({ groupId, userId, page, limit, options = {} }) {
+		this.client._require({ "groupId or userId": groupId ?? userId });
+		const queryString = this.client._getQueryString({ groupId, userId, page, limit });
+		return this.client(`/auth/history${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Log out all other users in the caller's active group
+	 * @async
+	 * @roles admin
+	 * @param {Object} [params]
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response containing loggedOutCount
+	 */
+	async logoutAll({ options = {} } = {}) {
+		return this.client(`/auth/logout-all`, { method: "POST", ...options });
+	}
+}

package/src/domains/Landings.js

@@ -1,132 +1,147 @@
-/**
- * @typedef {Object} CreateLandingData
- * @property {string} brandId - The ID of the brand to associate with the landing page
- * @property {string} description - A description of the landing page
- * @property {string} primaryBackgroundColor - The primary background color for the landing page (e.g., "#FFFFFF")
- * @property {string} secondaryBackgroundColor - The secondary background color for the landing page (e.g., "#F0F0F0")
- * @property {string} primaryTextColor - The primary text color for the landing page (e.g., "#000000")
- * @property {string} secondaryTextColor - The secondary text color for the landing page (e.g., "#333333")
- * @property {Buffer} logo - A logo image file for the landing page, provided as a Buffer
- */
-
-/**
- * @typedef {Object} UpdateLandingData
- * @property {string} [description] - A description of the landing page
- * @property {string} [primaryBackgroundColor] - The primary background color for the landing page (e.g., "#FFFFFF")
- * @property {string} [secondaryBackgroundColor] - The secondary background color for the landing page (e.g., "#F0F0F0")
- * @property {string} [primaryTextColor] - The primary text color for the landing page (e.g., "#000000")
- * @property {string} [secondaryTextColor] - The secondary text color for the landing page (e.g., "#333333")
- * @property {Buffer} [logo] - A logo image file for the landing page, provided as a Buffer
- */
-
-export class Landings {
-	constructor(client, multipartClient, enableAdmin) {
-		this.client = client;
-		this.multipartClient = multipartClient;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get details of a landing page by its ID
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting a landing page
-	 * @param {string} params.landingId - The ID of the landing page to retrieve
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the landingId parameter is missing
-	 * @returns {Promise<Object>} - The landing page object returned from the server
-	 */
-	async getLandings({ landingId, options = {} }) {
-		this.client._require({ landingId });
-		const safeLandingId = encodeURIComponent(landingId);
-		return this.client(`/landing/${safeLandingId}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Create a new landing page with the specified landing data and logo file
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for creating a new landing page (see CreateLandingData typedef for details)
-	 * @param {CreateLandingData} params.landingData - The data for the new landing page, including required fields such as brandId and description
-	 * @param {Buffer} params.file - A logo image file for the landing page, provided as a Buffer
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The newly created landing page object returned from the server
-	 */
-	async createLanding({ landingData, file, options = {} }) {
-		const formData = new FormData();
-
-		if (file) {
-			formData.append("file", file);
-		}
-
-		Object.entries(landingData).forEach(([key, value]) => {
-			if (value !== undefined) {
-				formData.append(key, typeof value === "object" ? JSON.stringify(value) : value);
-			}
-		});
-
-		return this.multipartClient(`/landing`, { method: "POST", body: formData, ...options });
-	}
-
-	/**
-	 * Update an existing landing page with the specified landing data and logo file
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for updating a landing page (see UpdateLandingData typedef for details)
-	 * @param {string} params.landingId - The ID of the landing page to update
-	 * @param {UpdateLandingData} params.landingData - The data for the landing page, including required fields such as brandId and description
-	 * @param {Buffer} params.file - A logo image file for the landing page, provided as a Buffer
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the landingId parameter is missing
-	 * @returns {Promise<Object>} - The updated landing page object returned from the server
-	 */
-	async updateLanding({ landingId, landingData, file, options = {} }) {
-		this.client._require({ landingId });
-		const safeLandingId = encodeURIComponent(landingId);
-		const formData = new FormData();
-
-		if (file) {
-			formData.append("file", file);
-		}
-
-		Object.entries(landingData).forEach(([key, value]) => {
-			if (value !== undefined) {
-				formData.append(key, typeof value === "object" ? JSON.stringify(value) : value);
-			}
-		});
-
-		return this.multipartClient(`/landing/${safeLandingId}`, { method: "PUT", body: formData, ...options });
-	}
-
-	/**
-	 * Delete a landing page by its ID
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for deleting a landing page
-	 * @param {string} params.landingId - The ID of the landing page to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the landingId parameter is missing
-	 * @returns {Promise<Object>} - The response from the server after deleting the landing page
-	 */
-	/**
-	 * Get a landing page by its associated brand ID
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting a landing page by brand
-	 * @param {string} params.brandId - The brand ID to look up the landing page 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 landing page object returned from the server
-	 */
-	async getLandingByBrandId({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		const safeBrandId = encodeURIComponent(brandId);
-		return this.client(`/landing/brand/${safeBrandId}`, { method: "GET", ...options });
-	}
-
-	async deleteLanding({ landingId, options = {} }) {
-		this.client._require({ landingId });
-		const safeLandingId = encodeURIComponent(landingId);
-		return this.client(`/landing/${safeLandingId}`, { method: "DELETE", ...options });
-	}
-}
+/**
+ * @typedef {Object} CreateLandingData
+ * @property {string} brandId - The ID of the brand to associate with the landing page
+ * @property {string} description - A description of the landing page
+ * @property {string} primaryBackgroundColor - The primary background color for the landing page (e.g., "#FFFFFF")
+ * @property {string} secondaryBackgroundColor - The secondary background color for the landing page (e.g., "#F0F0F0")
+ * @property {string} primaryTextColor - The primary text color for the landing page (e.g., "#000000")
+ * @property {string} secondaryTextColor - The secondary text color for the landing page (e.g., "#333333")
+ * @property {Buffer} logo - A logo image file for the landing page, provided as a Buffer
+ */
+
+/**
+ * @typedef {Object} UpdateLandingData
+ * @property {string} [description] - A description of the landing page
+ * @property {string} [primaryBackgroundColor] - The primary background color for the landing page (e.g., "#FFFFFF")
+ * @property {string} [secondaryBackgroundColor] - The secondary background color for the landing page (e.g., "#F0F0F0")
+ * @property {string} [primaryTextColor] - The primary text color for the landing page (e.g., "#000000")
+ * @property {string} [secondaryTextColor] - The secondary text color for the landing page (e.g., "#333333")
+ * @property {Buffer} [logo] - A logo image file for the landing page, provided as a Buffer
+ */
+
+export class Landings {
+	constructor(client, multipartClient, enableAdmin) {
+		this.client = client;
+		this.multipartClient = multipartClient;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get details of a landing page by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting a landing page
+	 * @param {string} params.landingId - The ID of the landing page to retrieve
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the landingId parameter is missing
+	 * @returns {Promise<Object>} - The landing page object returned from the server
+	 */
+	async getLandings({ landingId, options = {} }) {
+		this.client._require({ landingId });
+		const safeLandingId = encodeURIComponent(landingId);
+		return this.client(`/landing/${safeLandingId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a public (published) landing page by its ID. This endpoint is public and does not require authentication.
+	 * @async
+	 * @param {Object} params - The parameters for getting a public landing page
+	 * @param {string} params.landingId - The ID of the public landing page to retrieve
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the landingId parameter is missing
+	 * @returns {Promise<Object>} - The public landing page object returned from the server
+	 */
+	async getPublicLanding({ landingId, options = {} }) {
+		this.client._require({ landingId });
+		const safeLandingId = encodeURIComponent(landingId);
+		return this.client(`/landing/public/${safeLandingId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Create a new landing page with the specified landing data and logo file
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for creating a new landing page (see CreateLandingData typedef for details)
+	 * @param {CreateLandingData} params.landingData - The data for the new landing page, including required fields such as brandId and description
+	 * @param {Buffer} params.file - A logo image file for the landing page, provided as a Buffer
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - The newly created landing page object returned from the server
+	 */
+	async createLanding({ landingData, file, options = {} }) {
+		const formData = new FormData();
+
+		if (file) {
+			formData.append("file", file);
+		}
+
+		Object.entries(landingData).forEach(([key, value]) => {
+			if (value !== undefined) {
+				formData.append(key, typeof value === "object" ? JSON.stringify(value) : value);
+			}
+		});
+
+		return this.multipartClient(`/landing`, { method: "POST", body: formData, ...options });
+	}
+
+	/**
+	 * Update an existing landing page with the specified landing data and logo file
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for updating a landing page (see UpdateLandingData typedef for details)
+	 * @param {string} params.landingId - The ID of the landing page to update
+	 * @param {UpdateLandingData} params.landingData - The data for the landing page, including required fields such as brandId and description
+	 * @param {Buffer} params.file - A logo image file for the landing page, provided as a Buffer
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the landingId parameter is missing
+	 * @returns {Promise<Object>} - The updated landing page object returned from the server
+	 */
+	async updateLanding({ landingId, landingData, file, options = {} }) {
+		this.client._require({ landingId });
+		const safeLandingId = encodeURIComponent(landingId);
+		const formData = new FormData();
+
+		if (file) {
+			formData.append("file", file);
+		}
+
+		Object.entries(landingData).forEach(([key, value]) => {
+			if (value !== undefined) {
+				formData.append(key, typeof value === "object" ? JSON.stringify(value) : value);
+			}
+		});
+
+		return this.multipartClient(`/landing/${safeLandingId}`, { method: "PUT", body: formData, ...options });
+	}
+
+	/**
+	 * Delete a landing page by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for deleting a landing page
+	 * @param {string} params.landingId - The ID of the landing page to delete
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the landingId parameter is missing
+	 * @returns {Promise<Object>} - The response from the server after deleting the landing page
+	 */
+	/**
+	 * Get a landing page by its associated brand ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting a landing page by brand
+	 * @param {string} params.brandId - The brand ID to look up the landing page 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 landing page object returned from the server
+	 */
+	async getLandingByBrandId({ brandId, options = {} }) {
+		this.client._require({ brandId });
+		const safeBrandId = encodeURIComponent(brandId);
+		return this.client(`/landing/brand/${safeBrandId}`, { method: "GET", ...options });
+	}
+
+	async deleteLanding({ landingId, options = {} }) {
+		this.client._require({ landingId });
+		const safeLandingId = encodeURIComponent(landingId);
+		return this.client(`/landing/${safeLandingId}`, { method: "DELETE", ...options });
+	}
+}

package/src/domains/Messages.js

@@ -56,6 +56,26 @@ export class Messages {
 		return this.client(`/message${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Fetch the latest upstream carrier delivery report for a set of messages by ID (SHGHL-1856).
+	 * Useful for reconciling messages stuck in a non-terminal state. SMS and MMS messages are looked up
+	 * against the carrier; other message types are returned with their stored status.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for fetching delivery reports
+	 * @param {string[]} params.messageIds - The message IDs to fetch carrier delivery reports for (1-100)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to an array of carrier delivery reports
+	 */
+	async getDeliveryReports({ messageIds, options = {} }) {
+		this.client._require({ messageIds });
+		return this.client(`/message/delivery-report`, {
+			method: "POST",
+			body: { messageIds },
+			...options,
+		});
+	}
+
 	/**
 	 * Get aggregated analytics for messages with optional filters
 	 * @async
@@ -261,6 +281,22 @@ export class Messages {
 		});
 	}
 
+	/**
+	 * Get the details of a P2P batch by its ID
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting a P2P batch
+	 * @param {string} params.batchId - The ID of the P2P batch to retrieve
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the batchId parameter is missing
+	 * @returns {Promise<Object>} - The P2P batch object returned from the server
+	 */
+	async getP2PBatch({ batchId, options = {} }) {
+		this.client._require({ batchId });
+		const safeBatchId = encodeURIComponent(batchId);
+		return this.client(`/message/p2p/batches/${safeBatchId}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Send an MMS message to one or more recipient phone numbers, with optional media attachments and status callback
 	 * @async

package/src/domains/Notifications.js

@@ -1,56 +1,56 @@
-export class Notifications {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get notifications by id or by groupId with optional filters
-	 * @async
-	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
-	 * @param {Object} params
-	 * @param {string} [params.id] - Notification id (one of id/groupId required)
-	 * @param {string} [params.groupId] - Group id to fetch notifications for (one of id/groupId required)
-	 * @param {number} [params.page] - Page number (min 1, default 1)
-	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 10)
-	 * @param {string} [params.status] - Filter by status: "READ" or "UNREAD"
-	 * @param {string|string[]} [params.eventTypes] - Event types to filter by (comma-separated string or array)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async getNotifications({ id, groupId, page, limit, status, eventTypes, options = {} }) {
-		this.client._require({ "id or groupId": id ?? groupId });
-		const queryString = this.client._getQueryString({ id, groupId, page, limit, status, eventTypes });
-		return this.client(`/notification${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Update the status of one or more notifications
-	 * @async
-	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
-	 * @param {Object} params
-	 * @param {string|string[]} params.ids - Notification id or array of notification ids
-	 * @param {string} params.status - New status: "READ" or "UNREAD"
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async updateNotificationStatus({ ids, status, options = {} }) {
-		this.client._require({ ids, status });
-		return this.client(`/notification/status`, { method: "PUT", body: { ids, status }, ...options });
-	}
-
-	/**
-	 * Delete a notification by id
-	 * @async
-	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
-	 * @param {Object} params
-	 * @param {string} params.id - The notification id to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async deleteNotification({ id, options = {} }) {
-		this.client._require({ id });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/notification/${safeId}`, { method: "DELETE", ...options });
-	}
-}
+export class Notifications {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get notifications by id or by groupId with optional filters
+	 * @async
+	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} [params.id] - Notification id (one of id/groupId required)
+	 * @param {string} [params.groupId] - Group id to fetch notifications for (one of id/groupId required)
+	 * @param {number} [params.page] - Page number (min 1, default 1)
+	 * @param {number} [params.limit] - Results per page (min 1, max 100, default 10)
+	 * @param {string} [params.status] - Filter by status: "READ" or "UNREAD"
+	 * @param {string|string[]} [params.eventTypes] - Event types to filter by (comma-separated string or array)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getNotifications({ id, groupId, page, limit, status, eventTypes, options = {} }) {
+		this.client._require({ "id or groupId": id ?? groupId });
+		const queryString = this.client._getQueryString({ id, groupId, page, limit, status, eventTypes });
+		return this.client(`/notification${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update the status of one or more notifications
+	 * @async
+	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string|string[]} params.ids - Notification id or array of notification ids
+	 * @param {string} params.status - New status: "READ" or "UNREAD"
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async updateNotificationStatus({ ids, status, options = {} }) {
+		this.client._require({ ids, status });
+		return this.client(`/notification/status`, { method: "PUT", body: { ids, status }, ...options });
+	}
+
+	/**
+	 * Delete a notification by id
+	 * @async
+	 * @roles signalhouse_api, signalhouse_admin, signalhouse_user, api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.id - The notification id to delete
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async deleteNotification({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/notification/${safeId}`, { method: "DELETE", ...options });
+	}
+}

package/src/domains/Shortlinks.js

@@ -1,44 +1,44 @@
-export class Shortlinks {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get the redirect URL for a shortlink by its ID
-	 * @async
-	 * @roles public
-	 * @param {Object} params - The parameters for getting the shortlink redirect
-	 * @param {string} params.shortlinkId - The ID of the shortlink
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the redirect URL for the shortlink
-	 */
-	async getShortlinkRedirect({ shortlinkId, options = {} }) {
-		this.client._require({ shortlinkId });
-		const safeShortlinkId = encodeURIComponent(shortlinkId);
-		return this.client(`/shortlink/redirect/${safeShortlinkId}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get details of a shortlink by its ID, with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting the shortlink details
-	 * @param {string} [params.shortlinkId] - The ID of the shortlink
-	 * @param {string} [params.messageId] - Filter by associated message ID
-	 * @param {string} [params.phoneNumber] - Filter by associated phone number
-	 * @param {string} [params.campaignId] - Filter by associated campaign ID
-	 * @param {string} [params.brandId] - Filter by associated brand ID
-	 * @param {string} [params.subgroupId] - Filter by associated subgroup ID
-	 * @param {string} [params.groupId] - Filter by associated group ID
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} A promise that resolves to the shortlink details
-	 */
-	async getShortlink({ shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
-		const filters = { shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/shortlink${queryString}`, { method: "GET", ...options });
-	}
-}
+export class Shortlinks {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get the redirect URL for a shortlink by its ID
+	 * @async
+	 * @roles public
+	 * @param {Object} params - The parameters for getting the shortlink redirect
+	 * @param {string} params.shortlinkId - The ID of the shortlink
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the redirect URL for the shortlink
+	 */
+	async getShortlinkRedirect({ shortlinkId, options = {} }) {
+		this.client._require({ shortlinkId });
+		const safeShortlinkId = encodeURIComponent(shortlinkId);
+		return this.client(`/shortlink/redirect/${safeShortlinkId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get details of a shortlink by its ID, with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the shortlink details
+	 * @param {string} [params.shortlinkId] - The ID of the shortlink
+	 * @param {string} [params.messageId] - Filter by associated message ID
+	 * @param {string} [params.phoneNumber] - Filter by associated phone number
+	 * @param {string} [params.campaignId] - Filter by associated campaign ID
+	 * @param {string} [params.brandId] - Filter by associated brand ID
+	 * @param {string} [params.subgroupId] - Filter by associated subgroup ID
+	 * @param {string} [params.groupId] - Filter by associated group ID
+	 * @param {number} [params.page] - The page number for pagination
+	 * @param {number} [params.limit] - The number of items per page for pagination
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to the shortlink details
+	 */
+	async getShortlink({ shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit, options = {} }) {
+		const filters = { shortlinkId, messageId, phoneNumber, campaignId, brandId, subgroupId, groupId, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/shortlink${queryString}`, { method: "GET", ...options });
+	}
+}

package/src/domains/Subscriptions.js

@@ -1,140 +1,140 @@
-export class Subscriptions {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-
-		if (enableAdmin) {
-			this.admin = {
-				/**
-				 * Get subscription templates with optional filtering by template ID
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for getting subscription templates
-				 * @param {string} [params.templateId] - The ID of a specific template to retrieve (optional)
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Object>} - The subscription templates returned from the server
-				 */
-				getTemplates: async ({ templateId, options = {} }) => {
-					const filters = { templateId };
-					const queryString = this.client._getQueryString(filters);
-					return this.client(`/subscription/template${queryString}`, { method: "GET", ...options });
-				},
-
-				/**
-				 * Create a new subscription template with the provided template data
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for creating a subscription template
-				 * @param {Object} params.templateData - The data for the new subscription template, including required fields such as templateName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the templateData parameter is missing or if required fields within templateData are missing
-				 * @returns {Promise<Object>} - The created subscription template object returned from the server
-				 */
-				createTemplate: async ({ templateData, options = {} }) => {
-					this.client._require({ templateData: templateData });
-					return this.client(`/subscription/template`, { method: "POST", body: templateData, ...options });
-				},
-
-				/**
-				 * Update an existing subscription template with the provided template data
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for updating a subscription template
-				 * @param {string} params.templateId - The ID of the subscription template to update
-				 * @param {Object} params.templateData - The data for the subscription template, including fields such as templateName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the templateId or templateData parameter is missing
-				 * @returns {Promise<Object>} - The updated subscription template object returned from the server
-				 */
-				updateTemplate: async ({ templateId, templateData, options = {} }) => {
-					this.client._require({ templateId, templateData });
-					const safeTemplateId = encodeURIComponent(templateId);
-					return this.client(`/subscription/template/${safeTemplateId}`, { method: "PUT", body: templateData, ...options });
-				},
-
-				/**
-				 * Delete an existing subscription template
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for deleting a subscription template
-				 * @param {string} params.templateId - The ID of the subscription template to delete
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the templateId parameter is missing
-				 * @returns {Promise<Object>} - The deleted subscription template object returned from the server
-				 */
-				deleteTemplate: async ({ templateId, options = {} }) => {
-					this.client._require({ templateId });
-					const safeTemplateId = encodeURIComponent(templateId);
-					return this.client(`/subscription/template/${safeTemplateId}`, { method: "DELETE", ...options });
-				},
-
-				/**
-				 * Create a custom subscription for a group with the provided subscription data
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for creating a custom subscription
-				 * @param {string} params.groupId - The ID of the group to create the custom subscription for
-				 * @param {Object} params.subscriptionData - The data for the custom subscription, including required fields such as subscriptionName and monthlyFee
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the groupId or subscriptionData parameter is missing or if required fields within subscriptionData are missing
-				 * @returns {Promise<Object>} - The created custom subscription object returned from the server
-				 */
-				createCustomSubscription: async ({ groupId, subscriptionData, options = {} }) => {
-					this.client._require({ groupId, subscriptionData });
-					const safeGroupId = encodeURIComponent(groupId);
-					return this.client(`/subscription/user/custom/${safeGroupId}`, { method: "POST", body: subscriptionData, ...options });
-				},
-			};
-		}
-	}
-
-	/**
-	 * Get a list of subscription history for a group, with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting subscription history
-	 * @param {string} params.groupId - The ID of the group to get subscription history for
-	 * @param {boolean} [params.onlyActive] - Whether to only include active subscriptions
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - The subscription history returned from the server
-	 */
-	async getSubscriptions({ groupId, onlyActive, options = {} }) {
-		const filters = { groupId, onlyActive };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/subscription/user${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Subscribe a group to a template
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for subscribing a group to a template
-	 * @param {string} params.groupId - The ID of the group to subscribe
-	 * @param {string} params.templateId - The ID of the template to subscribe the group to
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the groupId or templateId parameter is missing
-	 * @returns {Promise<Object>} - The subscription object returned from the server
-	 */
-	async subscribe({ groupId, templateId, options = {} }) {
-		this.client._require({ groupId, templateId });
-		const safeGroupId = encodeURIComponent(groupId);
-		const safeTemplateId = encodeURIComponent(templateId);
-		return this.client(`/subscription/user/subscribe/${safeGroupId}/${safeTemplateId}`, { method: "POST", body: {}, ...options });
-	}
-
-	/**
-	 * Unsubscribe a group from a template
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for unsubscribing a group from a template
-	 * @param {string} params.groupId - The ID of the group to unsubscribe
-	 * @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 subscription object returned from the server
-	 */
-	async unsubscribe({ groupId, options = {} }) {
-		this.client._require({ groupId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/subscription/user/cancel/${safeGroupId}`, { method: "POST", ...options });
-	}
-}
+export class Subscriptions {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+
+		if (enableAdmin) {
+			this.admin = {
+				/**
+				 * Get subscription templates with optional filtering by template ID
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for getting subscription templates
+				 * @param {string} [params.templateId] - The ID of a specific template to retrieve (optional)
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @returns {Promise<Object>} - The subscription templates returned from the server
+				 */
+				getTemplates: async ({ templateId, options = {} }) => {
+					const filters = { templateId };
+					const queryString = this.client._getQueryString(filters);
+					return this.client(`/subscription/template${queryString}`, { method: "GET", ...options });
+				},
+
+				/**
+				 * Create a new subscription template with the provided template data
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for creating a subscription template
+				 * @param {Object} params.templateData - The data for the new subscription template, including required fields such as templateName and monthlyFee
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the templateData parameter is missing or if required fields within templateData are missing
+				 * @returns {Promise<Object>} - The created subscription template object returned from the server
+				 */
+				createTemplate: async ({ templateData, options = {} }) => {
+					this.client._require({ templateData: templateData });
+					return this.client(`/subscription/template`, { method: "POST", body: templateData, ...options });
+				},
+
+				/**
+				 * Update an existing subscription template with the provided template data
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for updating a subscription template
+				 * @param {string} params.templateId - The ID of the subscription template to update
+				 * @param {Object} params.templateData - The data for the subscription template, including fields such as templateName and monthlyFee
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the templateId or templateData parameter is missing
+				 * @returns {Promise<Object>} - The updated subscription template object returned from the server
+				 */
+				updateTemplate: async ({ templateId, templateData, options = {} }) => {
+					this.client._require({ templateId, templateData });
+					const safeTemplateId = encodeURIComponent(templateId);
+					return this.client(`/subscription/template/${safeTemplateId}`, { method: "PUT", body: templateData, ...options });
+				},
+
+				/**
+				 * Delete an existing subscription template
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for deleting a subscription template
+				 * @param {string} params.templateId - The ID of the subscription template to delete
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the templateId parameter is missing
+				 * @returns {Promise<Object>} - The deleted subscription template object returned from the server
+				 */
+				deleteTemplate: async ({ templateId, options = {} }) => {
+					this.client._require({ templateId });
+					const safeTemplateId = encodeURIComponent(templateId);
+					return this.client(`/subscription/template/${safeTemplateId}`, { method: "DELETE", ...options });
+				},
+
+				/**
+				 * Create a custom subscription for a group with the provided subscription data
+				 * @async
+				 * @roles signalhouse
+				 * @param {Object} params - The parameters for creating a custom subscription
+				 * @param {string} params.groupId - The ID of the group to create the custom subscription for
+				 * @param {Object} params.subscriptionData - The data for the custom subscription, including required fields such as subscriptionName and monthlyFee
+				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+				 * @throws {Error} Throws an error if the groupId or subscriptionData parameter is missing or if required fields within subscriptionData are missing
+				 * @returns {Promise<Object>} - The created custom subscription object returned from the server
+				 */
+				createCustomSubscription: async ({ groupId, subscriptionData, options = {} }) => {
+					this.client._require({ groupId, subscriptionData });
+					const safeGroupId = encodeURIComponent(groupId);
+					return this.client(`/subscription/user/custom/${safeGroupId}`, { method: "POST", body: subscriptionData, ...options });
+				},
+			};
+		}
+	}
+
+	/**
+	 * Get a list of subscription history for a group, with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting subscription history
+	 * @param {string} params.groupId - The ID of the group to get subscription history for
+	 * @param {boolean} [params.onlyActive] - Whether to only include active subscriptions
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - The subscription history returned from the server
+	 */
+	async getSubscriptions({ groupId, onlyActive, options = {} }) {
+		const filters = { groupId, onlyActive };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/subscription/user${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Subscribe a group to a template
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for subscribing a group to a template
+	 * @param {string} params.groupId - The ID of the group to subscribe
+	 * @param {string} params.templateId - The ID of the template to subscribe the group to
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the groupId or templateId parameter is missing
+	 * @returns {Promise<Object>} - The subscription object returned from the server
+	 */
+	async subscribe({ groupId, templateId, options = {} }) {
+		this.client._require({ groupId, templateId });
+		const safeGroupId = encodeURIComponent(groupId);
+		const safeTemplateId = encodeURIComponent(templateId);
+		return this.client(`/subscription/user/subscribe/${safeGroupId}/${safeTemplateId}`, { method: "POST", body: {}, ...options });
+	}
+
+	/**
+	 * Unsubscribe a group from a template
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for unsubscribing a group from a template
+	 * @param {string} params.groupId - The ID of the group to unsubscribe
+	 * @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 subscription object returned from the server
+	 */
+	async unsubscribe({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/subscription/user/cancel/${safeGroupId}`, { method: "POST", ...options });
+	}
+}

package/src/domains/Webhooks.js

@@ -1,74 +1,74 @@
-export class Webhooks {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get a list of webhooks with optional filters
-	 * @async
-	 * @roles api, admin, developer
-	 * @param {Object} params - The parameters for getting webhooks
-	 * @param {string} [params.id] - Filter by webhook ID
-	 * @param {string} [params.groupId] - Filter by associated group ID
-	 * @param {string} [params.endpointType] - Filter by endpoint type (Global, Number)
-	 * @param {string} [params.phoneNumber] - Filter by associated phone number (for SMS webhooks)
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {number} [params.limit] - The number of items per page for pagination
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
-	 */
-	async getWebhooks({ id, groupId, endpointType, phoneNumber, page, limit, options = {} }) {
-		const filters = { id, groupId, endpointType, phoneNumber, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/webhook${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Create a new webhook with the specified data
-	 * @async
-	 * @roles api, admin, developer
-	 * @param {Object} params - The parameters for creating a webhook
-	 * @param {Object} params.webhookData - The data for the new webhook
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the webhookData parameter is missing or if required fields in webhookData are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async createWebhook({ webhookData, options = {} }) {
-		this.client._require({ webhookData: webhookData });
-		return this.client(`/webhook`, { method: "POST", body: webhookData, ...options });
-	}
-
-	/**
-	 * Update an existing webhook with the specified data
-	 * @async
-	 * @roles api, admin, developer
-	 * @param {Object} params - The parameters for updating a webhook
-	 * @param {string} params.id - The ID of the webhook to update
-	 * @param {Object} params.updateData - The data for the webhook to be updated, including fields such as endpoint URL and event types
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id or updateData parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async updateWebhook({ id, updateData, options = {} }) {
-		this.client._require({ id, updateData });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/webhook/${safeId}`, { method: "PUT", body: updateData, ...options });
-	}
-
-	/**
-	 * Delete a webhook by its ID (mark as inactive)
-	 * @async
-	 * @roles api, admin, developer
-	 * @param {Object} params - The parameters for deleting a webhook
-	 * @param {string} params.id - The ID of the webhook to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the id parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async deleteWebhook({ id, options = {} }) {
-		this.client._require({ id });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/webhook/${safeId}`, { method: "DELETE", ...options });
-	}
-}
+export class Webhooks {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get a list of webhooks with optional filters
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for getting webhooks
+	 * @param {string} [params.id] - Filter by webhook ID
+	 * @param {string} [params.groupId] - Filter by associated group ID
+	 * @param {string} [params.endpointType] - Filter by endpoint type (Global, Number)
+	 * @param {string} [params.phoneNumber] - Filter by associated phone number (for SMS webhooks)
+	 * @param {number} [params.page] - The page number for pagination
+	 * @param {number} [params.limit] - The number of items per page for pagination
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getWebhooks({ id, groupId, endpointType, phoneNumber, page, limit, options = {} }) {
+		const filters = { id, groupId, endpointType, phoneNumber, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/webhook${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Create a new webhook with the specified data
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for creating a webhook
+	 * @param {Object} params.webhookData - The data for the new webhook
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the webhookData parameter is missing or if required fields in webhookData are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async createWebhook({ webhookData, options = {} }) {
+		this.client._require({ webhookData: webhookData });
+		return this.client(`/webhook`, { method: "POST", body: webhookData, ...options });
+	}
+
+	/**
+	 * Update an existing webhook with the specified data
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for updating a webhook
+	 * @param {string} params.id - The ID of the webhook to update
+	 * @param {Object} params.updateData - The data for the webhook to be updated, including fields such as endpoint URL and event types
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id or updateData parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async updateWebhook({ id, updateData, options = {} }) {
+		this.client._require({ id, updateData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/webhook/${safeId}`, { method: "PUT", body: updateData, ...options });
+	}
+
+	/**
+	 * Delete a webhook by its ID (mark as inactive)
+	 * @async
+	 * @roles api, admin, developer
+	 * @param {Object} params - The parameters for deleting a webhook
+	 * @param {string} params.id - The ID of the webhook to delete
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the id parameter is missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async deleteWebhook({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/webhook/${safeId}`, { method: "DELETE", ...options });
+	}
+}