kalshi-typescript 2.1.3 → 3.3.0

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

@@ -0,0 +1,242 @@
+/**
+ * Kalshi Trade API Manual Endpoints
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * 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 { CreateMarketInMultivariateEventCollectionRequest } from '../models';
+import type { CreateMarketInMultivariateEventCollectionResponse } from '../models';
+import type { GetMultivariateEventCollectionLookupHistoryResponse } from '../models';
+import type { GetMultivariateEventCollectionResponse } from '../models';
+import type { GetMultivariateEventCollectionsResponse } from '../models';
+import type { LookupTickersForMarketInMultivariateEventCollectionRequest } from '../models';
+import type { LookupTickersForMarketInMultivariateEventCollectionResponse } from '../models';
+/**
+ * CollectionApi - axios parameter creator
+ */
+export declare const CollectionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection: (collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection: (collectionTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory: (collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections: (status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection: (collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CollectionApi - functional programming interface
+ */
+export declare const CollectionApiFp: (configuration?: Configuration) => {
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMarketInMultivariateEventCollectionResponse>>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionResponse>>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionLookupHistoryResponse>>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMultivariateEventCollectionsResponse>>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LookupTickersForMarketInMultivariateEventCollectionResponse>>;
+};
+/**
+ * CollectionApi - factory interface
+ */
+export declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMarketInMultivariateEventCollectionResponse>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionResponse>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionLookupHistoryResponse>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMultivariateEventCollectionsResponse>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<LookupTickersForMarketInMultivariateEventCollectionResponse>;
+};
+/**
+ * CollectionApi - object-oriented interface
+ */
+export declare class CollectionApi extends BaseAPI {
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
+     * @summary Create Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {CreateMarketInMultivariateEventCollectionRequest} createMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMarketInMultivariateEventCollection(collectionTicker: string, createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMarketInMultivariateEventCollectionResponse, any, {}>>;
+    /**
+     *  Endpoint for getting data about a multivariate event collection by its ticker.
+     * @summary Get Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any, {}>>;
+    /**
+     *  Endpoint for retrieving which markets in an event collection were recently looked up.
+     * @summary Get Multivariate Event Collection Lookup History
+     * @param {string} collectionTicker Collection ticker
+     * @param {GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum} lookbackSeconds Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollectionLookupHistory(collectionTicker: string, lookbackSeconds: GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionLookupHistoryResponse, any, {}>>;
+    /**
+     *  Endpoint for getting data about multivariate event collections.
+     * @summary Get Multivariate Event Collections
+     * @param {GetMultivariateEventCollectionsStatusEnum} [status] Only return collections of a certain status. Can be unopened, open, or closed.
+     * @param {string} [associatedEventTicker] Only return collections associated with a particular event ticker.
+     * @param {string} [seriesTicker] Only return collections with a particular series ticker.
+     * @param {number} [limit] Specify the maximum number of results.
+     * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMultivariateEventCollections(status?: GetMultivariateEventCollectionsStatusEnum, associatedEventTicker?: string, seriesTicker?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any, {}>>;
+    /**
+     *  Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
+     * @summary Lookup Tickers For Market In Multivariate Event Collection
+     * @param {string} collectionTicker Collection ticker
+     * @param {LookupTickersForMarketInMultivariateEventCollectionRequest} lookupTickersForMarketInMultivariateEventCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupTickersForMarketInMultivariateEventCollection(collectionTicker: string, lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupTickersForMarketInMultivariateEventCollectionResponse, any, {}>>;
+}
+export declare const GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum: {
+    readonly NUMBER_10: 10;
+    readonly NUMBER_60: 60;
+    readonly NUMBER_300: 300;
+    readonly NUMBER_3600: 3600;
+};
+export type GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum = typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum[keyof typeof GetMultivariateEventCollectionLookupHistoryLookbackSecondsEnum];
+export declare const GetMultivariateEventCollectionsStatusEnum: {
+    readonly Unopened: "unopened";
+    readonly Open: "open";
+    readonly Closed: "closed";
+};
+export type GetMultivariateEventCollectionsStatusEnum = typeof GetMultivariateEventCollectionsStatusEnum[keyof typeof GetMultivariateEventCollectionsStatusEnum];