@blocklet/payment-types 1.13.113

package/README.md

@@ -0,0 +1,9 @@
+# `@did-pay/util`
+
+Payment Kit common library
+
+## Usage
+
+```javascript
+const constant = require('@did-pay/util/lib/constant');
+```

package/index.js

@@ -0,0 +1 @@
+module.exports = {};

package/lib/checkout-session.d.ts

@@ -0,0 +1,291 @@
+import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { CurrencyConversion, CustomField, CustomerDetail, InvoiceData, LineItem, NftMintDetails, NftMintSettings, PaymentDetails } from './types';
+export declare const nextCheckoutSessionId: (size?: number | undefined) => string;
+export declare class CheckoutSession extends Model<InferAttributes<CheckoutSession>, InferCreationAttributes<CheckoutSession>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    client_reference_id?: string;
+    currency_id: string;
+    invoice_id?: string;
+    customer_id?: string;
+    customer_did?: string;
+    payment_link_id?: string;
+    subscription_id?: string;
+    recovered_from?: string;
+    payment_intent_id?: string;
+    setup_intent_id?: string;
+    mode: LiteralUnion<'payment' | 'setup' | 'subscription', string>;
+    status: LiteralUnion<'complete' | 'open' | 'expired', string>;
+    payment_status: LiteralUnion<'paid' | 'unpaid' | 'no_payment_required', string>;
+    line_items: LineItem[];
+    amount_subtotal: string;
+    amount_total: string;
+    total_details?: {
+        amount_discount?: string;
+        amount_shipping?: string;
+        amount_tax?: string;
+        breakdown?: {
+            discounts?: {
+                amount?: string;
+                discount?: string;
+            }[];
+            taxes?: {
+                amount?: string;
+                rate?: string;
+            }[];
+        };
+    };
+    url?: string;
+    cancel_url?: string;
+    success_url?: string;
+    currency_conversion?: CurrencyConversion;
+    customer_details?: CustomerDetail;
+    customer_creation: LiteralUnion<'if_required' | 'always', string>;
+    customer_update?: {
+        address: LiteralUnion<'auto' | 'never', string>;
+        name: LiteralUnion<'auto' | 'never', string>;
+        shipping: LiteralUnion<'auto' | 'never', string>;
+    };
+    after_expiration?: {
+        recovery: {
+            enabled: boolean;
+            allow_promotion_codes?: boolean;
+        };
+    };
+    allow_promotion_codes?: boolean;
+    consent_collection?: {
+        promotions?: LiteralUnion<'auto' | 'none', string>;
+        terms_of_service?: LiteralUnion<'required' | 'none', string>;
+    };
+    consent?: {
+        promotions?: LiteralUnion<'opt_in', string>;
+        terms_of_service?: LiteralUnion<'accepted', string>;
+    };
+    custom_fields?: CustomField[];
+    custom_text?: {
+        shipping_address?: string;
+        submit?: string;
+    };
+    expires_at: number;
+    invoice_creation?: {
+        enabled: boolean;
+        invoice_data?: InvoiceData;
+    };
+    payment_method_types: string[];
+    phone_number_collection?: {
+        enabled: boolean;
+    };
+    submit_type: LiteralUnion<'auto' | 'book' | 'donate' | 'pay', string>;
+    metadata?: Record<string, any>;
+    billing_address_collection?: LiteralUnion<'auto' | 'required', string>;
+    subscription_data?: {
+        description: string;
+        trial_period_days: number;
+        billing_cycle_anchor?: number;
+        metadata?: Record<string, any>;
+        proration_behavior?: LiteralUnion<'create_prorations' | 'none', string>;
+        trial_end?: number;
+        trial_settings?: {
+            end_behavior: {
+                missing_payment_method: LiteralUnion<'cancel' | 'pause' | 'create_invoice', string>;
+            };
+        };
+    };
+    payment_details?: PaymentDetails;
+    payment_intent_data?: {
+        description?: string;
+        statement_descriptor?: string;
+        metadata?: Record<string, any>;
+    };
+    nft_mint_status: LiteralUnion<'disabled' | 'pending' | 'minted' | 'sent' | 'error', string>;
+    nft_mint_settings?: NftMintSettings;
+    nft_mint_details?: NftMintDetails;
+    cross_sell_behavior?: LiteralUnion<'auto' | 'required', string>;
+    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;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        client_reference_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_did: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_link_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        recovered_from: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_intent_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        mode: {
+            type: DataTypes.EnumDataType<"subscription" | "payment" | "setup">;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"open" | "complete" | "expired">;
+            allowNull: boolean;
+        };
+        payment_status: {
+            type: DataTypes.EnumDataType<"paid" | "unpaid" | "no_payment_required">;
+            allowNull: boolean;
+        };
+        line_items: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        amount_subtotal: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        amount_total: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        total_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        url: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        cancel_url: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        success_url: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_conversion: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        after_expiration: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        allow_promotion_codes: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        consent_collection: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        consent: {
+            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;
+        };
+        customer_update: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {
+                address: string;
+                name: string;
+                shipping: string;
+            };
+        };
+        expires_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            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;
+        };
+        payment_details: {
+            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;
+    static findByPkOrClientRefId(id: string, options?: FindOptions<CheckoutSession>): Promise<CheckoutSession | null>;
+    isImmutable(): boolean;
+}
+export type TCheckoutSession = InferAttributes<CheckoutSession>;

