kalshi-typescript 3.3.0 → 3.5.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.3.0
+ * The version of the OpenAPI document: 3.5.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,15 +12,34 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { ApplySubaccountTransferRequest } from '../models';
+import type { CreateSubaccountResponse } from '../models';
 import type { GetBalanceResponse } from '../models';
 import type { GetFillsResponse } from '../models';
 import type { GetPortfolioRestingOrderTotalValueResponse } from '../models';
 import type { GetPositionsResponse } from '../models';
 import type { GetSettlementsResponse } from '../models';
+import type { GetSubaccountBalancesResponse } from '../models';
+import type { GetSubaccountTransfersResponse } from '../models';
 /**
  * PortfolioApi - axios parameter creator
  */
 export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Transfer Between Subaccounts
+     * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applySubaccountTransfer: (applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+     * @summary Create Subaccount
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubaccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
@@ -37,10 +56,11 @@ 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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getFills: (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getFills: (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
      * @summary Get Total Resting Order Value
@@ -56,10 +76,11 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPositions: (cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getPositions: (cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting the member\'s settlements historical track.
      * @summary Get Settlements
@@ -73,11 +94,42 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getSettlements: (limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets balances for all subaccounts including the primary account.
+     * @summary Get All Subaccount Balances
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountBalances: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets a paginated list of all transfers between subaccounts for the authenticated user.
+     * @summary Get Subaccount Transfers
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountTransfers: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PortfolioApi - functional programming interface
  */
 export declare const PortfolioApiFp: (configuration?: Configuration) => {
+    /**
+     * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Transfer Between Subaccounts
+     * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+     * @summary Create Subaccount
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubaccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSubaccountResponse>>;
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
@@ -94,10 +146,11 @@ 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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
     /**
      *  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
      * @summary Get Total Resting Order Value
@@ -113,10 +166,11 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>;
+    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>;
     /**
      *  Endpoint for getting the member\'s settlements historical track.
      * @summary Get Settlements
@@ -130,11 +184,42 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>;
+    /**
+     * Gets balances for all subaccounts including the primary account.
+     * @summary Get All Subaccount Balances
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountBalancesResponse>>;
+    /**
+     * Gets a paginated list of all transfers between subaccounts for the authenticated user.
+     * @summary Get Subaccount Transfers
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountTransfersResponse>>;
 };
 /**
  * PortfolioApi - factory interface
  */
 export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Transfer Between Subaccounts
+     * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
+    /**
+     * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+     * @summary Create Subaccount
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubaccount(options?: RawAxiosRequestConfig): AxiosPromise<CreateSubaccountResponse>;
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
@@ -151,10 +236,11 @@ 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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
     /**
      *  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
      * @summary Get Total Resting Order Value
@@ -170,10 +256,11 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
+    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
     /**
      *  Endpoint for getting the member\'s settlements historical track.
      * @summary Get Settlements
@@ -187,11 +274,42 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>;
+    /**
+     * Gets balances for all subaccounts including the primary account.
+     * @summary Get All Subaccount Balances
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountBalances(options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountBalancesResponse>;
+    /**
+     * Gets a paginated list of all transfers between subaccounts for the authenticated user.
+     * @summary Get Subaccount Transfers
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountTransfersResponse>;
 };
 /**
  * PortfolioApi - object-oriented interface
  */
 export declare class PortfolioApi extends BaseAPI {
+    /**
+     * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts.
+     * @summary Transfer Between Subaccounts
+     * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
+    /**
+     * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user.
+     * @summary Create Subaccount
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubaccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubaccountResponse, any, {}>>;
     /**
      *  Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
      * @summary Get Balance
@@ -208,10 +326,11 @@ 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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
     /**
      *  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
      * @summary Get Total Resting Order Value
@@ -227,10 +346,11 @@ export declare class PortfolioApi extends BaseAPI {
      * @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] Filter by subaccount number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
+    getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
     /**
      *  Endpoint for getting the member\'s settlements historical track.
      * @summary Get Settlements
@@ -244,4 +364,20 @@ export declare class PortfolioApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
+    /**
+     * Gets balances for all subaccounts including the primary account.
+     * @summary Get All Subaccount Balances
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountBalancesResponse, any, {}>>;
+    /**
+     * Gets a paginated list of all transfers between subaccounts for the authenticated user.
+     * @summary Get Subaccount Transfers
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountTransfersResponse, any, {}>>;
 }