@signalhousellc/sdk 1.0.14 → 1.0.16

package/package.json

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

package/src/SignalHouseSDK.js

@@ -19,6 +19,7 @@ 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 {
@@ -61,6 +62,7 @@ export class SignalHouseSDK {
 		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);
 	}
 

package/src/domains/Notifications.js

@@ -0,0 +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(`/notifications${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(`/notifications/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(`/notifications/${safeId}`, { method: "DELETE", ...options });
+	}
+}

package/src/domains/Users.js

@@ -160,4 +160,35 @@ export class Users {
 		const safeId = encodeURIComponent(id);
 		return this.client(`/user/${safeId}`, { method: "DELETE", ...options });
 	}
+
+	/**
+	 * Get notification preferences for a user
+	 * @async
+	 * @roles api, admin, self
+	 * @param {Object} params
+	 * @param {string} params.id - The ID of the user
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getNotificationPreferences({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/user/${safeId}/notification-preferences`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update notification preferences for a user
+	 * @async
+	 * @roles api, admin, self
+	 * @param {Object} params
+	 * @param {string} params.id - The ID of the user
+	 * @param {Array<{name: string, web: boolean, email: boolean}>} params.notificationPreferences - Array of notification preference objects
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async updateNotificationPreferences({ id, notificationPreferences, options = {} }) {
+		this.client._require({ id, notificationPreferences });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/user/${safeId}/notification-preferences`, { method: "PUT", body: { notificationPreferences }, ...options });
+	}
 }