@paykit-sdk/core/dist/telemetry.d.ts

The Payment Toolkit for Typescript

interface TelemetryEvent {
    /**
     * The name of the provider
     */
    provider: string;
    /**
     * The action of the event
     */
    action: string;
    /**
     * The amount of the event
     */
    amount?: number;
    /**
     * The currency of the event
     */
    currency?: string;
    /**
     * The status of the event
     */
    status?: string;
    /**
     * The metadata of the event
     */
    metadata?: Record<string, any>;
    /**
     * The version of the provider package (e.g. @paykit-sdk/stripe version)
     */
    provider_version?: string;
    /**
     * The adapter name if PayKit is used through a framework adapter (e.g. "medusajs")
     */
    adapter?: string;
    /**
     * The version of the adapter package
     */
    adapter_version?: string;
}
declare class Telemetry {
    static log(event: TelemetryEvent, sdkVersion: string, isLiveMode: boolean): void;
}

export { Telemetry, type TelemetryEvent };