kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
139 lines (138 loc) • 7.11 kB
TypeScript
/**
* Kalshi Trading API
* Complete API for the Kalshi trading platform including all handlers for SDK generation
*
* 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
* 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 { GetMultivariateEventCollectionResponse } from '../models';
import type { GetMultivariateEventCollectionsResponse } from '../models';
import type { LookupBundleRequest } from '../models';
import type { LookupBundleResponse } from '../models';
/**
* MultivariateCollectionsApi - axios parameter creator
*/
export declare const MultivariateCollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get a single multivariate event collection by 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>;
/**
* Get all multivariate event collections
* @summary Get Multivariate Event Collections
* @param {string} [status] Filter by multivariate collection status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultivariateEventCollections: (status?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Lookup a bundle in a multivariate event collection
* @summary Lookup Multivariate Event Collection Bundle
* @param {string} collectionTicker Collection ticker
* @param {LookupBundleRequest} lookupBundleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
lookupMultivariateEventCollectionBundle: (collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* MultivariateCollectionsApi - functional programming interface
*/
export declare const MultivariateCollectionsApiFp: (configuration?: Configuration) => {
/**
* Get a single multivariate event collection by 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>>;
/**
* Get all multivariate event collections
* @summary Get Multivariate Event Collections
* @param {string} [status] Filter by multivariate collection status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionsResponse>>;
/**
* Lookup a bundle in a multivariate event collection
* @summary Lookup Multivariate Event Collection Bundle
* @param {string} collectionTicker Collection ticker
* @param {LookupBundleRequest} lookupBundleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LookupBundleResponse>>;
};
/**
* MultivariateCollectionsApi - factory interface
*/
export declare const MultivariateCollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get a single multivariate event collection by 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>;
/**
* Get all multivariate event collections
* @summary Get Multivariate Event Collections
* @param {string} [status] Filter by multivariate collection status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionsResponse>;
/**
* Lookup a bundle in a multivariate event collection
* @summary Lookup Multivariate Event Collection Bundle
* @param {string} collectionTicker Collection ticker
* @param {LookupBundleRequest} lookupBundleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): AxiosPromise<LookupBundleResponse>;
};
/**
* MultivariateCollectionsApi - object-oriented interface
*/
export declare class MultivariateCollectionsApi extends BaseAPI {
/**
* Get a single multivariate event collection by 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, {}>>;
/**
* Get all multivariate event collections
* @summary Get Multivariate Event Collections
* @param {string} [status] Filter by multivariate collection status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any, {}>>;
/**
* Lookup a bundle in a multivariate event collection
* @summary Lookup Multivariate Event Collection Bundle
* @param {string} collectionTicker Collection ticker
* @param {LookupBundleRequest} lookupBundleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupBundleResponse, any, {}>>;
}