kalshi-typescript 3.21.0 → 3.23.0

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/CancelOrderResponse.md

@@ -1,22 +0,0 @@
-# CancelOrderResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [default to undefined]
-**reduced_by_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
-
-## Example
-
-```typescript
-import { CancelOrderResponse } from 'kalshi-typescript';
-
-const instance: CancelOrderResponse = {
-    order,
-    reduced_by_fp,
-};
-```
-
-[[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/DecreaseOrderRequest.md

@@ -1,30 +0,0 @@
-# DecreaseOrderRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**subaccount** | **number** | Optional subaccount number to use for this decrease (0 for primary, 1-63 for subaccounts) | [optional] [default to 0]
-**reduce_by** | **number** | Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
-**reduce_by_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
-**reduce_to** | **number** | Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
-**reduce_to_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
-**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { DecreaseOrderRequest } from 'kalshi-typescript';
-
-const instance: DecreaseOrderRequest = {
-    subaccount,
-    reduce_by,
-    reduce_by_fp,
-    reduce_to,
-    reduce_to_fp,
-    exchange_index,
-};
-```
-
-[[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/GetExchangeAnnouncementsResponse.md

@@ -1,20 +0,0 @@
-# GetExchangeAnnouncementsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**announcements** | [**Array<Announcement>**](Announcement.md) | A list of exchange-wide announcements. | [default to undefined]
-
-## Example
-
-```typescript
-import { GetExchangeAnnouncementsResponse } from 'kalshi-typescript';
-
-const instance: GetExchangeAnnouncementsResponse = {
-    announcements,
-};
-```
-
-[[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/GetMultivariateEventCollectionLookupHistoryResponse.md

@@ -1,20 +0,0 @@
-# GetMultivariateEventCollectionLookupHistoryResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**lookup_points** | [**Array<LookupPoint>**](LookupPoint.md) | List of recent lookup points in the collection. | [default to undefined]
-
-## Example
-
-```typescript
-import { GetMultivariateEventCollectionLookupHistoryResponse } from 'kalshi-typescript';
-
-const instance: GetMultivariateEventCollectionLookupHistoryResponse = {
-    lookup_points,
-};
-```
-
-[[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/LookupPoint.md

@@ -1,26 +0,0 @@
-# LookupPoint
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_ticker** | **string** | Event ticker for the lookup point. | [default to undefined]
-**market_ticker** | **string** | Market ticker for the lookup point. | [default to undefined]
-**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | Markets that were selected for this lookup. | [default to undefined]
-**last_queried_ts** | **string** | Timestamp when this lookup was last queried. | [default to undefined]
-
-## Example
-
-```typescript
-import { LookupPoint } from 'kalshi-typescript';
-
-const instance: LookupPoint = {
-    event_ticker,
-    market_ticker,
-    selected_markets,
-    last_queried_ts,
-};
-```
-
-[[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/models/announcement.ts

@@ -1,50 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-
-export interface Announcement {
-    /**
-     * The type of the announcement.
-     */
-    'type': AnnouncementTypeEnum;
-    /**
-     * The message contained within the announcement.
-     */
-    'message': string;
-    /**
-     * The time the announcement was delivered.
-     */
-    'delivery_time': string;
-    /**
-     * The current status of this announcement.
-     */
-    'status': AnnouncementStatusEnum;
-}
-
-export const AnnouncementTypeEnum = {
-    Info: 'info',
-    Warning: 'warning',
-    Error: 'error'
-} as const;
-
-export type AnnouncementTypeEnum = typeof AnnouncementTypeEnum[keyof typeof AnnouncementTypeEnum];
-export const AnnouncementStatusEnum = {
-    Active: 'active',
-    Inactive: 'inactive'
-} as const;
-
-export type AnnouncementStatusEnum = typeof AnnouncementStatusEnum[keyof typeof AnnouncementStatusEnum];
-
-

package/models/cancel-order-response.ts

@@ -1,27 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-// May contain unused imports in some cases
-// @ts-ignore
-import type { Order } from './order';
-
-export interface CancelOrderResponse {
-    'order': Order;
-    /**
-     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
-     */
-    'reduced_by_fp': string;
-}
-

package/models/decrease-order-request.ts

@@ -1,43 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-
-export interface DecreaseOrderRequest {
-    /**
-     * Optional subaccount number to use for this decrease (0 for primary, 1-63 for subaccounts)
-     */
-    'subaccount'?: number;
-    /**
-     * Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.
-     */
-    'reduce_by'?: number;
-    /**
-     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
-     */
-    'reduce_by_fp'?: string;
-    /**
-     * Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.
-     */
-    'reduce_to'?: number;
-    /**
-     * Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match.
-     */
-    'reduce_to_fp'?: string;
-    /**
-     * Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported.
-     */
-    'exchange_index'?: number;
-}
-

package/models/get-exchange-announcements-response.ts

@@ -1,26 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-// May contain unused imports in some cases
-// @ts-ignore
-import type { Announcement } from './announcement';
-
-export interface GetExchangeAnnouncementsResponse {
-    /**
-     * A list of exchange-wide announcements.
-     */
-    'announcements': Array<Announcement>;
-}
-

package/models/get-multivariate-event-collection-lookup-history-response.ts

@@ -1,26 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-// May contain unused imports in some cases
-// @ts-ignore
-import type { LookupPoint } from './lookup-point';
-
-export interface GetMultivariateEventCollectionLookupHistoryResponse {
-    /**
-     * List of recent lookup points in the collection.
-     */
-    'lookup_points': Array<LookupPoint>;
-}
-

package/models/lookup-point.ts

@@ -1,38 +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.21.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-// May contain unused imports in some cases
-// @ts-ignore
-import type { TickerPair } from './ticker-pair';
-
-export interface LookupPoint {
-    /**
-     * Event ticker for the lookup point.
-     */
-    'event_ticker': string;
-    /**
-     * Market ticker for the lookup point.
-     */
-    'market_ticker': string;
-    /**
-     * Markets that were selected for this lookup.
-     */
-    'selected_markets': Array<TickerPair>;
-    /**
-     * Timestamp when this lookup was last queried.
-     */
-    'last_queried_ts': string;
-}
-