/**
 * Linkbreakers API
 * This is a documentation of all the APIs of Linkbreakers
 *
 * The version of the OpenAPI document: 1.118.3
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { ListEventTracesResponse, ListEventsResponse } from '../models/index';
export interface EventsServiceListEventTracesRequest {
    eventId: string;
}
export interface EventsServiceListEventsRequest {
    linkId?: string;
    startDate?: Date;
    endDate?: Date;
    responseFormat?: string;
    pageSize?: number;
    pageToken?: string;
    include?: Array<string>;
    visitorId?: string;
}
/**
 * EventsApi - interface
 *
 * @export
 * @interface EventsApiInterface
 */
export interface EventsApiInterface {
    /**
     * Creates request options for eventsServiceListEventTraces without sending the request
     * @param {string} eventId Event ID to get traces for (UUID)
     * @throws {RequiredError}
     * @memberof EventsApiInterface
     */
    eventsServiceListEventTracesRequestOpts(requestParameters: EventsServiceListEventTracesRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves all workflow step traces for an event, ordered by completion time. Useful for analyzing user engagement and workflow progression.
     * @summary List event traces
     * @param {string} eventId Event ID to get traces for (UUID)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EventsApiInterface
     */
    eventsServiceListEventTracesRaw(requestParameters: EventsServiceListEventTracesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEventTracesResponse>>;
    /**
     * Retrieves all workflow step traces for an event, ordered by completion time. Useful for analyzing user engagement and workflow progression.
     * List event traces
     */
    eventsServiceListEventTraces(requestParameters: EventsServiceListEventTracesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEventTracesResponse>;
    /**
     * Creates request options for eventsServiceListEvents without sending the request
     * @param {string} [linkId] Filter events to a specific link (optional, UUID)  Optional
     * @param {Date} [startDate] Inclusive start timestamp for the query window (workspace timezone aware). Note: For free plan workspaces, this will be automatically adjusted to not go back more than 2 weeks. For light plan workspaces, this will be automatically adjusted to not go back more than 3 months.
     * @param {Date} [endDate] Inclusive end timestamp for the query window
     * @param {string} [responseFormat] Desired response format (defaults to RESPONSE_FORMAT_JSON; use RESPONSE_FORMAT_CSV for exports)   - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
     * @param {number} [pageSize] Maximum number of events to return (default: 100, max: 1000)  Maximum number of events to return (default: 100, max: 1000)
     * @param {string} [pageToken] Cursor token to retrieve the next page of results  Cursor token to retrieve the next page of results
     * @param {Array<string>} [include] Optional list of relationships to include: visitor, device, link, workspace, leadScore  Optional list of relationships to include: visitor, device, link, workspace, leadScore
     * @param {string} [visitorId] Filter events to a specific visitor (optional, UUID)  Optional
     * @throws {RequiredError}
     * @memberof EventsApiInterface
     */
    eventsServiceListEventsRequestOpts(requestParameters: EventsServiceListEventsRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves the workspace\'s event timeline, returning paginated JSON by default or CSV payloads for reporting exports. For workspaces on the free plan, events older than 2 weeks are restricted, and for light plan workspaces, events older than 3 months are restricted.
     * @summary List events
     * @param {string} [linkId] Filter events to a specific link (optional, UUID)  Optional
     * @param {Date} [startDate] Inclusive start timestamp for the query window (workspace timezone aware). Note: For free plan workspaces, this will be automatically adjusted to not go back more than 2 weeks. For light plan workspaces, this will be automatically adjusted to not go back more than 3 months.
     * @param {Date} [endDate] Inclusive end timestamp for the query window
     * @param {string} [responseFormat] Desired response format (defaults to RESPONSE_FORMAT_JSON; use RESPONSE_FORMAT_CSV for exports)   - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
     * @param {number} [pageSize] Maximum number of events to return (default: 100, max: 1000)  Maximum number of events to return (default: 100, max: 1000)
     * @param {string} [pageToken] Cursor token to retrieve the next page of results  Cursor token to retrieve the next page of results
     * @param {Array<string>} [include] Optional list of relationships to include: visitor, device, link, workspace, leadScore  Optional list of relationships to include: visitor, device, link, workspace, leadScore
     * @param {string} [visitorId] Filter events to a specific visitor (optional, UUID)  Optional
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EventsApiInterface
     */
    eventsServiceListEventsRaw(requestParameters: EventsServiceListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEventsResponse>>;
    /**
     * Retrieves the workspace\'s event timeline, returning paginated JSON by default or CSV payloads for reporting exports. For workspaces on the free plan, events older than 2 weeks are restricted, and for light plan workspaces, events older than 3 months are restricted.
     * List events
     */
    eventsServiceListEvents(requestParameters: EventsServiceListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEventsResponse>;
}
/**
 *
 */
export declare class EventsApi extends runtime.BaseAPI implements EventsApiInterface {
    /**
     * Creates request options for eventsServiceListEventTraces without sending the request
     */
    eventsServiceListEventTracesRequestOpts(requestParameters: EventsServiceListEventTracesRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves all workflow step traces for an event, ordered by completion time. Useful for analyzing user engagement and workflow progression.
     * List event traces
     */
    eventsServiceListEventTracesRaw(requestParameters: EventsServiceListEventTracesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEventTracesResponse>>;
    /**
     * Retrieves all workflow step traces for an event, ordered by completion time. Useful for analyzing user engagement and workflow progression.
     * List event traces
     */
    eventsServiceListEventTraces(requestParameters: EventsServiceListEventTracesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEventTracesResponse>;
    /**
     * Creates request options for eventsServiceListEvents without sending the request
     */
    eventsServiceListEventsRequestOpts(requestParameters: EventsServiceListEventsRequest): Promise<runtime.RequestOpts>;
    /**
     * Retrieves the workspace\'s event timeline, returning paginated JSON by default or CSV payloads for reporting exports. For workspaces on the free plan, events older than 2 weeks are restricted, and for light plan workspaces, events older than 3 months are restricted.
     * List events
     */
    eventsServiceListEventsRaw(requestParameters: EventsServiceListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEventsResponse>>;
    /**
     * Retrieves the workspace\'s event timeline, returning paginated JSON by default or CSV payloads for reporting exports. For workspaces on the free plan, events older than 2 weeks are restricted, and for light plan workspaces, events older than 3 months are restricted.
     * List events
     */
    eventsServiceListEvents(requestParameters?: EventsServiceListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEventsResponse>;
}