kalshi-typescript 2.1.3 → 3.3.0

package/dist/api/api-keys-api.js

@@ -2,11 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * 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
@@ -38,7 +38,7 @@ const base_1 = require("../base");
 const ApiKeysApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -57,9 +57,12 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication bearerAuth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
             localVarHeaderParameter['Content-Type'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -71,7 +74,7 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -91,9 +94,12 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication bearerAuth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -103,7 +109,7 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -122,9 +128,12 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication bearerAuth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
             localVarHeaderParameter['Content-Type'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -136,7 +145,7 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -152,9 +161,12 @@ const ApiKeysApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication bearerAuth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -173,7 +185,7 @@ const ApiKeysApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ApiKeysApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -189,7 +201,7 @@ const ApiKeysApiFp = function (configuration) {
             });
         },
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -205,7 +217,7 @@ const ApiKeysApiFp = function (configuration) {
             });
         },
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -221,7 +233,7 @@ const ApiKeysApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -245,7 +257,7 @@ const ApiKeysApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ApiKeysApiFp)(configuration);
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -255,7 +267,7 @@ const ApiKeysApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createApiKey(createApiKeyRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -265,7 +277,7 @@ const ApiKeysApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteApiKey(apiKey, options).then((request) => request(axios, basePath));
         },
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest
          * @param {*} [options] Override http request option.
@@ -275,7 +287,7 @@ const ApiKeysApiFactory = function (configuration, basePath, axios) {
             return localVarFp.generateApiKey(generateApiKeyRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -291,7 +303,7 @@ exports.ApiKeysApiFactory = ApiKeysApiFactory;
  */
 class ApiKeysApi extends base_1.BaseAPI {
     /**
-     * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
+     *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
      * @summary Create API Key
      * @param {CreateApiKeyRequest} createApiKeyRequest
      * @param {*} [options] Override http request option.
@@ -301,7 +313,7 @@ class ApiKeysApi extends base_1.BaseAPI {
         return (0, exports.ApiKeysApiFp)(this.configuration).createApiKey(createApiKeyRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
+     *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
      * @summary Delete API Key
      * @param {string} apiKey API key ID to delete
      * @param {*} [options] Override http request option.
@@ -311,7 +323,7 @@ class ApiKeysApi extends base_1.BaseAPI {
         return (0, exports.ApiKeysApiFp)(this.configuration).deleteApiKey(apiKey, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
+     *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
      * @summary Generate API Key
      * @param {GenerateApiKeyRequest} generateApiKeyRequest
      * @param {*} [options] Override http request option.
@@ -321,7 +333,7 @@ class ApiKeysApi extends base_1.BaseAPI {
         return (0, exports.ApiKeysApiFp)(this.configuration).generateApiKey(generateApiKeyRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
+     *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
      * @summary Get API Keys
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/collection-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: 2.0.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';
+/**
+ * CollectionApi - axios parameter creator
+ */
+export declare const CollectionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for looking up 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>;
+};
+/**
+ * CollectionApi - functional programming interface
+ */
+export declare const CollectionApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for looking up 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>>;
+};
+/**
+ * CollectionApi - factory interface
+ */
+export declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for looking up 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>;
+};
+/**
+ * CollectionApi - object-oriented interface
+ */
+export declare class CollectionApi extends BaseAPI {
+    /**
+     *  Endpoint for looking up 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];