kalshi-typescript/dist/api/search-api.d.ts

OpenAPI client for kalshi-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 { GetFiltersBySportsResponse } from '../models';
import type { GetTagsForSeriesCategoriesResponse } from '../models';
/**
 * SearchApi - axios parameter creator
 */
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
     * @summary Get Filters for Sports
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFiltersForSports: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
     * @summary Get Tags for Series Categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTagsForSeriesCategories: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SearchApi - functional programming interface
 */
export declare const SearchApiFp: (configuration?: Configuration) => {
    /**
     * Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
     * @summary Get Filters for Sports
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFiltersForSports(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFiltersBySportsResponse>>;
    /**
     * Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
     * @summary Get Tags for Series Categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTagsForSeriesCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTagsForSeriesCategoriesResponse>>;
};
/**
 * SearchApi - factory interface
 */
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
     * @summary Get Filters for Sports
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFiltersForSports(options?: RawAxiosRequestConfig): AxiosPromise<GetFiltersBySportsResponse>;
    /**
     * Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
     * @summary Get Tags for Series Categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTagsForSeriesCategories(options?: RawAxiosRequestConfig): AxiosPromise<GetTagsForSeriesCategoriesResponse>;
};
/**
 * SearchApi - object-oriented interface
 */
export declare class SearchApi extends BaseAPI {
    /**
     * Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
     * @summary Get Filters for Sports
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFiltersForSports(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFiltersBySportsResponse, any, {}>>;
    /**
     * Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
     * @summary Get Tags for Series Categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTagsForSeriesCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagsForSeriesCategoriesResponse, any, {}>>;
}