@abacatepay/types 0.0.4 → 2.0.1

package/README.md

@@ -1,29 +1,37 @@
-<h1 align="center">AbacatePay API Types</h1>
-<p align="center">Tipagens oficiais e helpers modernos para integrar com a API da AbacatePay.</p>
+<div align="center">
 
-<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>
+## AbacatePay API Types
 
-<h2 align="center">📦 Instalação</h2>
+Tipagens oficiais e helpers modernos para integrar com a API da AbacatePay.
+
+<img src="https://res.cloudinary.com/dkok1obj5/image/upload/v1767631413/avo_clhmaf.png" width="100%" alt="AbacatePay Open Source"/>
+
+## Instalação
+
+Use com o seu *package manager* favorito
+
+</div>
 
 ```bash
+bun add @abacatepay/types
+pnpm add @abacatepay/types
 npm install @abacatepay/types
 ```
 
-<h2 align="center">Como a AbacatePay API Types documenta</h2>
+<div align="center">
+
+## Como a AbacatePay API Types documenta
 
 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:
 
+</div>
+
 ```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.
+
+<p align="center">Para tipos globais como <code>API_BASE_URL</code>, <code>API_VERSION</code>, <code>version</code> e <code>Routes</code>, apenas import normalmente sem a versão.</p>
 
 ```ts
 import { version } from '@abacatepay/types'
