recurrente-js 1.0.0

package/dist/api/recurrente-webhooks.d.ts

@@ -0,0 +1,71 @@
+import { PaymentIntentSucceeded, PaymentIntentFailed, SubscriptionCreate, SubscriptionPastDue, SubscriptionPaused, SubscriptionCancel, RecurrenteWebhookEvent } from '../types/globals';
+/**
+ * A handler function type definition.
+ * @template T The type of the webhook event.
+ */
+type WebhookHandler<T> = (event: T) => void;
+/**
+ * Mapping of event types to corresponding event interfaces.
+ */
+interface EventTypeMapping {
+    'payment_intent.succeeded': PaymentIntentSucceeded;
+    'payment_intent.failed': PaymentIntentFailed;
+    'subscription.create': SubscriptionCreate;
+    'subscription.past_due': SubscriptionPastDue;
+    'subscription.paused': SubscriptionPaused;
+    'subscription.cancel': SubscriptionCancel;
+}
+/**
+ * Verifies the Svix webhook signature and parses the event.
+ *
+ * @param payload - The raw request body as a string.
+ * @param headers - The request headers.
+ * @returns The verified and parsed event.
+ * @throws {Error} If the signature verification fails.
+ */
+declare function verifySvixSignature(payload: string, headers: Record<string, string | string[] | undefined>): RecurrenteWebhookEvent;
+/**
+ * Registers a custom webhook handler for a specific event type.
+ *
+ * @template T The type of the webhook event.
+ * @param {keyof EventTypeMapping} eventType - The type of the event (e.g., 'payment_intent.succeeded').
+ * @param {WebhookHandler<EventTypeMapping[T]>} handler - The custom handler function to register for this event type.
+ *
+ * @example
+ * registerWebhookHandler('payment_intent.succeeded', (event) => {
+ *   console.log(`Payment succeeded for: ${event.customer.email}`);
+ *   // Custom logic for a successful payment
+ * });
+ */
+declare function registerWebhookHandler<T extends keyof EventTypeMapping>(eventType: T, handler: WebhookHandler<EventTypeMapping[T]>): void;
+/**
+ * Handles a verified webhook event by dispatching it to the appropriate registered or default handler.
+ *
+ * **Important Note:** Before calling this function, you must verify the webhook signature using `verifySvixSignature`
+ * to ensure the event is authentic and has not been tampered with.
+ *
+ * @param {RecurrenteWebhookEvent} event - The verified webhook event object sent by Recurrente.
+ *
+ * @example
+ * app.post('/webhook', (req, res) => {
+ *   try {
+ *     const payload = req.body;
+ *     const headers = req.headers;
+ *
+ *     // Verify the signature and obtain the event
+ *     const event = verifySvixSignature(payload, headers);
+ *
+ *     // Handle the verified event
+ *     handleWebhookEvent(event);
+ *
+ *     res.status(200).send('Webhook processed');
+ *   } catch (error) {
+ *     console.error('Error processing webhook:', error);
+ *     res.status(400).send('Invalid webhook signature');
+ *   }
+ * });
+ *
+ * @throws {Error} If no handler is found for the event type.
+ */
+declare function handleWebhookEvent(event: RecurrenteWebhookEvent): void;
+export { handleWebhookEvent, verifySvixSignature, registerWebhookHandler };

package/dist/api/recurrente-webhooks.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleWebhookEvent = handleWebhookEvent;
+exports.verifySvixSignature = verifySvixSignature;
+exports.registerWebhookHandler = registerWebhookHandler;
+const svix_1 = require("svix");
+const conversion_1 = require("../utils/conversion");
+const dotenv_1 = __importDefault(require("dotenv"));
+// Load environment variables from .env file if they are not already set
+dotenv_1.default.config();
+/**
+ * A record to store the user-registered webhook handlers.
+ * Each event type is mapped to its corresponding handler function.
+ */
+const userHandlers = {
+    'payment_intent.succeeded': (event) => {
+        console.log('Default PaymentIntentSucceeded Handler:', event);
+    },
+    'payment_intent.failed': (event) => {
+        console.log('Default PaymentIntentFailed Handler:', event);
+    },
+    'subscription.create': (event) => {
+        console.log('Default SubscriptionCreate Handler:', event);
+    },
+    'subscription.past_due': (event) => {
+        console.log('Default SubscriptionPastDue Handler:', event);
+    },
+    'subscription.paused': (event) => {
+        console.log('Default SubscriptionPaused Handler:', event);
+    },
+    'subscription.cancel': (event) => {
+        console.log('Default SubscriptionCancel Handler:', event);
+    },
+};
+/**
+ * Verifies the Svix webhook signature and parses the event.
+ *
+ * @param payload - The raw request body as a string.
+ * @param headers - The request headers.
+ * @returns The verified and parsed event.
+ * @throws {Error} If the signature verification fails.
+ */
+function verifySvixSignature(payload, headers) {
+    const signingSecret = process.env.RECURRENTE_SVIX_SIGNING_SECRET;
+    if (!signingSecret) {
+        throw new Error('Missing signing secret');
+    }
+    const svixHeaders = {
+        'svix-id': headers['svix-id'],
+        'svix-timestamp': headers['svix-timestamp'],
+        'svix-signature': headers['svix-signature'],
+    };
+    const svix = new svix_1.Webhook(signingSecret);
+    try {
+        // Verify the signature and parse the event
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const event = svix.verify(payload, svixHeaders);
+        // Convert snake_case keys to camelCase
+        const camelCasedEvent = (0, conversion_1.toCamelCase)(event);
+        return camelCasedEvent;
+    }
+    catch (error) {
+        throw new Error('Invalid webhook signature');
+    }
+}
+/**
+ * Registers a custom webhook handler for a specific event type.
+ *
+ * @template T The type of the webhook event.
+ * @param {keyof EventTypeMapping} eventType - The type of the event (e.g., 'payment_intent.succeeded').
+ * @param {WebhookHandler<EventTypeMapping[T]>} handler - The custom handler function to register for this event type.
+ *
+ * @example
+ * registerWebhookHandler('payment_intent.succeeded', (event) => {
+ *   console.log(`Payment succeeded for: ${event.customer.email}`);
+ *   // Custom logic for a successful payment
+ * });
+ */
+function registerWebhookHandler(eventType, handler) {
+    userHandlers[eventType] = handler;
+}
+/**
+ * Handles a verified webhook event by dispatching it to the appropriate registered or default handler.
+ *
+ * **Important Note:** Before calling this function, you must verify the webhook signature using `verifySvixSignature`
+ * to ensure the event is authentic and has not been tampered with.
+ *
+ * @param {RecurrenteWebhookEvent} event - The verified webhook event object sent by Recurrente.
+ *
+ * @example
+ * app.post('/webhook', (req, res) => {
+ *   try {
+ *     const payload = req.body;
+ *     const headers = req.headers;
+ *
+ *     // Verify the signature and obtain the event
+ *     const event = verifySvixSignature(payload, headers);
+ *
+ *     // Handle the verified event
+ *     handleWebhookEvent(event);
+ *
+ *     res.status(200).send('Webhook processed');
+ *   } catch (error) {
+ *     console.error('Error processing webhook:', error);
+ *     res.status(400).send('Invalid webhook signature');
+ *   }
+ * });
+ *
+ * @throws {Error} If no handler is found for the event type.
+ */
+function handleWebhookEvent(event) {
+    const handler = userHandlers[event.eventType];
+    if (handler) {
+        handler(event);
+    }
+    else {
+        throw new Error(`No handler registered for event type: ${event.eventType}`);
+    }
+}

package/dist/api/recurrente.d.ts

