@blocklet/payment-types 1.13.113

package/lib/index.d.ts

@@ -0,0 +1,196 @@
+import { CheckoutSession, TCheckoutSession } from './checkout-session';
+import { Coupon } from './coupon';
+import { Customer, TCustomer } from './customer';
+import { Discount } from './discount';
+import { Event, TEvent } from './event';
+import { Invoice, TInvoice } from './invoice';
+import { InvoiceItem, TInvoiceItem } from './invoice-item';
+import { Job } from './job';
+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 { Price, TPrice } from './price';
+import { PricingTable, TPricingTable } from './pricing-table';
+import { Product, TProduct } from './product';
+import { PromotionCode } from './promotion-code';
+import { SetupIntent, TSetupIntent } from './setup-intent';
+import { Subscription, TSubscription } from './subscription';
+import { SubscriptionItem, TSubscriptionItem } from './subscription-item';
+import { SubscriptionSchedule } from './subscription-schedule';
+import type { LineItem, PricingTableItem } from './types';
+import { TUsageRecord, UsageRecord } from './usage-record';
+import { TWebhookAttempt, WebhookAttempt } from './webhook-attempt';
+import { TWebhookEndpoint, WebhookEndpoint } from './webhook-endpoint';
+declare const models: {
+    CheckoutSession: typeof CheckoutSession;
+    Coupon: typeof Coupon;
+    Customer: typeof Customer;
+    Discount: typeof Discount;
+    Event: typeof Event;
+    Invoice: typeof Invoice;
+    InvoiceItem: typeof InvoiceItem;
+    PaymentCurrency: typeof PaymentCurrency;
+    PaymentIntent: typeof PaymentIntent;
+    PaymentLink: typeof PaymentLink;
+    PaymentMethod: typeof PaymentMethod;
+    Price: typeof Price;
+    PricingTable: typeof PricingTable;
+    Product: typeof Product;
+    PromotionCode: typeof PromotionCode;
+    SetupIntent: typeof SetupIntent;
+    Subscription: typeof Subscription;
+    SubscriptionItem: typeof SubscriptionItem;
+    SubscriptionSchedule: typeof SubscriptionSchedule;
+    UsageRecord: typeof UsageRecord;
+    WebhookEndpoint: typeof WebhookEndpoint;
+    WebhookAttempt: typeof WebhookAttempt;
+    Job: typeof Job;
+};
+export declare function initialize(sequelize: any): void;
+export default models;
+export * from './checkout-session';
+export * from './coupon';
+export * from './customer';
+export * from './discount';
+export * from './event';
+export * from './invoice';
+export * from './invoice-item';
+export * from './job';
+export * from './payment-currency';
+export * from './payment-intent';
+export * from './payment-link';
+export * from './payment-method';
+export * from './price';
+export * from './pricing-table';
+export * from './product';
+export * from './promotion-code';
+export * from './setup-intent';
+export * from './subscription';
+export * from './subscription-item';
+export * from './subscription-schedule';
+export * from './usage-record';
+export * from './webhook-attempt';
+export * from './webhook-endpoint';
+export * from './types';
+export type TPriceExpanded = TPrice & {
+    object: 'price';
+    product: TProduct;
+    currency: TPaymentCurrency;
+    upsell?: {
+        upsells_to: TPriceExpanded;
+        upsells_to_id: string;
+    };
+};
+export type TLineItemExpanded = LineItem & {
+    price: TPriceExpanded;
+    upsell_price: TPriceExpanded;
+    metadata?: Record<string, any>;
+    [key: string]: any;
+};
+export type TProductExpanded = TProduct & {
+    object: 'price';
+    prices: TPriceExpanded[];
+    default_price: TPriceExpanded;
+    cross_sell?: {
+        cross_sells_to: TProductExpanded;
+        cross_sells_to_id: string;
+    };
+};
+export type TPaymentLinkExpanded = TPaymentLink & {
+    object: 'payment_link';
+    line_items: TLineItemExpanded[];
+};
+export type TPaymentMethodExpanded = TPaymentMethod & {
+    object: 'payment_method';
+    payment_currencies: TPaymentCurrency[];
+};
+export type TPaymentCurrencyExpanded = TPaymentCurrency & {
+    object: 'payment_currency';
+};
+export type TCheckoutSessionExpanded = TCheckoutSession & {
+    object: 'checkout_session';
+    line_items: TLineItemExpanded[];
+    payment_link?: TPaymentLink;
+    payment_intent?: TPaymentIntent;
+    subscription?: TSubscription;
+};
+export type TPaymentIntentExpanded = TPaymentIntent & {
+    object: 'payment_intent';
+    customer: TCustomer;
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod: TPaymentMethod;
+    checkoutSession?: TCheckoutSession;
+    subscription?: TSubscription;
+    invoice?: TInvoice;
+};
+export type TSubscriptionExpanded = TSubscription & {
+    object: 'subscription';
+    customer: TCustomer;
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod: TPaymentMethod;
+    items: TSubscriptionItemExpanded[];
+};
+export type TSubscriptionItemExpanded = TSubscriptionItem & {
+    object: 'subscription';
+    price: TPriceExpanded;
+};
+export type TCustomerExpanded = TCustomer & {
+    object: 'subscription';
+    payments: TPaymentIntent[];
+    subscriptions: TSubscription[];
+    invoices: TInvoice[];
+};
+export type TInvoiceExpanded = TInvoice & {
+    object: 'invoice';
+    customer: TCustomer;
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod: TPaymentMethod;
+    paymentIntent: TPaymentIntent;
+    subscription?: TSubscription;
+    lines: TInvoiceItemExpanded[];
+};
+export type TInvoiceItemExpanded = TInvoiceItem & {
+    object: 'invoice_item';
+    price: TPriceExpanded;
+};
+export type TEventExpanded = TEvent & {
+    object: 'event';
+    webhooks: TWebhookEndpointExpanded[];
+};
+export type TWebhookAttemptExpanded = TWebhookAttempt & {
+    object: 'webhook_attempt';
+    event: TEvent;
+    endpoint: TWebhookEndpoint;
+};
+export type TWebhookEndpointExpanded = TWebhookEndpoint & {
+    object: 'webhook_endpoint';
+    attempts: TWebhookAttemptExpanded[];
+};
+export type TUsageRecordExpanded = TUsageRecord & {
+    object: 'usage_record';
+};
+export type TUsageRecordSummary = {
+    object: 'usage_record_summary';
+    livemode: boolean;
+    invoice_id: string;
+    subscription_item_id: string;
+    total_usage: number;
+    period: {
+        start: number;
+        end: number;
+    };
+};
+export type TSetupIntentExpanded = TSetupIntent & {
+    object: 'setup_intent';
+};
+export type TPricingTableItem = PricingTableItem & {
+    price: TPrice;
+    product: TProduct;
+    is_selected?: boolean;
+    is_disabled?: boolean;
+};
+export type TPricingTableExpanded = TPricingTable & {
+    items: TPricingTableItem[];
+    currency: TPaymentCurrency;
+};

