@abacatepay/types 2.0.0 → 2.0.2

package/README.md

@@ -2,41 +2,46 @@
 
 ## AbacatePay API Types
 
-Tipagens oficiais e helpers modernos para integrar com a API da AbacatePay.
+O [@abacatepay/types](https://www.npmjs.com/package/@abacatepay/types) fornece **tipagens oficiais** e **helpers modernos** para trabalhar com a API da AbacatePay de forma **segura**, **previsível** e **alinhada** à documentação oficial.
+
+O pacote é **TypeScript-first** e serve como base para integrações diretas via **fetch**, **SDKs** internos, **CLIs** e validações em **aplicações** backend.
 
 <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
+Use o *package manager* da sua preferência:
 
 </div>
 
 ```bash
 bun add @abacatepay/types
+# ou
 pnpm add @abacatepay/types
+# ou
 npm install @abacatepay/types
 ```
 
 <div align="center">
 
-## Como a AbacatePay API Types documenta
+## Versionamento dos Tipos
 
-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:
+Antes de tudo, você deve especificar a versão da API que deseja usar, adicionando **/v*** na importação:
 
 </div>
 
 ```ts
-import { APICustomer } from '@abacatepay/types/v1'
+import { APICustomer } from '@abacatepay/types/v2';
 ```
 
-
-<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>
+<p align="center">Tipos e constantes globais não são versionados e devem ser importados diretamente sem a versão:</p>
 
 ```ts
-import { version } from '@abacatepay/types'
+import { version, API_BASE_URL, API_VERSION } from '@abacatepay/types';
 ```
 
+## Como a AbacatePay API Types documenta
+
 - Prefixo `API*`
 Representa estruturas gerais da API (Objetos retornados, modelos internos etc.).
 
@@ -69,36 +74,33 @@ São campos que não têm definição formal na documentação, mas cujo tipo fo
 
 ```ts
 import {
-	API_BASE,
-	API_VERSION,
-	type APICoupon,
-	type RESTPostCreateCouponBody,
-	Routes,
-} from '@abacatepay/types/v1';
+    Routes,
+    type APICoupon,
+    type RESTPostCreateCouponBody,
+} from '@abacatepay/types/v2';
+import { REST } from '@abacatepay/rest';
 
-async function createCoupon(body: RESTPostCreateCouponBody) {
-	const path = `${API_BASE_URL}/${API_VERSION}/${Routes.coupon.create}`;
-
-	const response = await fetch(path, {
-		method: 'POST',
-		body: JSON.stringify(body),
-	});
+const client = new REST({ secret });
 
-	const data: APICoupon = await response.json();
+async function createCoupon(body: RESTPostCreateCouponBody) {
+    const data = await client.post<APICoupon>(Routes.coupons.create, { body });
 
-	return data;
+    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';
+import { WebhookEvent } from '@abacatepay/zod/v2';
+import { WebhookEventType } from '@abacatepay/types/v2';
 
 Bun.serve({
     routes: {
         async '/webhooks/abacate'(request) {
-            const { data, event }: WebhookEvent = await request.json();
+            const raw = await request.json();
+            
+            const { data, event } = WebhookEvent.parse(raw);
 
             switch (event) {
                 case WebhookEventType.BillingPaid:
@@ -118,3 +120,6 @@ Bun.serve({
     },
 });
 ```
+
+<p align="center">Feito com 🥑 pela equipe AbacatePay</br>
+Open source, de verdade.</p>

package/dist/v1/rest.d.ts

@@ -86,7 +86,6 @@ export interface RESTPostCreateNewChargeBody {
      */
     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.
      */

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

@@ -27,7 +27,7 @@ export interface APICoupon {
     /**
      * Counter of how many times the coupon has been used by customers.
      */
-    redeemsCount: 0;
+    redeemsCount: number;
     /**
      * Indicates whether the coupon was created in a development (true) or production (false) environment.
      */

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

@@ -15,7 +15,7 @@ export interface APIStore {
     /**
      * 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
+     * @remarks All balance values ​​are returned in cents. To convert to Reais, divide by 100. For example: 15000 cents = R$150.00.
      */
     balance: {
         /**

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

@@ -12,7 +12,7 @@ export interface APISubscription {
      */
     amount: number;
     /**
-     * Subscription currenty.
+     * Subscription currency.
      */
     currency: string;
     /**

package/dist/v2/index.d.ts

@@ -7,5 +7,6 @@ export * from './entities/products';
 export * from './entities/store';
 export * from './entities/subscription';
 export * from './rest';
+export { Routes } from './routes';
 export * from './utils';
 export * from './webhook';

package/dist/v2/index.js

@@ -7,5 +7,6 @@ export * from './entities/products';
 export * from './entities/store';
 export * from './entities/subscription';
 export * from './rest';
+export { Routes } from './routes';
 export * from './utils';
 export * from './webhook';

package/dist/v2/rest.d.ts

@@ -2,73 +2,93 @@ import type { APICheckout, APICoupon, APICustomer, APIPayout, APIQRCodePIX, APIS
 import type { APIProduct } from './entities/products';
 import type { APISubscription } from './entities/subscription';
 /**
- * Any response returned by the AbacatePay API
+ * Any response returned by the AbacatePay API.
  */
 export type APIResponse<Data> = {
     /**
-     * The data of the response
+     * The data of the response.
      */
     data: Data;
     error: null;
+    /**
+     * Whether the request was successful or not.
+     */
+    success: true;
 } | {
     data: null;
     /**
-     * Error message returned from the API
+     * Error message returned from the API.
      */
     error: string;
+    /**
+     * Whether the request was successful or not.
+     */
+    success: false;
 };
 /**
- * Any response returned by the AbacatePay API that has a `pagination` field (Not cursor based)
+ * Any response returned by the AbacatePay API that has a `pagination` field (Not cursor based).
  */
 export type APIResponseWithPagination<Data> = {
     /**
-     * The data of the response
+     * The data of the response.
      */
     data: Data;
     error: null;
     /**
-     * Pagination info
+     * Whether the request was successful or not.
+     */
+    success: true;
+    /**
+     * Pagination info.
      */
     pagination: {
         /**
-         * Current page
+         * Current page.
          */
         page: number;
         /**
-         * Number of items per page
+         * Number of items per page.
          */
         limit: number;
         /**
-         * Number of items
+         * Number of items.
          */
         items: number;
         /**
-         * Number of pages
+         * Number of pages.
          */
         totalPages: number;
     };
 } | {
     data: null;
     /**
-     * Error message returned from the API
+     * Error message returned from the API.
      */
     error: string;
+    /**
+     * Whether the request was successful or not.
+     */
+    success: false;
 };
 /**
- * Any response returned by the AbacatePay API that has a `pagination` field and is cursor-based
+ * Any response returned by the AbacatePay API that has a `pagination` field and is cursor-based.
  */
 export type APIResponseWithCursorBasedPagination<Data> = {
     /**
-     * The data of the response
+     * The data of the response.
      */
     data: Data;
     error: null;
     /**
-     * Pagination info
+     * Whether the request was successful or not.
+     */
+    success: true;
+    /**
+     * Pagination info.
      */
     pagination: {
         /**
-         * Number of items per page
+         * Number of items per page.
          */
         limit: number;
         /**
@@ -80,16 +100,20 @@ export type APIResponseWithCursorBasedPagination<Data> = {
          */
         hasPrevious: boolean;
         /**
-         * Cursor for the next page
+         * Cursor for the next page.
          */
         nextCursor: string | null;
     };
 } | {
     data: null;
     /**
-     * Error message returned from the API
+     * Error message returned from the API.
      */
     error: string;
+    /**
+     * Whether the request was successful or not.
+     */
+    success: false;
 };
 /**
  * https://api.abacatepay.com/v2/customers/create
@@ -336,7 +360,7 @@ export interface RESTPostCreateCouponBody {
      */
     discountKind: CouponDiscountKind;
     /**
-     * Coupon description
+     * Coupon description.
      */
     notes?: string;
     /**
@@ -392,6 +416,12 @@ export interface RESTGetSearchPayoutQueryParams {
      */
     externalId: string;
 }
+/**
+ * https://api.abacatepay.com/v2/payouts/get
+ *
+ * @reference https://docs.abacatepay.com/pages/payouts/get
+ */
+export type RESTGetSearchPayoutData = APIPayout;
 /**
  * https://api.abacatepay.com/v2/payouts/list
  *
@@ -399,13 +429,13 @@ export interface RESTGetSearchPayoutQueryParams {
  */
 export interface RESTGetListPayoutsQueryParams {
     /**
-     * Number of the page
+     * Number of the page.
      *
      * @default 1
      */
     page?: number;
     /**
-     * Number of items per page
+     * Number of items per page.
      *
      * @default 20
      */
@@ -581,7 +611,7 @@ export type RESTPatchToggleCouponStatusData = APICoupon;
  */
 export interface RESTPostCreateProductBody extends Pick<APIProduct, 'externalId' | 'name' | 'price' | 'currency'> {
     /**
-     * Description for the product
+     * Description for the product.
      */
     description?: string;
 }

package/dist/v2/routes.d.ts

@@ -1,4 +1,4 @@
-import type { RESTGetListPayoutsQueryParams, RESTGetListSubscriptionsQueryParams, RESTGetProductQueryParams } from './rest';
+import type { RESTGetListCouponsQueryParams, RESTGetListCustomersQueryParams, RESTGetListPayoutsQueryParams, RESTGetListProductsQueryParams, RESTGetListSubscriptionsQueryParams, RESTGetProductQueryParams } from './rest';
 export declare const Routes: {
     readonly customers: {
         /**
@@ -8,7 +8,7 @@ export declare const Routes: {
         /**
          * GET - https://api.abacatepay.com/v2/customers/list
          */
-        readonly list: "/customers/list";
+        readonly list: ({ page, limit }?: RESTGetListCustomersQueryParams) => `/customers/list?page=${number}&limit=${number}`;
         /**
          * GET - https://api.abacatepay.com/v2/customers/get
          */
@@ -54,7 +54,7 @@ export declare const Routes: {
         /**
          * GET - https://api.abacatepay.com/v2/coupons/list
          */
-        readonly list: "/coupons/list";
+        readonly list: ({ page, limit }?: RESTGetListCouponsQueryParams) => `/coupons/list?page=${number}&limit=${number}`;
         /**
          * GET - https://api.abacatepay.com/v2/coupons/get
          */
@@ -120,7 +120,7 @@ export declare const Routes: {
         /**
          * GET - https://api.abacatepay.com/v2/products/list
          */
-        readonly list: ({ page, limit }?: Record<"page" | "limit", number>) => `/products/list?page=${number}&limit=${number}`;
+        readonly list: ({ page, limit }?: RESTGetListProductsQueryParams) => `/products/list?page=${number}&limit=${number}`;
         /**
          * GET - https://api.abacatepay.com/v2/products/get
          */

package/dist/v2/routes.js

@@ -7,7 +7,9 @@ export const Routes = {
         /**
          * GET - https://api.abacatepay.com/v2/customers/list
          */
-        list: '/customers/list',
+        list({ page = 1, limit = 20 } = {}) {
+            return `/customers/list?page=${page}&limit=${limit}`;
+        },
         /**
          * GET - https://api.abacatepay.com/v2/customers/get
          */
@@ -61,7 +63,9 @@ export const Routes = {
         /**
          * GET - https://api.abacatepay.com/v2/coupons/list
          */
-        list: '/coupons/list',
+        list({ page = 1, limit = 20 } = {}) {
+            return `/coupons/list?page=${page}&limit=${limit}`;
+        },
         /**
          * GET - https://api.abacatepay.com/v2/coupons/get
          */

package/dist/v2/utils.d.ts

@@ -1,26 +1,26 @@
 import { type WebhookEvent } from './webhook';
 /**
- * A type guard check for `payout.done` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a payout done webhook
+ * A type guard check for `payout.done` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout done webhook.
  */
 export declare function isPayoutDoneWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookPayoutDoneEvent;
 /**
- * A type guard check for `payout.failed` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a payout failed webhook
+ * A type guard check for `payout.failed` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout failed webhook.
  */
 export declare function isPayoutFailedWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookPayoutFailedEvent;
 /**
- * A type guard check for `billing.paid` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a billing paid webhook
+ * A type guard check for `billing.paid` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a billing paid webhook.
  */
 export declare function isBillingPaidWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookBillingPaidEvent;
 /**
- * Verify whether the signature is valid or not
- * @param raw Raw body response (string)
- * @param signature The content of the`X-Webhook-Signature` header
- * @returns A boolean that indicates if the signature is valid
+ * Verify whether the signature is valid or not.
+ * @param raw Raw body response (string).
+ * @param signature The content of the`X-Webhook-Signature` header.
+ * @returns A boolean that indicates if the signature is valid.
  */
 export declare const verifyWebhookSignature: (raw: string, signature: string) => boolean;

package/dist/v2/utils.js

@@ -1,35 +1,35 @@
 import { createHmac, timingSafeEqual } from 'node:crypto';
 import { WebhookEventType } from './webhook';
 /**
- * A type guard check for `payout.done` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a payout done webhook
+ * A type guard check for `payout.done` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout done webhook.
  */
 export function isPayoutDoneWebhookEvent(event) {
     return event.event === WebhookEventType.PayoutDone;
 }
 /**
- * A type guard check for `payout.failed` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a payout failed webhook
+ * A type guard check for `payout.failed` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout failed webhook.
  */
 export function isPayoutFailedWebhookEvent(event) {
     return event.event === WebhookEventType.PayoutFailed;
 }
 /**
- * A type guard check for `billing.paid` webhook events
- * @param event - The webhook event to check against
- * @returns A boolean that indicates if the webhook is a billing paid webhook
+ * A type guard check for `billing.paid` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a billing paid webhook.
  */
 export function isBillingPaidWebhookEvent(event) {
     return event.event === WebhookEventType.BillingPaid;
 }
 const ABACATEPAY_PUBLIC_KEY = 't9dXRhHHo3yDEj5pVDYz0frf7q6bMKyMRmxxCPIPp3RCplBfXRxqlC6ZpiWmOqj4L63qEaeUOtrCI8P0VMUgo6iIga2ri9ogaHFs0WIIywSMg0q7RmBfybe1E5XJcfC4IW3alNqym0tXoAKkzvfEjZxV6bE0oG2zJrNNYmUCKZyV0KZ3JS8Votf9EAWWYdiDkMkpbMdPggfh1EqHlVkMiTady6jOR3hyzGEHrIz2Ret0xHKMbiqkr9HS1JhNHDX9';
 /**
- * Verify whether the signature is valid or not
- * @param raw Raw body response (string)
- * @param signature The content of the`X-Webhook-Signature` header
- * @returns A boolean that indicates if the signature is valid
+ * Verify whether the signature is valid or not.
+ * @param raw Raw body response (string).
+ * @param signature The content of the`X-Webhook-Signature` header.
+ * @returns A boolean that indicates if the signature is valid.
  */
 export const verifyWebhookSignature = (raw, signature) => {
     const bodyBuffer = Buffer.from(raw, 'utf8');

package/dist/v2/webhook.d.ts

@@ -83,11 +83,11 @@ export type WebhookBillingPaidEvent = BaseWebhookEvent<WebhookEventType.BillingP
          */
         id: string;
         /**
-         * Kind of the payment
+         * Kind of the payment.
          */
         kind: 'PIX';
         /**
-         * Billing status, can only be `PAID` here
+         * Billing status, can only be `PAID` here.
          *
          * @see {@link PaymentStatus.Paid}
          */

package/dist/version.d.ts

@@ -1,2 +1,8 @@
-export declare const version: "2.0.0";
+/**
+ * Current version of [@abacatepay/types](https://www.npmjs.com/package/@abacatepay/types).
+ */
+export declare const version: "2.0.2";
+/**
+ * Current version of the AbacatePay API.
+ */
 export declare const API_VERSION: "2";

package/dist/version.js

@@ -1,3 +1,9 @@
 // AUTO-GENERATED — DO NOT EDIT
-export const version = '2.0.0';
+/**
+ * Current version of [@abacatepay/types](https://www.npmjs.com/package/@abacatepay/types).
+ */
+export const version = '2.0.2';
+/**
+ * Current version of the AbacatePay API.
+ */
 export const API_VERSION = '2';

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.0.0",
+	"version": "2.0.2",
 	"name": "@abacatepay/types",
 	"description": "Abacate Pay API typings that are always up to date.",
 	"type": "module",
@@ -46,12 +46,24 @@
 		"build": "bun run gen:version && tsc",
 		"prepublishOnly": "bun run build",
 		"gen:version": "bun run scripts/version.ts",
+		"test": "bun test",
 		"fmt": "bunx biome check --write package.json types && clear"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.3.8",
 		"typescript": "^5.9.3"
 	},
+	"author": {
+		"name": "AbacatePay",
+		"email": "opensource@abacatepay.com",
+		"url": "https://abacatepay.com"
+	},
+	"maintainers": [
+		{
+			"name": "Almeida",
+			"url": "https://github.com/almeidazs"
+		}
+	],
 	"keywords": [
 		"api",
 		"abacatepay",
@@ -63,6 +75,6 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/almeidazs/abacate-pay-types"
+		"url": "git+https://github.com/AbacatePay/ecosystem.git"
 	}
 }