@blocklet/payment-types 1.13.113

package/lib/price.d.ts

@@ -0,0 +1,156 @@
+import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { TPaymentCurrency } from './payment-currency';
+import type { CustomUnitAmount, LineItem, PriceCurrency, PriceRecurring, PriceTier, TransformQuantity } from './types';
+export declare const nextPriceId: (size?: number | undefined) => string;
+type TPriceExpanded = TPrice & {
+    object: 'price';
+    product: any;
+    currency: TPaymentCurrency;
+    upsell?: {
+        upsells_to: TPriceExpanded;
+        upsells_to_id: string;
+    };
+};
+type TLineItemExpanded = LineItem & {
+    price: TPriceExpanded;
+    upsell_price: TPriceExpanded;
+};
+export declare class Price extends Model<InferAttributes<Price>, InferCreationAttributes<Price>> {
+    id: CreationOptional<string>;
+    product_id: string;
+    nickname: string | null;
+    active: boolean;
+    livemode: boolean;
+    locked: CreationOptional<boolean>;
+    type: LiteralUnion<'one_time' | 'recurring', string>;
+    billing_scheme: LiteralUnion<'per_unit' | 'tiered', string>;
+    unit_amount: string;
+    recurring: PriceRecurring | null;
+    tiers_mode: LiteralUnion<'graduated' | 'volume', string> | null;
+    tiers: PriceTier[] | null;
+    custom_unit_amount: CustomUnitAmount | null;
+    lookup_key: string | null;
+    metadata: Record<string, any>;
+    transform_quantity: TransformQuantity | null;
+    currency_id: string;
+    currency_options: PriceCurrency[];
+    upsell?: {
+        upsells_to_id: string;
+    } | null;
+    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;
+        };
+        product_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        nickname: {
+            type: DataTypes.StringDataType;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        locked: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        type: {
+            type: DataTypes.EnumDataType<"recurring" | "one_time">;
+            allowNull: boolean;
+        };
+        billing_scheme: {
+            type: DataTypes.EnumDataType<"per_unit" | "tiered">;
+            allowNull: boolean;
+        };
+        unit_amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        recurring: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        tiers_mode: {
+            type: DataTypes.EnumDataType<"graduated" | "volume">;
+            allowNull: boolean;
+        };
+        tiers: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        custom_unit_amount: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        lookup_key: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        transform_quantity: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+        };
+        currency_options: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        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 getModel(price: TPrice): LiteralUnion<"graduated" | "volume", string> | "package" | "standard" | null;
+    static formatBeforeSave(price: Partial<TPrice & {
+        model: string;
+    }>): Partial<InferAttributes<Price, {
+        omit: never;
+    }> & {
+        model: string;
+    }>;
+    static formatAfterRead(doc: TPrice, currencies: TPaymentCurrency[]): InferAttributes<Price, {
+        omit: never;
+    }>;
+    static formatCurrencies(options: PriceCurrency[], currencies: TPaymentCurrency[]): any[];
+    static expand(items: LineItem[], { product, upsell }?: {
+        product?: boolean;
+        upsell?: boolean;
+    }): Promise<TLineItemExpanded[]>;
+    static insert(price: TPrice & {
+        model: string;
+    }): Promise<Price>;
+    static findByPkOrLookupKey(id: string, options?: FindOptions<Price>): Promise<Price | null>;
+    isUsed(checkProduct?: boolean): Promise<boolean>;
+}
+export type TPrice = InferAttributes<Price>;
+export {};

package/lib/pricing-table.d.ts

@@ -0,0 +1,109 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { BrandSettings, PricingTableItem } from './types';
+export declare const nextPricingTableId: (size?: number | undefined) => string;
+export declare class PricingTable extends Model<InferAttributes<PricingTable>, InferCreationAttributes<PricingTable>> {
+    id: CreationOptional<string>;
+    active: boolean;
+    livemode: boolean;
+    locked: boolean;
+    name: string;
+    items: PricingTableItem[];
+    branding_settings: BrandSettings;
+    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;
+        };
+        locked: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        items: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        branding_settings: {
+            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(): void;
+    static formatItem(payload: any): {
+        adjustable_quantity: {
+            enabled: boolean;
+            maximum: number;
+            minimum: number;
+        };
+        after_completion: {
+            type: string;
+            hosted_confirmation: {
+                custom_message: string;
+            };
+        };
+        allow_promotion_codes: boolean;
+        customer_creation: string;
+        consent_collection: {
+            promotions: string;
+            terms_of_service: string;
+        };
+        invoice_creation: {
+            enabled: boolean;
+        };
+        phone_number_collection: {
+            enabled: boolean;
+        };
+        billing_address_collection: string;
+        subscription_data: {
+            description: string;
+            trial_period_days: number;
+        };
+        nft_mint_settings: {
+            enabled: boolean;
+            factory: string;
+        };
+        submit_type: string;
+        cross_sell_behavior: string;
+    } & Pick<any, "custom_fields" | "price_id" | "after_completion" | "allow_promotion_codes" | "consent_collection" | "phone_number_collection" | "billing_address_collection" | "submit_type" | "subscription_data" | "nft_mint_settings" | "cross_sell_behavior" | "product_id" | "adjustable_quantity" | "highlight_text" | "is_highlight">;
+    static format(payload: any): Partial<PricingTable>;
+    expand(): Promise<InferAttributes<PricingTable, {
+        omit: never;
+    }>>;
+}
+export type TPricingTable = InferAttributes<PricingTable>;

