@signalhousellc/sdk 1.0.46 → 1.0.48

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