kalshi-typescript 3.8.0 → 3.9.0

package/dist/api/portfolio-api.d.ts

@@ -2,7 +2,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.8.0
+ * The version of the OpenAPI document: 3.9.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,9 @@ import type { GetPortfolioRestingOrderTotalValueResponse } from '../models';
 import type { GetPositionsResponse } from '../models';
 import type { GetSettlementsResponse } from '../models';
 import type { GetSubaccountBalancesResponse } from '../models';
+import type { GetSubaccountNettingResponse } from '../models';
 import type { GetSubaccountTransfersResponse } from '../models';
+import type { UpdateSubaccountNettingRequest } from '../models';
 /**
  * PortfolioApi - axios parameter creator
  */
@@ -43,13 +45,13 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getBalance: (subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *  Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
+     * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Fills
      * @param {string} [ticker] Filter by market ticker
      * @param {string} [orderId] Filter by order ID
@@ -57,7 +59,7 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @param {number} [maxTs] Filter items before this Unix timestamp
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -76,8 +78,8 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -88,10 +90,10 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {number} [minTs] Filter items after this Unix timestamp
      * @param {number} [maxTs] Filter items before this Unix timestamp
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -103,6 +105,13 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getSubaccountBalances: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets the netting enabled settings for all subaccounts.
+     * @summary Get Subaccount Netting
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountNetting: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Gets a paginated list of all transfers between subaccounts for the authenticated user.
      * @summary Get Subaccount Transfers
@@ -112,6 +121,14 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getSubaccountTransfers: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Update Subaccount Netting
+     * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubaccountNetting: (updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PortfolioApi - functional programming interface
@@ -135,13 +152,13 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getBalance(subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>>;
     /**
-     *  Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
+     * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Fills
      * @param {string} [ticker] Filter by market ticker
      * @param {string} [orderId] Filter by order ID
@@ -149,7 +166,7 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @param {number} [maxTs] Filter items before this Unix timestamp
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -168,8 +185,8 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -180,10 +197,10 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {number} [minTs] Filter items after this Unix timestamp
      * @param {number} [maxTs] Filter items before this Unix timestamp
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -195,6 +212,13 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountBalancesResponse>>;
+    /**
+     * Gets the netting enabled settings for all subaccounts.
+     * @summary Get Subaccount Netting
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountNetting(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountNettingResponse>>;
     /**
      * Gets a paginated list of all transfers between subaccounts for the authenticated user.
      * @summary Get Subaccount Transfers
@@ -204,6 +228,14 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountTransfersResponse>>;
+    /**
+     * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Update Subaccount Netting
+     * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * PortfolioApi - factory interface
@@ -227,13 +259,13 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getBalance(subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetBalanceResponse>;
     /**
-     *  Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
+     * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Fills
      * @param {string} [ticker] Filter by market ticker
      * @param {string} [orderId] Filter by order ID
@@ -241,7 +273,7 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @param {number} [maxTs] Filter items before this Unix timestamp
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -260,8 +292,8 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -272,10 +304,10 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {number} [minTs] Filter items after this Unix timestamp
      * @param {number} [maxTs] Filter items before this Unix timestamp
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -287,6 +319,13 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getSubaccountBalances(options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountBalancesResponse>;
+    /**
+     * Gets the netting enabled settings for all subaccounts.
+     * @summary Get Subaccount Netting
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountNetting(options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountNettingResponse>;
     /**
      * Gets a paginated list of all transfers between subaccounts for the authenticated user.
      * @summary Get Subaccount Transfers
@@ -296,6 +335,14 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountTransfersResponse>;
+    /**
+     * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Update Subaccount Netting
+     * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
 /**
  * PortfolioApi - object-oriented interface
@@ -319,13 +366,13 @@ export declare class PortfolioApi extends BaseAPI {
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getBalance(subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>;
     /**
-     *  Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
+     * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
      * @summary Get Fills
      * @param {string} [ticker] Filter by market ticker
      * @param {string} [orderId] Filter by order ID
@@ -333,7 +380,7 @@ export declare class PortfolioApi extends BaseAPI {
      * @param {number} [maxTs] Filter items before this Unix timestamp
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -352,8 +399,8 @@ export declare class PortfolioApi extends BaseAPI {
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -364,10 +411,10 @@ export declare class PortfolioApi extends BaseAPI {
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {number} [minTs] Filter items after this Unix timestamp
      * @param {number} [maxTs] Filter items before this Unix timestamp
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -379,6 +426,13 @@ export declare class PortfolioApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountBalancesResponse, any, {}>>;
+    /**
+     * Gets the netting enabled settings for all subaccounts.
+     * @summary Get Subaccount Netting
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountNetting(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountNettingResponse, any, {}>>;
     /**
      * Gets a paginated list of all transfers between subaccounts for the authenticated user.
      * @summary Get Subaccount Transfers
@@ -388,4 +442,12 @@ export declare class PortfolioApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountTransfersResponse, any, {}>>;
+    /**
+     * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Update Subaccount Netting
+     * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }