recurrente-js 1.0.2 → 1.0.4

package/dist/api/recurrente.d.ts

@@ -1,4 +1,4 @@
-import { ProductSubscription, CreateSubscriptionResponse, SubscriptionStatusResponse, CreateProductRequest, CreateProductResponse, GetProductResponse, GetAllProductsResponse, UpdateProductRequest } from '../types/globals';
+import { ProductSubscription, CreateSubscriptionResponse, SubscriptionStatusResponse, CreateProductRequest, CreateProductResponse, GetProductResponse, GetAllProductsResponse, UpdateProductRequest, CreateCheckoutRequest, CreateCheckoutResponse, CreateRefundRequest, CreateRefundResponse } from '../types/globals';
 /**
  * Recurrente API utility for managing product subscriptions, cancellations, and product deletions.
  *
@@ -15,6 +15,8 @@ import { ProductSubscription, CreateSubscriptionResponse, SubscriptionStatusResp
  * @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.
+ * @property {Function} createCheckout - Creates a new checkout with provided product ID.
+ * @property {Function} createRefund - Creates a new refund for a specific payment intent.
  */
 declare const recurrente: {
     /**
@@ -127,5 +129,27 @@ declare const recurrente: {
      * @see getSubscription
      */
     getSubscription: (subscriptionId: string) => Promise<SubscriptionStatusResponse>;
+    /**
+     * Creates a new checkout session.
+     *
+     * @function
+     * @memberof recurrente.checkouts
+     * @see createCheckout
+     * @param {CreateCheckoutRequest} checkoutData - The details for the checkout session.
+     * @returns {Promise<CreateCheckoutResponse>} A promise that resolves with the checkout ID and URL.
+     * @throws {ErrorResponse} Throws an error if the checkout creation fails.
+     */
+    createCheckout: (checkoutData: CreateCheckoutRequest) => Promise<CreateCheckoutResponse>;
+    /**
+     * Creates a new refund for a specific payment intent.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createRefund
+     * @param {CreateRefundRequest} refundData - The data containing the paymentIntentId to refund.
+     * @returns {Promise<CreateRefundResponse>} A promise that resolves with the refund details.
+     * @throws {ErrorResponse} Throws an error if the refund creation fails.
+     */
+    createRefund: (refundData: CreateRefundRequest) => Promise<CreateRefundResponse>;
 };
 export default recurrente;

package/dist/api/recurrente.js

@@ -15,6 +15,27 @@ 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 checkout session.
+ *
+ * This function takes checkout data, including items (by product_id or details),
+ * converts it to snake_case, and sends it to the API to create a new checkout session.
+ * It returns the checkout ID and the URL for redirection.
+ *
+ * @param {CreateCheckoutRequest} checkoutData - The details for the checkout session.
+ * @returns {Promise<CreateCheckoutResponse>} The response containing the checkout ID and URL.
+ * @throws {ErrorResponse} Throws an error if the checkout creation fails.
+ */
+const createCheckout = (checkoutData) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const checkoutDataInSnakeCase = (0, conversion_1.toSnakeCase)(checkoutData);
+        const response = yield axiosInstance_1.default.post('/checkouts/', checkoutDataInSnakeCase);
+        return (0, conversion_1.toCamelCase)(response.data);
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
 /**
  * Creates a new product with a one-time payment.
  *
@@ -229,6 +250,26 @@ const test = () => __awaiter(void 0, void 0, void 0, function* () {
         throw handleAxiosError(error);
     }
 });
+/**
+ * Creates a new refund for a specific payment intent.
+ *
+ * This function takes a payment_intent_id, converts the payload to snake_case,
+ * and sends it to the API to process a refund.
+ *
+ * @param {CreateRefundRequest} refundData - The data containing the paymentIntentId to refund.
+ * @returns {Promise<CreateRefundResponse>} The response containing the details of the created refund.
+ * @throws {ErrorResponse} Throws an error if the refund creation fails.
+ */
+const createRefund = (refundData) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const refundDataInSnakeCase = (0, conversion_1.toSnakeCase)(refundData);
+        const response = yield axiosInstance_1.default.post('/refunds/', refundDataInSnakeCase);
+        return (0, conversion_1.toCamelCase)(response.data);
+    }
+    catch (error) {
+        throw handleAxiosError(error);
+    }
+});
 /**
  * Recurrente API utility for managing product subscriptions, cancellations, and product deletions.
  *
@@ -245,6 +286,8 @@ const test = () => __awaiter(void 0, void 0, void 0, function* () {
  * @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.
+ * @property {Function} createCheckout - Creates a new checkout with provided product ID.
+ * @property {Function} createRefund - Creates a new refund for a specific payment intent.
  */
 const recurrente = {
     /**
@@ -351,5 +394,27 @@ const recurrente = {
      * @see getSubscription
      */
     getSubscription,
+    /**
+     * Creates a new checkout session.
+     *
+     * @function
+     * @memberof recurrente.checkouts
+     * @see createCheckout
+     * @param {CreateCheckoutRequest} checkoutData - The details for the checkout session.
+     * @returns {Promise<CreateCheckoutResponse>} A promise that resolves with the checkout ID and URL.
+     * @throws {ErrorResponse} Throws an error if the checkout creation fails.
+     */
+    createCheckout,
+    /**
+     * Creates a new refund for a specific payment intent.
+     *
+     * @function
+     * @memberof recurrente
+     * @see createRefund
+     * @param {CreateRefundRequest} refundData - The data containing the paymentIntentId to refund.
+     * @returns {Promise<CreateRefundResponse>} A promise that resolves with the refund details.
+     * @throws {ErrorResponse} Throws an error if the refund creation fails.
+     */
+    createRefund,
 };
 exports.default = recurrente;

