kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
105 lines (104 loc) • 4.41 kB
TypeScript
/**
* Kalshi Trade API Manual Endpoints
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
*
* The version of the OpenAPI document: 3.6.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 { GetLiveDataResponse } from '../models';
import type { GetLiveDatasResponse } from '../models';
/**
* LiveDataApi - axios parameter creator
*/
export declare const LiveDataApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get live data for a specific milestone
* @summary Get Live Data
* @param {string} type Type of live data
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveData: (type: string, milestoneId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get live data for multiple milestones
* @summary Get Multiple Live Data
* @param {Array<string>} milestoneIds Array of milestone IDs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveDatas: (milestoneIds: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* LiveDataApi - functional programming interface
*/
export declare const LiveDataApiFp: (configuration?: Configuration) => {
/**
* Get live data for a specific milestone
* @summary Get Live Data
* @param {string} type Type of live data
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDataResponse>>;
/**
* Get live data for multiple milestones
* @summary Get Multiple Live Data
* @param {Array<string>} milestoneIds Array of milestone IDs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDatasResponse>>;
};
/**
* LiveDataApi - factory interface
*/
export declare const LiveDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get live data for a specific milestone
* @summary Get Live Data
* @param {string} type Type of live data
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDataResponse>;
/**
* Get live data for multiple milestones
* @summary Get Multiple Live Data
* @param {Array<string>} milestoneIds Array of milestone IDs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDatasResponse>;
};
/**
* LiveDataApi - object-oriented interface
*/
export declare class LiveDataApi extends BaseAPI {
/**
* Get live data for a specific milestone
* @summary Get Live Data
* @param {string} type Type of live data
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLiveDataResponse, any, {}>>;
/**
* Get live data for multiple milestones
* @summary Get Multiple Live Data
* @param {Array<string>} milestoneIds Array of milestone IDs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLiveDatasResponse, any, {}>>;
}