@signalhousellc/sdk 1.0.44 → 1.0.45

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

package/src/domains/Subgroups.js

@@ -1,106 +1,106 @@
-/**
- * @typedef {Object} CreateSubgroupData
- * @property {string} groupId - The ID of the parent group for the subgroup (must be at least 8 characters long and start with 'G')
- * @property {string} subgroupName - The name of the subgroup (required)
- * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
- * @property {string} [contactLastName] - The last name of the contact person for the subgroup
- * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
- * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
- * @property {string} [addressLine1] - The first line of the address for the subgroup
- * @property {string} [addressLine2] - The second line of the address for the subgroup
- * @property {string} [city] - The city for the subgroup's address
- * @property {string} [state] - The state for the subgroup's address
- * @property {string} [country] - The country for the subgroup's address
- * @property {string} [postalCode] - The postal code for the subgroup's address
- * @property {string} [phone] - The phone number for the subgroup
- */
-
-/**
- * @typedef {Object} UpdateSubgroupData
- * @property {string} [subgroupName] - The name of the subgroup
- * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
- * @property {string} [contactLastName] - The last name of the contact person for the subgroup
- * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
- * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
- * @property {string} [addressLine1] - The first line of the address for the subgroup
- * @property {string} [addressLine2] - The second line of the address for the subgroup
- * @property {string} [city] - The city for the subgroup's address
- * @property {string} [state] - The state for the subgroup's address
- * @property {string} [country] - The country for the subgroup's address
- * @property {string} [postalCode] - The postal code for the subgroup's address
- * @property {string} [phone] - The phone number for the subgroup
- * @property {string} [status] - The status of the subgroup (e.g., "active", "inactive")
- */
-
-export class Subgroups {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get a list of subgroups with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting subgroups
-	 * @param {string} [params.id] - Filter by subgroup ID
-	 * @param {string} [params.groupId] - Filter by parent 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>} - The list of subgroups returned from the server
-	 */
-	async getSubgroups({ id, groupId, page, limit, options = {} }) {
-		const filters = { id, groupId, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/subgroup${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Create a new subgroup with the specified subgroup data
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for creating a subgroup (see CreateSubgroupData typedef for details)
-	 * @param {CreateSubgroupData} params.subgroupData - The data for the subgroup to be created, including required fields such as groupId and subgroupName
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the subgroupData parameter is missing or if required fields in subgroupData are missing
-	 * @returns {Promise<Object>} - The created subgroup object returned from the server
-	 */
-	async createSubgroup({ subgroupData, options = {} }) {
-		this.client._require({ subgroupData: subgroupData });
-		return this.client(`/subgroup`, { method: "POST", body: subgroupData, ...options });
-	}
-
-	/**
-	 * Update an existing subgroup with the specified subgroup data
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for updating a subgroup (see UpdateSubgroupData typedef for details)
-	 * @param {string} params.id - The ID of the subgroup to update
-	 * @param {UpdateSubgroupData} params.updateData - The data for the subgroup to be updated, including fields such as subgroupName, contact information, and status
-	 * @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 updated subgroup object returned from the server
-	 */
-	async updateSubgroup({ id, updateData, options = {} }) {
-		this.client._require({ id, updateData });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/subgroup/${safeId}`, { method: "PUT", body: updateData, ...options });
-	}
-
-	/**
-	 * Delete a subgroup by its ID (mark as inactive)
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for deleting a subgroup
-	 * @param {string} params.id - The ID of the subgroup 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 deleted subgroup object returned from the server
-	 */
-	async deleteSubgroup({ id, options = {} }) {
-		this.client._require({ id });
-		const safeId = encodeURIComponent(id);
-		return this.client(`/subgroup/${safeId}`, { method: "DELETE", ...options });
-	}
-}
+/**
+ * @typedef {Object} CreateSubgroupData
+ * @property {string} groupId - The ID of the parent group for the subgroup (must be at least 8 characters long and start with 'G')
+ * @property {string} subgroupName - The name of the subgroup (required)
+ * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
+ * @property {string} [contactLastName] - The last name of the contact person for the subgroup
+ * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
+ * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
+ * @property {string} [addressLine1] - The first line of the address for the subgroup
+ * @property {string} [addressLine2] - The second line of the address for the subgroup
+ * @property {string} [city] - The city for the subgroup's address
+ * @property {string} [state] - The state for the subgroup's address
+ * @property {string} [country] - The country for the subgroup's address
+ * @property {string} [postalCode] - The postal code for the subgroup's address
+ * @property {string} [phone] - The phone number for the subgroup
+ */
+
+/**
+ * @typedef {Object} UpdateSubgroupData
+ * @property {string} [subgroupName] - The name of the subgroup
+ * @property {string} [contactFirstName] - The first name of the contact person for the subgroup
+ * @property {string} [contactLastName] - The last name of the contact person for the subgroup
+ * @property {string} [contactMiddleName] - The middle name of the contact person for the subgroup
+ * @property {string} [subgroupCompanyName] - The company name associated with the subgroup
+ * @property {string} [addressLine1] - The first line of the address for the subgroup
+ * @property {string} [addressLine2] - The second line of the address for the subgroup
+ * @property {string} [city] - The city for the subgroup's address
+ * @property {string} [state] - The state for the subgroup's address
+ * @property {string} [country] - The country for the subgroup's address
+ * @property {string} [postalCode] - The postal code for the subgroup's address
+ * @property {string} [phone] - The phone number for the subgroup
+ * @property {string} [status] - The status of the subgroup (e.g., "active", "inactive")
+ */
+
+export class Subgroups {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get a list of subgroups with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting subgroups
+	 * @param {string} [params.id] - Filter by subgroup ID
+	 * @param {string} [params.groupId] - Filter by parent 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>} - The list of subgroups returned from the server
+	 */
+	async getSubgroups({ id, groupId, page, limit, options = {} }) {
+		const filters = { id, groupId, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/subgroup${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Create a new subgroup with the specified subgroup data
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for creating a subgroup (see CreateSubgroupData typedef for details)
+	 * @param {CreateSubgroupData} params.subgroupData - The data for the subgroup to be created, including required fields such as groupId and subgroupName
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the subgroupData parameter is missing or if required fields in subgroupData are missing
+	 * @returns {Promise<Object>} - The created subgroup object returned from the server
+	 */
+	async createSubgroup({ subgroupData, options = {} }) {
+		this.client._require({ subgroupData: subgroupData });
+		return this.client(`/subgroup`, { method: "POST", body: subgroupData, ...options });
+	}
+
+	/**
+	 * Update an existing subgroup with the specified subgroup data
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for updating a subgroup (see UpdateSubgroupData typedef for details)
+	 * @param {string} params.id - The ID of the subgroup to update
+	 * @param {UpdateSubgroupData} params.updateData - The data for the subgroup to be updated, including fields such as subgroupName, contact information, and status
+	 * @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 updated subgroup object returned from the server
+	 */
+	async updateSubgroup({ id, updateData, options = {} }) {
+		this.client._require({ id, updateData });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/subgroup/${safeId}`, { method: "PUT", body: updateData, ...options });
+	}
+
+	/**
+	 * Delete a subgroup by its ID (mark as inactive)
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for deleting a subgroup
+	 * @param {string} params.id - The ID of the subgroup 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 deleted subgroup object returned from the server
+	 */
+	async deleteSubgroup({ id, options = {} }) {
+		this.client._require({ id });
+		const safeId = encodeURIComponent(id);
+		return this.client(`/subgroup/${safeId}`, { method: "DELETE", ...options });
+	}
+}