@abacatepay/types 0.0.3 → 0.0.4

package/dist/routes.d.ts

@@ -1,68 +1,82 @@
 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";
+    readonly customer: {
+        /**
+         * POST - https://api.abacatepay.com/v1/customer/create
+         */
+        readonly create: "/customer/create";
+        /**
+         * GET - https://api.abacatepay.com/v1/customer/list
+         */
+        readonly list: "/customer/list";
+    };
+    readonly billing: {
+        /**
+         * POST - https://api.abacatepay.com/v1/billing/create
+         */
+        readonly create: "/billing/create";
+        /**
+         * GET - https://api.abacatepay.com/v1/billing/list
+         */
+        readonly list: "/billing/list";
+    };
+    readonly pix: {
+        /**
+         * POST - https://api.abacatepay.com/v1/pixQrCode/create
+         */
+        readonly createQRCode: "/pixQrCode/create";
+        /**
+         * POST - https://api.abacatepay.com/v1/pixQrCode/simulate-payment
+         */
+        readonly simulatePayment: ({ id }: RESTPostSimulatePaymentQueryParams) => `/pixQrCode/simulate-payment?id=${string}`;
+        /**
+         * GET - https://api.abacatepay.com/v1/pixQrCode/check
+         */
+        readonly checkStatus: ({ id }: RESTGetCheckQRCodePixStatusQueryParams) => `/pixQrCode/check?id=${string}`;
+    };
+    readonly coupon: {
+        /**
+         * POST - https://api.abacatepay.com/v1/coupon/create
+         */
+        readonly create: "/coupon/create";
+        /**
+         * GET - https://api.abacatepay.com/v1/coupon/list
+         */
+        readonly list: "/coupon/list";
+    };
+    readonly withdraw: {
+        /**
+         * POST - https://api.abacatepay.com/v1/withdraw/create
+         */
+        readonly create: "/withdraw/create";
+        /**
+         * GET - https://api.abacatepay.com/v1/withdraw/get
+         */
+        readonly get: ({ externalId }: RESTGetSearchWithdrawQueryParams) => `/withdraw/get?externalId=${string}`;
+        /**
+         * GET - https://api.abacatepay.com/v1/withdraw/list
+         */
+        readonly list: "/withdraw/list";
+    };
+    readonly store: {
+        /**
+         * GET - https://api.abacatepay.com/v1/store/get
+         */
+        readonly get: "/store/get";
+    };
+    readonly mrr: {
+        /**
+         * GET - https://api.abacatepay.com/v1/public-mrr/mrr
+         */
+        readonly get: "/public-mrr/mrr";
+        /**
+         * GET - https://api.abacatepay.com/v1/public-mrr/merchant-info
+         */
+        readonly merchant: "/public-mrr/merchant-info";
+        /**
+         * GET - https://api.abacatepay.com/v1/public-mrr/renevue
+         */
+        readonly revenue: "/public-mrr/revenue";
+    };
 };

package/dist/routes.js

@@ -1,99 +1,87 @@
 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';
+    customer: {
+        /**
+         * POST - https://api.abacatepay.com/v1/customer/create
+         */
+        create: '/customer/create',
+        /**
+         * GET - https://api.abacatepay.com/v1/customer/list
+         */
+        list: '/customer/list',
+    },
+    billing: {
+        /**
+         * POST - https://api.abacatepay.com/v1/billing/create
+         */
+        create: '/billing/create',
+        /**
+         * GET - https://api.abacatepay.com/v1/billing/list
+         */
+        list: '/billing/list',
+    },
+    pix: {
+        /**
+         * POST - https://api.abacatepay.com/v1/pixQrCode/create
+         */
+        createQRCode: '/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
+         */
+        checkStatus({ id }) {
+            return `/pixQrCode/check?id=${id}`;
+        },
+    },
+    coupon: {
+        /**
+         * POST - https://api.abacatepay.com/v1/coupon/create
+         */
+        create: '/coupon/create',
+        /**
+         * GET - https://api.abacatepay.com/v1/coupon/list
+         */
+        list: '/coupon/list',
+    },
+    withdraw: {
+        /**
+         * POST - https://api.abacatepay.com/v1/withdraw/create
+         */
+        create: '/withdraw/create',
+        /**
+         * GET - https://api.abacatepay.com/v1/withdraw/get
+         */
+        get({ externalId }) {
+            return `/withdraw/get?externalId=${externalId}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v1/withdraw/list
+         */
+        list: '/withdraw/list',
+    },
+    store: {
+        /**
+         * GET - https://api.abacatepay.com/v1/store/get
+         */
+        get: '/store/get',
+    },
+    mrr: {
+        /**
+         * GET - https://api.abacatepay.com/v1/public-mrr/mrr
+         */
+        get: '/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
+         */
+        revenue: '/public-mrr/revenue',
     },
 };

package/dist/v1/utils.d.ts

@@ -0,0 +1,19 @@
+import { type WebhookEvent } from './webhook';
+/**
+ * A type guard check for `withdraw.done` webhook events
+ * @param event - The webhook event to check against
+ * @returns A boolean that indicates if the webhook is a withdraw done webhook
+ */
+export declare function isWithdrawDoneWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookWithdrawDoneEvent;
+/**
+ * A type guard check for `withdraw.failed` webhook events
+ * @param event - The webhook event to check against
+ * @returns A boolean that indicates if the webhook is a withdraw failed webhook
+ */
+export declare function isWithdrawFailedWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookWithdrawFailedEvent;
+/**
+ * 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;

package/dist/v1/utils.js

@@ -0,0 +1,25 @@
+import { WebhookEventType } from './webhook';
+/**
+ * A type guard check for `withdraw.done` webhook events
+ * @param event - The webhook event to check against
+ * @returns A boolean that indicates if the webhook is a withdraw done webhook
+ */
+export function isWithdrawDoneWebhookEvent(event) {
+    return event.event === WebhookEventType.WithdrawDone;
+}
+/**
+ * A type guard check for `withdraw.failed` webhook events
+ * @param event - The webhook event to check against
+ * @returns A boolean that indicates if the webhook is a withdraw failed webhook
+ */
+export function isWithdrawFailedWebhookEvent(event) {
+    return event.event === WebhookEventType.WithdrawFailed;
+}
+/**
+ * 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;
+}

package/dist/version.d.ts

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

package/dist/version.js

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

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"name": "@abacatepay/types",
 	"description": "Abacate Pay API typings that are always up to date.",
 	"type": "module",
@@ -29,7 +29,7 @@
 		"gen:version": "bun run scripts/version.ts",
 		"build": "bun run gen:version && tsc",
 		"prepublishOnly": "bun run build",
-		"fmt": "bunx biome check --write . && clear"
+		"fmt": "bunx biome check --write types && clear"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.3.8",
@@ -40,5 +40,8 @@
 		"abacatepay",
 		"types",
 		"typescript"
-	]
+	],
+	"publishConfig": {
+		"access": "public"
+	}
 }