@blocklet/payment-types 1.22.31 → 1.23.0

package/lib/checkout-session.d.ts

@@ -188,7 +188,7 @@ export declare class CheckoutSession extends Model<InferAttributes<CheckoutSessi
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"open" | "complete" | "expired">;
+            type: DataTypes.EnumDataType<"expired" | "open" | "complete">;
             allowNull: boolean;
         };
         payment_status: {

package/lib/credit-grant.d.ts

@@ -1,9 +1,11 @@
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
-import { CreditGrantApplicabilityConfig } from './types';
+import { CreditGrantApplicabilityConfig, CreditGrantChainDetail, CreditGrantChainStatus } from './types';
 import { TPaymentCurrency } from './payment-currency';
+import { TMeter } from './meter';
 type CreditGrantSummary = {
     paymentCurrency: TPaymentCurrency;
+    meter?: TMeter;
     totalAmount: string;
     remainingAmount: string;
     grantCount: number;
@@ -27,6 +29,8 @@ export declare class CreditGrant extends Model<InferAttributes<CreditGrant>, Inf
     voided_at?: number;
     status: LiteralUnion<'pending' | 'granted' | 'depleted' | 'expired' | 'voided', string>;
     remaining_amount: string;
+    chain_status?: CreditGrantChainStatus;
+    chain_detail?: CreditGrantChainDetail;
     created_by?: string;
     updated_by?: string;
     created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
@@ -102,7 +106,7 @@ export declare class CreditGrant extends Model<InferAttributes<CreditGrant>, Inf
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"pending" | "voided" | "expired" | "depleted" | "granted">;
+            type: DataTypes.EnumDataType<"pending" | "expired" | "voided" | "depleted" | "granted">;
             defaultValue: string;
             allowNull: boolean;
         };
@@ -110,6 +114,14 @@ export declare class CreditGrant extends Model<InferAttributes<CreditGrant>, Inf
             type: DataTypes.StringDataType;
             allowNull: boolean;
         };
+        chain_status: {
+            type: DataTypes.EnumDataType<"mint_pending" | "mint_completed" | "mint_failed" | "burn_pending" | "burn_completed" | "burn_failed">;
+            allowNull: boolean;
+        };
+        chain_detail: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
         created_by: {
             type: DataTypes.StringDataType;
             allowNull: boolean;
@@ -143,6 +155,10 @@ export declare class CreditGrant extends Model<InferAttributes<CreditGrant>, Inf
         depleted: boolean;
     }>;
     isApplicableToPrice(priceId: string): boolean;
+    hasOnchainToken(): boolean;
+    static hasOnchainToken(grant: {
+        chain_status?: string | null;
+    }): boolean;
     static initialize(sequelize: any): void;
     static associate(models: any): void;
     static getAvailableCreditsForCustomer(customerId: string, currencyId: string, priceIds?: string[] | string): Promise<CreditGrant[]>;

package/lib/credit-transaction.d.ts

@@ -14,6 +14,8 @@ export declare class CreditTransaction extends Model<InferAttributes<CreditTrans
     meter_unit: string;
     description?: string;
     metadata?: Record<string, any>;
+    transfer_status?: 'pending' | 'completed' | 'failed' | null;
+    transfer_hash?: string;
     created_at: CreationOptional<Date>;
     updated_at: CreationOptional<Date>;
     static readonly GENESIS_ATTRIBUTES: {
@@ -71,6 +73,14 @@ export declare class CreditTransaction extends Model<InferAttributes<CreditTrans
             type: DataTypes.AbstractDataTypeConstructor;
             allowNull: boolean;
         };
