@abacatepay/types 0.0.3 → 2.0.0

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;
+}

package/dist/v2/entities/subscription.js

@@ -0,0 +1,8 @@
+export var SubscriptionStatus;
+(function (SubscriptionStatus) {
+    SubscriptionStatus["Pending"] = "PENDING";
+    SubscriptionStatus["Active"] = "ACTIVE";
+    SubscriptionStatus["Cancelled"] = "CANCELLED";
+    SubscriptionStatus["Expired"] = "EXPIRED";
+    SubscriptionStatus["Failed"] = "FAILED";
+})(SubscriptionStatus || (SubscriptionStatus = {}));

package/dist/v2/index.d.ts

@@ -0,0 +1,11 @@
+export * from './entities/checkout';
+export * from './entities/coupon';
+export * from './entities/customer';
+export * from './entities/payout';
+export * from './entities/pix';
+export * from './entities/products';
+export * from './entities/store';
+export * from './entities/subscription';
+export * from './rest';
+export * from './utils';
+export * from './webhook';

package/dist/v2/index.js

@@ -0,0 +1,11 @@
+export * from './entities/checkout';
+export * from './entities/coupon';
+export * from './entities/customer';
+export * from './entities/payout';
+export * from './entities/pix';
+export * from './entities/products';
+export * from './entities/store';
+export * from './entities/subscription';
+export * from './rest';
+export * from './utils';
+export * from './webhook';