@@ -0,0 +1,131 @@
+import { ProductSubscription, CreateSubscriptionResponse, SubscriptionStatusResponse, CreateProductRequest, CreateProductResponse, GetProductResponse, GetAllProductsResponse, UpdateProductRequest } from '../types/globals';
+/**
+ * Recurrente API utility for managing product subscriptions, cancellations, and product deletions.
+ *
+ * The `recurrente` object provides methods to create, cancel, retrieve, and delete subscriptions and products,
+ * making it easy to integrate Recurrente's payment services into your project.
+ *
+ * @namespace recurrente
+ * @property {Function} test - Test endpoint.
+ * @property {Function} createProduct - Creates a new product with a one-time payment.
+ * @property {Function} getProduct - Retrieves details of a specific product by its ID.
+ * @property {Function} getAllProducts - Retrieves a paginated list of all products.
+ * @property {Function} updateProduct - Updates an existing product by its ID.
+ * @property {Function} deleteProduct - Deletes a product by its ID.
+ * @property {Function} createSubscription - Creates a new subscription for a product.
+ * @property {Function} cancelSubscription - Cancels an existing subscription by its ID.
+ * @property {Function} getSubscription - Retrieves details of a specific subscription by its ID.
+ */
+declare const recurrente: {
+    /**
+     * Makes a GET request to the '/test' endpoint.
+     *
+     * **FOR DEVELOPMENT PURPOSES ONLY TO TEST**
+     *
+     * This method is included for testing internal API functionality.
+     *
+     * @function
+     * @memberof recurrente
+     * @returns {Promise<{message: string}>} A message indicating the success or failure of the request.
+     * @throws {ErrorResponse} Throws an error if the request fails.
+     */
+    test: () => Promise<{
+        message: string;
+    }>;
+    /**
+     * Creates a new product with a one-time payment.
+     *
+     * This function takes the product data, converts it to snake_case,
+     * and sends it to the API to create a one-time payment product.
+     * It returns the created product's details.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createProduct
+     * @param {CreateProductRequest} productData - The details of the product to create.
+     * @returns {Promise<CreateProductResponse>} A promise that resolves with the created product's details.
+     * @throws {ErrorResponse} Throws an error if the product creation fails.
+     */
+    createProduct: (productData: CreateProductRequest) => Promise<CreateProductResponse>;
+    /**
+     * Retrieves details of a specific product by its ID.
+     *
+     * This function fetches details of an existing product by making a GET request
+     * using the product ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getProduct
+     * @param {string} productId - The ID of the product to retrieve.
+     * @returns {Promise<GetProductResponse>} The details of the product.
+     * @throws {ErrorResponse} Throws an error if the retrieval fails.
+     */
+    getProduct: (productId: string) => Promise<GetProductResponse>;
+    /**
+     * Retrieves a paginated list of all products.
+     *
+     * This function fetches a list of products from the API. By default, it retrieves
+     * the 10 most recent products, but pagination can be controlled using query parameters.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getAllProducts
+     * @param {number} [page=1] - The page number to retrieve, defaults to the first page.
+     * @returns {Promise<GetAllProductsResponse>} A promise that resolves with an array of product details.
+     * @throws {ErrorResponse} Throws an error if the product retrieval fails.
+     */
+    getAllProducts: (page?: number) => Promise<GetAllProductsResponse>;
+    /**
+     * Updates an existing product by its ID.
+     *
+     * This function takes the product ID and an object containing the updated product details.
+     * It sends a PATCH request to the API to update the specified product. You can also
+     * modify product prices or delete them by passing the _destroy parameter in prices_attributes.
+     *
+     * @function
+     * @memberof recurrente
+     * @see updateProduct
+     * @param {string} productId - The ID of the product to update.
+     * @param {UpdateProductRequest} productData - The updated product details.
+     * @returns {Promise<GetProductResponse>} A promise that resolves with the updated product's details.
+     * @throws {ErrorResponse} Throws an error if the product update fails.
+     */
+    updateProduct: (productId: string, productData: UpdateProductRequest) => Promise<GetProductResponse>;
+    /**
+     * Deletes a product by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see deleteProduct
+     */
+    deleteProduct: (productId: string) => Promise<{
+        message: string;
+    }>;
+    /**
+     * Creates a new subscription for a product.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createSubscription
+     */
+    createSubscription: (productData: ProductSubscription) => Promise<CreateSubscriptionResponse>;
+    /**
+     * Cancels an existing subscription by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see cancelSubscription
+     */
+    cancelSubscription: (subscriptionId: string) => Promise<{
+        message: string;
+    }>;
+    /**
+     * Retrieves details of a specific subscription by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getSubscription
+     */
+    getSubscription: (subscriptionId: string) => Promise<SubscriptionStatusResponse>;
+};
+export default recurrente;

