kalshi-typescript 2.1.0

package/dist/esm/api/communications-api.d.ts

@@ -0,0 +1,388 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+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 { GetCommunicationsIDResponse } from '../models';
+import type { GetQuoteResponse } from '../models';
+import type { GetQuotesResponse } from '../models';
+import type { GetRFQResponse } from '../models';
+import type { GetRFQsResponse } from '../models';
+/**
+ * CommunicationsApi - axios parameter creator
+ */
+export declare const CommunicationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Accept a quote. This will require the quoter to confirm
+     * @summary Accept Quote
+     * @param {string} quoteId Quote ID
+     * @param {AcceptQuoteRequest} acceptQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptQuote: (quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Confirm a quote. This will start a timer for order execution
+     * @summary Confirm Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a quote in response to an RFQ
+     * @summary Create Quote
+     * @param {CreateQuoteRequest} createQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createQuote: (createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new RFQ
+     * @summary Create RFQ
+     * @param {CreateRFQRequest} createRFQRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRFQ: (createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a quote, which means it can no longer be accepted
+     * @summary Delete Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an RFQ by ID
+     * @summary Delete RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRFQ: (rfqId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the communications ID of the logged-in user
+     * @summary Get Communications ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommunicationsID: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a particular quote by ID
+     * @summary Get Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuote: (quoteId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve all quotes
+     * @summary Get Quotes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuotes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a single RFQ by ID
+     * @summary Get RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQ: (rfqId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve all RFQs
+     * @summary Get RFQs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommunicationsApi - functional programming interface
+ */
+export declare const CommunicationsApiFp: (configuration?: Configuration) => {
+    /**
+     * Accept a quote. This will require the quoter to confirm
+     * @summary Accept Quote
+     * @param {string} quoteId Quote ID
+     * @param {AcceptQuoteRequest} acceptQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Confirm a quote. This will start a timer for order execution
+     * @summary Confirm Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Create a quote in response to an RFQ
+     * @summary Create Quote
+     * @param {CreateQuoteRequest} createQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQuoteResponse>>;
+    /**
+     * Create a new RFQ
+     * @summary Create RFQ
+     * @param {CreateRFQRequest} createRFQRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRFQResponse>>;
+    /**
+     * Delete a quote, which means it can no longer be accepted
+     * @summary Delete Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete an RFQ by ID
+     * @summary Delete RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get the communications ID of the logged-in user
+     * @summary Get Communications ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommunicationsID(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommunicationsIDResponse>>;
+    /**
+     * Get a particular quote by ID
+     * @summary Get Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuoteResponse>>;
+    /**
+     * Retrieve all quotes
+     * @summary Get Quotes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuotes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>>;
+    /**
+     * Get a single RFQ by ID
+     * @summary Get RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQResponse>>;
+    /**
+     * Retrieve all RFQs
+     * @summary Get RFQs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQsResponse>>;
+};
+/**
+ * CommunicationsApi - factory interface
+ */
+export declare const CommunicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Accept a quote. This will require the quoter to confirm
+     * @summary Accept Quote
+     * @param {string} quoteId Quote ID
+     * @param {AcceptQuoteRequest} acceptQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Confirm a quote. This will start a timer for order execution
+     * @summary Confirm Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Create a quote in response to an RFQ
+     * @summary Create Quote
+     * @param {CreateQuoteRequest} createQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQuoteResponse>;
+    /**
+     * Create a new RFQ
+     * @summary Create RFQ
+     * @param {CreateRFQRequest} createRFQRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateRFQResponse>;
+    /**
+     * Delete a quote, which means it can no longer be accepted
+     * @summary Delete Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete an RFQ by ID
+     * @summary Delete RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get the communications ID of the logged-in user
+     * @summary Get Communications ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommunicationsID(options?: RawAxiosRequestConfig): AxiosPromise<GetCommunicationsIDResponse>;
+    /**
+     * Get a particular quote by ID
+     * @summary Get Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuote(quoteId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetQuoteResponse>;
+    /**
+     * Retrieve all quotes
+     * @summary Get Quotes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuotes(options?: RawAxiosRequestConfig): AxiosPromise<GetQuotesResponse>;
+    /**
+     * Get a single RFQ by ID
+     * @summary Get RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQ(rfqId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetRFQResponse>;
+    /**
+     * Retrieve all RFQs
+     * @summary Get RFQs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQs(options?: RawAxiosRequestConfig): AxiosPromise<GetRFQsResponse>;
+};
+/**
+ * CommunicationsApi - object-oriented interface
+ */
+export declare class CommunicationsApi extends BaseAPI {
+    /**
+     * Accept a quote. This will require the quoter to confirm
+     * @summary Accept Quote
+     * @param {string} quoteId Quote ID
+     * @param {AcceptQuoteRequest} acceptQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Confirm a quote. This will start a timer for order execution
+     * @summary Confirm Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Create a quote in response to an RFQ
+     * @summary Create Quote
+     * @param {CreateQuoteRequest} createQuoteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQuoteResponse, any>>;
+    /**
+     * Create a new RFQ
+     * @summary Create RFQ
+     * @param {CreateRFQRequest} createRFQRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRFQResponse, any>>;
+    /**
+     * Delete a quote, which means it can no longer be accepted
+     * @summary Delete Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Delete an RFQ by ID
+     * @summary Delete RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get the communications ID of the logged-in user
+     * @summary Get Communications ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommunicationsID(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommunicationsIDResponse, any>>;
+    /**
+     * Get a particular quote by ID
+     * @summary Get Quote
+     * @param {string} quoteId Quote ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuoteResponse, any>>;
+    /**
+     * Retrieve all quotes
+     * @summary Get Quotes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuotes(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any>>;
+    /**
+     * Get a single RFQ by ID
+     * @summary Get RFQ
+     * @param {string} rfqId RFQ ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQResponse, any>>;
+    /**
+     * Retrieve all RFQs
+     * @summary Get RFQs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRFQs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any>>;
+}