@signalhousellc/sdk 1.0.41 → 1.0.43

package/src/domains/Landings.js

@@ -1,132 +1,132 @@
-/**
- * @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 });
+	}
+
+	/**
+	 * 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

@@ -21,8 +21,8 @@ export class Messages {
 	 * @param {string} [params.carrier] - Filter messages by the carrier used for sending
 	 * @param {string} [params.senderPhoneNumber] - Filter messages by the sender's phone number
 	 * @param {string} [params.recipientPhoneNumber] - Filter messages by the recipient's phone number
-	 * @param {string} [params.startDate] - Filter messages by their start date
-	 * @param {string} [params.endDate] - Filter messages by their end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {string} [params.sortField] - The field to sort the messages by
 	 * @param {string} [params.sortOrder] - The order to sort the messages (asc, desc)
 	 * @param {number} [params.page] - The page number for pagination
@@ -67,8 +67,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
-	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the analytics data
 	 */
@@ -89,8 +89,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
 	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
-	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Array>} - A promise that resolves to an array of analytics snapshot records
 	 */
@@ -111,8 +111,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the DNC analytics data (totals, byDate, byPhoneNumber, byCarrier)
 	 */
@@ -133,8 +133,8 @@ export class Messages {
 	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
 	 * @param {string} [params.phoneNumber] - Filter by the phone number
 	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {string} [params.startDate] - ISO-8601 date or timestamp; normalized to start-of-UTC-day (inclusive)
+	 * @param {string} [params.endDate] - ISO-8601 date or timestamp; normalized to end-of-UTC-day (inclusive). Hourly resolution is not supported
 	 * @param {number} [params.page] - Page number for pagination
 	 * @param {number} [params.limit] - Number of records per page
 	 * @param {string} [params.sortField] - Field to sort by
@@ -158,14 +158,15 @@ export class Messages {
 	 * @param {string} params.messageBody - The body of the SMS message
 	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
 	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
+	 * @param {boolean} [params.filterLandlinesAndInactiveNumbers=false] - Whether to filter out landline and inactive numbers before sending
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
 	 */
-	async sendSMS({ senderPhoneNumber, recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink = false, options = {} }) {
+	async sendSMS({ senderPhoneNumber, recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink = false, filterLandlinesAndInactiveNumbers = false, options = {} }) {
 		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
 		return this.client(`/message/sms`, {
 			method: "POST",
-			body: { senderPhoneNumber, recipientPhoneNumber: recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink },
+			body: { senderPhoneNumber, recipientPhoneNumber: recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink, ...(filterLandlinesAndInactiveNumbers && { filterLandlinesAndInactiveNumbers }) },
 			...options,
 		});
 	}
@@ -182,6 +183,7 @@ export class Messages {
 	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
 	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
 	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
+	 * @param {boolean} [params.filterLandlinesAndInactiveNumbers=false] - Whether to filter out landline and inactive numbers before sending
 	 * @param {File[]} [params.images] - The images to attach to the MMS message
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
@@ -194,10 +196,11 @@ export class Messages {
 		statusCallbackUrl,
 		enableShortlink = false,
 		enableCompression = true,
+		filterLandlinesAndInactiveNumbers = false,
 		images,
 		options = {},
 	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers });
 
 		const formData = new FormData();
 
@@ -210,7 +213,7 @@ export class Messages {
 		formData.append("senderPhoneNumber", senderPhoneNumber);
 
 		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
+		if (messageBody) formData.append("messageBody", messageBody);
 
 		if (mediaUrls && mediaUrls.length > 0) {
 			formData.append("mediaUrls", JSON.stringify(mediaUrls));
@@ -222,6 +225,7 @@ export class Messages {
 
 		formData.append("enableShortlink", enableShortlink);
 		formData.append("enableCompression", enableCompression);
+		if (filterLandlinesAndInactiveNumbers) formData.append("filterLandlinesAndInactiveNumbers", filterLandlinesAndInactiveNumbers);
 
 		return this.multipartClient(`/message/mms`, { method: "POST", body: formData, ...options });
 	}
@@ -238,6 +242,7 @@ export class Messages {
 	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
 	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
 	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
+	 * @param {boolean} [params.filterLandlinesAndInactiveNumbers=false] - Whether to filter out landline and inactive numbers before sending
 	 * @param {File[]} [params.images] - The images to attach to the MMS message
 	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
 	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
@@ -250,10 +255,11 @@ export class Messages {
 		statusCallbackUrl,
 		enableShortlink = false,
 		enableCompression = true,
+		filterLandlinesAndInactiveNumbers = false,
 		images,
 		options = {},
 	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers });
 
 		const formData = new FormData();
 
@@ -266,7 +272,7 @@ export class Messages {
 		formData.append("senderPhoneNumber", senderPhoneNumber);
 
 		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
+		if (messageBody) formData.append("messageBody", messageBody);
 
 		if (mediaUrls && mediaUrls.length > 0) {
 			formData.append("mediaUrls", JSON.stringify(mediaUrls));
@@ -278,7 +284,26 @@ export class Messages {
 
 		formData.append("enableShortlink", enableShortlink);
 		formData.append("enableCompression", enableCompression);
+		if (filterLandlinesAndInactiveNumbers) formData.append("filterLandlinesAndInactiveNumbers", filterLandlinesAndInactiveNumbers);
 
 		return this.multipartClient(`/message/groupMessage`, { method: "POST", body: formData, ...options });
 	}
+
+	/**
+	 * Look up the carrier for a phone number. Always performs a fresh lookup (not cached). Billed per request.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for looking up a carrier
+	 * @param {string} params.phoneNumber - The phone number to look up (10+ digits, no + prefix)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to carrier information
+	 */
+	async carrierIdLookup({ phoneNumber, options = {} }) {
+		this.client._require({ phoneNumber });
+		return this.client(`/message/carrier-id`, {
+			method: "POST",
+			body: { phoneNumber },
+			...options,
+		});
+	}
 }

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 });
+	}
+}