@blocklet/payment-types 1.13.113

package/lib/job.d.ts

@@ -0,0 +1,56 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare class Job extends Model<InferAttributes<Job>, InferCreationAttributes<Job>> {
+    id: CreationOptional<string>;
+    queue: string;
+    job: any;
+    retry_count: number;
+    delay?: number;
+    will_run_at?: number;
+    cancelled?: boolean;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+        };
+        queue: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        job: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        retry_count: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        delay: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        will_run_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        cancelled: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: 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(): void;
+}
+export type TJob = InferAttributes<Job>;

package/lib/payment-currency.d.ts

@@ -0,0 +1,99 @@
+import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, InferCreationAttributes<PaymentCurrency>> {
+    id: CreationOptional<string>;
+    payment_method_id: string;
+    active: boolean;
+    livemode: boolean;
+    locked: boolean;
+    is_base_currency: boolean;
+    name: string;
+    description: string;
+    logo: string;
+    symbol: string;
+    decimal: number;
+    minimum_payment_amount: string;
+    maximum_payment_amount: string;
+    contract?: string;
+    metadata: Record<string, any>;
+    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;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        locked: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        is_base_currency: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        logo: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        symbol: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+            unique: boolean;
+        };
+        decimal: {
+            type: DataTypes.NumberDataTypeConstructor;
+            defaultValue: number;
+        };
+        minimum_payment_amount: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        maximum_payment_amount: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        contract: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            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(): void;
+    static findByPkOrSymbol(id: string, options?: FindOptions<PaymentCurrency>): Promise<PaymentCurrency | null>;
+}
+export type TPaymentCurrency = InferAttributes<PaymentCurrency>;

package/lib/payment-intent.d.ts

@@ -0,0 +1,158 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { 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>;
+    livemode: boolean;
+    description: string;
+    amount: string;
+    amount_received?: string;
+    amount_capturable?: string;
+    amount_details?: {
+        tip: string;
+    };
+    currency_id: string;
+    customer_id?: string;
+    payment_method_id: string;
+    invoice_id?: string;
+    last_charge?: string;
+    last_payment_error: PaymentError | null;
+    metadata?: Record<string, any>;
+    receipt_email?: string;
+    statement_descriptor: string;
+    statement_descriptor_suffix?: string;
+    status: LiteralUnion<'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'canceled' | 'succeeded', string>;
+    canceled_at?: number;
+    cancellation_reason?: LiteralUnion<'abandoned' | 'duplicate' | 'requested_by_customer' | 'fraudulent' | 'failed_invoice' | 'void_invoice' | 'automatic', string>;
+    capture_method: LiteralUnion<'automatic' | 'manual', string>;
+    confirmation_method: LiteralUnion<'automatic' | 'manual', string>;
+    payment_method_types: string[];
+    review?: string;
+    payment_details?: PaymentDetails;
+    setup_future_usage?: LiteralUnion<'off_session' | 'on_session', string>;
+    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;
+        };
+        amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        amount_received: {
+            type: DataTypes.StringDataType;
+            default: string;
+        };
+        amount_capturable: {
+            type: DataTypes.StringDataType;
+            default: string;
+        };
+        amount_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        last_payment_error: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        last_charge: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        receipt_email: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        statement_descriptor: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        statement_descriptor_suffix: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded">;
+            allowNull: boolean;
+        };
+        canceled_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            allowNull: boolean;
+        };
+        cancellation_reason: {
+            type: DataTypes.EnumDataType<"automatic" | "abandoned" | "duplicate" | "requested_by_customer" | "fraudulent" | "failed_invoice" | "void_invoice">;
+            allowNull: boolean;
+        };
+        capture_method: {
+            type: DataTypes.EnumDataType<"automatic" | "manual">;
+            allowNull: boolean;
+        };
+        confirmation_method: {
+            type: DataTypes.EnumDataType<"automatic" | "manual">;
+            allowNull: boolean;
+        };
+        payment_method_types: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        review: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        setup_future_usage: {
+            type: DataTypes.EnumDataType<"off_session" | "on_session">;
+            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;
+}
+export type TPaymentIntent = InferAttributes<PaymentIntent>;

