kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
117 lines (116 loc) • 6.73 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 { GetStructuredTargetResponse } from '../models';
import type { GetStructuredTargetsResponse } from '../models';
/**
* StructuredTargetsApi - axios parameter creator
*/
export declare const StructuredTargetsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Endpoint for getting data about a specific structured target by its ID.
* @summary Get Structured Target
* @param {string} structuredTargetId Structured target ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTarget: (structuredTargetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Page size (min: 1, max: 2000)
* @summary Get Structured Targets
* @param {Array<string>} [ids] Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`).
* @param {string} [type] Filter by structured target type
* @param {string} [competition] Filter by competition. Matches against the league, conference, division, or tour in the structured target details.
* @param {number} [pageSize] Number of items per page (min 1, max 2000, default 100)
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTargets: (ids?: Array<string>, type?: string, competition?: string, pageSize?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* StructuredTargetsApi - functional programming interface
*/
export declare const StructuredTargetsApiFp: (configuration?: Configuration) => {
/**
* Endpoint for getting data about a specific structured target by its ID.
* @summary Get Structured Target
* @param {string} structuredTargetId Structured target ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTarget(structuredTargetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStructuredTargetResponse>>;
/**
* Page size (min: 1, max: 2000)
* @summary Get Structured Targets
* @param {Array<string>} [ids] Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`).
* @param {string} [type] Filter by structured target type
* @param {string} [competition] Filter by competition. Matches against the league, conference, division, or tour in the structured target details.
* @param {number} [pageSize] Number of items per page (min 1, max 2000, default 100)
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTargets(ids?: Array<string>, type?: string, competition?: string, pageSize?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStructuredTargetsResponse>>;
};
/**
* StructuredTargetsApi - factory interface
*/
export declare const StructuredTargetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Endpoint for getting data about a specific structured target by its ID.
* @summary Get Structured Target
* @param {string} structuredTargetId Structured target ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTarget(structuredTargetId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetStructuredTargetResponse>;
/**
* Page size (min: 1, max: 2000)
* @summary Get Structured Targets
* @param {Array<string>} [ids] Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`).
* @param {string} [type] Filter by structured target type
* @param {string} [competition] Filter by competition. Matches against the league, conference, division, or tour in the structured target details.
* @param {number} [pageSize] Number of items per page (min 1, max 2000, default 100)
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTargets(ids?: Array<string>, type?: string, competition?: string, pageSize?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetStructuredTargetsResponse>;
};
/**
* StructuredTargetsApi - object-oriented interface
*/
export declare class StructuredTargetsApi extends BaseAPI {
/**
* Endpoint for getting data about a specific structured target by its ID.
* @summary Get Structured Target
* @param {string} structuredTargetId Structured target ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTarget(structuredTargetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStructuredTargetResponse, any, {}>>;
/**
* Page size (min: 1, max: 2000)
* @summary Get Structured Targets
* @param {Array<string>} [ids] Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`).
* @param {string} [type] Filter by structured target type
* @param {string} [competition] Filter by competition. Matches against the league, conference, division, or tour in the structured target details.
* @param {number} [pageSize] Number of items per page (min 1, max 2000, default 100)
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStructuredTargets(ids?: Array<string>, type?: string, competition?: string, pageSize?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStructuredTargetsResponse, any, {}>>;
}