@blocklet/payment-types 1.13.210 → 1.13.212

package/lib/customer.d.ts

@@ -1,6 +1,7 @@
 import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { CustomerAddress, CustomerShipping } from './types';
 export declare const nextCustomerId: (size?: number | undefined) => string;
+export declare const nextInvoicePrefix: (size?: number | undefined) => string;
 export declare class Customer extends Model<InferAttributes<Customer>, InferCreationAttributes<Customer>> {
     id: CreationOptional<string>;
     livemode: boolean;
@@ -139,5 +140,6 @@ export declare class Customer extends Model<InferAttributes<Customer>, InferCrea
     static initialize(sequelize: any): void;
     static associate(models: any): void;
     static findByPkOrDid(id: string, options?: FindOptions<Customer>): Promise<Customer | null>;
+    static getInvoicePrefix(): string;
 }
 export type TCustomer = InferAttributes<Customer>;

package/lib/index.d.ts

@@ -11,6 +11,7 @@ import { PaymentCurrency, TPaymentCurrency } from './payment-currency';
 import { PaymentIntent, TPaymentIntent } from './payment-intent';
 import { PaymentLink, TPaymentLink } from './payment-link';
 import { PaymentMethod, TPaymentMethod } from './payment-method';
+import { Payout, TPayout } from './payout';
 import { Price, TPrice } from './price';
 import { PricingTable, TPricingTable } from './pricing-table';
 import { Product, TProduct } from './product';