package/lib/invoice-item.d.ts

@@ -0,0 +1,127 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { DiscountAmount } from './types';
+export declare const nextInvoiceItemId: (size?: number | undefined) => string;
+export type InvoiceLineItem = {
+    id: string;
+};
+export declare class InvoiceItem extends Model<InferAttributes<InvoiceItem>, InferCreationAttributes<InvoiceItem>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    amount: string;
+    quantity: number;
+    description: string;
+    period?: {
+        start: number;
+        end: number;
+    };
+    currency_id: string;
+    customer_id: string;
+    price_id: string;
+    invoice_id: string;
+    subscription_id?: string;
+    subscription_item_id?: string;
+    test_clock_id?: string;
+    discountable: boolean;
+    discount_amounts: DiscountAmount[];
+    discounts: string[];
+    proration: boolean;
+    proration_details: {
+        credited_items?: {
+            invoice_id: string;
+            invoice_line_items: 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;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        quantity: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        period: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        price_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_item_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        discountable: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        discount_amounts: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        discounts: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        proration: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        proration_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {};
+        };
+        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 TInvoiceItem = InferAttributes<InvoiceItem>;

package/lib/invoice.d.ts

@@ -0,0 +1,356 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { CustomerAddress, CustomerShipping, DiscountAmount, PaymentError, PaymentSettings, SimpleCustomField } from './types';
+export declare const nextInvoiceId: (size?: number | undefined) => string;
+export declare class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttributes<Invoice>> {
+    id: CreationOptional<string>;
+    number: string;
+    livemode: boolean;
+    description?: string;
+    statement_descriptor: string;
+    period_end: number;
+    period_start: number;
+    auto_advance: boolean;
+    paid: boolean;
+    paid_out_of_band: boolean;
+    status: LiteralUnion<'draft' | 'open' | 'void' | 'paid' | 'uncollectible', string>;
+    collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+    billing_reason: LiteralUnion<'subscription_create' | 'subscription_cycle' | 'subscription_update' | 'subscription_threshold' | 'subscription_cancel' | 'subscription' | 'manual' | 'upcoming', string>;
+    currency_id: string;
+    customer_id: string;
+    payment_intent_id?: string;
+    subscription_id?: string;
+    checkout_session_id?: string;
+    quote_id?: string;
+    charge_id?: string;
+    subscription_details?: any;
+    subscription_proration_date?: number;
+    subtotal: string;
+    subtotal_excluding_tax: string;
+    tax: string;
+    total: string;
+    amount_due: string;
+    amount_paid: string;
+    amount_remaining: string;
+    amount_shipping: string;
+    starting_balance: string;
+    ending_balance: string;
+    starting_token_balance?: Record<string, string>;
+    ending_token_balance?: Record<string, string>;
+    attempt_count: number;
+    attempted: boolean;
+    next_payment_attempt?: number;
+    custom_fields?: SimpleCustomField[];
+    customer_address?: CustomerAddress;
+    customer_email?: string;
+    customer_name?: string;
+    customer_phone?: string;
+    customer_shipping?: CustomerShipping;
+    discounts?: string[];
+    total_discount_amounts?: DiscountAmount[];
+    due_date?: number;
+    effective_at?: number;
+    footer?: string;
+    from_invoice?: any;
+    account_country?: string;
+    account_name?: string;
+    hosted_invoice_url?: string;
+    invoice_pdf?: string;
+    last_finalization_error?: PaymentError;
+    latest_revision?: string;
+    payment_settings?: PaymentSettings;
+    default_payment_method_id: string;
+    post_payment_credit_notes_amount?: string;
+    pre_payment_credit_notes_amount?: string;
+    rendering_options?: any;
+    status_transitions?: {
+        finalized_at?: number;
+        marked_uncollectible_at?: number;
+        paid_at?: number;
+        voided_at?: number;
+    };
+    test_clock_id?: string;
+    threshold_reason?: any;
+    webhooks_delivered_at?: number;
+    receipt_number?: 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;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        auto_advance: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        account_country: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        account_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        charge_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        collection_method: {
+            type: DataTypes.EnumDataType<"charge_automatically" | "send_invoice">;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        hosted_invoice_url: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        payment_intent_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        period_end: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        period_start: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"paid" | "draft" | "open" | "void" | "uncollectible">;
+            allowNull: boolean;
+        };
+        checkout_session_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {};
+        };
+        subscription_proration_date: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        total: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subtotal: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subtotal_excluding_tax: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        tax: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        amount_due: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        amount_paid: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        amount_remaining: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        amount_shipping: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        attempt_count: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+        };
+        attempted: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        next_payment_attempt: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        billing_reason: {
+            type: DataTypes.EnumDataType<"subscription_create" | "subscription_cycle" | "subscription_update" | "subscription_threshold" | "subscription_cancel" | "subscription" | "manual" | "upcoming">;
+        };
+        custom_fields: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        customer_address: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        customer_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_email: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_phone: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_shipping: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        default_payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        discounts: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        due_date: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        effective_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        ending_balance: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        footer: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        from_invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        invoice_pdf: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        last_finalization_error: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        latest_revision: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        number: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        paid: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        paid_out_of_band: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        payment_settings: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        post_payment_credit_notes_amount: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        pre_payment_credit_notes_amount: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        quote_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        receipt_number: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        days_until_due: {
+            type: DataTypes.NumberDataTypeConstructor;
+            allowNull: boolean;
+        };
+        rendering_options: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        starting_balance: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+        };
+        statement_descriptor: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        status_transitions: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: {};
+        };
+        test_clock_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        threshold_reason: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        total_discount_amounts: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: never[];
+        };
+        webhooks_delivered_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            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;
+    isImmutable(): boolean;
+}
+export type TInvoice = InferAttributes<Invoice>;