kalshi-typescript/dist/api/incentive-programs-api.d.ts

Official TypeScript SDK for the Kalshi API

/**
 * 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 { GetIncentiveProgramsResponse } from '../models';
/**
 * IncentiveProgramsApi - axios parameter creator
 */
export declare const IncentiveProgramsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
     * @summary Get Incentives
     * @param {GetIncentiveProgramsStatusEnum} [status] Status filter. Can be \"all\", \"active\", \"upcoming\", \"closed\", or \"paid_out\". Default is \"all\".
     * @param {GetIncentiveProgramsTypeEnum} [type] Type filter. Can be \"all\", \"liquidity\", or \"volume\". Default is \"all\".
     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 10000.
     * @param {string} [cursor] Cursor for pagination
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIncentivePrograms: (status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * IncentiveProgramsApi - functional programming interface
 */
export declare const IncentiveProgramsApiFp: (configuration?: Configuration) => {
    /**
     *  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
     * @summary Get Incentives
     * @param {GetIncentiveProgramsStatusEnum} [status] Status filter. Can be \&quot;all\&quot;, \&quot;active\&quot;, \&quot;upcoming\&quot;, \&quot;closed\&quot;, or \&quot;paid_out\&quot;. Default is \&quot;all\&quot;.
     * @param {GetIncentiveProgramsTypeEnum} [type] Type filter. Can be \&quot;all\&quot;, \&quot;liquidity\&quot;, or \&quot;volume\&quot;. Default is \&quot;all\&quot;.
     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 10000.
     * @param {string} [cursor] Cursor for pagination
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIncentivePrograms(status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIncentiveProgramsResponse>>;
};
/**
 * IncentiveProgramsApi - factory interface
 */
export declare const IncentiveProgramsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
     * @summary Get Incentives
     * @param {GetIncentiveProgramsStatusEnum} [status] Status filter. Can be \&quot;all\&quot;, \&quot;active\&quot;, \&quot;upcoming\&quot;, \&quot;closed\&quot;, or \&quot;paid_out\&quot;. Default is \&quot;all\&quot;.
     * @param {GetIncentiveProgramsTypeEnum} [type] Type filter. Can be \&quot;all\&quot;, \&quot;liquidity\&quot;, or \&quot;volume\&quot;. Default is \&quot;all\&quot;.
     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 10000.
     * @param {string} [cursor] Cursor for pagination
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIncentivePrograms(status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetIncentiveProgramsResponse>;
};
/**
 * IncentiveProgramsApi - object-oriented interface
 */
export declare class IncentiveProgramsApi extends BaseAPI {
    /**
     *  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
     * @summary Get Incentives
     * @param {GetIncentiveProgramsStatusEnum} [status] Status filter. Can be \&quot;all\&quot;, \&quot;active\&quot;, \&quot;upcoming\&quot;, \&quot;closed\&quot;, or \&quot;paid_out\&quot;. Default is \&quot;all\&quot;.
     * @param {GetIncentiveProgramsTypeEnum} [type] Type filter. Can be \&quot;all\&quot;, \&quot;liquidity\&quot;, or \&quot;volume\&quot;. Default is \&quot;all\&quot;.
     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 10000.
     * @param {string} [cursor] Cursor for pagination
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getIncentivePrograms(status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIncentiveProgramsResponse, any, {}>>;
}
export declare const GetIncentiveProgramsStatusEnum: {
    readonly All: "all";
    readonly Active: "active";
    readonly Upcoming: "upcoming";
    readonly Closed: "closed";
    readonly PaidOut: "paid_out";
};
export type GetIncentiveProgramsStatusEnum = typeof GetIncentiveProgramsStatusEnum[keyof typeof GetIncentiveProgramsStatusEnum];
export declare const GetIncentiveProgramsTypeEnum: {
    readonly All: "all";
    readonly Liquidity: "liquidity";
    readonly Volume: "volume";
};
export type GetIncentiveProgramsTypeEnum = typeof GetIncentiveProgramsTypeEnum[keyof typeof GetIncentiveProgramsTypeEnum];