kalshi-typescript 2.1.3 → 3.0.0

package/api/incentive-programs-api.ts

@@ -0,0 +1,168 @@
+/* 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.0.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 volume incentives with optional filters. Volume incentives are rewards programs for trading activity on specific markets.
+         * @summary Get Volume 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 volume incentives with optional filters. Volume incentives are rewards programs for trading activity on specific markets.
+         * @summary Get Volume 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 volume incentives with optional filters. Volume incentives are rewards programs for trading activity on specific markets.
+         * @summary Get Volume 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 volume incentives with optional filters. Volume incentives are rewards programs for trading activity on specific markets.
+     * @summary Get Volume 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];

package/api/live-data-api.ts

@@ -0,0 +1,207 @@
+/* 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.0.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 { GetLiveDataResponse } from '../models';
+// @ts-ignore
+import type { GetLiveDatasResponse } from '../models';
+/**
+ * LiveDataApi - axios parameter creator
+ */
+export const LiveDataApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get live data for a specific milestone
+         * @summary Get Live Data
+         * @param {string} type Type of live data
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveData: async (type: string, milestoneId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'type' is not null or undefined
+            assertParamExists('getLiveData', 'type', type)
+            // verify required parameter 'milestoneId' is not null or undefined
+            assertParamExists('getLiveData', 'milestoneId', milestoneId)
+            const localVarPath = `/live_data/{type}/milestone/{milestone_id}`
+                .replace(`{${"type"}}`, encodeURIComponent(String(type)))
+                .replace(`{${"milestone_id"}}`, encodeURIComponent(String(milestoneId)));
+            // 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;
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get live data for multiple milestones
+         * @summary Get Multiple Live Data
+         * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveDatas: async (milestoneIds: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'milestoneIds' is not null or undefined
+            assertParamExists('getLiveDatas', 'milestoneIds', milestoneIds)
+            const localVarPath = `/live_data/batch`;
+            // 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 (milestoneIds) {
+                localVarQueryParameter['milestone_ids'] = milestoneIds;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * LiveDataApi - functional programming interface
+ */
+export const LiveDataApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = LiveDataApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get live data for a specific milestone
+         * @summary Get Live Data
+         * @param {string} type Type of live data
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDataResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLiveData(type, milestoneId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get live data for multiple milestones
+         * @summary Get Multiple Live Data
+         * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDatasResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLiveDatas(milestoneIds, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * LiveDataApi - factory interface
+ */
+export const LiveDataApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = LiveDataApiFp(configuration)
+    return {
+        /**
+         * Get live data for a specific milestone
+         * @summary Get Live Data
+         * @param {string} type Type of live data
+         * @param {string} milestoneId Milestone ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDataResponse> {
+            return localVarFp.getLiveData(type, milestoneId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get live data for multiple milestones
+         * @summary Get Multiple Live Data
+         * @param {Array<string>} milestoneIds Array of milestone IDs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDatasResponse> {
+            return localVarFp.getLiveDatas(milestoneIds, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * LiveDataApi - object-oriented interface
+ */
+export class LiveDataApi extends BaseAPI {
+    /**
+     * Get live data for a specific milestone
+     * @summary Get Live Data
+     * @param {string} type Type of live data
+     * @param {string} milestoneId Milestone ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getLiveData(type: string, milestoneId: string, options?: RawAxiosRequestConfig) {
+        return LiveDataApiFp(this.configuration).getLiveData(type, milestoneId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get live data for multiple milestones
+     * @summary Get Multiple Live Data
+     * @param {Array<string>} milestoneIds Array of milestone IDs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getLiveDatas(milestoneIds: Array<string>, options?: RawAxiosRequestConfig) {
+        return LiveDataApiFp(this.configuration).getLiveDatas(milestoneIds, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+