+        transfer_status: {
+            type: DataTypes.EnumDataType<"pending" | "completed" | "failed">;
+            allowNull: boolean;
+        };
+        transfer_hash: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
         created_at: {
             type: DataTypes.DateDataTypeConstructor;
             defaultValue: DataTypes.AbstractDataTypeConstructor;

package/lib/invoice.d.ts

@@ -200,7 +200,7 @@ export declare class Invoice extends Model<InferAttributes<Invoice>, InferCreati
             allowNull: boolean;
         };
         billing_reason: {
-            type: DataTypes.EnumDataType<"subscription_create" | "subscription_cycle" | "subscription_update" | "subscription_threshold" | "subscription_cancel" | "subscription" | "manual" | "upcoming" | "slash_stake" | "stake" | "overdraft_protection" | "stake_overdraft_protection" | "recharge">;
+            type: DataTypes.EnumDataType<"manual" | "subscription_create" | "subscription_cycle" | "subscription_update" | "subscription_threshold" | "subscription_cancel" | "subscription" | "upcoming" | "slash_stake" | "stake" | "overdraft_protection" | "stake_overdraft_protection" | "recharge">;
         };
         custom_fields: {
             type: DataTypes.AbstractDataTypeConstructor;

package/lib/payment-currency.d.ts

@@ -23,6 +23,7 @@ export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurren
     vault_config?: VaultConfig;
     type: LiteralUnion<'standard' | 'credit', string>;
     recharge_config?: RechargeConfig;
+    token_config?: Record<string, any> | null;
     static readonly GENESIS_ATTRIBUTES: {
         id: {
             type: DataTypes.StringDataType;
@@ -111,7 +112,17 @@ export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurren
     static findByPkOrSymbol(id: string, options?: FindOptions<PaymentCurrency>): Promise<PaymentCurrency | null>;
     isLocked(): Promise<boolean>;
     isUsed(): Promise<boolean>;
-    static createForMeter(meter: any, paymentMethodId: string): Promise<PaymentCurrency>;
+    static createForMeter(meter: any, paymentMethodId: string, tokenConfig?: Record<string, any>, options?: {
+        decimal?: number;
+    }): Promise<PaymentCurrency>;
     isCredit(): boolean;
+    isOnChainCredit(): boolean;
+    static isCredit(currency: {
+        type?: string | null;
+    }): boolean;
+    static isOnChainCredit(currency: {
+        type?: string | null;
+        token_config?: any;
+    }): boolean;
 }
 export type TPaymentCurrency = InferAttributes<PaymentCurrency>;

package/lib/refund.d.ts

@@ -15,7 +15,7 @@ export declare class Refund extends Model<InferAttributes<Refund>, InferCreation
     invoice_id?: string;
     subscription_id?: string;
     metadata?: Record<string, any>;
-    status: LiteralUnion<'pending' | 'requires_action' | 'failed' | 'canceled' | 'succeeded', string>;
+    status: LiteralUnion<'pending' | 'requires_action' | 'processing' | 'failed' | 'canceled' | 'succeeded', string>;
     reason?: LiteralUnion<'duplicate' | 'requested_by_customer' | 'requested_by_admin' | 'fraudulent' | 'expired_uncaptured_charge', string>;
     failure_reason?: LiteralUnion<'lost_or_stolen_card' | 'expired_or_canceled_card' | 'charge_for_pending_refund_disputed' | 'insufficient_funds' | 'declined' | 'merchant_request' | 'unknown', string>;
     attempt_count: number;

package/lib/types.d.ts

@@ -501,4 +501,35 @@ export type StructuredSourceDataField = {
     group?: string;
 };
 export type SourceData = SimpleSourceData | StructuredSourceDataField[];
+export type CreditGrantChainStatus = 'mint_pending' | 'mint_completed' | 'mint_failed' | 'burn_pending' | 'burn_completed' | 'burn_failed' | 'transfer_completed' | 'transfer_failed';
+export type CreditGrantChainDetail = {
+    mint?: {
+        hash?: string;
+        at?: number;
+        error?: string;
+        failed_at?: number;
+    };
+    burn?: {
+        hash?: string;
+        at?: number;
+        amount?: string;
+        error?: string;
+        failed_at?: number;
+    };
+    expired_transfer?: {
+        hash?: string;
+        at?: number;
+        amount?: string;
+        error?: string;
+        failed_at?: number;
+    };
+    refund?: {
+        id?: string;
+        burn_hash?: string;
+        burned_amount?: string;
+        system_retained?: string;
+        burn_error?: string;
+    };
+    voided_reason?: 'refund' | 'expired' | 'manual';
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-types",
-  "version": "1.22.31",
+  "version": "1.23.0",
   "description": "Typings for Payment Kit SDK",
   "keywords": [
     "types",
@@ -48,5 +48,5 @@
     "sequelize": "^6.37.7",
     "type-fest": "^4.41.0"
   },
-  "gitHead": "fc03087134d309474256b122eba125e4a01dd6c0"
+  "gitHead": "d791ace5b095ff78f4b7328dac8a9575e6b2e265"
 }