@signalhousellc/sdk 1.0.42 → 1.0.44

package/src/domains/Subscriptions.js

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

package/src/domains/Webhooks.js

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