kalshi-typescript 2.1.3 → 3.3.0

package/docs/Position.md

@@ -1,34 +0,0 @@
-# Position
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**event_ticker** | **string** |  | [optional] [default to undefined]
-**market_result** | **string** |  | [optional] [default to undefined]
-**realized_pnl** | **number** |  | [optional] [default to undefined]
-**resting_order_count** | **number** |  | [optional] [default to undefined]
-**position** | **number** |  | [optional] [default to undefined]
-**fees_paid** | **number** |  | [optional] [default to undefined]
-**total_cost** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Position } from 'kalshi-typescript';
-
-const instance: Position = {
-    ticker,
-    event_ticker,
-    market_result,
-    realized_pnl,
-    resting_order_count,
-    position,
-    fees_paid,
-    total_cost,
-};
-```
-
-[[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/Quote.md

@@ -1,36 +0,0 @@
-# Quote
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quote_id** | **string** |  | [optional] [default to undefined]
-**rfq_id** | **string** |  | [optional] [default to undefined]
-**quoter_id** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**size** | **number** |  | [optional] [default to undefined]
-**side** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**created_ts** | **string** |  | [optional] [default to undefined]
-**expires_ts** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Quote } from 'kalshi-typescript';
-
-const instance: Quote = {
-    quote_id,
-    rfq_id,
-    quoter_id,
-    price,
-    size,
-    side,
-    status,
-    created_ts,
-    expires_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/docs/RFQ.md

@@ -1,34 +0,0 @@
-# RFQ
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rfq_id** | **string** |  | [optional] [default to undefined]
-**requester_id** | **string** |  | [optional] [default to undefined]
-**ticker** | **string** |  | [optional] [default to undefined]
-**side** | **string** |  | [optional] [default to undefined]
-**size** | **number** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**created_ts** | **string** |  | [optional] [default to undefined]
-**expires_ts** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RFQ } from 'kalshi-typescript';
-
-const instance: RFQ = {
-    rfq_id,
-    requester_id,
-    ticker,
-    side,
-    size,
-    status,
-    created_ts,
-    expires_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/docs/Series.md

@@ -1,26 +0,0 @@
-# Series
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | The ticker symbol for this series | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**category** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Series } from 'kalshi-typescript';
-
-const instance: Series = {
-    ticker,
-    title,
-    category,
-    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/SeriesApi.md

@@ -1,122 +0,0 @@
-# SeriesApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getSeries**](#getseries) | **GET** /series | Get Series|
-|[**getSeriesByTicker**](#getseriesbyticker) | **GET** /series/{ticker} | Get Series by Ticker|
-
-# **getSeries**
-> GetSeriesResponse getSeries()
-
-Get all market series
-
-### Example
-
-```typescript
-import {
-    SeriesApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new SeriesApi(configuration);
-
-let status: string; //Filter by series status (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getSeries(
-    status
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by series status | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetSeriesResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Series retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getSeriesByTicker**
-> GetSeriesByTickerResponse getSeriesByTicker()
-
-Get a single series by its ticker
-
-### Example
-
-```typescript
-import {
-    SeriesApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new SeriesApi(configuration);
-
-let ticker: string; //The series ticker (default to undefined)
-
-const { status, data } = await apiInstance.getSeriesByTicker(
-    ticker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | The series ticker | defaults to undefined|
-
-
-### Return type
-
-**GetSeriesByTickerResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Series retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/Settlement.md

@@ -1,30 +0,0 @@
-# Settlement
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**result** | **string** |  | [optional] [default to undefined]
-**yes_count** | **number** |  | [optional] [default to undefined]
-**no_count** | **number** |  | [optional] [default to undefined]
-**revenue** | **number** |  | [optional] [default to undefined]
-**settled_time** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Settlement } from 'kalshi-typescript';
-
-const instance: Settlement = {
-    ticker,
-    result,
-    yes_count,
-    no_count,
-    revenue,
-    settled_time,
-};
-```
-
-[[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/StructuredTarget.md

@@ -1,24 +0,0 @@
-# StructuredTarget
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**structured_target_id** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { StructuredTarget } from 'kalshi-typescript';
-
-const instance: StructuredTarget = {
-    structured_target_id,
-    title,
-    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/StructuredTargetsApi.md

@@ -1,125 +0,0 @@
-# StructuredTargetsApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getStructuredTarget**](#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target|
-|[**getStructuredTargets**](#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets|
-
-# **getStructuredTarget**
-> GetStructuredTargetResponse getStructuredTarget()
-
-Get a single structured target by ID
-
-### Example
-
-```typescript
-import {
-    StructuredTargetsApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new StructuredTargetsApi(configuration);
-
-let structuredTargetId: string; //Structured target ID (default to undefined)
-
-const { status, data } = await apiInstance.getStructuredTarget(
-    structuredTargetId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **structuredTargetId** | [**string**] | Structured target ID | defaults to undefined|
-
-
-### Return type
-
-**GetStructuredTargetResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Structured target retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getStructuredTargets**
-> GetStructuredTargetsResponse getStructuredTargets()
-
-Get all structured targets
-
-### Example
-
-```typescript
-import {
-    StructuredTargetsApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new StructuredTargetsApi(configuration);
-
-let status: string; //Filter by structured target status (optional) (default to undefined)
-let pageSize: number; //Number of items per page (minimum 100, default 100) (optional) (default to 100)
-
-const { status, data } = await apiInstance.getStructuredTargets(
-    status,
-    pageSize
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by structured target status | (optional) defaults to undefined|
-| **pageSize** | [**number**] | Number of items per page (minimum 100, default 100) | (optional) defaults to 100|
-
-
-### Return type
-
-**GetStructuredTargetsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Structured targets retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/Trade.md

@@ -1,30 +0,0 @@
-# Trade
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**trade_id** | **string** |  | [optional] [default to undefined]
-**ticker** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**count** | **number** |  | [optional] [default to undefined]
-**taker_side** | **string** |  | [optional] [default to undefined]
-**created_time** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Trade } from 'kalshi-typescript';
-
-const instance: Trade = {
-    trade_id,
-    ticker,
-    price,
-    count,
-    taker_side,
-    created_time,
-};
-```
-
-[[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/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -1,18 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
- *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./api";
-export * from "./configuration";
-export * from "./models";

package/models/amend-order-request.ts

@@ -1,56 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
- *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
- *
- * 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 AmendOrderRequest {
-    /**
-     * Market ticker
-     */
-    'ticker': string;
-    /**
-     * Side of the order
-     */
-    'side': AmendOrderRequestSideEnum;
-    /**
-     * Buy or sell action
-     */
-    'action': AmendOrderRequestActionEnum;
-    'yes_price'?: number;
-    'no_price'?: number;
-    'count'?: number;
-    /**
-     * Current client order ID
-     */
-    'client_order_id': string;
-    /**
-     * New client order ID after amendment
-     */
-    'updated_client_order_id': string;
-}
-
-export const AmendOrderRequestSideEnum = {
-    Yes: 'yes',
-    No: 'no'
-} as const;
-
-export type AmendOrderRequestSideEnum = typeof AmendOrderRequestSideEnum[keyof typeof AmendOrderRequestSideEnum];
-export const AmendOrderRequestActionEnum = {
-    Buy: 'buy',
-    Sell: 'sell'
-} as const;
-
-export type AmendOrderRequestActionEnum = typeof AmendOrderRequestActionEnum[keyof typeof AmendOrderRequestActionEnum];
-
-

package/models/amend-order-response.ts

@@ -1,23 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
- *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
- *
- * 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 AmendOrderResponse {
-    'order'?: Order;
-}
-

package/models/announcement.ts

@@ -1,38 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
- *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
- *
- * 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 {
-    'delivery_time'?: string;
-    'message'?: string;
-    'status'?: AnnouncementStatusEnum;
-    'type'?: AnnouncementTypeEnum;
-}
-
-export const AnnouncementStatusEnum = {
-    Active: 'active',
-    Inactive: 'inactive'
-} as const;
-
-export type AnnouncementStatusEnum = typeof AnnouncementStatusEnum[keyof typeof AnnouncementStatusEnum];
-export const AnnouncementTypeEnum = {
-    Info: 'info',
-    Warning: 'warning',
-    Error: 'error'
-} as const;
-
-export type AnnouncementTypeEnum = typeof AnnouncementTypeEnum[keyof typeof AnnouncementTypeEnum];
-
-

package/models/api-key.ts

@@ -1,31 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
- *
- * The version of the OpenAPI document: 2.0.0
- * Contact: support@kalshi.com
- *
- * 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 ApiKey {
-    /**
-     * Unique identifier for the API key
-     */
-    'api_key_id': string;
-    /**
-     * User-provided name for the API key
-     */
-    'name': string;
-    /**
-     * Timestamp when the API key was created
-     */
-    'created_ts'?: string;
-}
-