package/dist/types/globals.d.ts

@@ -1262,6 +1262,64 @@ export interface SubscriptionCancel {
      */
     customerName: string;
 }
+/**
+ * Represents the payload for creating a checkout session.
+ */
+export interface CreateCheckoutRequest {
+    /**
+     * An array of items to be included in the checkout.
+     * Each item can be defined by its product_id or by its details.
+     * @required
+     */
+    items: {
+        /**
+         * The ID of a pre-existing product. Use this to create a checkout for a master plan.
+         * @optional
+         */
+        productId?: string;
+    }[];
+    /**
+     * URL to redirect the user after a successful transaction.
+     * @optional
+     */
+    successUrl?: string;
+    /**
+     * URL to redirect the user after canceling the transaction.
+     * @optional
+     */
+    cancelUrl?: string;
+    /**
+     * The ID of the user to whom the checkout belongs.
+     * Pre-populates user information fields.
+     * @optional
+     */
+    userId?: string;
+    /**
+     * Optional metadata for additional information.
+     * @optional
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Optional expiration date for the checkout in ISO 8601 format.
+     * @optional
+     */
+    expiresAt?: string;
+}
+/**
+ * Represents the response after creating a checkout session.
+ */
+export interface CreateCheckoutResponse {
+    /**
+     * The unique identifier for the checkout session (e.g., "ch_...").
+     * @required
+     */
+    id: string;
+    /**
+     * The URL to which you should redirect your user to complete the payment.
+     * @required
+     */
+    checkoutUrl: string;
+}
 /**
  * Represents the possible webhook events that can be triggered in the Recurrente system.
  * These events correspond to various stages of the payment or subscription lifecycle.
@@ -1275,3 +1333,57 @@ export type RecurrenteWebhookEvent = PaymentIntentSucceeded | PaymentIntentFaile
  * @param event - The webhook event object.
  */
 export type WebhookHandler<T> = (event: T) => void;
+/**
+ * Represents the payload for creating a refund.
+ */
+export interface CreateRefundRequest {
+    /**
+     * The ID of the payment intent (`pa_...`) to be refunded.
+     * @required
+     */
+    paymentIntentId: string;
+}
+/**
+ * Represents the response after successfully creating a refund.
+ */
+export interface CreateRefundResponse {
+    /**
+     * The unique identifier for the refund object (e.g., "re_...").
+     * @required
+     */
+    id: string;
+    /**
+     * The status of the refund.
+     * @required
+     */
+    status: 'succeeded' | 'pending' | 'failed';
+    /**
+     * The customer associated with the refunded payment.
+     * @required
+     */
+    customer: {
+        id: string;
+        email: string;
+        fullName: string;
+    };
+    /**
+     * The amount in cents that was refunded to your account balance.
+     * @required
+     */
+    accountRefundedAmountInCents: number;
+    /**
+     * The amount in cents that was refunded to the customer.
+     * @required
+     */
+    customerRefundedAmountInCents: number;
+    /**
+     * The currency of the refund.
+     * @required
+     */
+    currency: string;
+    /**
+     * The timestamp of when the refund was created.
+     * @required
+     */
+    createdAt: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recurrente-js",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "main": "./dist/index.js",
   "types": "./dist/globals.d.ts",
   "exports": {