kalshi-typescript 3.20.0 → 3.22.0

package/dist/esm/api/communications-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.20.0
+ * The version of the OpenAPI document: 3.22.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,21 +12,34 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { AcceptBlockTradeProposalRequest } from '../models';
 import type { AcceptQuoteRequest } from '../models';
 import type { CreateQuoteRequest } from '../models';
 import type { CreateQuoteResponse } from '../models';
 import type { CreateRFQRequest } from '../models';
 import type { CreateRFQResponse } from '../models';
+import type { GetBlockTradeProposalsResponse } from '../models';
 import type { GetCommunicationsIDResponse } from '../models';
 import type { GetQuoteResponse } from '../models';
 import type { GetQuotesResponse } from '../models';
 import type { GetRFQResponse } from '../models';
 import type { GetRFQsResponse } from '../models';
+import type { ProposeBlockTradeRequest } from '../models';
+import type { ProposeBlockTradeResponse } from '../models';
 import type { UserFilter } from '../models';
 /**
  * CommunicationsApi - axios parameter creator
  */
 export declare const CommunicationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for accepting a block trade proposal.
+     * @summary Accept Block Trade Proposal
+     * @param {string} blockTradeProposalId Block trade proposal ID
+     * @param {AcceptBlockTradeProposalRequest} [acceptBlockTradeProposalRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptBlockTradeProposal: (blockTradeProposalId: string, acceptBlockTradeProposalRequest?: AcceptBlockTradeProposalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for accepting a quote. This will require the quoter to confirm
      * @summary Accept Quote
@@ -77,6 +90,17 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     deleteRFQ: (rfqId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting block trade proposals visible to the authenticated user.
+     * @summary Get Block Trade Proposals
+     * @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} [marketTicker] Filter by market ticker
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
+     * @param {string} [status] Filter block trade proposals by status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlockTradeProposals: (cursor?: string, marketTicker?: string, limit?: number, status?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting the communications ID of the logged-in user.
      * @summary Get Communications ID
@@ -96,8 +120,8 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
      *  Endpoint for getting quotes
      * @summary Get Quotes
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
-     * @param {string} [marketTicker] Filter by market ticker
+     * @param {number} [minTs] Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp
+     * @param {number} [maxTs] Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
      * @param {string} [status] Filter quotes by status
      * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
@@ -109,7 +133,7 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getQuotes: (cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getQuotes: (cursor?: string, minTs?: number, maxTs?: number, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *  Endpoint for getting a single RFQ by id
      * @summary Get RFQ
@@ -124,7 +148,7 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {string} [marketTicker] Filter by market ticker
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [status] Filter RFQs by status
      * @param {string} [creatorUserId] Filter RFQs by creator user ID
@@ -133,11 +157,28 @@ export declare const CommunicationsApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getRFQs: (cursor?: string, eventTicker?: string, marketTicker?: string, subaccount?: number, limit?: number, status?: string, creatorUserId?: string, userFilter?: UserFilter, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for creating a block trade proposal.
+     * @summary Propose Block Trade
+     * @param {ProposeBlockTradeRequest} proposeBlockTradeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeBlockTrade: (proposeBlockTradeRequest: ProposeBlockTradeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CommunicationsApi - functional programming interface
  */
 export declare const CommunicationsApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for accepting a block trade proposal.
+     * @summary Accept Block Trade Proposal
+     * @param {string} blockTradeProposalId Block trade proposal ID
+     * @param {AcceptBlockTradeProposalRequest} [acceptBlockTradeProposalRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptBlockTradeProposal(blockTradeProposalId: string, acceptBlockTradeProposalRequest?: AcceptBlockTradeProposalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *  Endpoint for accepting a quote. This will require the quoter to confirm
      * @summary Accept Quote
@@ -188,6 +229,17 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *  Endpoint for getting block trade proposals visible to the authenticated user.
+     * @summary Get Block Trade Proposals
+     * @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} [marketTicker] Filter by market ticker
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
+     * @param {string} [status] Filter block trade proposals by status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlockTradeProposals(cursor?: string, marketTicker?: string, limit?: number, status?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlockTradeProposalsResponse>>;
     /**
      *  Endpoint for getting the communications ID of the logged-in user.
      * @summary Get Communications ID
@@ -207,8 +259,8 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
      *  Endpoint for getting quotes
      * @summary Get Quotes
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
-     * @param {string} [marketTicker] Filter by market ticker
+     * @param {number} [minTs] Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp
+     * @param {number} [maxTs] Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
      * @param {string} [status] Filter quotes by status
      * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
@@ -220,7 +272,7 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>>;
+    getQuotes(cursor?: string, minTs?: number, maxTs?: number, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>>;
     /**
      *  Endpoint for getting a single RFQ by id
      * @summary Get RFQ
@@ -235,7 +287,7 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {string} [marketTicker] Filter by market ticker
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [status] Filter RFQs by status
      * @param {string} [creatorUserId] Filter RFQs by creator user ID
@@ -244,11 +296,28 @@ export declare const CommunicationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, subaccount?: number, limit?: number, status?: string, creatorUserId?: string, userFilter?: UserFilter, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQsResponse>>;
+    /**
+     *  Endpoint for creating a block trade proposal.
+     * @summary Propose Block Trade
+     * @param {ProposeBlockTradeRequest} proposeBlockTradeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeBlockTrade(proposeBlockTradeRequest: ProposeBlockTradeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProposeBlockTradeResponse>>;
 };
 /**
  * CommunicationsApi - factory interface
  */
 export declare const CommunicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for accepting a block trade proposal.
+     * @summary Accept Block Trade Proposal
+     * @param {string} blockTradeProposalId Block trade proposal ID
+     * @param {AcceptBlockTradeProposalRequest} [acceptBlockTradeProposalRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptBlockTradeProposal(blockTradeProposalId: string, acceptBlockTradeProposalRequest?: AcceptBlockTradeProposalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *  Endpoint for accepting a quote. This will require the quoter to confirm
      * @summary Accept Quote
@@ -299,6 +368,17 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *  Endpoint for getting block trade proposals visible to the authenticated user.
+     * @summary Get Block Trade Proposals
+     * @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} [marketTicker] Filter by market ticker
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
+     * @param {string} [status] Filter block trade proposals by status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlockTradeProposals(cursor?: string, marketTicker?: string, limit?: number, status?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetBlockTradeProposalsResponse>;
     /**
      *  Endpoint for getting the communications ID of the logged-in user.
      * @summary Get Communications ID
@@ -318,8 +398,8 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
      *  Endpoint for getting quotes
      * @summary Get Quotes
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
-     * @param {string} [marketTicker] Filter by market ticker
+     * @param {number} [minTs] Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp
+     * @param {number} [maxTs] Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
      * @param {string} [status] Filter quotes by status
      * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
@@ -331,7 +411,7 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetQuotesResponse>;
+    getQuotes(cursor?: string, minTs?: number, maxTs?: number, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetQuotesResponse>;
     /**
      *  Endpoint for getting a single RFQ by id
      * @summary Get RFQ
@@ -346,7 +426,7 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {string} [marketTicker] Filter by market ticker
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [status] Filter RFQs by status
      * @param {string} [creatorUserId] Filter RFQs by creator user ID
@@ -355,11 +435,28 @@ export declare const CommunicationsApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, subaccount?: number, limit?: number, status?: string, creatorUserId?: string, userFilter?: UserFilter, options?: RawAxiosRequestConfig): AxiosPromise<GetRFQsResponse>;
+    /**
+     *  Endpoint for creating a block trade proposal.
+     * @summary Propose Block Trade
+     * @param {ProposeBlockTradeRequest} proposeBlockTradeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeBlockTrade(proposeBlockTradeRequest: ProposeBlockTradeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProposeBlockTradeResponse>;
 };
 /**
  * CommunicationsApi - object-oriented interface
  */
 export declare class CommunicationsApi extends BaseAPI {
+    /**
+     *  Endpoint for accepting a block trade proposal.
+     * @summary Accept Block Trade Proposal
+     * @param {string} blockTradeProposalId Block trade proposal ID
+     * @param {AcceptBlockTradeProposalRequest} [acceptBlockTradeProposalRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptBlockTradeProposal(blockTradeProposalId: string, acceptBlockTradeProposalRequest?: AcceptBlockTradeProposalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *  Endpoint for accepting a quote. This will require the quoter to confirm
      * @summary Accept Quote
@@ -410,6 +507,17 @@ export declare class CommunicationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *  Endpoint for getting block trade proposals visible to the authenticated user.
+     * @summary Get Block Trade Proposals
+     * @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} [marketTicker] Filter by market ticker
+     * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
+     * @param {string} [status] Filter block trade proposals by status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBlockTradeProposals(cursor?: string, marketTicker?: string, limit?: number, status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBlockTradeProposalsResponse, any, {}>>;
     /**
      *  Endpoint for getting the communications ID of the logged-in user.
      * @summary Get Communications ID
@@ -429,8 +537,8 @@ export declare class CommunicationsApi extends BaseAPI {
      *  Endpoint for getting quotes
      * @summary Get Quotes
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
-     * @param {string} [marketTicker] Filter by market ticker
+     * @param {number} [minTs] Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp
+     * @param {number} [maxTs] Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 500.
      * @param {string} [status] Filter quotes by status
      * @param {string} [quoteCreatorUserId] Filter quotes by quote creator user ID
@@ -442,7 +550,7 @@ export declare class CommunicationsApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getQuotes(cursor?: string, eventTicker?: string, marketTicker?: string, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any, {}>>;
+    getQuotes(cursor?: string, minTs?: number, maxTs?: number, limit?: number, status?: string, quoteCreatorUserId?: string, userFilter?: UserFilter, rfqUserFilter?: UserFilter, rfqCreatorUserId?: string, rfqCreatorSubtraderId?: string, rfqId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any, {}>>;
     /**
      *  Endpoint for getting a single RFQ by id
      * @summary Get RFQ
@@ -457,7 +565,7 @@ export declare class CommunicationsApi extends BaseAPI {
      * @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} [eventTicker] Event ticker to filter by. Only a single event ticker is supported.
      * @param {string} [marketTicker] Filter by market ticker
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
      * @param {string} [status] Filter RFQs by status
      * @param {string} [creatorUserId] Filter RFQs by creator user ID
@@ -466,4 +574,12 @@ export declare class CommunicationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getRFQs(cursor?: string, eventTicker?: string, marketTicker?: string, subaccount?: number, limit?: number, status?: string, creatorUserId?: string, userFilter?: UserFilter, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any, {}>>;
+    /**
+     *  Endpoint for creating a block trade proposal.
+     * @summary Propose Block Trade
+     * @param {ProposeBlockTradeRequest} proposeBlockTradeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeBlockTrade(proposeBlockTradeRequest: ProposeBlockTradeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProposeBlockTradeResponse, any, {}>>;
 }