package/lib/product.d.ts

@@ -0,0 +1,104 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+export declare const nextProductId: (size?: number | undefined) => string;
+export type ProductFeature = {
+    name: string;
+};
+export declare class Product extends Model<InferAttributes<Product>, InferCreationAttributes<Product>> {
+    id: CreationOptional<string>;
+    active: boolean;
+    livemode: boolean;
+    locked: CreationOptional<boolean>;
+    type: LiteralUnion<'service' | 'good', string>;
+    name: string;
+    description: string;
+    images: any[];
+    features: ProductFeature[];
+    unit_label?: string;
+    default_price_id?: string;
+    metadata?: Record<string, any>;
+    statement_descriptor?: string;
+    nft_factory?: string;
+    cross_sell?: {
+        cross_sells_to_id: 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;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        locked: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        type: {
+            type: DataTypes.EnumDataType<"service" | "good">;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+        };
+        images: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        features: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        unit_label: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        default_price_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        statement_descriptor: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        nft_factory: {
+            type: DataTypes.StringDataType;
+            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 expand(id: string): Promise<InferAttributes<Product, {
+        omit: never;
+    }> | null>;
+}
+export type TProduct = InferAttributes<Product>;

package/lib/promotion-code.d.ts

@@ -0,0 +1,81 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare class PromotionCode extends Model<InferAttributes<PromotionCode>, InferCreationAttributes<PromotionCode>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    active: boolean;
+    code: string;
+    coupon_id: string;
+    max_redemptions?: number;
+    restrictions?: {
+        currency_options?: Record<string, number>;
+        first_time_transaction?: boolean;
+        minimum_amount?: number;
+        minimum_amount_currency?: string;
+    };
+    customer_id?: string;
+    times_redeemed?: number;
+    expires_at: CreationOptional<Date>;
+    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;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        code: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        coupon_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        max_redemptions: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        restrictions: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {};
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        times_redeemed: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        expires_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            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 TPromotionCode = InferAttributes<PromotionCode>;

package/lib/setup-intent.d.ts

@@ -0,0 +1,112 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { PaymentError, PaymentMethodOptions } from './types';
+export declare class SetupIntent extends Model<InferAttributes<SetupIntent>, InferCreationAttributes<SetupIntent>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    description: string;
+    currency_id: string;
+    customer_id: string;
+    last_setup_error: PaymentError | null;
+    metadata?: Record<string, any>;
+    status: LiteralUnion<'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'canceled' | 'succeeded', string>;
+    usage: LiteralUnion<'on_session' | 'off_session', string>;
+    canceled_at?: number;
+    cancellation_reason?: LiteralUnion<'abandoned' | 'duplicate' | 'requested_by_customer', string>;
+    flow_directions: LiteralUnion<'inbound' | 'outbound', string>[];
+    payment_method_options?: PaymentMethodOptions;
+    payment_method_types?: string[];
+    payment_method_id: string;
+    setup_details?: {
+        tx_hash?: string;
+        payer?: 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;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        last_setup_error: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        last_attempt: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded">;
+            allowNull: boolean;
+        };
+        usage: {
+            type: DataTypes.EnumDataType<"off_session" | "on_session">;
+            allowNull: boolean;
+        };
+        canceled_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        cancellation_reason: {
+            type: DataTypes.EnumDataType<"abandoned" | "duplicate" | "requested_by_customer">;
+            allowNull: boolean;
+        };
+        flow_directions: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: string[];
+        };
+        payment_method_types: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        payment_method_options: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        setup_details: {
+            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;
+}
+export type TSetupIntent = InferAttributes<SetupIntent>;

package/lib/subscription-item.d.ts

@@ -0,0 +1,61 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare const nextSubscriptionItemId: (size?: number | undefined) => string;
+export declare class SubscriptionItem extends Model<InferAttributes<SubscriptionItem>, InferCreationAttributes<SubscriptionItem>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    subscription_id: string;
+    price_id: string;
+    quantity: number;
+    metadata: Record<string, any>;
+    billing_thresholds?: {
+        usage_gte: 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;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        price_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        quantity: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        billing_threshold: {
+            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 isPriceUsed(priceId: string): Promise<boolean>;
+}
+export type TSubscriptionItem = InferAttributes<SubscriptionItem>;