package/dist/api/recurrente.js

@@ -0,0 +1,355 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const axiosInstance_1 = __importDefault(require("../config/axiosInstance"));
+const conversion_1 = require("../utils/conversion");
+/**
+ * Creates a new product with a one-time payment.
+ *
+ * This function takes the product data, converts it to snake_case,
+ * and sends it to the API to create a new one-time payment product.
+ * It returns the created product's details.
+ *
+ * @param {CreateProductRequest} productData - The product details for the one-time payment.
+ * @returns {Promise<CreateProductResponse>} The response containing product details.
+ * @throws {ErrorResponse} Throws an error if the product creation fails.
+ */
+const createProduct = (productData) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const productDataInSnakeCase = (0, conversion_1.toSnakeCase)(productData);
+        const response = yield axiosInstance_1.default.post('/products/', productDataInSnakeCase);
+        return (0, conversion_1.toCamelCase)(response.data); // Return the created product's details
+    }
+    catch (error) {
+        // Handle errors via the centralized error handler
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Retrieves details of a specific product by its ID.
+ *
+ * This function fetches details of an existing product by making a GET request
+ * to the API using the provided product ID. It returns the product's details.
+ *
+ * @param {string} productId - The ID of the product to retrieve.
+ * @returns {Promise<GetProductResponse>} The response containing the product details.
+ * @throws {ErrorResponse} Throws an error if the product retrieval fails.
+ */
+const getProduct = (productId) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const response = yield axiosInstance_1.default.get(`/products/${productId}`);
+        return (0, conversion_1.toCamelCase)(response.data);
+    }
+    catch (error) {
+        throw handleAxiosError(error); // Handle errors via the centralized error handler
+    }
+});
+/**
+ * Retrieves a list of all products.
+ *
+ * This function fetches a paginated list of products from the API.
+ * By default, it retrieves the 10 most recent products, but pagination
+ * can be controlled using query parameters.
+ *
+ * @param {number} [page=1] - The page number to retrieve, defaults to the first page.
+ * @returns {Promise<GetAllProductsResponse>} The response containing an array of product details.
+ * @throws {ErrorResponse} Throws an error if the product retrieval fails.
+ */
+const getAllProducts = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (page = 1) {
+    try {
+        const response = yield axiosInstance_1.default.get(`/products?page=${page}`);
+        return (0, conversion_1.toCamelCase)(response.data);
+    }
+    catch (error) {
+        throw handleAxiosError(error); // Handle errors via the centralized error handler
+    }
+});
+/**
+ * Updates an existing product by its ID.
+ *
+ * This function takes the product ID and an object containing the updated product details.
+ * It sends a PATCH request to the API to update the specified product. You can also
+ * modify product prices or delete them by passing the _destroy parameter in prices_attributes.
+ *
+ * @param {string} productId - The ID of the product to update.
+ * @param {UpdateProductRequest} productData - The updated product details.
+ * @returns {Promise<GetProductResponse>} A promise that resolves with the updated product's details.
+ * @throws {ErrorResponse} Throws an error if the product update fails.
+ */
+const updateProduct = (productId, productData) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const productDataInSnakeCase = (0, conversion_1.toSnakeCase)(productData);
+        const response = yield axiosInstance_1.default.patch(`/products/${productId}`, productDataInSnakeCase);
+        return (0, conversion_1.toCamelCase)(response.data); // Return the updated product's details
+    }
+    catch (error) {
+        throw handleAxiosError(error); // Handle errors via the centralized error handler
+    }
+});
+/**
+ * Creates a new subscription for a product.
+ *
+ * This function takes a product's subscription data, converts it to snake_case,
+ * and sends it to the API to create a new subscription. It returns the created
+ * subscription's details.
+ *
+ * @param {ProductSubscription} productData - The subscription details for the product.
+ * @returns {Promise<CreateSubscriptionResponse>} The response containing subscription details.
+ * @throws {ErrorResponse} Throws an error if the subscription creation fails.
+ */
+const createSubscription = (productData) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const productDataInSnakeCase = (0, conversion_1.toSnakeCase)(productData);
+        const response = yield axiosInstance_1.default.post('/products/', productDataInSnakeCase);
+        return (0, conversion_1.toCamelCase)(response.data); // Return the success response only
+    }
+    catch (error) {
+        // Throw an error to handle it in a higher-level function or component
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Cancels an existing subscription by its ID.
+ *
+ * This function sends a request to cancel the subscription specified by the
+ * subscription ID. It returns a message indicating the success of the operation.
+ *
+ * @param {string} subscriptionId - The ID of the subscription to cancel.
+ * @returns {Promise<{message: string}>} A message indicating whether the subscription was canceled successfully.
+ * @throws {ErrorResponse} Throws an error if the cancellation fails.
+ */
+const cancelSubscription = (subscriptionId) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const response = yield axiosInstance_1.default.delete(`/subscriptions/${subscriptionId}`);
+        return {
+            message: `Subscription canceled successfully. Status: ${response.status}`,
+        };
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Deletes a product by its ID.
+ *
+ * This function deletes a product from the system using the product ID. It
+ * returns a message indicating whether the product was deleted successfully.
+ *
+ * @param {string} productId - The ID of the product to delete.
+ * @returns {Promise<{message: string}>} A message indicating whether the product was deleted successfully.
+ * @throws {ErrorResponse} Throws an error if the deletion fails.
+ */
+const deleteProduct = (productId) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield axiosInstance_1.default.delete(`/products/${productId}`);
+        return { message: 'Product deleted successfully' };
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Retrieves details of a specific subscription by its ID.
+ *
+ * This function fetches details of an existing subscription by making a GET request
+ * using the subscription ID.
+ *
+ * @param {string} subscriptionId - The ID of the subscription to retrieve.
+ * @returns {Promise<SubscriptionStatusResponse>} The details of the subscription.
+ * @throws {ErrorResponse} Throws an error if the retrieval fails.
+ */
+const getSubscription = (subscriptionId) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const response = yield axiosInstance_1.default.get(`/subscriptions/${subscriptionId}`);
+        return (0, conversion_1.toCamelCase)(response.data);
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Centralized error handler for Axios requests.
+ *
+ * This function checks if the error is from Axios and extracts meaningful
+ * information from the response or throws a general error message if the error
+ * is not from Axios.
+ *
+ * @param {unknown} error - The error object caught during an API request.
+ * @returns {ErrorResponse} An object containing error details such as status and message.
+ */
+function handleAxiosError(error) {
+    if (axios_1.default.isAxiosError(error)) {
+        if (error.response && error.response.data) {
+            return {
+                status: 'error',
+                message: error.response.data.message || 'An error occurred',
+                errors: error.response.data.errors || {},
+            };
+        }
+        return {
+            status: 'error',
+            message: error.message || 'Unknown Axios error occurred',
+        };
+    }
+    else {
+        return {
+            status: 'error',
+            message: 'An unknown error occurred',
+        };
+    }
+}
+/**
+ * Makes a GET request to the '/test' endpoint.
+ *
+ * This function is not exported and is intended for internal use.
+ *
+ * @returns {Promise<{message: string}>} A message indicating success or failure of the request.
+ * @throws {ErrorResponse} Throws an error if the request fails.
+ */
+const test = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const response = yield axiosInstance_1.default.get('/test');
+        return {
+            message: `Test request succeeded. Status: ${response.data.message}`,
+        };
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
+/**
+ * Recurrente API utility for managing product subscriptions, cancellations, and product deletions.
+ *
+ * The `recurrente` object provides methods to create, cancel, retrieve, and delete subscriptions and products,
+ * making it easy to integrate Recurrente's payment services into your project.
+ *
+ * @namespace recurrente
+ * @property {Function} test - Test endpoint.
+ * @property {Function} createProduct - Creates a new product with a one-time payment.
+ * @property {Function} getProduct - Retrieves details of a specific product by its ID.
+ * @property {Function} getAllProducts - Retrieves a paginated list of all products.
+ * @property {Function} updateProduct - Updates an existing product by its ID.
+ * @property {Function} deleteProduct - Deletes a product by its ID.
+ * @property {Function} createSubscription - Creates a new subscription for a product.
+ * @property {Function} cancelSubscription - Cancels an existing subscription by its ID.
+ * @property {Function} getSubscription - Retrieves details of a specific subscription by its ID.
+ */
+const recurrente = {
+    /**
+     * Makes a GET request to the '/test' endpoint.
+     *
+     * **FOR DEVELOPMENT PURPOSES ONLY TO TEST**
+     *
+     * This method is included for testing internal API functionality.
+     *
+     * @function
+     * @memberof recurrente
+     * @returns {Promise<{message: string}>} A message indicating the success or failure of the request.
+     * @throws {ErrorResponse} Throws an error if the request fails.
+     */
+    test,
+    /**
+     * Creates a new product with a one-time payment.
+     *
+     * This function takes the product data, converts it to snake_case,
+     * and sends it to the API to create a one-time payment product.
+     * It returns the created product's details.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createProduct
+     * @param {CreateProductRequest} productData - The details of the product to create.
+     * @returns {Promise<CreateProductResponse>} A promise that resolves with the created product's details.
+     * @throws {ErrorResponse} Throws an error if the product creation fails.
+     */
+    createProduct,
+    /**
+     * Retrieves details of a specific product by its ID.
+     *
+     * This function fetches details of an existing product by making a GET request
+     * using the product ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getProduct
+     * @param {string} productId - The ID of the product to retrieve.
+     * @returns {Promise<GetProductResponse>} The details of the product.
+     * @throws {ErrorResponse} Throws an error if the retrieval fails.
+     */
+    getProduct,
+    /**
+     * Retrieves a paginated list of all products.
+     *
+     * This function fetches a list of products from the API. By default, it retrieves
+     * the 10 most recent products, but pagination can be controlled using query parameters.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getAllProducts
+     * @param {number} [page=1] - The page number to retrieve, defaults to the first page.
+     * @returns {Promise<GetAllProductsResponse>} A promise that resolves with an array of product details.
+     * @throws {ErrorResponse} Throws an error if the product retrieval fails.
+     */
+    getAllProducts,
+    /**
+     * Updates an existing product by its ID.
+     *
+     * This function takes the product ID and an object containing the updated product details.
+     * It sends a PATCH request to the API to update the specified product. You can also
+     * modify product prices or delete them by passing the _destroy parameter in prices_attributes.
+     *
+     * @function
+     * @memberof recurrente
+     * @see updateProduct
+     * @param {string} productId - The ID of the product to update.
+     * @param {UpdateProductRequest} productData - The updated product details.
+     * @returns {Promise<GetProductResponse>} A promise that resolves with the updated product's details.
+     * @throws {ErrorResponse} Throws an error if the product update fails.
+     */
+    updateProduct,
+    /**
+     * Deletes a product by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see deleteProduct
+     */
+    deleteProduct,
+    /**
+     * Creates a new subscription for a product.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createSubscription
+     */
+    createSubscription,
+    /**
+     * Cancels an existing subscription by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see cancelSubscription
+     */
+    cancelSubscription,
+    /**
+     * Retrieves details of a specific subscription by its ID.
+     *
+     * @function
+     * @memberof recurrente
+     * @see getSubscription
+     */
+    getSubscription,
+};
+exports.default = recurrente;

package/dist/config/axiosInstance.d.ts

@@ -0,0 +1,3 @@
+import { AxiosInstance } from 'axios';
+declare const client: AxiosInstance;
+export default client;