package/lib/payment-link.d.ts

@@ -0,0 +1,143 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { AfterPayment, CustomField, 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>;
+    active: boolean;
+    livemode: boolean;
+    name: string;
+    line_items: LineItem[];
+    currency_id: string;
+    after_completion?: AfterPayment;
+    allow_promotion_codes: boolean;
+    consent_collection?: {
+        promotions?: LiteralUnion<'auto' | 'none', string>;
+        terms_of_service?: LiteralUnion<'required' | 'none', string>;
+    };
+    custom_fields: CustomField[];
+    custom_text?: {
+        shipping_address?: string;
+        submit?: string;
+    };
+    customer_creation: LiteralUnion<'if_required' | 'always', string>;
+    invoice_creation?: {
+        enabled: boolean;
+        invoice_data?: any;
+    };
+    payment_method_types?: string[];
+    phone_number_collection?: {
+        enabled: boolean;
+    };
+    billing_address_collection?: LiteralUnion<'auto' | 'required', string>;
+    submit_type: LiteralUnion<'auto' | 'book' | 'donate' | 'pay', string>;
+    subscription_data?: {
+        description: string;
+        trial_period_days: number;
+    };
+    nft_mint_settings?: NftMintSettings;
+    cross_sell_behavior?: LiteralUnion<'auto' | 'required', string>;
+    metadata?: Record<string, any>;
+    created_at: CreationOptional<Date>;
+    created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number | undefined) => string;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        line_items: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        after_completion: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {
+                type: string;
+            };
+        };
+        allow_promotion_codes: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        consent_collection: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        custom_fields: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        custom_text: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        customer_creation: {
+            type: DataTypes.EnumDataType<"if_required" | "always">;
+            allowNull: boolean;
+        };
+        invoice_creation: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        payment_method_types: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        phone_number_collection: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        billing_address_collection: {
+            type: DataTypes.EnumDataType<"auto" | "required">;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        submit_type: {
+            type: DataTypes.EnumDataType<"auto" | "book" | "donate" | "pay">;
+            allowNull: boolean;
+        };
+        subscription_data: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_via: {
+            type: DataTypes.EnumDataType<"api" | "dashboard" | "portal">;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+}
+export type TPaymentLink = InferAttributes<PaymentLink>;

package/lib/payment-method.d.ts

@@ -0,0 +1,102 @@
+import OcapClient from '@ocap/client';
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import Stripe from 'stripe';
+import type { LiteralUnion } from 'type-fest';
+import type { PaymentMethodSettings } from './types';
+export declare class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCreationAttributes<PaymentMethod>> {
+    id: CreationOptional<string>;
+    active: boolean;
+    livemode: boolean;
+    locked: boolean;
+    type: LiteralUnion<'stripe' | 'arcblock' | 'ethereum' | 'bitcoin', string>;
+    name: string;
+    description: string;
+    logo: string;
+    default_currency_id?: string;
+    confirmation: {
+        type: LiteralUnion<'immediate' | 'callback' | 'block', string>;
+        block?: number;
+    };
+    settings: PaymentMethodSettings;
+    features: {
+        recurring: boolean;
+        refund: boolean;
+        dispute: boolean;
+    };
+    metadata: Record<string, any>;
+    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;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        locked: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        type: {
+            type: DataTypes.EnumDataType<"arcblock" | "ethereum" | "bitcoin" | "stripe">;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+        };
+        logo: {
+            type: DataTypes.StringDataType;
+        };
+        default_currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        confirmation: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        settings: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        features: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            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;
+    static expand(livemode?: boolean, conditions?: Record<string, any>): Promise<InferAttributes<PaymentMethod, {
+        omit: never;
+    }>[]>;
+    static encryptSettings(settings: PaymentMethodSettings): PaymentMethodSettings;
+    static decryptSettings(settings: PaymentMethodSettings): PaymentMethodSettings;
+    getStripeClient(): Stripe;
+    getOcapClient(): OcapClient;
+    static supportAutoCharge(id: string): Promise<boolean | null>;
+}
+export type TPaymentMethod = InferAttributes<PaymentMethod>;