@blocklet/payment-types 1.13.113

package/lib/subscription-schedule.d.ts

@@ -0,0 +1,110 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { SubscriptionSchedulePhase } from './types';
+export declare class SubscriptionSchedule extends Model<InferAttributes<SubscriptionSchedule>, InferCreationAttributes<SubscriptionSchedule>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    current_phase: {
+        end_date: Date;
+        start_date: Date;
+    };
+    customer_id: string;
+    subscription_id: string;
+    metadata: Record<string, any>;
+    status: LiteralUnion<'active' | 'canceled' | 'completed' | 'not_started' | 'released', string>;
+    phases?: SubscriptionSchedulePhase[];
+    default_settings?: {
+        billing_cycle_anchor: LiteralUnion<'phase_start' | 'automatic', string>;
+        billing_thresholds: {
+            amount_gte: number;
+            reset_billing_cycle_anchor: boolean;
+        };
+        collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+        default_payment_method: string;
+        description: string;
+        invoice_settings: {
+            days_until_due: number;
+        };
+    };
+    end_behavior: LiteralUnion<'cancel' | 'release', string>;
+    released_subscription_id?: string;
+    test_clock_id?: string;
+    canceled_at: number;
+    completed_at: number;
+    released_at: 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;
+        };
+        current_phase: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        released_subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"active" | "canceled" | "completed" | "not_started" | "released">;
+            allowNull: boolean;
+        };
+        default_settings: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        end_behavior: {
+            type: DataTypes.EnumDataType<"cancel" | "release">;
+            allowNull: boolean;
+        };
+        test_clock_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        canceled_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        completed_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        released_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            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 TSubscriptionSchedule = InferAttributes<SubscriptionSchedule>;

package/lib/subscription.d.ts

@@ -0,0 +1,216 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { PaymentDetails, PaymentSettings, PriceRecurring } from './types';
+export declare const nextSubscriptionId: (size?: number | undefined) => string;
+export declare class Subscription extends Model<InferAttributes<Subscription>, InferCreationAttributes<Subscription>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    currency_id: string;
+    customer_id: string;
+    current_period_end: number;
+    current_period_start: number;
+    default_payment_method_id: string;
+    description?: string;
+    latest_invoice_id?: string;
+    metadata: Record<string, any>;
+    pending_setup_intent?: string;
+    pending_update?: {
+        billing_cycle_anchor?: number;
+        expires_at?: number;
+        subscription_items?: any[];
+        trial_end?: number;
+    };
+    status: LiteralUnion<'active' | 'past_due' | 'paused' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'trialing', string>;
+    cancel_at_period_end: boolean;
+    cancel_at: CreationOptional<number>;
+    canceled_at: CreationOptional<number>;
+    cancelation_details?: {
+        comment: string;
+        feedback: LiteralUnion<'too_expensive' | 'missing_features' | 'switched_service' | 'unused' | 'customer_service' | 'too_complex' | 'low_quality' | 'other', string>;
+        reason: LiteralUnion<'cancellation_requested' | 'payment_disputed' | 'payment_failed', string>;
+    };
+    billing_cycle_anchor: number;
+    billing_thresholds?: {
+        amount_gte: number;
+        reset_billing_cycle_anchor: boolean;
+    };
+    collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+    days_until_due?: number;
+    discount_id?: string;
+    next_pending_invoice_item_invoice?: number;
+    pause_collection?: {
+        behavior: LiteralUnion<'keep_as_draft' | 'mark_uncollectible' | 'void', string>;
+        resumes_at: number;
+    };
+    payment_settings?: PaymentSettings;
+    pending_invoice_item_interval: PriceRecurring;
+    schedule_id?: string;
+    ended_at?: number;
+    start_date: number;
+    trail_end?: number;
+    trail_start?: number;
+    trail_settings?: {
+        end_behavior: {
+            missing_payment_method: LiteralUnion<'cancel' | 'pause' | 'create_invoice', string>;
+        };
+    };
+    payment_details?: PaymentDetails;
+    proration_behavior?: LiteralUnion<'always_invoice' | 'create_prorations' | 'none', string>;
+    payment_behavior?: LiteralUnion<'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete', 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;
+        };
+        cancel_at_period_end: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        current_period_end: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        current_period_start: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        default_payment_method_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        latest_invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        pending_setup_intent: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        pending_update: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"active" | "canceled" | "past_due" | "paused" | "incomplete" | "incomplete_expired" | "trialing">;
+            allowNull: boolean;
+        };
+        cancel_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        canceled_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        cancelation_details: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        billing_cycle_anchor: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        billing_thresholds: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        collection_method: {
+            type: DataTypes.EnumDataType<"charge_automatically" | "send_invoice">;
+            allowNull: boolean;
+        };
+        days_until_due: {
+            type: DataTypes.NumberDataTypeConstructor;
+            allowNull: boolean;
+        };
+        discount_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        next_pending_invoice_item_invoice_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        pause_collection: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        payment_settings: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        pending_invoice_item_interval: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        schedule_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        end_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        start_date: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        trail_end: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        trail_start: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        trail_settings: {
+            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;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    isImmutable(): boolean;
+    isActive(): boolean;
+    isScheduledToCancel(): boolean;
+    start(): Promise<void>;
+}
+export type TSubscription = InferAttributes<Subscription>;
+export declare function getSubscriptionEventType(current: TSubscription, previous: Partial<TSubscription>): "" | "paused" | "resumed";

