kalshi-typescript 2.1.3 → 3.3.0

package/dist/api/events-api.d.ts

@@ -1,9 +1,9 @@
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 3.3.0
  *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -12,15 +12,18 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { GetEventCandlesticksResponse } from '../models';
+import type { GetEventForecastPercentilesHistoryResponse } from '../models';
 import type { GetEventMetadataResponse } from '../models';
 import type { GetEventResponse } from '../models';
 import type { GetEventsResponse } from '../models';
+import type { GetMultivariateEventsResponse } from '../models';
 /**
  * EventsApi - axios parameter creator
  */
 export declare const EventsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+     *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
      * @summary Get Event
      * @param {string} eventTicker Event ticker
      * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -29,7 +32,20 @@ export declare const EventsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getEvent: (eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get metadata about an event by its ticker
+     * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
+     * @summary Get Event Forecast Percentile History
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventForecastPercentilesHistory: (ticker: string, seriesTicker: string, percentiles: Array<number>, startTs: number, endTs: number, periodInterval: GetEventForecastPercentilesHistoryPeriodIntervalEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
      * @summary Get Event Metadata
      * @param {string} eventTicker Event ticker
      * @param {*} [options] Override http request option.
@@ -37,25 +53,50 @@ export declare const EventsApiAxiosParamCreator: (configuration?: Configuration)
      */
     getEventMetadata: (eventTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
+     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
      * @summary Get Events
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
+     * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
+     * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
+     * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
+     * @param {string} [seriesTicker] Filter by series ticker
+     * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents: (limit?: number, cursor?: string, withNestedMarkets?: boolean, withMilestones?: boolean, status?: GetEventsStatusEnum, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  End-point for returning aggregated data across all markets corresponding to an event.
+     * @summary Get Event Candlesticks
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksByEvent: (ticker: string, seriesTicker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksByEventPeriodIntervalEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+     * @summary Get Multivariate Events
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
-     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
-     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
      * @param {string} [seriesTicker] Filter by series ticker
-     * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
+     * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvents: (limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getMultivariateEvents: (limit?: number, cursor?: string, seriesTicker?: string, collectionTicker?: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * EventsApi - functional programming interface
  */
 export declare const EventsApiFp: (configuration?: Configuration) => {
     /**
-     * Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+     *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
      * @summary Get Event
      * @param {string} eventTicker Event ticker
      * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -64,7 +105,20 @@ export declare const EventsApiFp: (configuration?: Configuration) => {
      */
     getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
     /**
-     * Get metadata about an event by its ticker
+     * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
+     * @summary Get Event Forecast Percentile History
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventForecastPercentilesHistory(ticker: string, seriesTicker: string, percentiles: Array<number>, startTs: number, endTs: number, periodInterval: GetEventForecastPercentilesHistoryPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventForecastPercentilesHistoryResponse>>;
+    /**
+     *  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
      * @summary Get Event Metadata
      * @param {string} eventTicker Event ticker
      * @param {*} [options] Override http request option.
@@ -72,25 +126,50 @@ export declare const EventsApiFp: (configuration?: Configuration) => {
      */
     getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventMetadataResponse>>;
     /**
-     * Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
+     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
      * @summary Get Events
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
+     * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
+     * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
+     * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
+     * @param {string} [seriesTicker] Filter by series ticker
+     * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, withMilestones?: boolean, status?: GetEventsStatusEnum, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventsResponse>>;
+    /**
+     *  End-point for returning aggregated data across all markets corresponding to an event.
+     * @summary Get Event Candlesticks
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksByEvent(ticker: string, seriesTicker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksByEventPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventCandlesticksResponse>>;
+    /**
+     * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+     * @summary Get Multivariate Events
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
-     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
-     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
      * @param {string} [seriesTicker] Filter by series ticker
-     * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
+     * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventsResponse>>;
+    getMultivariateEvents(limit?: number, cursor?: string, seriesTicker?: string, collectionTicker?: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventsResponse>>;
 };
 /**
  * EventsApi - factory interface
  */
 export declare const EventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+     *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
      * @summary Get Event
      * @param {string} eventTicker Event ticker
      * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -99,7 +178,20 @@ export declare const EventsApiFactory: (configuration?: Configuration, basePath?
      */
     getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetEventResponse>;
     /**
-     * Get metadata about an event by its ticker
+     * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
+     * @summary Get Event Forecast Percentile History
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventForecastPercentilesHistory(ticker: string, seriesTicker: string, percentiles: Array<number>, startTs: number, endTs: number, periodInterval: GetEventForecastPercentilesHistoryPeriodIntervalEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetEventForecastPercentilesHistoryResponse>;
+    /**
+     *  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
      * @summary Get Event Metadata
      * @param {string} eventTicker Event ticker
      * @param {*} [options] Override http request option.
@@ -107,25 +199,50 @@ export declare const EventsApiFactory: (configuration?: Configuration, basePath?
      */
     getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetEventMetadataResponse>;
     /**
-     * Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
+     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
      * @summary Get Events
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
+     * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
+     * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
+     * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
+     * @param {string} [seriesTicker] Filter by series ticker
+     * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, withMilestones?: boolean, status?: GetEventsStatusEnum, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetEventsResponse>;
+    /**
+     *  End-point for returning aggregated data across all markets corresponding to an event.
+     * @summary Get Event Candlesticks
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksByEvent(ticker: string, seriesTicker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksByEventPeriodIntervalEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetEventCandlesticksResponse>;
+    /**
+     * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+     * @summary Get Multivariate Events
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
-     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
-     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
      * @param {string} [seriesTicker] Filter by series ticker
-     * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
+     * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetEventsResponse>;
+    getMultivariateEvents(limit?: number, cursor?: string, seriesTicker?: string, collectionTicker?: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventsResponse>;
 };
 /**
  * EventsApi - object-oriented interface
  */
 export declare class EventsApi extends BaseAPI {
     /**
-     * Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
+     *  Endpoint for getting data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
      * @summary Get Event
      * @param {string} eventTicker Event ticker
      * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
@@ -134,7 +251,20 @@ export declare class EventsApi extends BaseAPI {
      */
     getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any, {}>>;
     /**
-     * Get metadata about an event by its ticker
+     * Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
+     * @summary Get Event Forecast Percentile History
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {Array<number>} percentiles Array of percentile values to retrieve (0-10000, max 10 values)
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetEventForecastPercentilesHistoryPeriodIntervalEnum} periodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventForecastPercentilesHistory(ticker: string, seriesTicker: string, percentiles: Array<number>, startTs: number, endTs: number, periodInterval: GetEventForecastPercentilesHistoryPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventForecastPercentilesHistoryResponse, any, {}>>;
+    /**
+     *  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
      * @summary Get Event Metadata
      * @param {string} eventTicker Event ticker
      * @param {*} [options] Override http request option.
@@ -142,16 +272,60 @@ export declare class EventsApi extends BaseAPI {
      */
     getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventMetadataResponse, any, {}>>;
     /**
-     * Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
+     * Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint.
      * @summary Get Events
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
+     * @param {string} [cursor] Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
+     * @param {boolean} [withMilestones] If true, includes related milestones as a field alongside events.
+     * @param {GetEventsStatusEnum} [status] Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status.
+     * @param {string} [seriesTicker] Filter by series ticker
+     * @param {number} [minCloseTs] Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, withMilestones?: boolean, status?: GetEventsStatusEnum, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventsResponse, any, {}>>;
+    /**
+     *  End-point for returning aggregated data across all markets corresponding to an event.
+     * @summary Get Event Candlesticks
+     * @param {string} ticker The event ticker
+     * @param {string} seriesTicker The series ticker
+     * @param {number} startTs Start timestamp for the range
+     * @param {number} endTs End timestamp for the range
+     * @param {GetMarketCandlesticksByEventPeriodIntervalEnum} periodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketCandlesticksByEvent(ticker: string, seriesTicker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksByEventPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventCandlesticksResponse, any, {}>>;
+    /**
+     * Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+     * @summary Get Multivariate Events
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
-     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
-     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
      * @param {string} [seriesTicker] Filter by series ticker
-     * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
+     * @param {string} [collectionTicker] Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
+     * @param {boolean} [withNestedMarkets] Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventsResponse, any, {}>>;
+    getMultivariateEvents(limit?: number, cursor?: string, seriesTicker?: string, collectionTicker?: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventsResponse, any, {}>>;
 }
+export declare const GetEventForecastPercentilesHistoryPeriodIntervalEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_60: 60;
+    readonly NUMBER_1440: 1440;
+};
+export type GetEventForecastPercentilesHistoryPeriodIntervalEnum = typeof GetEventForecastPercentilesHistoryPeriodIntervalEnum[keyof typeof GetEventForecastPercentilesHistoryPeriodIntervalEnum];
+export declare const GetEventsStatusEnum: {
+    readonly Open: "open";
+    readonly Closed: "closed";
+    readonly Settled: "settled";
+};
+export type GetEventsStatusEnum = typeof GetEventsStatusEnum[keyof typeof GetEventsStatusEnum];
+export declare const GetMarketCandlesticksByEventPeriodIntervalEnum: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_60: 60;
+    readonly NUMBER_1440: 1440;
+};
+export type GetMarketCandlesticksByEventPeriodIntervalEnum = typeof GetMarketCandlesticksByEventPeriodIntervalEnum[keyof typeof GetMarketCandlesticksByEventPeriodIntervalEnum];