@getopenpay/client/models/EventSearchParams.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { DateTimeFilter } from './DateTimeFilter';
import type { EventType } from './EventType';
/**
 *
 * @export
 * @interface EventSearchParams
 */
export interface EventSearchParams {
    /**
     *
     * @type {DateTimeFilter}
     * @memberof EventSearchParams
     */
    createdAt?: DateTimeFilter | null;
    /**
     * Specifies which fields in the response should be expanded.
     * @type {Array<string>}
     * @memberof EventSearchParams
     */
    expand?: Array<string>;
    /**
     * Maximum number of documents to retrieve.
     * @type {number}
     * @memberof EventSearchParams
     */
    limit?: number;
    /**
     * Unique ID of the object.
     * @type {string}
     * @memberof EventSearchParams
     */
    objectId: string;
    /**
     * Page number
     * @type {number}
     * @memberof EventSearchParams
     */
    pageNumber?: number;
    /**
     * Page size
     * @type {number}
     * @memberof EventSearchParams
     */
    pageSize?: number;
    /**
     * Sort direction.
     * @type {boolean}
     * @memberof EventSearchParams
     */
    sortDescending?: boolean;
    /**
     * Key name based on which data is sorted.
     * @type {string}
     * @memberof EventSearchParams
     */
    sortKey?: string;
    /**
     * An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property.
     * @type {Array<EventType>}
     * @memberof EventSearchParams
     */
    types?: Array<EventType>;
    /**
     *
     * @type {DateTimeFilter}
     * @memberof EventSearchParams
     */
    updatedAt?: DateTimeFilter | null;
}
/**
 * Check if a given object implements the EventSearchParams interface.
 */
export declare function instanceOfEventSearchParams(value: object): value is EventSearchParams;
export declare function EventSearchParamsFromJSON(json: any): EventSearchParams;
export declare function EventSearchParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventSearchParams;
export declare function EventSearchParamsToJSON(json: any): EventSearchParams;
export declare function EventSearchParamsToJSONTyped(value?: EventSearchParams | null, ignoreDiscriminator?: boolean): any;