kalshi-typescript 3.0.0 → 3.4.0

package/base.ts

@@ -1,96 +0,0 @@
-/**
- * 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.
- */
-
-/* tslint:disable */
-/* eslint-disable */
-
-import type { Configuration } from './configuration';
-// Some imports not used depending on template conditions
-// @ts-ignore
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios';
-import globalAxios from 'axios';
-import { KalshiAuth } from './auth';
-
-export const BASE_PATH = "https://api.elections.kalshi.com/trade-api/v2".replace(/\/+$/, "");
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: AxiosRequestConfig;
-}
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPI {
-    protected configuration: Configuration | undefined;
-    protected auth: KalshiAuth | undefined;
-
-    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = configuration.basePath || this.basePath;
-
-            // Initialize auth if credentials are provided
-            if (configuration.apiKey && (configuration.privateKeyPath || configuration.privateKeyPem)) {
-                const privateKey = configuration.privateKeyPem ||
-                    (configuration.privateKeyPath ? require('fs').readFileSync(configuration.privateKeyPath, 'utf8') : '');
-                this.auth = new KalshiAuth(configuration.apiKey, privateKey);
-            }
-        }
-
-        // Add request interceptor for authentication
-        this.axios.interceptors.request.use((config) => {
-            if (this.auth && config.url && config.method) {
-                // Extract path from URL
-                const url = new URL(config.url, this.basePath);
-                const path = url.pathname;
-                const method = config.method.toUpperCase();
-
-                // Generate and add auth headers
-                const authHeaders = this.auth.generateAuthHeaders(method, path);
-                Object.assign(config.headers, authHeaders);
-            }
-            return config;
-        });
-    }
-};
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-    name: "RequiredError" = "RequiredError";
-    constructor(public field: string, msg?: string) {
-        super(msg);
-    }
-}

package/common.ts

@@ -1,98 +0,0 @@
-/* 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 { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from "./base";
-import { URL, URLSearchParams } from 'url';
-
-export const DUMMY_BASE_URL = 'https://example.com'
-
-/**
- *
- * @throws {RequiredError}
- */
-export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
-    if (paramValue === null || paramValue === undefined) {
-        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
-    }
-}
-
-// Kalshi uses custom authentication, so we stub out these functions
-export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
-    // Kalshi authentication is handled differently
-}
-
-export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
-    // Not used - Kalshi uses API key + RSA signature
-}
-
-export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
-    // Not used - Kalshi uses API key + RSA signature
-}
-
-export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
-    // Not used - Kalshi uses API key + RSA signature
-}
-
-function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
-    if (parameter == null) return;
-    if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
-            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        }
-        else {
-            Object.keys(parameter).forEach(currentKey =>
-                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
-            );
-        }
-    }
-    else {
-        if (urlSearchParams.has(key)) {
-            urlSearchParams.append(key, parameter);
-        }
-        else {
-            urlSearchParams.set(key, parameter);
-        }
-    }
-}
-
-export const setSearchParams = function (url: URL, ...objects: any[]) {
-    const searchParams = new URLSearchParams(url.search);
-    setFlattenedQueryParams(searchParams, objects);
-    url.search = searchParams.toString();
-}
-
-export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
-    const nonString = typeof value !== 'string';
-    const needsSerialization = nonString && configuration && configuration.isJsonMime
-        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
-        : nonString;
-    return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
-        : (value || "");
-}
-
-export const toPathString = function (url: URL) {
-    return url.pathname + url.search + url.hash
-}
-
-export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
-    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
-        return axios.request<T, R>(axiosRequestArgs);
-    };
-}

package/configuration.ts

@@ -1,93 +0,0 @@
-/**
- * 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.
- */
-
-/* tslint:disable */
-/* eslint-disable */
-
-export interface ConfigurationParameters {
-    apiKey?: string;
-    privateKeyPath?: string;
-    privateKeyPem?: string;
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-
-export class Configuration {
-    /**
-     * Kalshi API Key ID
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    apiKey?: string;
-    /**
-     * Path to RSA private key PEM file
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    privateKeyPath?: string;
-    /**
-     * RSA private key PEM string
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    privateKeyPem?: string;
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * override server index
-     */
-    serverIndex?: number;
-    /**
-     * base options for axios calls
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests.
-     */
-    formDataCtor?: new () => any;
-
-    constructor(param: ConfigurationParameters = {}) {
-        this.apiKey = param.apiKey;
-        this.privateKeyPath = param.privateKeyPath;
-        this.privateKeyPem = param.privateKeyPem;
-        this.basePath = param.basePath;
-        this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
-        this.formDataCtor = param.formDataCtor;
-    }
-
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    }
-}

package/docs/AcceptQuoteRequest.md

