@signalhousellc/sdk 1.0.44 → 1.0.46

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

@@ -17,7 +17,7 @@ export class Messages {
 	 * @param {string} [params.groupId] - Filter messages by the ID of the associated group
 	 * @param {string} [params.status] - Filter messages by their status (ENQUEUED, DEQUEUED, SENT, FAILED, DELIVERED)
 	 * @param {string} [params.direction] - Filter messages by their direction (INBOUND, OUTBOUND)
-	 * @param {string} [params.messageType] - Filter messages by their type (SMS, MMS)
+	 * @param {string|string[]} [params.messageType] - Filter messages by their type. Accepts a single value or an array (e.g. ["SMS", "MMS"]). Allowed values: SMS, MMS, RCS, WHATSAPP, VIBER, P2P. When omitted, defaults to all non-P2P types.
 	 * @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
@@ -116,6 +116,58 @@ export class Messages {
 		return this.client(`/message/analytics/filter-options${queryString}`, { method: "GET", ...options });
 	}
 
+	/**
+	 * Get a paginated breakdown of message metrics grouped by subgroup. Each row carries the
+	 * full set of sms/mms/p2p metric columns so the caller can apply channel toggles client-side.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.groupId - The Group ID
+	 * @param {string|string[]} [params.subgroupId]
+	 * @param {string|string[]} [params.brandId]
+	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.phoneNumber]
+	 * @param {string|string[]} [params.carrier]
+	 * @param {string} [params.startDate]
+	 * @param {string} [params.endDate]
+	 * @param {number} [params.page=1]
+	 * @param {number} [params.limit=50] - max 50 per page
+	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + row inclusion. "tenDLC" excludes rows with no SMS/MMS activity; "p2p" excludes rows with no P2P activity; "both" returns rows with any activity.
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
+	 * @returns {Promise<Object>} - { rows, totalCount, page, limit }
+	 */
+	async getAnalyticsBySubgroup({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics/by-subgroup${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get a paginated breakdown of failed messages grouped by error code.
+	 * Each row contains per-channel (sms/mms/p2p) error counts plus an enriched description.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params
+	 * @param {string} params.groupId - The Group ID
+	 * @param {string|string[]} [params.subgroupId]
+	 * @param {string|string[]} [params.brandId]
+	 * @param {string|string[]} [params.campaignId]
+	 * @param {string|string[]} [params.phoneNumber]
+	 * @param {string|string[]} [params.carrier]
+	 * @param {string} [params.startDate]
+	 * @param {string} [params.endDate]
+	 * @param {number} [params.page=1]
+	 * @param {number} [params.limit=50] - max 50 per page
+	 * @param {"tenDLC"|"p2p"|"both"} [params.channel="both"] - Scope the ORDER BY + totalCount. "tenDLC" excludes rows with no SMS/MMS errors; "p2p" excludes rows with no P2P errors; "both" returns rows with any error.
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options]
+	 * @returns {Promise<Object>} - { rows, totalCount, totalErrors: { sms, mms, p2p, all }, page, limit }
+	 */
+	async getAnalyticsByErrorCode({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, channel };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics/by-error-code${queryString}`, { method: "GET", ...options });
+	}
+
 	/**
 	 * Get aggregated DNC (Do Not Contact) opt-out analytics with optional filters
 	 * @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/Onboarding.js

@@ -36,4 +36,31 @@ export class Onboarding {
 			};
 		}
 	}
+
+	/**
+	 * Get the caller's own onboarding record (customer-safe projection).
+	 * Returns `{ acceptedTermsOfService: boolean }`.
+	 * @async
+	 * @param {Object} [params] - Optional parameters
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - `{ acceptedTermsOfService: boolean }`
+	 */
+	async getMyOnboarding({ options = {} } = {}) {
+		return this.client(`/group/onboarding/my`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Accept the Terms of Service for the caller's active group.
+	 * @async
+	 * @param {Object} [params] - Optional parameters
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - `{ acceptedTermsOfService: true }`
+	 */
+	async acceptTermsOfService({ options = {} } = {}) {
+		return this.client(`/group/onboarding/my/accept-terms`, {
+			method: "PUT",
+			body: { acceptedTermsOfService: true },
+			...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 });
+	}
+}