package/lib/types.d.ts

@@ -0,0 +1,285 @@
+import type { LiteralUnion } from 'type-fest';
+export type Pagination<T = any> = T & {
+    page?: number;
+    pageSize?: number;
+    limit?: number;
+    starting_after?: string;
+    ending_before?: string;
+};
+export type Searchable<T = any> = Pagination<T> & {
+    query: string;
+};
+export type Paginated<T = any> = {
+    count: number;
+    list: T[];
+};
+export type InferFormType<T> = Omit<T, 'id' | 'created_at' | 'created_via' | 'updated_at' | 'active' | 'livemode' | 'metadata'> & {
+    metadata: {
+        key: string;
+        value: string;
+    }[];
+};
+export type PriceRecurring = {
+    interval: LiteralUnion<'hour' | 'day' | 'week' | 'month' | 'year', string>;
+    interval_count: number;
+    aggregate_usage?: LiteralUnion<'sum' | 'last_during_period' | 'max' | 'last_ever', string>;
+    usage_type?: LiteralUnion<'licensed' | 'metered', string>;
+};
+export type PriceCurrency = {
+    currency_id: string;
+    unit_amount: string;
+    tiers: PriceTier[] | null;
+    custom_unit_amount: CustomUnitAmount | null;
+};
+export type CustomUnitAmount = {
+    maximum: string;
+    minimum: string;
+    preset: string;
+};
+export type PriceTier = {
+    flat_amount?: number;
+    unit_amount?: string;
+    up_to?: number;
+};
+export type TransformQuantity = {
+    divide_by: number;
+    round: LiteralUnion<'up' | 'down', string>;
+};
+export type CustomField = {
+    key: string;
+    label: string;
+    type: LiteralUnion<'text' | 'numeric' | 'dropdown', string>;
+    optional: boolean;
+    text?: {
+        maximum_length: number;
+        minimum_length: number;
+    };
+    numeric?: {
+        maximum_length: number;
+        minimum_length: number;
+    };
+    dropdown?: {
+        options: {
+            label: string;
+            value: string;
+        }[];
+    };
+};
+export type AfterPayment = {
+    type: LiteralUnion<'redirect' | 'hosted_confirmation', string>;
+    redirect?: {
+        url: string;
+    };
+    hosted_confirmation?: {
+        custom_message: string;
+    };
+};
+export type SimpleCustomField = {
+    name: string;
+    value: string;
+};
+export type DiscountAmount = {
+    amount: number;
+    discount: string;
+};
+export type CustomerAddress = {
+    city?: string;
+    country?: string;
+    line1?: string;
+    line2?: string;
+    postal_code?: string;
+    state?: string;
+};
+export type CustomerShipping = {
+    address: CustomerAddress;
+    name: string;
+    phone: string;
+};
+export type CustomerDetail = {
+    address?: CustomerAddress;
+    email?: string;
+    name?: string;
+    phone?: string;
+};
+export type PaymentError = {
+    type: LiteralUnion<'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error', string>;
+    charge?: string;
+    code?: string;
+    decline_code?: string;
+    doc_url?: string;
+    message?: string;
+    param?: string;
+    payment_settings?: any;
+    payment_method_id?: string;
+    payment_method_type?: string;
+};
+export type LineItem = {
+    price_id: string;
+    quantity: number;
+    adjustable_quantity?: {
+        enabled: boolean;
+        maximum: number;
+        minimum: number;
+    };
+    upsell_price_id?: string;
+    cross_sell?: boolean;
+};
+export type InvoiceData = {
+    description?: string;
+    footer?: string;
+    metadata?: Record<string, any>;
+    custom_fields?: SimpleCustomField[];
+};
+export type CurrencyConversion = {
+    amount_subtotal: string;
+    amount_total: string;
+    fx_rate: string;
+    source_currency: string;
+};
+export type SubscriptionSchedulePhase = {
+    billing_cycle_anchor: LiteralUnion<'phase_start' | 'automatic', string>;
+    billing_thresholds?: {
+        amount_gte: string;
+        reset_billing_cycle_anchor: boolean;
+    };
+    collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+    coupon_id?: string;
+    currency_id?: string;
+    description?: string;
+    start_date?: number;
+    end_date?: number;
+    trail_end?: number;
+    invoice_settings?: {
+        days_until_due?: number;
+    };
+    items: {
+        price: string;
+        quantity?: number;
+        billing_thresholds?: {
+            usage_gte: number;
+        };
+    }[];
+    metadata?: Record<string, any>;
+};
+export type PaymentMethodOptions = {
+    arcblock?: {
+        payer: string;
+    };
+    ethereum?: {
+        payer: string;
+    };
+    stripe?: {
+        payer: string;
+    };
+};
+export type PaymentMethodSettings = {
+    stripe?: {
+        dashboard: string;
+        publishable_key: string;
+        secret_key: string;
+        webhook_signing_secret: string;
+    };
+    arcblock?: {
+        chain_id: string;
+        api_host: string;
+        explorer_host: string;
+    };
+    ethereum?: {
+        chain_id: number;
+        api_host: string;
+        explorer_host: string;
+    };
+    bitcoin?: {
+        chain_id: number;
+        api_host: string;
+        explorer_host: string;
+    };
+};
+export type PaymentSettings = {
+    payment_method_options: PaymentMethodOptions;
+    payment_method_types: string[];
+};
+export type PaymentDetails = {
+    arcblock?: {
+        tx_hash: string;
+        payer: string;
+    };
+    stripe?: {
+        payment_intent_id?: string;
+        setup_intent_id?: string;
+        subscription_id?: string;
+        customer_id?: string;
+    };
+    ethereum?: {
+        tx_hash: string;
+        payer: string;
+        block_height: number;
+        confirmations: number;
+    };
+    bitcoin?: {
+        tx_hash: string;
+        payer: string;
+        block_height: number;
+        confirmations: number;
+    };
+};
+export type NftMintSettings = {
+    enabled: boolean;
+    behavior?: LiteralUnion<'per_customer' | 'per_checkout_session', string>;
+    factory?: string;
+    inputs?: Record<string, string>;
+};
+export interface NftMintItem {
+    tx_hash?: string;
+    address: string;
+    owner: string;
+    error?: string;
+}
+export type NftMintDetails = {
+    type: LiteralUnion<'arcblock' | 'ethereum' | 'bitcoin', string>;
+    arcblock?: NftMintItem;
+    ethereum?: NftMintItem;
+};
+export type PricingTableItem = {
+    price_id: string;
+    product_id: string;
+    adjustable_quantity: {
+        enabled: boolean;
+        maximum: number;
+        minimum: number;
+    };
+    after_completion?: AfterPayment;
+    allow_promotion_codes: boolean;
+    billing_address_collection?: LiteralUnion<'auto' | 'required', string>;
+    is_highlight: boolean;
+    highlight_text?: LiteralUnion<'deal' | 'popular' | 'recommended', string>;
+    consent_collection?: {
+        promotions?: LiteralUnion<'auto' | 'none', string>;
+        terms_of_service?: LiteralUnion<'required' | 'none', string>;
+    };
+    custom_fields: CustomField[];
+    phone_number_collection?: {
+        enabled: boolean;
+    };
+    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>;
+};
+export type BrandSettings = {
+    background_color: string;
+    border_style: string;
+    button_color: string;
+    font_family: string;
+};
+export type SubscriptionUpdateItem = {
+    id?: string;
+    deleted?: boolean;
+    clear_usage?: boolean;
+    price_id?: string;
+    quantity?: number;
+};
+export type EventType = LiteralUnion<'account.application.authorized' | 'account.application.deauthorized' | 'account.external_account.created' | 'account.external_account.deleted' | 'account.external_account.updated' | 'account.updated' | 'application_fee.created' | 'application_fee.refund.updated' | 'application_fee.refunded' | 'balance.available' | 'billing_portal.configuration.created' | 'billing_portal.configuration.updated' | 'billing_portal.session.created' | 'capability.updated' | 'cash_balance.funds_available' | 'charge.captured' | 'charge.dispute.closed' | 'charge.dispute.created' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'charge.expired' | 'charge.failed' | 'charge.pending' | 'charge.refund.updated' | 'charge.refunded' | 'charge.succeeded' | 'charge.updated' | 'checkout.session.async_payment_failed' | 'checkout.session.async_payment_succeeded' | 'checkout.session.nft_minted' | 'checkout.session.completed' | 'checkout.session.expired' | 'checkout.session.created' | 'coupon.created' | 'coupon.deleted' | 'coupon.updated' | 'credit_note.created' | 'credit_note.updated' | 'credit_note.voided' | 'customer_cash_balance_transaction.created' | 'customer.created' | 'customer.deleted' | 'customer.discount.created' | 'customer.discount.deleted' | 'customer.discount.updated' | 'customer.source.created' | 'customer.source.deleted' | 'customer.source.expiring' | 'customer.source.updated' | 'customer.subscription.created' | 'customer.subscription.deleted' | 'customer.subscription.paused' | 'customer.subscription.past_due' | 'customer.subscription.pending_update_applied' | 'customer.subscription.pending_update_expired' | 'customer.subscription.resumed' | 'customer.subscription.renewed' | 'customer.subscription.upgraded' | 'customer.subscription.renew_failed' | 'customer.subscription.trial_start' | 'customer.subscription.trial_will_end' | 'customer.subscription.trial_end' | 'customer.subscription.started' | 'customer.subscription.updated' | 'customer.tax_id.created' | 'customer.tax_id.deleted' | 'customer.tax_id.updated' | 'customer.updated' | 'file.created' | 'financial_connections.account.created' | 'financial_connections.account.deactivated' | 'financial_connections.account.disconnected' | 'financial_connections.account.reactivated' | 'financial_connections.account.refreshed_balance' | 'identity.verification_session.canceled' | 'identity.verification_session.created' | 'identity.verification_session.processing' | 'identity.verification_session.redacted' | 'identity.verification_session.requires_input' | 'identity.verification_session.verified' | 'invoice.created' | 'invoice.deleted' | 'invoice.finalization_failed' | 'invoice.finalized' | 'invoice.marked_uncollectible' | 'invoice.paid' | 'invoice.payment_action_required' | 'invoice.payment_failed' | 'invoice.payment_succeeded' | 'invoice.sent' | 'invoice.upcoming' | 'invoice.updated' | 'invoice.voided' | 'invoiceitem.created' | 'invoiceitem.deleted' | 'issuing_authorization.created' | 'issuing_authorization.request' | 'issuing_authorization.updated' | 'issuing_card.created' | 'issuing_card.updated' | 'issuing_cardholder.created' | 'issuing_cardholder.updated' | 'issuing_dispute.closed' | 'issuing_dispute.created' | 'issuing_dispute.funds_reinstated' | 'issuing_dispute.submitted' | 'issuing_dispute.updated' | 'issuing_transaction.created' | 'issuing_transaction.updated' | 'mandate.updated' | 'order.created' | 'payment_intent.amount_capturable_updated' | 'payment_intent.canceled' | 'payment_intent.created' | 'payment_intent.partially_funded' | 'payment_intent.payment_failed' | 'payment_intent.processing' | 'payment_intent.requires_action' | 'payment_intent.succeeded' | 'payment_link.created' | 'payment_link.updated' | 'payment_method.attached' | 'payment_method.automatically_updated' | 'payment_method.detached' | 'payment_method.updated' | 'payout.canceled' | 'payout.created' | 'payout.failed' | 'payout.paid' | 'payout.reconciliation_completed' | 'payout.updated' | 'person.created' | 'person.deleted' | 'person.updated' | 'plan.created' | 'plan.deleted' | 'plan.updated' | 'price.created' | 'price.deleted' | 'price.updated' | 'product.created' | 'product.deleted' | 'product.updated' | 'promotion_code.created' | 'promotion_code.updated' | 'quote.accepted' | 'quote.canceled' | 'quote.created' | 'quote.finalized' | 'radar.early_fraud_warning.created' | 'radar.early_fraud_warning.updated' | 'recipient.created' | 'recipient.deleted' | 'recipient.updated' | 'refund.created' | 'refund.updated' | 'reporting.report_run.failed' | 'reporting.report_run.succeeded' | 'reporting.report_type.updated' | 'review.closed' | 'review.opened' | 'setup_intent.canceled' | 'setup_intent.created' | 'setup_intent.requires_action' | 'setup_intent.setup_failed' | 'setup_intent.succeeded' | 'sigma.scheduled_query_run.created' | 'sku.created' | 'sku.deleted' | 'sku.updated' | 'source.canceled' | 'source.chargeable' | 'source.failed' | 'source.mandate_notification' | 'source.refund_attributes_required' | 'source.transaction.created' | 'source.transaction.updated' | 'subscription_schedule.aborted' | 'subscription_schedule.canceled' | 'subscription_schedule.completed' | 'subscription_schedule.created' | 'subscription_schedule.expiring' | 'subscription_schedule.released' | 'subscription_schedule.updated' | 'tax_rate.created' | 'tax_rate.updated' | 'tax.settings.updated' | 'terminal.reader.action_failed' | 'terminal.reader.action_succeeded' | 'test_helpers.test_clock.advancing' | 'test_helpers.test_clock.created' | 'test_helpers.test_clock.deleted' | 'test_helpers.test_clock.internal_failure' | 'test_helpers.test_clock.ready' | 'topup.canceled' | 'topup.created' | 'topup.failed' | 'topup.reversed' | 'topup.succeeded' | 'transfer.created' | 'transfer.reversed' | 'transfer.updated', string>;

package/lib/usage-record.d.ts

@@ -0,0 +1,54 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+export declare class UsageRecord extends Model<InferAttributes<UsageRecord>, InferCreationAttributes<UsageRecord>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    timestamp: number;
+    quantity: number;
+    subscription_item_id: 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;
+        };
+        timestamp: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        quantity: {
+            type: DataTypes.BigIntDataTypeConstructor;
+            allowNull: boolean;
+        };
+        subscription_item_id: {
+            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(models: any): void;
+    static getSummary(subscription_item_id: string, period_start: number, period_end: number, method: LiteralUnion<'sum' | 'last_during_period' | 'max' | 'last_ever', string>): Promise<number>;
+}
+export type TUsageRecord = InferAttributes<UsageRecord>;