kalshi-typescript/api/multivariate-api.ts

OpenAPI client for kalshi-typescript

/* 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.11.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 globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import type { CreateMarketInMultivariateEventCollectionRequest } from '../models';
// @ts-ignore
import type { CreateMarketInMultivariateEventCollectionResponse } from '../models';
// @ts-ignore
import type { ErrorResponse } from '../models';
// @ts-ignore
import type { GetMultivariateEventCollectionLookupHistoryResponse } from '../models';
// @ts-ignore
import type { GetMultivariateEventCollectionResponse } from '../models';
// @ts-ignore
import type { GetMultivariateEventCollectionsResponse } from '../models';
// @ts-ignore
import type { LookupTickersForMarketInMultivariateEventCollectionRequest } from '../models';
// @ts-ignore
import type { LookupTickersForMarketInMultivariateEventCollectionResponse } from '../models';
/**
 * MultivariateApi - axios parameter creator
 */
export const MultivariateApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * 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. Users are limited to 5000 creations per week.
         * @summary Create Market In Multivariate Event Collection
         * @param {string} collectionTicker Collection ticker
         * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        createMarketInMultivariateEventCollection: async (collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'collectionTicker' is not null or undefined
            assertParamExists('createMarketInMultivariateEventCollection', 'collectionTicker', collectionTicker)
            // verify required parameter 'createMarketInMultivariateEventCollectionRequest' is not null or undefined
            assertParamExists('createMarketInMultivariateEventCollection', 'createMarketInMultivariateEventCollectionRequest', createMarketInMultivariateEventCollectionRequest)
            const localVarPath = `/multivariate_event_collections/{collection_ticker}`
                .replace(`{${"collection_ticker"}}`, encodeURIComponent(String(collectionTicker)));
            // 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 = { method: 'POST', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication kalshiAccessSignature required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)

            // authentication kalshiAccessKey required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)

            // authentication kalshiAccessTimestamp required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)


    
            localVarHeaderParameter['Content-Type'] = 'application/json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(createMarketInMultivariateEventCollectionRequest, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         *  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: async (collectionTicker: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'collectionTicker' is not null or undefined
            assertParamExists('getMultivariateEventCollection', 'collectionTicker', collectionTicker)
            const localVarPath = `/multivariate_event_collections/{collection_ticker}`
                .replace(`{${"collection_ticker"}}`, encodeURIComponent(String(collectionTicker)));
            // 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 = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         *  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: async (collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'collectionTicker' is not null or undefined
            assertParamExists('getMultivariateEventCollectionLookupHistory', 'collectionTicker', collectionTicker)
            // verify required parameter 'lookbackSeconds' is not null or undefined
            assertParamExists('getMultivariateEventCollectionLookupHistory', 'lookbackSeconds', lookbackSeconds)
            const localVarPath = `/multivariate_event_collections/{collection_ticker}/lookup`
                .replace(`{${"collection_ticker"}}`, encodeURIComponent(String(collectionTicker)));
            // 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 = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            if (lookbackSeconds !== undefined) {
                localVarQueryParameter['lookback_seconds'] = lookbackSeconds;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         *  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: async (status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/multivariate_event_collections`;
            // 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 = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            if (status !== undefined) {
                localVarQueryParameter['status'] = status;
            }

            if (associatedEventTicker !== undefined) {
                localVarQueryParameter['associated_event_ticker'] = associatedEventTicker;
            }

            if (seriesTicker !== undefined) {
                localVarQueryParameter['series_ticker'] = seriesTicker;
            }

            if (limit !== undefined) {
                localVarQueryParameter['limit'] = limit;
            }

            if (cursor !== undefined) {
                localVarQueryParameter['cursor'] = cursor;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         *  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: async (collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'collectionTicker' is not null or undefined
            assertParamExists('lookupTickersForMarketInMultivariateEventCollection', 'collectionTicker', collectionTicker)
            // verify required parameter 'lookupTickersForMarketInMultivariateEventCollectionRequest' is not null or undefined
            assertParamExists('lookupTickersForMarketInMultivariateEventCollection', 'lookupTickersForMarketInMultivariateEventCollectionRequest', lookupTickersForMarketInMultivariateEventCollectionRequest)
            const localVarPath = `/multivariate_event_collections/{collection_ticker}/lookup`
                .replace(`{${"collection_ticker"}}`, encodeURIComponent(String(collectionTicker)));
            // 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 = { method: 'PUT', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication kalshiAccessSignature required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)

            // authentication kalshiAccessKey required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)

            // authentication kalshiAccessTimestamp required
            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)


    
            localVarHeaderParameter['Content-Type'] = 'application/json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(lookupTickersForMarketInMultivariateEventCollectionRequest, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
    }
};

/**
 * MultivariateApi - functional programming interface
 */
export const MultivariateApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = MultivariateApiAxiosParamCreator(configuration)
    return {
        /**
         * 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. Users are limited to 5000 creations per week.
         * @summary Create Market In Multivariate Event Collection
         * @param {string} collectionTicker Collection ticker
         * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMarketInMultivariateEventCollectionResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.createMarketInMultivariateEventCollection(collectionTicker, createMarketInMultivariateEventCollectionRequest, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         *  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}
         */
        async getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getMultivariateEventCollection(collectionTicker, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         *  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}
         */
        async getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionLookupHistoryResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getMultivariateEventCollectionLookupHistory(collectionTicker, lookbackSeconds, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         *  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}
         */
        async getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionsResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getMultivariateEventCollections(status, associatedEventTicker, seriesTicker, limit, cursor, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         *  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}
         */
        async lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LookupTickersForMarketInMultivariateEventCollectionResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.lookupTickersForMarketInMultivariateEventCollection(collectionTicker, lookupTickersForMarketInMultivariateEventCollectionRequest, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
    }
};

/**
 * MultivariateApi - factory interface
 */
export const MultivariateApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = MultivariateApiFp(configuration)
    return {
        /**
         * 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. Users are limited to 5000 creations per week.
         * @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> {
            return localVarFp.createMarketInMultivariateEventCollection(collectionTicker, createMarketInMultivariateEventCollectionRequest, options).then((request) => request(axios, basePath));
        },
        /**
         *  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> {
            return localVarFp.getMultivariateEventCollection(collectionTicker, options).then((request) => request(axios, basePath));
        },
        /**
         *  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> {
            return localVarFp.getMultivariateEventCollectionLookupHistory(collectionTicker, lookbackSeconds, options).then((request) => request(axios, basePath));
        },
        /**
         *  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> {
            return localVarFp.getMultivariateEventCollections(status, associatedEventTicker, seriesTicker, limit, cursor, options).then((request) => request(axios, basePath));
        },
        /**
         *  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> {
            return localVarFp.lookupTickersForMarketInMultivariateEventCollection(collectionTicker, lookupTickersForMarketInMultivariateEventCollectionRequest, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * MultivariateApi - object-oriented interface
 */
export 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. Users are limited to 5000 creations per week.
     * @summary Create Market In Multivariate Event Collection
     * @param {string} collectionTicker Collection ticker
     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    public createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) {
        return MultivariateApiFp(this.configuration).createMarketInMultivariateEventCollection(collectionTicker, createMarketInMultivariateEventCollectionRequest, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     *  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}
     */
    public getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig) {
        return MultivariateApiFp(this.configuration).getMultivariateEventCollection(collectionTicker, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     *  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}
     */
    public getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig) {
        return MultivariateApiFp(this.configuration).getMultivariateEventCollectionLookupHistory(collectionTicker, lookbackSeconds, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     *  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}
     */
    public getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
        return MultivariateApiFp(this.configuration).getMultivariateEventCollections(status, associatedEventTicker, seriesTicker, limit, cursor, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     *  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}
     */
    public lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) {
        return MultivariateApiFp(this.configuration).lookupTickersForMarketInMultivariateEventCollection(collectionTicker, lookupTickersForMarketInMultivariateEventCollectionRequest, options).then((request) => request(this.axios, this.basePath));
    }
}

export const GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum = {
    NUMBER_10: 10,
    NUMBER_60: 60,
    NUMBER_300: 300,
    NUMBER_3600: 3600
} as const;
export type GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum = typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum[keyof typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum];
export const GetMultivariateEventCollectionsStatusEnum = {
    Unopened: 'unopened',
    Open: 'open',
    Closed: 'closed'
} as const;
export type GetMultivariateEventCollectionsStatusEnum = typeof GetMultivariateEventCollectionsStatusEnum[keyof typeof GetMultivariateEventCollectionsStatusEnum];