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

OpenAPI client for kalshi-typescript

/* tslint:disable */
/* eslint-disable */
/**
 * 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 globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import type { ErrorResponse } from '../models';
// @ts-ignore
import type { GetIncentiveProgramsResponse } from '../models';
/**
 * IncentiveProgramsApi - axios parameter creator
 */
export const IncentiveProgramsApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         *  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: async (status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/incentive_programs`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            if (status !== undefined) {
                localVarQueryParameter['status'] = status;
            }

            if (type !== undefined) {
                localVarQueryParameter['type'] = type;
            }

            if (limit !== undefined) {
                localVarQueryParameter['limit'] = limit;
            }

            if (cursor !== undefined) {
                localVarQueryParameter['cursor'] = cursor;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
    }
};

/**
 * IncentiveProgramsApi - functional programming interface
 */
export const IncentiveProgramsApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = IncentiveProgramsApiAxiosParamCreator(configuration)
    return {
        /**
         *  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}
         */
        async getIncentivePrograms(status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIncentiveProgramsResponse>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getIncentivePrograms(status, type, limit, cursor, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath: string | undefined = undefined;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
    }
};

/**
 * IncentiveProgramsApi - factory interface
 */
export const IncentiveProgramsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = IncentiveProgramsApiFp(configuration)
    return {
        /**
         *  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> {
            return localVarFp.getIncentivePrograms(status, type, limit, cursor, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * IncentiveProgramsApi - object-oriented interface
 */
export 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}
     */
    public getIncentivePrograms(status?: GetIncentiveProgramsStatusEnum, type?: GetIncentiveProgramsTypeEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
        return IncentiveProgramsApiFp(this.configuration).getIncentivePrograms(status, type, limit, cursor, options).then((request) => request(this.axios, this.basePath));
    }
}

export const GetIncentiveProgramsStatusEnum = {
    All: 'all',
    Active: 'active',
    Upcoming: 'upcoming',
    Closed: 'closed',
    PaidOut: 'paid_out'
} as const;
export type GetIncentiveProgramsStatusEnum = typeof GetIncentiveProgramsStatusEnum[keyof typeof GetIncentiveProgramsStatusEnum];
export const GetIncentiveProgramsTypeEnum = {
    All: 'all',
    Liquidity: 'liquidity',
    Volume: 'volume'
} as const;
export type GetIncentiveProgramsTypeEnum = typeof GetIncentiveProgramsTypeEnum[keyof typeof GetIncentiveProgramsTypeEnum];