@abacatepay/types 0.0.3

package/README.md

@@ -0,0 +1,112 @@
+<h1 align="center">AbacatePay API Types</h1>
+<p align="center">Tipagens oficiais e helpers modernos para integrar com a API da AbacatePay.</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@abacatepay/types"><img src="https://img.shields.io/npm/v/@abacatepay/types" /></a>
+  <a href="https://www.npmjs.com/package/@abacatepay/types"><img src="https://img.shields.io/npm/dm/@abacatepay/types" /></a>
+  <img src="https://img.shields.io/badge/built%20for-bun%20%26%20node-0b7" />
+  <img src="https://img.shields.io/badge/types-TypeScript-3178c6" />
+  <img src="https://img.shields.io/badge/license-MIT-lightgray" />
+</p>
+
+<h2 align="center">📦 Instalação</h2>
+
+```bash
+npm install @abacatepay/types
+```
+
+<h2 align="center">Como a AbacatePay API Types documenta</h2>
+
+Antes de tudo, você deve específicar a versão da API que você deseja importar os tipos. Coloque `/v*` no final da importação, sendo `*` a versão que deseja usar:
+
+```ts
+import { APICustomer } from '@abacatepay/types/v1'
+```
+
+Para tipos globais como `API_BASE_URL`, `API_VERSION`, `version` e `Routes`, apenas import normalmente sem a versão.
+
+```ts
+import { version } from '@abacatepay/types'
+```
+
+- Prefixo `API*`
+Representa estruturas gerais da API (Objetos retornados, modelos internos etc.).
+
+- Prefixo `Webhook*`
+Representa payloads recebidos pelos eventos de webhook.
+Documentação: https://docs.abacatepay.com/pages/webhooks
+
+- Prefixo `REST<HTTPMethod>*`
+Tipos usados em requisições diretas à API.
+  - Sufixo Body → corpo enviado na requisição
+  Ex.: `RESTPostCreateNewChargeBody`
+
+  - Sufixo `QueryParams` → parâmetros de query
+  Ex.: `RESTGetCheckQRCodePixStatusQueryParams`
+
+  - Sufixo `Data` → dados retornados pela API
+  Ex.: `RESTGetListCouponsData`
+
+- O pacote **NÃO adiciona tipos além do que existe na documentação oficial**.
+Cada tipo reflete exatamente o que está documentado aqui:
+https://docs.abacatepay.com/pages/introduction
+
+- Campos marcados com `@unstable`
+São campos que não têm definição formal na documentação, mas cujo tipo foi inferido com base nos exemplos oficiais.
+(Ex.: `WebhookWithdrawDoneEvent.billing.kind`)
+
+<h2 align="center">Quickstart</h2>
+
+<p align="center"><strong>Crie um novo cupom</strong></p>
+
+```ts
+import {
+	API_BASE,
+	API_VERSION,
+	type APICoupon,
+	type RESTPostCreateCouponBody,
+	Routes,
+} from '@abacatepay/types/v1';
+
+async function createCoupon(body: RESTPostCreateCouponBody) {
+	const path = `${API_BASE_URL}/${API_VERSION}/${Routes.createCoupon()}`;
+
+	const response = await fetch(path, {
+		method: 'POST',
+		body: JSON.stringify(body),
+	});
+
+	const data: APICoupon = await response.json();
+
+	return data;
+}
+```
+
+<p align="center"><strong>Crie um servidor e escute eventos de Webhooks do Aabacate</strong></p>
+
+```ts
+import { type WebhookEvent, WebhookEventType } from '@abacatepay/types/v1';
+
+Bun.serve({
+    routes: {
+        async '/webhooks/abacate'(request) {
+            const { data, event }: WebhookEvent = await request.json();
+
+            switch (event) {
+                case WebhookEventType.BillingPaid:
+                    console.log(`Um novo pagamento de ${data.payment.amount} foi feito`);
+
+                    break;
+                case WebhookEventType.WithdrawDone:
+                    console.log(`Um novo saque foi feito ${data.transaction.receiptUrl}`);
+
+                    break;
+                case WebhookEventType.WithdrawFailed:
+                    console.log(`O saque com o ID ${data.transaction.id} falhou`);
+            }
+
+            return new Response('OK');
+        },
+    },
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { API_BASE_URL, Routes } from './routes';
+export { API_VERSION, version } from './version';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { API_BASE_URL, Routes } from './routes';
+export { API_VERSION, version } from './version';

package/dist/routes.d.ts

@@ -0,0 +1,68 @@
+import type { RESTGetCheckQRCodePixStatusQueryParams, RESTGetSearchWithdrawQueryParams, RESTPostSimulatePaymentQueryParams } from './v1/rest';
+export declare const API_BASE_URL = "https://api.abacatepay.com/";
+export declare const Routes: {
+    /**
+     * POST - https://api.abacatepay.com/v1/customer/create
+     */
+    createCustomer(): "/customer/create";
+    /**
+     * GET - https://api.abacatepay.com/v1/customer/list
+     */
+    listCustomers(): "/customer/list";
+    /**
+     * POST - https://api.abacatepay.com/v1/billing/create
+     */
+    createCharge(): "/billing/create";
+    /**
+     * GET - https://api.abacatepay.com/v1/billing/list
+     */
+    listCharges(): "/billing/list";
+    /**
+     * POST - https://api.abacatepay.com/v1/pixQrCode/create
+     */
+    createPIXQRCode(): "/pixQrCode/create";
+    /**
+     * POST - https://api.abacatepay.com/v1/pixQrCode/simulate-payment
+     */
+    simulatePayment({ id }: RESTPostSimulatePaymentQueryParams): `/pixQrCode/simulate-payment?id=${string}`;
+    /**
+     * GET - https://api.abacatepay.com/v1/pixQrCode/check
+     */
+    checkQRCodePIXStatus({ id }: RESTGetCheckQRCodePixStatusQueryParams): `/pixQrCode/check?id=${string}`;
+    /**
+     * POST - https://api.abacatepay.com/v1/coupon/create
+     */
+    createCoupon(): "/coupon/create";
+    /**
+     * GET - https://api.abacatepay.com/v1/coupon/list
+     */
+    listCoupons(): "/coupon/list";
+    /**
+     * POST - https://api.abacatepay.com/v1/withdraw/create
+     */
+    createWithdraw(): "/withdraw/create";
+    /**
+     * GET - https://api.abacatepay.com/v1/withdraw/get
+     */
+    getWithdraw({ externalId }: RESTGetSearchWithdrawQueryParams): `/withdraw/get?externalId=${string}`;
+    /**
+     * GET - https://api.abacatepay.com/v1/withdraw/list
+     */
+    listWithdraw(): "/withdraw/list";
+    /**
+     * GET - https://api.abacatepay.com/v1/store/get
+     */
+    store(): "/store/get";
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/mrr
+     */
+    getMRR(): "/public-mrr/mrr";
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/merchant-info
+     */
+    merchant(): "/public-mrr/merchant-info";
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/renevue
+     */
+    renevue(): "/public-mrr/revenue";
+};

package/dist/routes.js

@@ -0,0 +1,99 @@
+export const API_BASE_URL = 'https://api.abacatepay.com/';
+export const Routes = {
+    /**
+     * POST - https://api.abacatepay.com/v1/customer/create
+     */
+    createCustomer() {
+        return '/customer/create';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/customer/list
+     */
+    listCustomers() {
+        return '/customer/list';
+    },
+    /**
+     * POST - https://api.abacatepay.com/v1/billing/create
+     */
+    createCharge() {
+        return '/billing/create';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/billing/list
+     */
+    listCharges() {
+        return '/billing/list';
+    },
+    /**
+     * POST - https://api.abacatepay.com/v1/pixQrCode/create
+     */
+    createPIXQRCode() {
+        return '/pixQrCode/create';
+    },
+    /**
+     * POST - https://api.abacatepay.com/v1/pixQrCode/simulate-payment
+     */
+    simulatePayment({ id }) {
+        return `/pixQrCode/simulate-payment?id=${id}`;
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/pixQrCode/check
+     */
+    checkQRCodePIXStatus({ id }) {
+        return `/pixQrCode/check?id=${id}`;
+    },
+    /**
+     * POST - https://api.abacatepay.com/v1/coupon/create
+     */
+    createCoupon() {
+        return '/coupon/create';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/coupon/list
+     */
+    listCoupons() {
+        return '/coupon/list';
+    },
+    /**
+     * POST - https://api.abacatepay.com/v1/withdraw/create
+     */
+    createWithdraw() {
+        return '/withdraw/create';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/withdraw/get
+     */
+    getWithdraw({ externalId }) {
+        return `/withdraw/get?externalId=${externalId}`;
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/withdraw/list
+     */
+    listWithdraw() {
+        return '/withdraw/list';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/store/get
+     */
+    store() {
+        return '/store/get';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/mrr
+     */
+    getMRR() {
+        return '/public-mrr/mrr';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/merchant-info
+     */
+    merchant() {
+        return '/public-mrr/merchant-info';
+    },
+    /**
+     * GET - https://api.abacatepay.com/v1/public-mrr/renevue
+     */
+    renevue() {
+        return '/public-mrr/revenue';
+    },
+};

package/dist/v1/entities/charge.d.ts

@@ -0,0 +1,134 @@
+import type { APICoupon } from './coupon';
+import type { APICustomer } from './customer';
+/**
+ * https://docs.abacatepay.com/pages/payment/reference#estrutura
+ */
+export interface APICharge {
+    /**
+     * Unique billing ID at AbacatePay.
+     */
+    id: string;
+    /**
+     * Billing frequency. It can be `ONE_TIME` or `MULTIPLE_PAYMENTS`.
+     *
+     * @see {@link PaymentFrequency}
+     */
+    frequency: PaymentFrequency;
+    /**
+     * URL for your customer to make payment for the charge.
+     */
+    url: string;
+    /**
+     * Billing status. Can be `PENDING`, `EXPIRED`, `CANCELLED`, `PAID`, `REFUNDED`.
+     *
+     * @see {@link PaymentStatus}
+     */
+    status: PaymentStatus;
+    /**
+     * Indicates whether the charge was created in a development (true) or production (false) environment.
+     */
+    devMode: boolean;
+    /**
+     * Supported payment types: `PIX` and `CARD` (beta).
+     *
+     * @see {@link PaymentMethod}
+     */
+    methods: PaymentMethod[];
+    /**
+     * List of products included in the charge.
+     */
+    products: APIProduct[];
+    /**
+     * Customer you are billing. Optional. See structure reference [here](https://docs.abacatepay.com/pages/payment/client/reference.mdx).
+     */
+    customer: APICustomer;
+    /**
+     * Object with metadata about the charge.
+     */
+    metadata: {
+        /**
+         * Fee applied by AbacatePay.
+         */
+        fee: number;
+        /**
+         * URL that the customer will be redirected to when clicking the “back” button.
+         */
+        returnUrl: string;
+        /**
+         * URL that the customer will be redirected to when making payment.
+         */
+        completionUrl: string;
+    };
+    /**
+     * Date and time of next charge, or null for one-time charges.
+     */
+    nextBilling: string | null;
+    /**
+     * Whether or not to allow coupons for billing.
+     */
+    allowCoupons: boolean | null;
+    /**
+     * Coupons allowed in billing. Coupons are only considered if `allowCoupons` is true.
+     */
+    coupons: APICoupon[];
+    /**
+     * Charge creation date and time.
+     */
+    createdAt: string;
+    /**
+     * Charge last updated date and time.
+     */
+    updatedAt: string;
+}
+export interface APIProduct {
+    /**
+     * The product id on your system. We use this id to create your product on AbacatePay automatically, so make sure your id is unique.
+     *
+     * @example "prod-1234"
+     */
+    externalId: string;
+    /**
+     * Product name.
+     *
+     * @example "Assinatura de Programa Fitness"
+     */
+    name: string;
+    /**
+     * Quantity of product being purchased.
+     *
+     * @example 2
+     */
+    quantity: number;
+    /**
+     * Price per unit of product in cents. The minimum is 100 (1 BRL).
+     */
+    price: number;
+    /**
+     * Detailed product description.
+     */
+    description?: string;
+}
+/**
+ * https://docs.abacatepay.com/pages/payment/reference#atributos
+ */
+export declare enum PaymentStatus {
+    Pending = "PENDING",
+    Expired = "EXPIRED",
+    Cancelled = "CANCELLED",
+    Paid = "PAID",
+    Refunded = "REFUNDED"
+}
+/**
+ * https://docs.abacatepay.com/pages/payment/create#body-methods
+ */
+export declare enum PaymentMethod {
+    Pix = "PIX",
+    Card = "CARD"
+}
+/**
+ * https://docs.abacatepay.com/pages/payment/create#body-frequency
+ */
+export declare enum PaymentFrequency {
+    OneTime = "ONE_TIME",
+    Multiple = "MULTIPLE_PAYMENTS"
+}

package/dist/v1/entities/charge.js

@@ -0,0 +1,27 @@
+/**
+ * https://docs.abacatepay.com/pages/payment/reference#atributos
+ */
+export var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus["Pending"] = "PENDING";
+    PaymentStatus["Expired"] = "EXPIRED";
+    PaymentStatus["Cancelled"] = "CANCELLED";
+    PaymentStatus["Paid"] = "PAID";
+    PaymentStatus["Refunded"] = "REFUNDED";
+})(PaymentStatus || (PaymentStatus = {}));
+/**
+ * https://docs.abacatepay.com/pages/payment/create#body-methods
+ */
+export var PaymentMethod;
+(function (PaymentMethod) {
+    PaymentMethod["Pix"] = "PIX";
+    PaymentMethod["Card"] = "CARD";
+})(PaymentMethod || (PaymentMethod = {}));
+/**
+ * https://docs.abacatepay.com/pages/payment/create#body-frequency
+ */
+export var PaymentFrequency;
+(function (PaymentFrequency) {
+    PaymentFrequency["OneTime"] = "ONE_TIME";
+    PaymentFrequency["Multiple"] = "MULTIPLE_PAYMENTS";
+})(PaymentFrequency || (PaymentFrequency = {}));

package/dist/v1/entities/coupon.d.ts

@@ -0,0 +1,56 @@
+/**
+ * https://docs.abacatepay.com/pages/coupon/reference#estrutura
+ */
+export interface APICoupon {
+    /**
+     * Unique coupon code that your customers will use to apply the discount.
+     */
+    id: string;
+    /**
+     * Type of discount applied by the coupon.
+     */
+    discountKind: CouponDiscountKind;
+    /**
+     * Discount amount. For `PERCENTAGE` use numbers from 1-100 (ex: 10 = 10%). For `FIXED` use the value in cents (ex: 500 = R$5.00).
+     */
+    discount: number;
+    /**
+     * Limit on the number of times the coupon can be used. Use `-1` for unlimited coupons or a specific number to limit usage.
+     */
+    maxRedeems: number;
+    /**
+     * Counter of how many times the coupon has been used by customers.
+     */
+    redeemsCount: 0;
+    /**
+     * Coupon status.
+     */
+    status: 'ACTIVE' | 'DELETED' | 'DISABLED';
+    /**
+     * Indicates whether the coupon was created in a development (true) or production (false) environment.
+     */
+    devMode: boolean;
+    /**
+     * Internal description of the coupon for your organization and control.
+     */
+    notes?: string;
+    /**
+     * Coupon creation date and time.
+     */
+    createdAt: string;
+    /**
+     * Coupon last updated date and time.
+     */
+    updatedAt: string;
+    /**
+     * Object to store additional information about the coupon, such as campaign, category, or other data relevant to your organization.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * https://docs.abacatepay.com/pages/coupon/reference#atributos
+ */
+export declare enum CouponDiscountKind {
+    Percentage = "PERCENTAGE",
+    Fixed = "FIXED"
+}

package/dist/v1/entities/coupon.js

@@ -0,0 +1,8 @@
+/**
+ * https://docs.abacatepay.com/pages/coupon/reference#atributos
+ */
+export var CouponDiscountKind;
+(function (CouponDiscountKind) {
+    CouponDiscountKind["Percentage"] = "PERCENTAGE";
+    CouponDiscountKind["Fixed"] = "FIXED";
+})(CouponDiscountKind || (CouponDiscountKind = {}));

package/dist/v1/entities/customer.d.ts

@@ -0,0 +1,30 @@
+/**
+ * https://docs.abacatepay.com/pages/client/reference#estrutura
+ */
+export interface APICustomer {
+    /**
+     * Unique customer identifier.
+     */
+    id: string;
+    /**
+     * Customer data.
+     */
+    metadata: {
+        /**
+         * Customer's full name.
+         */
+        name: string;
+        /**
+         * Customer's email.
+         */
+        email: string;
+        /**
+         * Customer's CPF or CNPJ.
+         */
+        taxId: string;
+        /**
+         * Customer's cell phone.
+         */
+        cellphone: string;
+    };
+}

package/dist/v1/entities/customer.js

@@ -0,0 +1 @@
+export {};

package/dist/v1/entities/pix.d.ts

@@ -0,0 +1,57 @@
+import type { PaymentStatus } from './charge';
+export interface APIQRCodePIX {
+    /**
+     * Unique billing identifier.
+     */
+    id: string;
+    /**
+     * Charge amount in cents (e.g. 4000 = R$40.00).
+     */
+    amount: number;
+    /**
+     * Billing status. Can be `PENDING`, `EXPIRED`, `CANCELLED`, `PAID`, `REFUNDED`.
+     *
+     * @see {@link PaymentStatus}
+     */
+    status: PaymentStatus;
+    /**
+     * Indicates whether the charge is in a testing (true) or production (false) environment.
+     */
+    devMode: boolean;
+    /**
+     * Payment method.
+     */
+    method: 'PIX';
+    /**
+     * PIX code (copy-and-paste) for payment.
+     */
+    brCode: string;
+    /**
+     * PIX code in Base64 format (Useful for displaying in images).
+     */
+    brCodeBase64: string;
+    /**
+     * Platform fee in cents. Example: 80 means R$0.80.
+     */
+    platformFee: number;
+    /**
+     * Payment description.
+     */
+    description: string;
+    /**
+     * Payment metadata.
+     */
+    metadata: Record<string, unknown>;
+    /**
+     * QRCode PIX creation date and time.
+     */
+    createdAt: string;
+    /**
+     * QRCode PIX last updated date and time.
+     */
+    updatedAt: string;
+    /**
+     * QRCode expiration date and time.
+     */
+    expiresAt: string;
+}

package/dist/v1/entities/pix.js

@@ -0,0 +1 @@
+export {};

package/dist/v1/entities/store.d.ts

@@ -0,0 +1,36 @@
+/**
+ * https://docs.abacatepay.com/pages/store/reference#estrutura
+ */
+export interface APIStore {
+    /**
+     * Unique identifier for your store on AbacatePay.
+     */
+    id: string;
+    /**
+     * Name of your store/company.
+     *
+     * @example "Minha Loja Online"
+     */
+    name: string;
+    /**
+     * Object containing information about your account balances.
+     *
+     * @remarks All balance values ​​are returned in cents. To convert to Reais, divide by 100. For example: 15000 cents = R$150.00
+     */
+    balance: {
+        /**
+         * Balance available for withdrawal in cents.
+         */
+        available: number;
+        /**
+         * Balance pending confirmation in cents.
+         */
+        pending: number;
+        /**
+         * Balance blocked in disputes in cents.
+         *
+         * @remarks The blocked balance represents amounts that are in dispute or under review. These amounts are not available for withdrawal until the situation is resolved.
+         */
+        blocked: number;
+    };
+}

package/dist/v1/entities/store.js

@@ -0,0 +1 @@
+export {};

package/dist/v1/entities/withdraw.d.ts

@@ -0,0 +1,55 @@
+/**
+ * https://docs.abacatepay.com/pages/withdraw/reference#estrutura
+ */
+export interface APIWithdraw {
+    /**
+     * Unique ID of the AbacatePay withdrawal transaction.
+     */
+    id: string;
+    /**
+     * Current status of the withdrawal transaction.
+     */
+    status: WithdrawStatus;
+    /**
+     * Indicates whether the loot was created in a development environment (sandbox) or production. AbacatePay currently only supports withdrawals in production.
+     */
+    devMode: boolean;
+    /**
+     * Withdrawal transaction receipt URL.
+     */
+    receiptUrl: string;
+    /**
+     * Transaction type. It will always be 'WITHDRAW'.
+     */
+    kind: 'WITHDRAW';
+    /**
+     * Withdrawal value in cents.
+     */
+    amount: number;
+    /**
+     * Platform fee charged for withdrawal in cents.
+     */
+    platformFee: number;
+    /**
+     * Unique identifier of the withdrawal in your system. Optional.
+     */
+    externalId?: string;
+    /**
+     * Date and time of withdrawal creation.
+     */
+    createdAt: string;
+    /**
+     * Date and time of last withdrawal update.
+     */
+    updatedAt: string;
+}
+/**
+ * https://docs.abacatepay.com/pages/withdraw/reference#atributos
+ */
+export declare enum WithdrawStatus {
+    Pending = "PENDING",
+    Expired = "EXPIRED",
+    Cancelled = "CANCELLED",
+    Complete = "COMPLETE",
+    Refunded = "REFUNDED"
+}

package/dist/v1/entities/withdraw.js

@@ -0,0 +1,11 @@
+/**
+ * https://docs.abacatepay.com/pages/withdraw/reference#atributos
+ */
+export var WithdrawStatus;
+(function (WithdrawStatus) {
+    WithdrawStatus["Pending"] = "PENDING";
+    WithdrawStatus["Expired"] = "EXPIRED";
+    WithdrawStatus["Cancelled"] = "CANCELLED";
+    WithdrawStatus["Complete"] = "COMPLETE";
+    WithdrawStatus["Refunded"] = "REFUNDED";
+})(WithdrawStatus || (WithdrawStatus = {}));

package/dist/v1/index.d.ts

@@ -0,0 +1,8 @@
+export * from './entities/charge';
+export * from './entities/coupon';
+export * from './entities/customer';
+export * from './entities/pix';
+export * from './entities/store';
+export * from './entities/withdraw';
+export * from './rest';
+export * from './webhook';

package/dist/v1/index.js

@@ -0,0 +1,8 @@
+export * from './entities/charge';
+export * from './entities/coupon';
+export * from './entities/customer';
+export * from './entities/pix';
+export * from './entities/store';
+export * from './entities/withdraw';
+export * from './rest';
+export * from './webhook';

package/dist/v1/rest.d.ts

@@ -0,0 +1,367 @@
+import type { APICharge, APICoupon, APICustomer, APIQRCodePIX, APIStore, APIWithdraw, CouponDiscountKind, PaymentFrequency, PaymentMethod, PaymentStatus } from '.';
+type APIResponse<Data> = {
+    /**
+     * The data of the response
+     */
+    data: Data;
+    error: null;
+} | {
+    data: null;
+    /**
+     * Error message returned from the API
+     */
+    error: string;
+};
+/**
+ * https://api.abacatepay.com/v1/customer/create
+ *
+ * @reference https://docs.abacatepay.com/pages/client/create
+ */
+export type RESTPostCreateCustomerBody = APICustomer['metadata'];
+/**
+ * https://api.abacatepay.com/v1/customer/create
+ *
+ * @reference https://docs.abacatepay.com/pages/client/create
+ */
+export type RESTPostCreateCustomerData = APIResponse<APICustomer>;
+/**
+ * https://api.abacatepay.com/v1/billing/create
+ *
+ * @reference https://docs.abacatepay.com/pages/payment/create
+ */
+export interface RESTPostCreateNewChargeBody {
+    /**
+     * Payment methods that will be used. Currently, only `PIX` is supported, `CARD` is in beta.
+     *
+     * @see {@link PaymentMethod}
+     */
+    methods: PaymentMethod[];
+    /**
+     * Defines the type of billing frequency. For one-time charges, use `ONE_TIME`. For charges that can be paid more than once, use `MULTIPLE_PAYMENTS`.
+     *
+     * @see {@link PaymentFrequency}
+     */
+    frequency: PaymentFrequency;
+    /**
+     * List of products your customer is paying for.
+     */
+    products: {
+        /**
+         * The product id on your system. We use this id to create your product on AbacatePay automatically, so make sure your id is unique.
+         *
+         * @example "prod-1234"
+         */
+        externalId: string;
+        /**
+         * Product name.
+         *
+         * @example "Assinatura de Programa Fitness"
+         */
+        name: string;
+        /**
+         * Quantity of product being purchased.
+         *
+         * @example 2
+         */
+        quantity: number;
+        /**
+         * Price per unit of product in cents. The minimum is 100 (1 BRL).
+         */
+        price: number;
+        /**
+         * Detailed product description.
+         */
+        description?: string;
+    }[];
+    /**
+     * URL to redirect the customer if they click on the "Back" option.
+     */
+    returnUrl: string;
+    /**
+     * URL to redirect the customer when payment is completed.
+     */
+    completionUrl: string;
+    /**
+     * The ID of a customer already registered in your store.
+     */
+    customerId?: string;
+    /**
+     * /**
+     * Your customer's data to create it.
+     * The customer object is not mandatory, but when entering any `customer` information, all `name`, `cellphone`, `email` and `taxId` fields are mandatory.
+     */
+    customer?: APICustomer['metadata'];
+    /**
+     * If true coupons can be used in billing.
+     *
+     * @default false
+     */
+    allowCoupons?: boolean;
+    /**
+     * List of coupons available for resem used with billing (0-50 max.).
+     */
+    coupons?: string[];
+    /**
+     * If you have a unique identifier for your billing application, completely optional.
+     */
+    externalId?: string;
+    /**
+     * Optional billing metadata.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * https://api.abacatepay.com/v1/billing/create
+ *
+ * @reference https://docs.abacatepay.com/pages/payment/create
+ */
+export type RESTPostCreateNewChargeData = APIResponse<APICharge>;
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/create
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/create
+ */
+export interface RESTPostCreateQRCodePixBody extends Pick<RESTPostCreateNewChargeBody, 'customer' | 'metadata'> {
+    /**
+     * Charge amount in cents.
+     */
+    amount: number;
+    /**
+     * Billing expiration time in seconds.
+     */
+    expiresIn?: number;
+    /**
+     * Message that will appear when paying the PIX.
+     */
+    description?: string;
+}
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/create
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/create
+ */
+export type RESTPostCreateQRCodePixData = APIResponse<APIQRCodePIX>;
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/simulate-payment
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/simulate-payment
+ */
+export interface RESTPostSimulatePaymentQueryParams {
+    /**
+     * QRCode Pix ID.
+     */
+    id: string;
+}
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/simulate-payment
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/simulate-payment
+ */
+export type RESTPostSimulatePaymentData = APIResponse<APIQRCodePIX>;
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/check
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/check
+ */
+export interface RESTGetCheckQRCodePixStatusQueryParams {
+    /**
+     * QRCode Pix ID.
+     */
+    id: string;
+}
+/**
+ * https://api.abacatepay.com/v1/pixQrCode/check
+ *
+ * @reference https://docs.abacatepay.com/pages/pix-qrcode/check
+ */
+export type RESTGetCheckQRCodePixStatusData = APIResponse<{
+    /**
+     * QRCode Pix expiration date.
+     */
+    expiresAt: string;
+    /**
+     * Information about the progress of QRCode Pix.
+     */
+    status: PaymentStatus;
+}>;
+/**
+ * https://api.abacatepay.com/v1/billing/list
+ *
+ * @reference https://docs.abacatepay.com/pages/payment/list
+ */
+export type RESTGetListBillingsData = APIResponse<APICharge[]>;
+/**
+ * https://api.abacatepay.com/v1/customer/list
+ *
+ * @reference https://docs.abacatepay.com/pages/client/list
+ */
+export type RESTGetListCustomersData = APIResponse<APICustomer[]>;
+/**
+ * https://api.abacatepay.com/v1/coupon/create
+ *
+ * @reference https://docs.abacatepay.com/pages/coupon/create
+ */
+export interface RESTPostCreateCouponBody {
+    /**
+     * Coupon data.
+     */
+    data: {
+        /**
+         * Unique coupon identifier.
+         *
+         * @example "DEYVIN_20"
+         */
+        code: string;
+        /**
+         * Discount amount to be applied.
+         */
+        discount: number;
+        /**
+         * Type of discount applied, percentage or fixed.
+         *
+         * @see {@link CouponDiscountKind}
+         */
+        discountKind: CouponDiscountKind;
+        /**
+         * Coupon description
+         */
+        notes?: string;
+        /**
+         * Number of times the coupon can be redeemed. -1 means this coupon can be redeemed without limits.
+         *
+         * @default -1
+         */
+        maxRedeems?: number;
+        /**
+         * Key value object for coupon metadata.
+         */
+        metadata?: Record<string, unknown>;
+    };
+}
+/**
+ * https://api.abacatepay.com/v1/coupon/create
+ *
+ * @reference https://docs.abacatepay.com/pages/coupon/create
+ */
+export type RESTPostCreateCouponData = APIResponse<APICoupon>;
+/**
+ * https://api.abacatepay.com/v1/withdraw/create
+ *
+ * @reference https://docs.abacatepay.com/pages/withdraw/create
+ */
+export interface RESTPostCreateNewWithdrawBody {
+    /**
+     * Unique identifier of the withdrawal in your system.
+     */
+    externalId: string;
+    /**
+     * Withdrawal method available.
+     */
+    method: 'PIX';
+    /**
+     * Withdrawal value in cents (Min 350).
+     */
+    amount: number;
+    /**
+     * PIX key data to receive the withdrawal.
+     */
+    pix: {
+        /**
+         * PIX key type.
+         */
+        type: 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'RANDOM' | 'BR_CODE';
+        /**
+         * PIX key value.
+         */
+        key: string;
+    };
+    /**
+     * Optional description of the withdrawal.
+     */
+    description?: string;
+}
+/**
+ * https://api.abacatepay.com/v1/withdraw/create
+ *
+ * @reference https://docs.abacatepay.com/pages/withdraw/create
+ */
+export type RESTPostCreateNewWithdrawData = APIResponse<APIWithdraw>;
+/**
+ * https://api.abacatepay.com/v1/withdraw/get
+ *
+ * @reference https://docs.abacatepay.com/pages/withdraw/get
+ */
+export interface RESTGetSearchWithdrawQueryParams {
+    /**
+     * Unique identifier of the withdrawal in your system.
+     */
+    externalId: string;
+}
+/**
+ * https://api.abacatepay.com/v1/public-mrr/revenue
+ *
+ * @reference https://docs.abacatepay.com/pages/trustMRR/list
+ */
+export interface RESTGetRevenueByPeriodQueryParams {
+    /**
+     * Period start date (YYYY-MM-DD format).
+     */
+    startDate: string;
+    /**
+     * Period end date (YYYY-MM-DD format).
+     */
+    endDate: string;
+}
+/**
+ * https://api.abacatepay.com/v1/public-mrr/merchant-info
+ *
+ * @reference https://docs.abacatepay.com/pages/trustMRR/get
+ */
+export type RESTGetMerchantData = APIResponse<{
+    /**
+     * Store name.
+     */
+    name: string;
+    /**
+     * Store website.
+     */
+    website: string;
+    /**
+     * Store creation date.
+     */
+    createdAt: string;
+}>;
+/**
+ * https://api.abacatepay.com/v1/public-mrr/mrr
+ *
+ * @reference https://docs.abacatepay.com/pages/trustMRR/mrr
+ */
+export type RESTGetMRRData = APIResponse<{
+    /**
+     * Monthly recurring revenue in cents. Value 0 indicates that there is no recurring revenue at the moment.
+     */
+    mrr: number;
+    /**
+     * Total active subscriptions. Value 0 indicates that there are no currently active subscriptions.
+     */
+    totalActiveSubscriptions: number;
+}>;
+/**
+ * https://api.abacatepay.com/v1/store/get
+ *
+ * @reference https://docs.abacatepay.com/pages/store/get
+ */
+export type RESTGetStoreDetailsData = APIResponse<APIStore>;
+/**
+ * https://api.abacatepay.com/v1/withdraw/list
+ *
+ * @reference https://docs.abacatepay.com/pages/withdraw/list
+ */
+export type RESTGetListWithdrawsData = APIResponse<APIWithdraw[]>;
+/**
+ * https://api.abacatepay.com/v1/coupon/list
+ *
+ * @reference https://docs.abacatepay.com/pages/coupon/list
+ */
+export type RESTGetListCouponsData = APIResponse<APICoupon[]>;
+export {};

package/dist/v1/rest.js

@@ -0,0 +1 @@
+export {};

package/dist/v1/webhook.d.ts

@@ -0,0 +1,161 @@
+import type { APIProduct, PaymentFrequency, PaymentMethod, PaymentStatus } from './entities/charge';
+import type { APICustomer } from './entities/customer';
+import type { APIWithdraw, WithdrawStatus } from './entities/withdraw';
+export interface BaseWebhookEvent<Type extends WebhookEventType, Data extends object> {
+    /**
+     * The data received in the event.
+     */
+    data: Data;
+    /**
+     * Unique identifier for the webhook.
+     */
+    id: string;
+    /**
+     * This field identifies the type of event received.
+     */
+    event: Type;
+    /**
+     * Indicates whether the event occurred in the development environment.
+     */
+    devMode: boolean;
+}
+/**
+ * https://docs.abacatepay.com/pages/webhooks#withdraw-failed
+ */
+export type WebhookWithdrawFailedEvent = BaseWebhookEvent<WebhookEventType.WithdrawFailed, {
+    /**
+     * Transaction data.
+     */
+    transaction: Omit<APIWithdraw, 'status'> & {
+        /**
+         * Status of the withdraw. Always `WithdrawStatus.Cancelled`.
+         *
+         * @see {@link WithdrawStatus.Cancelled}
+         */
+        status: WithdrawStatus.Cancelled;
+    };
+}>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks#withdraw-done
+ */
+export type WebhookWithdrawDoneEvent = BaseWebhookEvent<WebhookEventType.WithdrawDone, {
+    /**
+     * Transaction data.
+     */
+    transaction: Omit<APIWithdraw, 'status'> & {
+        /**
+         * Status of the withdraw. Always `WithdrawStatus.Complete`.
+         *
+         * @see {@link WithdrawStatus.Complete}
+         */
+        status: WithdrawStatus.Complete;
+    };
+}>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks#billing-paid
+ */
+export type WebhookBillingPaidEvent = BaseWebhookEvent<WebhookEventType.BillingPaid, {
+    /**
+     * Payment data.
+     */
+    payment: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * The fee charged by AbacatePay.
+         */
+        fee: 80;
+        /**
+         * Payment method.
+         *
+         * @see {@link PaymentMethod}
+         */
+        method: PaymentMethod;
+    };
+} & ({
+    pixQrCode: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * Unique billing identifier.
+         */
+        id: string;
+        /**
+         * Kind of the payment
+         */
+        kind: 'PIX';
+        /**
+         * Billing status, can only be `PAID` here
+         *
+         * @see {@link PaymentStatus.Paid}
+         */
+        status: PaymentStatus.Paid;
+    };
+} | {
+    billing: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * Counpons used in the billing.
+         */
+        couponsUsed: string[];
+        /**
+         * Customer of the charge.
+         */
+        customer: APICustomer;
+        /**
+         * Payment frequency.
+         *
+         * @see {@link PaymentFrequency}
+         */
+        frequency: PaymentFrequency;
+        /**
+         * Unique billing identifier.
+         */
+        id: string;
+        /**
+         * Payment methods?
+         *
+         * @unstable
+         */
+        kind: PaymentMethod[];
+        /**
+         * Charge amount in cents.
+         *
+         * @unstable
+         */
+        paidAmount: number;
+        /**
+         * Products used in the billing.
+         */
+        products: (Pick<APIProduct, 'quantity' | 'externalId'> & {
+            id: string;
+        })[];
+        /**
+         * Status of the payment. Always `PaymentStatus.Paid`.
+         *
+         * @see {@link PaymentStatus.Paid}
+         */
+        status: PaymentStatus.Paid;
+    };
+})>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ *
+ * Any field that contains the tag "@unstable" means that the field is an assumption, it is uncertain (Since AbacatePay does not provide any information about).
+ */
+export type WebhookEvent = WebhookWithdrawDoneEvent | WebhookWithdrawFailedEvent | WebhookBillingPaidEvent;
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ */
+export declare enum WebhookEventType {
+    WithdrawFailed = "withdraw.failed",
+    WithdrawDone = "withdraw.done",
+    BillingPaid = "billing.paid"
+}

package/dist/v1/webhook.js

@@ -0,0 +1,9 @@
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ */
+export var WebhookEventType;
+(function (WebhookEventType) {
+    WebhookEventType["WithdrawFailed"] = "withdraw.failed";
+    WebhookEventType["WithdrawDone"] = "withdraw.done";
+    WebhookEventType["BillingPaid"] = "billing.paid";
+})(WebhookEventType || (WebhookEventType = {}));

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version: "0.0.3";
+export declare const API_VERSION: "1";

package/dist/version.js

@@ -0,0 +1,4 @@
+// Auto-generated in build (DO NOT edit)
+export const version = '0.0.3';
+// Current AbacatePay API version - https://docs.abacatepay.com/pages/introduction
+export const API_VERSION = '1';

package/package.json

@@ -0,0 +1,44 @@
+{
+	"version": "0.0.3",
+	"name": "@abacatepay/types",
+	"description": "Abacate Pay API typings that are always up to date.",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		},
+		"./v1": {
+			"import": "./dist/v1/index.js",
+			"types": "./dist/v1/index.d.ts"
+		}
+	},
+	"typesVersions": {
+		"*": {
+			"v1": [
+				"dist/v1/index.d.ts"
+			]
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"gen:version": "bun run scripts/version.ts",
+		"build": "bun run gen:version && tsc",
+		"prepublishOnly": "bun run build",
+		"fmt": "bunx biome check --write . && clear"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.3.8",
+		"typescript": "^5.9.3"
+	},
+	"keywords": [
+		"api",
+		"abacatepay",
+		"types",
+		"typescript"
+	]
+}