kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
64 lines (63 loc) • 2.54 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.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 { type RequestArgs, BaseAPI } from '../base';
import type { GetAccountApiLimitsResponse } from '../models';
/**
* AccountApi - axios parameter creator
*/
export declare const AccountApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Endpoint to retrieve the API tier limits associated with the authenticated user.
* @summary Get Account API Limits
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccountApiLimits: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* AccountApi - functional programming interface
*/
export declare const AccountApiFp: (configuration?: Configuration) => {
/**
* Endpoint to retrieve the API tier limits associated with the authenticated user.
* @summary Get Account API Limits
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccountApiLimits(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountApiLimitsResponse>>;
};
/**
* AccountApi - factory interface
*/
export declare const AccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Endpoint to retrieve the API tier limits associated with the authenticated user.
* @summary Get Account API Limits
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccountApiLimits(options?: RawAxiosRequestConfig): AxiosPromise<GetAccountApiLimitsResponse>;
};
/**
* AccountApi - object-oriented interface
*/
export declare class AccountApi extends BaseAPI {
/**
* Endpoint to retrieve the API tier limits associated with the authenticated user.
* @summary Get Account API Limits
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccountApiLimits(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountApiLimitsResponse, any, {}>>;
}