userplex/resources/events.d.mts

The official TypeScript library for the Userplex API

import { APIResource } from "../core/resource.mjs";
import { APIPromise } from "../core/api-promise.mjs";
import { RequestOptions } from "../internal/request-options.mjs";
export declare class Events extends APIResource {
    /**
     * Creates or uses an existing event and records an event occurrence for an end
     * user. Requires a valid API key for authentication.
     */
    track(body: EventTrackParams, options?: RequestOptions): APIPromise<EventTrackResponse>;
}
export interface EventTrackResponse {
    /**
     * The event ID
     */
    eventId: string;
    /**
     * The event occurrence ID
     */
    occurrenceId: string;
    /**
     * Whether the operation was successful
     */
    success: boolean;
}
export interface EventTrackParams {
    /**
     * Event name
     */
    event: string;
    /**
     * External user ID
     */
    userId: string;
    /**
     * Event metadata
     */
    properties?: {
        [key: string]: unknown;
    };
    /**
     * Event timestamp (ISO 8601)
     */
    timestamp?: string;
}
export declare namespace Events {
    export { type EventTrackResponse as EventTrackResponse, type EventTrackParams as EventTrackParams };
}
//# sourceMappingURL=events.d.mts.map