@@ -35,6 +36,7 @@ declare const models: {
     PaymentCurrency: typeof PaymentCurrency;
     PaymentIntent: typeof PaymentIntent;
     PaymentLink: typeof PaymentLink;
+    Payout: typeof Payout;
     PaymentMethod: typeof PaymentMethod;
     Price: typeof Price;
     PricingTable: typeof PricingTable;
@@ -66,6 +68,7 @@ export * from './payment-currency';
 export * from './payment-intent';
 export * from './payment-link';
 export * from './payment-method';
+export * from './payout';
 export * from './price';
 export * from './pricing-table';
 export * from './product';
@@ -120,6 +123,7 @@ export type TCheckoutSessionExpanded = TCheckoutSession & {
     payment_link?: TPaymentLink;
     payment_intent?: TPaymentIntent;
     subscription?: TSubscription;
+    customer?: TCustomer;
 };
 export type TPaymentIntentExpanded = TPaymentIntent & {
     object: 'payment_intent';
@@ -208,3 +212,10 @@ export type TRefundExpanded = TRefund & {
     invoice?: TInvoice;
     subscription?: TSubscription;
 };
+export type TPayoutExpanded = TPayout & {
+    object: 'price';
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod: TPaymentMethod;
+    paymentIntent: TPaymentIntent;
+    customer: TCustomer;
+};

package/lib/payment-intent.d.ts

@@ -1,6 +1,6 @@
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
-import type { GroupedBN, PaymentDetails, PaymentError } from './types';
+import type { GroupedBN, PaymentBeneficiary, PaymentDetails, PaymentError } from './types';
 export declare const nextPaymentIntentId: (size?: number | undefined) => string;
 export declare class PaymentIntent extends Model<InferAttributes<PaymentIntent>, InferCreationAttributes<PaymentIntent>> {
     id: CreationOptional<string>;
@@ -31,6 +31,7 @@ export declare class PaymentIntent extends Model<InferAttributes<PaymentIntent>,
     review?: string;
     payment_details?: PaymentDetails;
     setup_future_usage?: LiteralUnion<'off_session' | 'on_session', string>;
+    beneficiaries?: PaymentBeneficiary[];
     created_at: CreationOptional<Date>;
     updated_at: CreationOptional<Date>;
     static readonly GENESIS_ATTRIBUTES: {

package/lib/payment-link.d.ts

@@ -1,6 +1,6 @@
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
-import type { AfterPayment, CustomField, LineItem, NftMintSettings } from './types';
+import type { AfterPayment, CustomField, DonationSettings, LineItem, NftMintSettings } from './types';
 export declare const nextPaymentLinkId: (size?: number | undefined) => string;
 export declare class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreationAttributes<PaymentLink>> {
     id: CreationOptional<string>;
@@ -38,6 +38,7 @@ export declare class PaymentLink extends Model<InferAttributes<PaymentLink>, Inf
     };
     nft_mint_settings?: NftMintSettings;
     cross_sell_behavior?: LiteralUnion<'auto' | 'required', string>;
+    donation_settings?: DonationSettings;
     metadata?: Record<string, any>;
     created_at: CreationOptional<Date>;
     created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;

package/lib/payout.d.ts

@@ -0,0 +1,122 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { GroupedBN, PaymentDetails, PaymentError } from './types';
+export declare const nextPayoutId: (size?: number | undefined) => string;
+export declare class Payout extends Model<InferAttributes<Payout>, InferCreationAttributes<Payout>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    automatic: boolean;
+    description: string;
+    destination: string;
+    amount: string;
+    payment_details?: PaymentDetails;
+    currency_id: string;
+    customer_id: string;
+    payment_intent_id: string;
+    payment_method_id: string;
+    metadata?: Record<string, any>;
+    status: LiteralUnion<'pending' | 'paid' | 'failed' | 'canceled' | 'in_transit', string>;
+    failure_message?: string;
+    failure_code?: LiteralUnion<'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'could_not_process' | 'debit_not_authorized' | 'declined' | 'incorrect_account_holder_address' | 'incorrect_account_holder_name' | 'incorrect_account_holder_tax_id' | 'incorrect_account_type' | 'insufficient_funds' | 'invalid_account_number', string>;
+    attempt_count: number;
+    attempted: boolean;
+    next_attempt?: number;
+    last_attempt_error?: PaymentError | null;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number | undefined) => string;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        automatic: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        destination: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_intent_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"paid" | "canceled" | "pending" | "failed" | "in_transit">;
+            allowNull: boolean;
+        };
+        failure_message: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        failure_code: {
+            type: DataTypes.EnumDataType<"account_closed" | "account_frozen" | "bank_account_restricted" | "bank_ownership_changed" | "could_not_process" | "debit_not_authorized" | "declined" | "incorrect_account_holder_address" | "incorrect_account_holder_name" | "incorrect_account_holder_tax_id" | "incorrect_account_type" | "insufficient_funds" | "invalid_account_number">;
+            allowNull: boolean;
+        };
+        attempt_count: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        attempted: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        next_attempt: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        last_attempt_error: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    isImmutable(): boolean;
+    static getPayoutAmountByCustomer(customerId: string, status?: string): Promise<GroupedBN>;
+}
+export type TPayout = InferAttributes<Payout>;

package/lib/refund.d.ts

@@ -84,7 +84,7 @@ export declare class Refund extends Model<InferAttributes<Refund>, InferCreation
             allowNull: boolean;
         };
         failure_reason: {
-            type: DataTypes.EnumDataType<"lost_or_stolen_card" | "expired_or_canceled_card" | "charge_for_pending_refund_disputed" | "insufficient_funds" | "declined" | "merchant_request" | "unknown">;
+            type: DataTypes.EnumDataType<"declined" | "insufficient_funds" | "lost_or_stolen_card" | "expired_or_canceled_card" | "charge_for_pending_refund_disputed" | "merchant_request" | "unknown">;
             allowNull: boolean;
         };
         attempt_count: {

package/lib/types.d.ts

@@ -50,6 +50,7 @@ export type CustomUnitAmount = {
     maximum: string;
     minimum: string;
     preset: string;
+    presets: string[];
 };
 export type PriceTier = {
     flat_amount?: number;
@@ -138,6 +139,7 @@ export type LineItem = {
     };
     upsell_price_id?: string;
     cross_sell?: boolean;
+    custom_amount?: string;
 };
 export type InvoiceData = {
     description?: string;
@@ -243,6 +245,41 @@ export type PaymentDetails = {
         confirmations: number;
     };
 };
+export type PaymentBeneficiary = {
+    address: string;
+    share: string;
+    memo?: string;
+};
+export type DonationSettings = {
+    target: string;
+    title: string;
+    description: string;
+    reference: string;
+    beneficiaries: PaymentBeneficiary[];
+    amount: {
+        presets?: string[];
+        preset?: string;
+        minimum?: string;
+        maximum?: string;
+        custom?: boolean;
+    };
+    message?: {
+        success?: string;
+        summary?: string;
+    };
+    appearance: {
+        button: {
+            text: any;
+            icon?: any;
+            size?: string;
+            color?: string;
+            variant?: string;
+        };
+        history: {
+            variant: string;
+        };
+    };
+};
 export type NftMintSettings = {
     enabled: boolean;
     behavior?: LiteralUnion<'per_customer' | 'per_checkout_session', string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-types",
-  "version": "1.13.210",
+  "version": "1.13.212",
   "description": "Typings for Payment Kit SDK",
   "keywords": [
     "types",
@@ -48,5 +48,5 @@
     "sequelize": "^6.36.0",
     "type-fest": "^4.10.2"
   },
-  "gitHead": "4d13c9b750596c25098c219a6e269ed141734d5e"
+  "gitHead": "942de3b017723af85a6c271a7e4ddd35443bc84d"
 }