kalshi-typescript 2.1.3 → 3.0.0

package/api/order-groups-api.ts

@@ -0,0 +1,454 @@
+/* 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 { CreateOrderGroupRequest } from '../models';
+// @ts-ignore
+import type { CreateOrderGroupResponse } from '../models';
+// @ts-ignore
+import type { ErrorResponse } from '../models';
+// @ts-ignore
+import type { GetOrderGroupResponse } from '../models';
+// @ts-ignore
+import type { GetOrderGroupsResponse } from '../models';
+/**
+ * OrderGroupsApi - axios parameter creator
+ */
+export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         *  Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
+         * @summary Create Order Group
+         * @param {CreateOrderGroupRequest} createOrderGroupRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrderGroup: async (createOrderGroupRequest: CreateOrderGroupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createOrderGroupRequest' is not null or undefined
+            assertParamExists('createOrderGroup', 'createOrderGroupRequest', createOrderGroupRequest)
+            const localVarPath = `/portfolio/order_groups/create`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createOrderGroupRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         *  Deletes an order group and cancels all orders within it. This permanently removes the group.
+         * @summary Delete Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteOrderGroup: async (orderGroupId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orderGroupId' is not null or undefined
+            assertParamExists('deleteOrderGroup', 'orderGroupId', orderGroupId)
+            const localVarPath = `/portfolio/order_groups/{order_group_id}`
+                .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
+            // 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: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         *  Retrieves details for a single order group including all order IDs and auto-cancel status.
+         * @summary Get Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderGroup: async (orderGroupId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orderGroupId' is not null or undefined
+            assertParamExists('getOrderGroup', 'orderGroupId', orderGroupId)
+            const localVarPath = `/portfolio/order_groups/{order_group_id}`
+                .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
+            // 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;
+
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         *  Retrieves all order groups for the authenticated user.
+         * @summary Get Order Groups
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderGroups: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/portfolio/order_groups`;
+            // 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;
+
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
+         * @summary Reset Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {object} [body] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetOrderGroup: async (orderGroupId: string, body?: object, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orderGroupId' is not null or undefined
+            assertParamExists('resetOrderGroup', 'orderGroupId', orderGroupId)
+            const localVarPath = `/portfolio/order_groups/{order_group_id}/reset`
+                .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * OrderGroupsApi - functional programming interface
+ */
+export const OrderGroupsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = OrderGroupsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         *  Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
+         * @summary Create Order Group
+         * @param {CreateOrderGroupRequest} createOrderGroupRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderGroupResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createOrderGroup(createOrderGroupRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         *  Deletes an order group and cancels all orders within it. This permanently removes the group.
+         * @summary Delete Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrderGroup(orderGroupId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         *  Retrieves details for a single order group including all order IDs and auto-cancel status.
+         * @summary Get Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroup(orderGroupId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         *  Retrieves all order groups for the authenticated user.
+         * @summary Get Order Groups
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getOrderGroups(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroups(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
+         * @summary Reset Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {object} [body] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.resetOrderGroup(orderGroupId, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath: string | undefined = undefined;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * OrderGroupsApi - factory interface
+ */
+export const OrderGroupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = OrderGroupsApiFp(configuration)
+    return {
+        /**
+         *  Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
+         * @summary Create Order Group
+         * @param {CreateOrderGroupRequest} createOrderGroupRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderGroupResponse> {
+            return localVarFp.createOrderGroup(createOrderGroupRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *  Deletes an order group and cancels all orders within it. This permanently removes the group.
+         * @summary Delete Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.deleteOrderGroup(orderGroupId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *  Retrieves details for a single order group including all order IDs and auto-cancel status.
+         * @summary Get Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupResponse> {
+            return localVarFp.getOrderGroup(orderGroupId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *  Retrieves all order groups for the authenticated user.
+         * @summary Get Order Groups
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderGroups(options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupsResponse> {
+            return localVarFp.getOrderGroups(options).then((request) => request(axios, basePath));
+        },
+        /**
+         *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
+         * @summary Reset Order Group
+         * @param {string} orderGroupId Order group ID
+         * @param {object} [body] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object> {
+            return localVarFp.resetOrderGroup(orderGroupId, body, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * OrderGroupsApi - object-oriented interface
+ */
+export class OrderGroupsApi extends BaseAPI {
+    /**
+     *  Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
+     * @summary Create Order Group
+     * @param {CreateOrderGroupRequest} createOrderGroupRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig) {
+        return OrderGroupsApiFp(this.configuration).createOrderGroup(createOrderGroupRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     *  Deletes an order group and cancels all orders within it. This permanently removes the group.
+     * @summary Delete Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig) {
+        return OrderGroupsApiFp(this.configuration).deleteOrderGroup(orderGroupId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     *  Retrieves details for a single order group including all order IDs and auto-cancel status.
+     * @summary Get Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig) {
+        return OrderGroupsApiFp(this.configuration).getOrderGroup(orderGroupId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     *  Retrieves all order groups for the authenticated user.
+     * @summary Get Order Groups
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getOrderGroups(options?: RawAxiosRequestConfig) {
+        return OrderGroupsApiFp(this.configuration).getOrderGroups(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
+     * @summary Reset Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {object} [body] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig) {
+        return OrderGroupsApiFp(this.configuration).resetOrderGroup(orderGroupId, body, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+