@signalhousellc/sdk 1.0.30 → 1.0.32

package/src/domains/Billing.js

@@ -1,172 +1,172 @@
-export class Billing {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get transaction history with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for filtering the transaction history
-	 * @param {string} [params.groupId] - The ID of the group to filter by
-	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
-	 * @param {string} [params.brandId] - The brand ID to filter by
-	 * @param {string} [params.campaignId] - The campaign ID to filter by
-	 * @param {string} [params.entryType] - The type of entry to filter by
-	 * @param {string} [params.transactionType] - The type of transaction to filter by
-	 * @param {string} [params.startDate] - The start date for the filter
-	 * @param {string} [params.endDate] - The end date for the filter
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
-	 */
-	async getTransactionHistory({ groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/billing/wallet/transactionHistory${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get the wallet information for a specific group
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting the wallet information
-	 * @param {string} params.groupId - The ID of the group to get the wallet information for
-	 * @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 response from the server
-	 */
-	async getWallet({ groupId, options = {} }) {
-		this.client._require({ groupId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/wallet/${safeGroupId}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Update the wallet settings for a specific group
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for updating the wallet settings
-	 * @param {string} params.groupId - The ID of the group to update the wallet settings for
-	 * @param {boolean} [params.autoRechargeEnabled] - Whether auto-recharge is enabled for the wallet
-	 * @param {number} [params.autoRechargeThreshold] - The threshold amount for auto-recharge to trigger
-	 * @param {number} [params.autoRechargeToAmount] - The amount to recharge to when auto-recharge is triggered
-	 * @param {string} [params.primaryPaymentMethodId] - The ID of the primary payment method to use for auto-recharge
-	 * @param {string} [params.secondaryPaymentMethodId] - The ID of the secondary payment method to use for auto-recharge if the primary method fails
-	 * @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 response from the server
-	 */
-	async updateWallet({ groupId, autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId, options = {} }) {
-		this.client._require({ groupId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/wallet/${safeGroupId}`, {
-			method: "PUT",
-			body: { autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId },
-			...options,
-		});
-	}
-
-	/**
-	 * Get the payment methods for a specific group
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting the payment methods
-	 * @param {string} params.groupId - The ID of the group to get the payment methods for
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the groupId parameter is missing
-	 * @returns {Promise<Array>} The response from the server
-	 */
-	async getPaymentMethods({ groupId, options = {} }) {
-		this.client._require({ groupId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/wallet/paymentMethods/${safeGroupId}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Add funds to a group's wallet
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for adding funds
-	 * @param {string} params.groupId - The ID of the group to add funds to
-	 * @param {number} params.amount - The amount to add to the group's wallet in microdollars (e.g., $10 would be 10000000)
-	 * @param {string} [params.paymentMethodId] - The ID of the payment method to use for adding funds
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the groupId or amount parameters are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async addFunds({ groupId, amount, paymentMethodId = undefined, options = {} }) {
-		this.client._require({ groupId, amount });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/wallet/addfunds/${safeGroupId}`, { method: "POST", body: { amount, paymentMethodId }, ...options });
-	}
-
-	/**
-	 * Add a payment method to a group's wallet
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for adding a payment method
-	 * @param {string} params.groupId - The ID of the group to add the payment method to
-	 * @param {string} params.paymentMethodId - The ID of the payment method to add
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async addPaymentMethod({ groupId, paymentMethodId, options = {} }) {
-		this.client._require({ groupId, paymentMethodId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/wallet/paymentMethod/${safeGroupId}`, { method: "POST", body: { paymentMethodId }, ...options });
-	}
-
-	/**
-	 * Remove a payment method from a group's wallet
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for removing a payment method
-	 * @param {string} params.groupId - The ID of the group to remove the payment method from
-	 * @param {string} params.paymentMethodId - The ID of the payment method to remove
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async removePaymentMethod({ groupId, paymentMethodId, options = {} }) {
-		this.client._require({ groupId, paymentMethodId });
-		const safeGroupId = encodeURIComponent(groupId);
-		const safePaymentMethodId = encodeURIComponent(paymentMethodId);
-		return this.client(`/billing/wallet/paymentMethod/${safeGroupId}/${safePaymentMethodId}`, { method: "DELETE", ...options });
-	}
-
-	/**
-	 * Get invoice details with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for filtering the invoice details
-	 * @param {string} [params.groupId] - The ID of the group to filter by
-	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
-	 * @param {string} [params.startDate] - The start date for the filter
-	 * @param {string} [params.endDate] - The end date for the filter
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async getInvoiceDetails({ groupId, subgroupId, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, startDate, endDate };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/billing/invoiceDetails${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get the fee schedule for a specific group
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting the fees
-	 * @param {string} params.groupId - The ID of the group to get fees for
-	 * @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 response from the server
-	 */
-	async getFees({ groupId, options = {} }) {
-		this.client._require({ groupId });
-		const safeGroupId = encodeURIComponent(groupId);
-		return this.client(`/billing/fees/${safeGroupId}`, { method: "GET", ...options });
-	}
-}
+export class Billing {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get transaction history with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the transaction history
+	 * @param {string} [params.groupId] - The ID of the group to filter by
+	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+	 * @param {string} [params.brandId] - The brand ID to filter by
+	 * @param {string} [params.campaignId] - The campaign ID to filter by
+	 * @param {string} [params.entryType] - The type of entry to filter by
+	 * @param {string} [params.transactionType] - The type of transaction to filter by
+	 * @param {string} [params.startDate] - The start date for the filter
+	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getTransactionHistory({ groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, entryType, transactionType, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/wallet/transactionHistory${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get the wallet information for a specific group
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the wallet information
+	 * @param {string} params.groupId - The ID of the group to get the wallet information for
+	 * @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 response from the server
+	 */
+	async getWallet({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/${safeGroupId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Update the wallet settings for a specific group
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for updating the wallet settings
+	 * @param {string} params.groupId - The ID of the group to update the wallet settings for
+	 * @param {boolean} [params.autoRechargeEnabled] - Whether auto-recharge is enabled for the wallet
+	 * @param {number} [params.autoRechargeThreshold] - The threshold amount for auto-recharge to trigger
+	 * @param {number} [params.autoRechargeToAmount] - The amount to recharge to when auto-recharge is triggered
+	 * @param {string} [params.primaryPaymentMethodId] - The ID of the primary payment method to use for auto-recharge
+	 * @param {string} [params.secondaryPaymentMethodId] - The ID of the secondary payment method to use for auto-recharge if the primary method fails
+	 * @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 response from the server
+	 */
+	async updateWallet({ groupId, autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/${safeGroupId}`, {
+			method: "PUT",
+			body: { autoRechargeEnabled, autoRechargeThreshold, autoRechargeToAmount, primaryPaymentMethodId, secondaryPaymentMethodId },
+			...options,
+		});
+	}
+
+	/**
+	 * Get the payment methods for a specific group
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the payment methods
+	 * @param {string} params.groupId - The ID of the group to get the payment methods for
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the groupId parameter is missing
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getPaymentMethods({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/paymentMethods/${safeGroupId}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Add funds to a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for adding funds
+	 * @param {string} params.groupId - The ID of the group to add funds to
+	 * @param {number} params.amount - The amount to add to the group's wallet in microdollars (e.g., $10 would be 10000000)
+	 * @param {string} [params.paymentMethodId] - The ID of the payment method to use for adding funds
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the groupId or amount parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async addFunds({ groupId, amount, paymentMethodId = undefined, options = {} }) {
+		this.client._require({ groupId, amount });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/addfunds/${safeGroupId}`, { method: "POST", body: { amount, paymentMethodId }, ...options });
+	}
+
+	/**
+	 * Add a payment method to a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for adding a payment method
+	 * @param {string} params.groupId - The ID of the group to add the payment method to
+	 * @param {string} params.paymentMethodId - The ID of the payment method to add
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async addPaymentMethod({ groupId, paymentMethodId, options = {} }) {
+		this.client._require({ groupId, paymentMethodId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/wallet/paymentMethod/${safeGroupId}`, { method: "POST", body: { paymentMethodId }, ...options });
+	}
+
+	/**
+	 * Remove a payment method from a group's wallet
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for removing a payment method
+	 * @param {string} params.groupId - The ID of the group to remove the payment method from
+	 * @param {string} params.paymentMethodId - The ID of the payment method to remove
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @throws {Error} Throws an error if the groupId or paymentMethodId parameters are missing
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async removePaymentMethod({ groupId, paymentMethodId, options = {} }) {
+		this.client._require({ groupId, paymentMethodId });
+		const safeGroupId = encodeURIComponent(groupId);
+		const safePaymentMethodId = encodeURIComponent(paymentMethodId);
+		return this.client(`/billing/wallet/paymentMethod/${safeGroupId}/${safePaymentMethodId}`, { method: "DELETE", ...options });
+	}
+
+	/**
+	 * Get invoice details with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for filtering the invoice details
+	 * @param {string} [params.groupId] - The ID of the group to filter by
+	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+	 * @param {string} [params.startDate] - The start date for the filter
+	 * @param {string} [params.endDate] - The end date for the filter
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} The response from the server
+	 */
+	async getInvoiceDetails({ groupId, subgroupId, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/billing/invoiceDetails${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get the fee schedule for a specific group
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting the fees
+	 * @param {string} params.groupId - The ID of the group to get fees for
+	 * @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 response from the server
+	 */
+	async getFees({ groupId, options = {} }) {
+		this.client._require({ groupId });
+		const safeGroupId = encodeURIComponent(groupId);
+		return this.client(`/billing/fees/${safeGroupId}`, { method: "GET", ...options });
+	}
+}