kalshi-typescript 2.1.3 → 3.3.0

package/dist/esm/api/milestone-api.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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
+ *
+ *
+ * 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 { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { GetMilestoneResponse } from '../models';
+import type { GetMilestonesResponse } from '../models';
+/**
+ * MilestoneApi - axios parameter creator
+ */
+export declare const MilestoneApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for getting data about a specific milestone by its ID.
+     * @summary Get Milestone
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestone: (milestoneId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Minimum start date to filter milestones. Format: RFC3339 timestamp
+     * @summary Get Milestones
+     * @param {number} limit Number of milestones to return per page
+     * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+     * @param {string} [category] Filter by milestone category
+     * @param {string} [competition] Filter by competition
+     * @param {string} [sourceId] Filter by source id
+     * @param {string} [type] Filter by milestone type
+     * @param {string} [relatedEventTicker] Filter by related event ticker
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestones: (limit: number, minimumStartDate?: string, category?: string, competition?: string, sourceId?: string, type?: string, relatedEventTicker?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MilestoneApi - functional programming interface
+ */
+export declare const MilestoneApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for getting data about a specific milestone by its ID.
+     * @summary Get Milestone
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMilestoneResponse>>;
+    /**
+     * Minimum start date to filter milestones. Format: RFC3339 timestamp
+     * @summary Get Milestones
+     * @param {number} limit Number of milestones to return per page
+     * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+     * @param {string} [category] Filter by milestone category
+     * @param {string} [competition] Filter by competition
+     * @param {string} [sourceId] Filter by source id
+     * @param {string} [type] Filter by milestone type
+     * @param {string} [relatedEventTicker] Filter by related event ticker
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestones(limit: number, minimumStartDate?: string, category?: string, competition?: string, sourceId?: string, type?: string, relatedEventTicker?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMilestonesResponse>>;
+};
+/**
+ * MilestoneApi - factory interface
+ */
+export declare const MilestoneApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for getting data about a specific milestone by its ID.
+     * @summary Get Milestone
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMilestoneResponse>;
+    /**
+     * Minimum start date to filter milestones. Format: RFC3339 timestamp
+     * @summary Get Milestones
+     * @param {number} limit Number of milestones to return per page
+     * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+     * @param {string} [category] Filter by milestone category
+     * @param {string} [competition] Filter by competition
+     * @param {string} [sourceId] Filter by source id
+     * @param {string} [type] Filter by milestone type
+     * @param {string} [relatedEventTicker] Filter by related event ticker
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestones(limit: number, minimumStartDate?: string, category?: string, competition?: string, sourceId?: string, type?: string, relatedEventTicker?: string, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMilestonesResponse>;
+};
+/**
+ * MilestoneApi - object-oriented interface
+ */
+export declare class MilestoneApi extends BaseAPI {
+    /**
+     *  Endpoint for getting data about a specific milestone by its ID.
+     * @summary Get Milestone
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestoneResponse, any, {}>>;
+    /**
+     * Minimum start date to filter milestones. Format: RFC3339 timestamp
+     * @summary Get Milestones
+     * @param {number} limit Number of milestones to return per page
+     * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+     * @param {string} [category] Filter by milestone category
+     * @param {string} [competition] Filter by competition
+     * @param {string} [sourceId] Filter by source id
+     * @param {string} [type] Filter by milestone type
+     * @param {string} [relatedEventTicker] Filter by related event ticker
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestones(limit: number, minimumStartDate?: string, category?: string, competition?: string, sourceId?: string, type?: string, relatedEventTicker?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any, {}>>;
+}

package/dist/esm/api/milestone-api.js

@@ -0,0 +1,242 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL } from 'url';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * MilestoneApi - axios parameter creator
+ */
+export const MilestoneApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *  Endpoint for getting data about a specific milestone by its ID.
+         * @summary Get Milestone
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestone: (milestoneId_1, ...args_1) => __awaiter(this, [milestoneId_1, ...args_1], void 0, function* (milestoneId, options = {}) {
+            // verify required parameter 'milestoneId' is not null or undefined
+            assertParamExists('getMilestone', 'milestoneId', milestoneId);
+            const localVarPath = `/milestones/{milestone_id}`
+                .replace(`{${"milestone_id"}}`, encodeURIComponent(String(milestoneId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Minimum start date to filter milestones. Format: RFC3339 timestamp
+         * @summary Get Milestones
+         * @param {number} limit Number of milestones to return per page
+         * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+         * @param {string} [category] Filter by milestone category
+         * @param {string} [competition] Filter by competition
+         * @param {string} [sourceId] Filter by source id
+         * @param {string} [type] Filter by milestone type
+         * @param {string} [relatedEventTicker] Filter by related event ticker
+         * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestones: (limit_1, minimumStartDate_1, category_1, competition_1, sourceId_1, type_1, relatedEventTicker_1, cursor_1, ...args_1) => __awaiter(this, [limit_1, minimumStartDate_1, category_1, competition_1, sourceId_1, type_1, relatedEventTicker_1, cursor_1, ...args_1], void 0, function* (limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options = {}) {
+            // verify required parameter 'limit' is not null or undefined
+            assertParamExists('getMilestones', 'limit', limit);
+            const localVarPath = `/milestones`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (minimumStartDate !== undefined) {
+                localVarQueryParameter['minimum_start_date'] = (minimumStartDate instanceof Date) ?
+                    minimumStartDate.toISOString() :
+                    minimumStartDate;
+            }
+            if (category !== undefined) {
+                localVarQueryParameter['category'] = category;
+            }
+            if (competition !== undefined) {
+                localVarQueryParameter['competition'] = competition;
+            }
+            if (sourceId !== undefined) {
+                localVarQueryParameter['source_id'] = sourceId;
+            }
+            if (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (relatedEventTicker !== undefined) {
+                localVarQueryParameter['related_event_ticker'] = relatedEventTicker;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * MilestoneApi - functional programming interface
+ */
+export const MilestoneApiFp = function (configuration) {
+    const localVarAxiosParamCreator = MilestoneApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *  Endpoint for getting data about a specific milestone by its ID.
+         * @summary Get Milestone
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestone(milestoneId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMilestone(milestoneId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Minimum start date to filter milestones. Format: RFC3339 timestamp
+         * @summary Get Milestones
+         * @param {number} limit Number of milestones to return per page
+         * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+         * @param {string} [category] Filter by milestone category
+         * @param {string} [competition] Filter by competition
+         * @param {string} [sourceId] Filter by source id
+         * @param {string} [type] Filter by milestone type
+         * @param {string} [relatedEventTicker] Filter by related event ticker
+         * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * MilestoneApi - factory interface
+ */
+export const MilestoneApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = MilestoneApiFp(configuration);
+    return {
+        /**
+         *  Endpoint for getting data about a specific milestone by its ID.
+         * @summary Get Milestone
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestone(milestoneId, options) {
+            return localVarFp.getMilestone(milestoneId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Minimum start date to filter milestones. Format: RFC3339 timestamp
+         * @summary Get Milestones
+         * @param {number} limit Number of milestones to return per page
+         * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+         * @param {string} [category] Filter by milestone category
+         * @param {string} [competition] Filter by competition
+         * @param {string} [sourceId] Filter by source id
+         * @param {string} [type] Filter by milestone type
+         * @param {string} [relatedEventTicker] Filter by related event ticker
+         * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options) {
+            return localVarFp.getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * MilestoneApi - object-oriented interface
+ */
+export class MilestoneApi extends BaseAPI {
+    /**
+     *  Endpoint for getting data about a specific milestone by its ID.
+     * @summary Get Milestone
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestone(milestoneId, options) {
+        return MilestoneApiFp(this.configuration).getMilestone(milestoneId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Minimum start date to filter milestones. Format: RFC3339 timestamp
+     * @summary Get Milestones
+     * @param {number} limit Number of milestones to return per page
+     * @param {string} [minimumStartDate] Minimum start date to filter milestones. Format RFC3339 timestamp
+     * @param {string} [category] Filter by milestone category
+     * @param {string} [competition] Filter by competition
+     * @param {string} [sourceId] Filter by source id
+     * @param {string} [type] Filter by milestone type
+     * @param {string} [relatedEventTicker] Filter by related event ticker
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options) {
+        return MilestoneApiFp(this.configuration).getMilestones(limit, minimumStartDate, category, competition, sourceId, type, relatedEventTicker, cursor, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/multivariate-api.d.ts

@@ -0,0 +1,242 @@
+/**
+ * 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
+ *
+ *
+ * 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 { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CreateMarketInMultivariateEventCollectionRequest } from '../models';
+import type { CreateMarketInMultivariateEventCollectionResponse } from '../models';
+import type { GetMultivariateEventCollectionLookupHistoryResponse } from '../models';
+import type { GetMultivariateEventCollectionResponse } from '../models';
+import type { GetMultivariateEventCollectionsResponse } from '../models';
+import type { LookupTickersForMarketInMultivariateEventCollectionRequest } from '../models';
+import type { LookupTickersForMarketInMultivariateEventCollectionResponse } from '../models';
+/**
+ * MultivariateApi - axios parameter creator
+ */
+export declare const MultivariateApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection: (collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection: (collectionTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory: (collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections: (status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection: (collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MultivariateApi - functional programming interface
+ */
+export declare const MultivariateApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMarketInMultivariateEventCollectionResponse>>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionResponse>>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionLookupHistoryResponse>>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionsResponse>>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LookupTickersForMarketInMultivariateEventCollectionResponse>>;
+};
+/**
+ * MultivariateApi - factory interface
+ */
+export declare const MultivariateApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMarketInMultivariateEventCollectionResponse>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionResponse>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionLookupHistoryResponse>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionsResponse>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<LookupTickersForMarketInMultivariateEventCollectionResponse>;
+};
+/**
+ * MultivariateApi - object-oriented interface
+ */
+export declare class MultivariateApi extends BaseAPI {
+    /**
+     *  Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMarketInMultivariateEventCollectionResponse, any, {}>>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any, {}>>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionLookupHistoryResponse, any, {}>>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any, {}>>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupTickersForMarketInMultivariateEventCollectionResponse, any, {}>>;
+}
+export declare const GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum: {
+    readonly NUMBER_10: 10;
+    readonly NUMBER_60: 60;
+    readonly NUMBER_300: 300;
+    readonly NUMBER_3600: 3600;
+};
+export type GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum = typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum[keyof typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum];
+export declare const GetMultivariateEventCollectionsStatusEnum: {
+    readonly Unopened: "unopened";
+    readonly Open: "open";
+    readonly Closed: "closed";
+};
+export type GetMultivariateEventCollectionsStatusEnum = typeof GetMultivariateEventCollectionsStatusEnum[keyof typeof GetMultivariateEventCollectionsStatusEnum];