@@ -1,20 +0,0 @@
-# AcceptQuoteRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accepted_side** | **string** | The side of the quote to accept (yes or no) | [default to undefined]
-
-## Example
-
-```typescript
-import { AcceptQuoteRequest } from 'kalshi-typescript';
-
-const instance: AcceptQuoteRequest = {
-    accepted_side,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AmendOrderRequest.md

@@ -1,38 +0,0 @@
-# AmendOrderRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | Market ticker | [default to undefined]
-**side** | **string** | Side of the order | [default to undefined]
-**action** | **string** | Action of the order | [default to undefined]
-**client_order_id** | **string** | The original client-specified order ID to be amended | [default to undefined]
-**updated_client_order_id** | **string** | The new client-specified order ID after amendment | [default to undefined]
-**yes_price** | **number** | Updated yes price for the order in cents | [optional] [default to undefined]
-**no_price** | **number** | Updated no price for the order in cents | [optional] [default to undefined]
-**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
-**count** | **number** | Updated quantity for the order | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AmendOrderRequest } from 'kalshi-typescript';
-
-const instance: AmendOrderRequest = {
-    ticker,
-    side,
-    action,
-    client_order_id,
-    updated_client_order_id,
-    yes_price,
-    no_price,
-    yes_price_dollars,
-    no_price_dollars,
-    count,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AmendOrderResponse.md

@@ -1,22 +0,0 @@
-# AmendOrderResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**old_order** | [**Order**](Order.md) |  | [default to undefined]
-**order** | [**Order**](Order.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AmendOrderResponse } from 'kalshi-typescript';
-
-const instance: AmendOrderResponse = {
-    old_order,
-    order,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Announcement.md

@@ -1,26 +0,0 @@
-# Announcement
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **string** | The type of the announcement. | [default to undefined]
-**message** | **string** | The message contained within the announcement. | [default to undefined]
-**delivery_time** | **string** | The time the announcement was delivered. | [default to undefined]
-**status** | **string** | The current status of this announcement. | [default to undefined]
-
-## Example
-
-```typescript
-import { Announcement } from 'kalshi-typescript';
-
-const instance: Announcement = {
-    type,
-    message,
-    delivery_time,
-    status,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiKey.md

@@ -1,22 +0,0 @@
-# ApiKey
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_key_id** | **string** | Unique identifier for the API key | [default to undefined]
-**name** | **string** | User-provided name for the API key | [default to undefined]
-
-## Example
-
-```typescript
-import { ApiKey } from 'kalshi-typescript';
-
-const instance: ApiKey = {
-    api_key_id,
-    name,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiKeysApi.md

@@ -1,145 +0,0 @@
-# ApiKeysApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createApiKey**](#createapikey) | **POST** /api_keys | Create API Key|
-|[**deleteApiKey**](#deleteapikey) | **DELETE** /api_keys/{api_key} | Delete API Key|
-|[**generateApiKey**](#generateapikey) | **POST** /api_keys/generate | Generate API Key|
-|[**getApiKeys**](#getapikeys) | **GET** /api_keys | Get API Keys|
-
-# **createApiKey**
-> CreateApiKeyResponse createApiKey(createApiKeyRequest)
-
- Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createApiKeyRequest** | **CreateApiKeyRequest**|  | |
-
-
-### Return type
-
-**CreateApiKeyResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | API key created successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized |  -  |
-|**403** | Forbidden - insufficient API usage level |  -  |
-|**500** | Internal server error |  -  |
-
-# **deleteApiKey**
-> deleteApiKey()
-
- Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **apiKey** | [**string**] | API key ID to delete | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | API key successfully deleted |  -  |
-|**400** | Bad request - invalid API key ID |  -  |
-|**401** | Unauthorized |  -  |
-|**404** | API key not found |  -  |
-|**500** | Internal server error |  -  |
-
-# **generateApiKey**
-> GenerateApiKeyResponse generateApiKey(generateApiKeyRequest)
-
- Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **generateApiKeyRequest** | **GenerateApiKeyRequest**|  | |
-
-
-### Return type
-
-**GenerateApiKeyResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | API key generated successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-
-# **getApiKeys**
-> GetApiKeysResponse getApiKeys()
-
- Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetApiKeysResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | List of API keys retrieved successfully |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/AssociatedEvent.md

@@ -1,28 +0,0 @@
-# AssociatedEvent
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | The event ticker. | [default to undefined]
-**is_yes_only** | **boolean** | Whether only the \'yes\' side can be used for this event. | [default to undefined]
-**size_max** | **number** | Maximum number of markets from this event (inclusive). Null means no limit. | [optional] [default to undefined]
-**size_min** | **number** | Minimum number of markets from this event (inclusive). Null means no limit. | [optional] [default to undefined]
-**active_quoters** | **Array<string>** | List of active quoters for this event. | [default to undefined]
-
-## Example
-
-```typescript
-import { AssociatedEvent } from 'kalshi-typescript';
-
-const instance: AssociatedEvent = {
-    ticker,
-    is_yes_only,
-    size_max,
-    size_min,
-    active_quoters,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BatchCancelOrdersIndividualResponse.md

@@ -1,26 +0,0 @@
-# BatchCancelOrdersIndividualResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_id** | **string** | The order ID to identify which order had an error during batch cancellation | [default to undefined]
-**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
-**reduced_by** | **number** | The number of contracts that were successfully canceled from this order | [default to undefined]
-**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCancelOrdersIndividualResponse } from 'kalshi-typescript';
-
-const instance: BatchCancelOrdersIndividualResponse = {
-    order_id,
-    order,
-    reduced_by,
-    error,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BatchCancelOrdersRequest.md

@@ -1,20 +0,0 @@
-# BatchCancelOrdersRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ids** | **Array<string>** | An array of order IDs to cancel | [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCancelOrdersRequest } from 'kalshi-typescript';
-
-const instance: BatchCancelOrdersRequest = {
-    ids,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BatchCancelOrdersResponse.md

@@ -1,20 +0,0 @@
-# BatchCancelOrdersResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orders** | [**Array<BatchCancelOrdersIndividualResponse>**](BatchCancelOrdersIndividualResponse.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCancelOrdersResponse } from 'kalshi-typescript';
-
-const instance: BatchCancelOrdersResponse = {
-    orders,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BatchCancelOrdersResponseResponsesInner.md

@@ -1,24 +0,0 @@
-# BatchCancelOrdersResponseResponsesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_id** | **string** |  | [optional] [default to undefined]
-**reduced_by** | **number** |  | [optional] [default to undefined]
-**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCancelOrdersResponseResponsesInner } from 'kalshi-typescript';
-
-const instance: BatchCancelOrdersResponseResponsesInner = {
-    order_id,
-    reduced_by,
-    error,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)