@@ -69,7 +77,7 @@ import {
 } from '@abacatepay/types/v1';
 
 async function createCoupon(body: RESTPostCreateCouponBody) {
-	const path = `${API_BASE_URL}/${API_VERSION}/${Routes.createCoupon()}`;
+	const path = `${API_BASE_URL}/${API_VERSION}/${Routes.coupon.create}`;
 
 	const response = await fetch(path, {
 		method: 'POST',
@@ -110,3 +118,6 @@ Bun.serve({
     },
 });
 ```
+
+<p align="center">Feito com 🥑 pela equipe AbacatePay</br>
+Open source, de verdade.</p>

package/dist/index.d.ts

@@ -1,2 +1,7 @@
-export { API_BASE_URL, Routes } from './routes';
 export { API_VERSION, version } from './version';
+/**
+ * Base URL for the AbacatePay API (Version not included).
+ *
+ * @see {@link https://docs.abacatepay.com/}
+ */
+export declare const API_BASE_URL = "https://api.abacatepay.com/";

package/dist/index.js

@@ -1,2 +1,7 @@
-export { API_BASE_URL, Routes } from './routes';
 export { API_VERSION, version } from './version';
+/**
+ * Base URL for the AbacatePay API (Version not included).
+ *
+ * @see {@link https://docs.abacatepay.com/}
+ */
+export const API_BASE_URL = 'https://api.abacatepay.com/';

package/dist/{routes.d.ts → v1/routes.d.ts}

@@ -1,5 +1,4 @@
-import type { RESTGetCheckQRCodePixStatusQueryParams, RESTGetSearchWithdrawQueryParams, RESTPostSimulatePaymentQueryParams } from './v1/rest';
-export declare const API_BASE_URL = "https://api.abacatepay.com/";
+import type { RESTGetCheckQRCodePixStatusQueryParams, RESTGetSearchWithdrawQueryParams, RESTPostSimulatePaymentQueryParams } from './rest';
 export declare const Routes: {
     readonly customer: {
         /**

package/dist/{routes.js → v1/routes.js}

@@ -1,4 +1,3 @@
-export const API_BASE_URL = 'https://api.abacatepay.com/';
 export const Routes = {
     customer: {
         /**

package/dist/v2/entities/checkout.d.ts

@@ -0,0 +1,106 @@
+/**
+ * https://docs.abacatepay.com/pages/checkouts/reference#estrutura
+ */
+export interface APICheckout {
+    /**
+     * Unique billing identifier.
+     */
+    id: string;
+    /**
+     * Total amount to be paid in cents.
+     */
+    amount: number;
+    /**
+     * Amount already paid in cents.`null` if it has not yet been paid.
+     */
+    paidAmount: number | null;
+    /**
+     * Bill ID in your system.
+     */
+    externalId: string | null;
+    /**
+     * URL where the user can complete the payment.
+     */
+    url: string;
+    /**
+     * List of items in billing.
+     */
+    items: {
+        /**
+         * Product ID.
+         */
+        id: string;
+        /**
+         * Item quantity.
+         */
+        quantity: number;
+    }[];
+    /**
+     * 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;
+    /**
+     * Additial metadata for the charge.
+     */
+    metadata?: Record<string, object>;
+    /**
+     * 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;
+    /**
+     * Payment receipt URL.
+     */
+    receiptUrl: string | null;
+    /**
+     * Coupons allowed in billing.
+     */
+    coupons: string[];
+    /**
+     * Customer ID associated with the charge.
+     */
+    customerId: string | null;
+    /**
+     * Charge creation date and time.
+     */
+    createdAt: string;
+    /**
+     * Charge last updated date and time.
+     */
+    updatedAt: 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
+ *
+ * @deprecated
+ */
+export declare enum PaymentFrequency {
+    OneTime = "ONE_TIME",
+    Multiple = "MULTIPLE_PAYMENTS"
+}

package/dist/v2/entities/checkout.js

@@ -0,0 +1,29 @@
+/**
+ * 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
+ *
+ * @deprecated
+ */
+export var PaymentFrequency;
+(function (PaymentFrequency) {
+    PaymentFrequency["OneTime"] = "ONE_TIME";
+    PaymentFrequency["Multiple"] = "MULTIPLE_PAYMENTS";
+})(PaymentFrequency || (PaymentFrequency = {}));

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

@@ -0,0 +1,63 @@
+/**
+ * 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;
+    /**
+     * Coupon status.
+     */
+    status: CouponStatus;
+    /**
+     * Limit on the number of times the coupon can be used. Use `-1` for unlimited coupons or a specific number to limit usage.
+     *
+     * @default 10
+     */
+    maxRedeems: number;
+    /**
+     * Counter of how many times the coupon has been used by customers.
+     */
+    redeemsCount: 0;
+    /**
+     * 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, object>;
+}
+/**
+ * https://docs.abacatepay.com/pages/coupon/reference#atributos
+ */
+export declare enum CouponDiscountKind {
+    Percentage = "PERCENTAGE",
+    Fixed = "FIXED"
+}
+export declare enum CouponStatus {
+    Active = "ACTIVE",
+    Inactive = "INACTIVE",
+    Expired = "EXPIRED"
+}

package/dist/v2/entities/coupon.js

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

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

@@ -0,0 +1,41 @@
+/**
+ * https://docs.abacatepay.com/pages/client/reference#estrutura
+ */
+export interface APICustomer {
+    /**
+     * Unique customer identifier.
+     */
+    id: string;
+    /**
+     * Indicates whether the client was created in a testing environment.
+     */
+    devMode: boolean;
+    /**
+     * Customer country.
+     */
+    country: string;
+    /**
+     * Customer's full name.
+     */
+    name: string;
+    /**
+     * Customer's email.
+     */
+    email: string;
+    /**
+     * Customer's CPF or CNPJ.
+     */
+    taxId: string;
+    /**
+     * Customer's cell phone.
+     */
+    cellphone: string;
+    /**
+     * Customer zip code.
+     */
+    zipCode: string;
+    /**
+     * Additional customer metadata.
+     */
+    metadata?: Record<string, object>;
+}

package/dist/v2/entities/customer.js

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

package/dist/v2/entities/payout.d.ts

@@ -0,0 +1,51 @@
+/**
+ * https://docs.abacatepay.com/pages/payouts/reference
+ */
+export interface APIPayout {
+    /**
+     * Unique transaction identifier.
+     */
+    id: string;
+    /**
+     * Current transaction status.
+     */
+    status: PayoutStatus;
+    /**
+     * Indicates whether the transaction was created in a testing environment.
+     */
+    devMode: boolean;
+    /**
+     * Transaction proof URL.
+     */
+    receiptUrl: string | null;
+    /**
+     * Payout value in cents.
+     */
+    amount: number;
+    /**
+     * Platform fee in cents.
+     */
+    platformFee: number;
+    /**
+     * External transaction identifier.
+     */
+    externalId: string;
+    /**
+     * Transaction creation date.
+     */
+    createdAt: string;
+    /**
+     * Transaction update date.
+     */
+    updatedAt: string;
+}
+/**
+ * https://docs.abacatepay.com/pages/payouts/reference#atributos
+ */
+export declare enum PayoutStatus {
+    Pending = "PENDING",
+    Expired = "EXPIRED",
+    Cancelled = "CANCELLED",
+    Complete = "COMPLETE",
+    Refunded = "REFUNDED"
+}

package/dist/v2/entities/payout.js

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

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

@@ -0,0 +1,48 @@
+import type { PaymentStatus } from './checkout';
+/**
+ * https://docs.abacatepay.com/pages/transparents/reference
+ */
+export interface APIQRCodePIX {
+    /**
+     * Unique QRCode PIX identifier.
+     */
+    id: string;
+    /**
+     * Charge amount in cents (e.g. 4000 = R$40.00).
+     */
+    amount: number;
+    /**
+     * PIX 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;
+    /**
+     * 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;
+    /**
+     * 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/v2/entities/pix.js

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

package/dist/v2/entities/products.d.ts

@@ -0,0 +1,49 @@
+/**
+ * https://docs.abacatepay.com/pages/products/reference#estrutura
+ */
+export interface APIProduct {
+    /**
+     * The ID of your product.
+     */
+    id: string;
+    /**
+     * Unique product identifier in your system.
+     */
+    externalId: string;
+    /**
+     * Product name.
+     */
+    name: string;
+    /**
+     * Product price in cents.
+     */
+    price: number;
+    /**
+     * Product currency.
+     */
+    currency: string;
+    /**
+     * Product status
+     */
+    status: ProductStatus;
+    /**
+     * Indicates whether the product was created in a testing environment.
+     */
+    devMode: boolean;
+    /**
+     * Product creation date.
+     */
+    createdAt: string;
+    /**
+     * Product update date.
+     */
+    updatedAt: string;
+    /**
+     * Product description.
+     */
+    description: string | null;
+}
+export declare enum ProductStatus {
+    Active = "ACTIVE",
+    Inactive = "INACTIVE"
+}

package/dist/v2/entities/products.js

@@ -0,0 +1,5 @@
+export var ProductStatus;
+(function (ProductStatus) {
+    ProductStatus["Active"] = "ACTIVE";
+    ProductStatus["Inactive"] = "INACTIVE";
+})(ProductStatus || (ProductStatus = {}));

package/dist/v2/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/v2/entities/store.js

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

package/dist/v2/entities/subscription.d.ts

@@ -0,0 +1,110 @@
+import type { PaymentMethod } from './checkout';
+/**
+ * https://docs.abacatepay.com/pages/subscriptions/reference#estrutura
+ */
+export interface APISubscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+    /**
+     * The subscription value in cents.
+     */
+    amount: number;
+    /**
+     * Subscription currenty.
+     */
+    currency: string;
+    /**
+     * Subscription name.
+     */
+    name: string;
+    /**
+     * Subscription description.
+     */
+    description: string;
+    /**
+     * Unique identifier of the subscription on your system.
+     */
+    externalId: string;
+    /**
+     * Indicates whether the signature was created in a testing environment.
+     */
+    devMode: boolean;
+    /**
+     * Subscription creation date.
+     */
+    createdAt: string;
+    /**
+     * Subscription update date.
+     */
+    updatedAt: string;
+    /**
+     * Payment method for the subscription.
+     */
+    method: PaymentMethod;
+    /**
+     * Status of the subscription.
+     */
+    status: SubscriptionStatus;
+    /**
+     * Billing frequency configuration.
+     */
+    frequency: {
+        /**
+         * Subscription billing cycle.
+         */
+        cycle: 'MONTHLY' | 'YEARLY' | 'WEEKLY' | 'DAILY';
+        /**
+         * Day of the month the charge will be processed (1-31).
+         */
+        dayOfProcessing: number;
+    };
+    /**
+     * Identifier of the customer who will have the signature.
+     */
+    customerId: string;
+    /**
+     * Retry policy in case of payment failure.
+     */
+    retryPolicy: {
+        /**
+         * Maximum number of billing attempts.
+         */
+        maxRetry: number;
+        /**
+         * Interval in days between charging attempts.
+         */
+        retryEvery: number;
+    };
+    /**
+     * Array of events related to the subscription.
+     */
+    events: APISubscriptionEvent[];
+}
+export declare enum SubscriptionStatus {
+    Pending = "PENDING",
+    Active = "ACTIVE",
+    Cancelled = "CANCELLED",
+    Expired = "EXPIRED",
+    Failed = "FAILED"
+}
+/**
+ * https://docs.abacatepay.com/pages/subscriptions/reference#estrutura
+ */
+export interface APISubscriptionEvent {
+    /**
+     * Event type.
+     *
+     * @remarks We need to use `(string & {})` because we don't know exactly all possible values.
+     */
+    event: 'CREATED' | (string & {});
+    /**
+     * Event description.
+     */
+    description: string;
+    /**
+     * Event creation date.
+     */
+    createdAt: string;
+}