kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
105 lines (104 loc) • 4.39 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 { GetMilestoneResponse } from '../models';
import type { GetMilestonesResponse } from '../models';
/**
* MilestonesApi - axios parameter creator
*/
export declare const MilestonesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get a single milestone by ID
* @summary Get Milestone
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestone: (milestoneId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get all milestones
* @summary Get Milestones
* @param {string} [status] Filter by milestone status
* @param {number} [limit] Number of items per page (minimum 1, maximum 500)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestones: (status?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* MilestonesApi - functional programming interface
*/
export declare const MilestonesApiFp: (configuration?: Configuration) => {
/**
* Get a single milestone by 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>>;
/**
* Get all milestones
* @summary Get Milestones
* @param {string} [status] Filter by milestone status
* @param {number} [limit] Number of items per page (minimum 1, maximum 500)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMilestonesResponse>>;
};
/**
* MilestonesApi - factory interface
*/
export declare const MilestonesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get a single milestone by ID
* @summary Get Milestone
* @param {string} milestoneId Milestone ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMilestoneResponse>;
/**
* Get all milestones
* @summary Get Milestones
* @param {string} [status] Filter by milestone status
* @param {number} [limit] Number of items per page (minimum 1, maximum 500)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetMilestonesResponse>;
};
/**
* MilestonesApi - object-oriented interface
*/
export declare class MilestonesApi extends BaseAPI {
/**
* Get a single milestone by 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, {}>>;
/**
* Get all milestones
* @summary Get Milestones
* @param {string} [status] Filter by milestone status
* @param {number} [limit] Number of items per page (minimum 1, maximum 500)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any, {}>>;
}