package/lib/coupon.d.ts

@@ -0,0 +1,99 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+export declare class Coupon extends Model<InferAttributes<Coupon>, InferCreationAttributes<Coupon>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    amount_off: string;
+    percent_off: number;
+    currency_id: string;
+    duration: LiteralUnion<'forever' | 'once' | 'repeating', string>;
+    duration_in_months: number;
+    name: string;
+    metadata: Record<string, any>;
+    applies_to?: {
+        products: string[];
+    };
+    currency_options?: Record<string, number>;
+    max_redemptions?: number;
+    redeem_by?: Date;
+    times_redeemed?: number;
+    valid?: boolean;
+    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_off: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        percent_off: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        duration: {
+            type: DataTypes.EnumDataType<"forever" | "once" | "repeating">;
+        };
+        duration_in_months: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        applies_to: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        currency_options: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {};
+        };
+        max_redemptions: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        redeem_by: {
+            type: DataTypes.DateDataTypeConstructor;
+            allowNull: boolean;
+        };
+        times_redeemed: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        valid: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: 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;
+}
+export type TCoupon = InferAttributes<Coupon>;

package/lib/customer.d.ts

@@ -0,0 +1,137 @@
+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 class Customer extends Model<InferAttributes<Customer>, InferCreationAttributes<Customer>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    did: string;
+    description: string;
+    name: string;
+    email: string;
+    phone: string;
+    address?: CustomerAddress;
+    shipping?: CustomerShipping;
+    balance?: string;
+    token_balance?: Record<string, string>;
+    currency_id?: string;
+    delinquent: boolean;
+    discount_id?: string;
+    metadata: Record<string, any>;
+    invoice_credit_balance?: any;
+    invoice_prefix?: string;
+    invoice_settings?: {
+        custom_fields?: {
+            name: string;
+            value: string;
+        }[];
+        default_payment_method?: string;
+        footer?: string;
+    };
+    next_invoice_sequence?: number;
+    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;
+        };
+        did: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        address: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        email: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        phone: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        shipping: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        balance: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        delinquent: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        discount_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        invoice_credit_balance: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        invoice_prefix: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_settings: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        next_invoice_sequence: {
+            type: DataTypes.NumberDataTypeConstructor;
+            defaultValue: number;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    getInvoiceNumber(): Promise<string>;
+    getBalanceToApply(currencyId: string, amount: string): string;
+    decreaseTokenBalance(currencyId: string, amount: string, dryRun?: boolean): Promise<{
+        starting: Record<string, string>;
+        ending: {
+            [x: string]: any;
+        };
+    }>;
+    increaseTokenBalance(currencyId: string, amount: string, dryRun?: boolean): Promise<{
+        starting: Record<string, string>;
+        ending: {
+            [x: string]: any;
+        };
+    }>;
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    static findByPkOrDid(id: string, options?: FindOptions<Customer>): Promise<Customer | null>;
+}
+export type TCustomer = InferAttributes<Customer>;

package/lib/discount.d.ts

@@ -0,0 +1,81 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare class Discount extends Model<InferAttributes<Discount>, InferCreationAttributes<Discount>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    coupon_id: string;
+    promotion_code_id?: string;
+    customer_id: string;
+    subscription_id?: string;
+    checkout_session_id?: string;
+    invoice_id?: string;
+    invoice_item_id?: string;
+    start: number;
+    end: number;
+    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;
+        };
+        coupon_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        promotion_code_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        checkout_session_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_item_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        start: {
+            type: DataTypes.DateDataTypeConstructor;
+            allowNull: boolean;
+        };
+        end: {
+            type: DataTypes.DateDataTypeConstructor;
+            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;
+}
+export type TDiscount = InferAttributes<Discount>;

package/lib/event.d.ts

@@ -0,0 +1,76 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { EventType } from './types';
+export declare class Event extends Model<InferAttributes<Event>, InferCreationAttributes<Event>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    type: EventType;
+    api_version: string;
+    data: Record<string, any>;
+    object_type: string;
+    object_id: string;
+    request: {
+        id: string;
+        idempotency_key: string;
+    };
+    pending_webhooks: number;
+    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;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        type: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        api_version: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        object_type: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        object_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        data: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        request: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        pending_webhooks: {
+            type: DataTypes.NumberDataTypeConstructor;
+            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;
+}
+export type TEvent = InferAttributes<Event>;