kalshi-typescript 3.19.0 → 3.21.0

package/dist/api/account-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.19.0
+ * The version of the OpenAPI document: 3.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,18 +13,26 @@ import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { GetAccountApiLimitsResponse } from '../models';
+import type { GetAccountApiUsageLevelVolumeProgressResponse } from '../models';
 import type { GetAccountEndpointCostsResponse } from '../models';
 /**
  * AccountApi - axios parameter creator
  */
 export declare const AccountApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+     * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
      * @summary Get Account API Limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getAccountApiLimits: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+     * @summary Get Account API Usage Level Volume Progress
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountApiUsageLevelVolumeProgress: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
      * @summary List Non-Default Endpoint Costs
@@ -32,18 +40,32 @@ export declare const AccountApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getAccountEndpointCosts: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+     * @summary Upgrade Account API Usage Level
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeAccountApiUsageLevel: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AccountApi - functional programming interface
  */
 export declare const AccountApiFp: (configuration?: Configuration) => {
     /**
-     *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+     * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
      * @summary Get Account API Limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getAccountApiLimits(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountApiLimitsResponse>>;
+    /**
+     * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+     * @summary Get Account API Usage Level Volume Progress
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountApiUsageLevelVolumeProgress(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountApiUsageLevelVolumeProgressResponse>>;
     /**
      * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
      * @summary List Non-Default Endpoint Costs
@@ -51,18 +73,32 @@ export declare const AccountApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAccountEndpointCosts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountEndpointCostsResponse>>;
+    /**
+     * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+     * @summary Upgrade Account API Usage Level
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeAccountApiUsageLevel(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * AccountApi - factory interface
  */
 export declare const AccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+     * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
      * @summary Get Account API Limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getAccountApiLimits(options?: RawAxiosRequestConfig): AxiosPromise<GetAccountApiLimitsResponse>;
+    /**
+     * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+     * @summary Get Account API Usage Level Volume Progress
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountApiUsageLevelVolumeProgress(options?: RawAxiosRequestConfig): AxiosPromise<GetAccountApiUsageLevelVolumeProgressResponse>;
     /**
      * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
      * @summary List Non-Default Endpoint Costs
@@ -70,18 +106,32 @@ export declare const AccountApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getAccountEndpointCosts(options?: RawAxiosRequestConfig): AxiosPromise<GetAccountEndpointCostsResponse>;
+    /**
+     * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+     * @summary Upgrade Account API Usage Level
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeAccountApiUsageLevel(options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
 /**
  * AccountApi - object-oriented interface
  */
 export declare class AccountApi extends BaseAPI {
     /**
-     *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+     * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
      * @summary Get Account API Limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getAccountApiLimits(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountApiLimitsResponse, any, {}>>;
+    /**
+     * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+     * @summary Get Account API Usage Level Volume Progress
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountApiUsageLevelVolumeProgress(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountApiUsageLevelVolumeProgressResponse, any, {}>>;
     /**
      * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
      * @summary List Non-Default Endpoint Costs
@@ -89,4 +139,11 @@ export declare class AccountApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getAccountEndpointCosts(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountEndpointCostsResponse, any, {}>>;
+    /**
+     * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+     * @summary Upgrade Account API Usage Level
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeAccountApiUsageLevel(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }

package/dist/api/account-api.js

@@ -5,7 +5,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.19.0
+ * The version of the OpenAPI document: 3.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ const base_1 = require("../base");
 const AccountApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+         * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
          * @summary Get Account API Limits
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -68,6 +68,37 @@ const AccountApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+         * @summary Get Account API Usage Level Volume Progress
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAccountApiUsageLevelVolumeProgress: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/account/api_usage_level/volume_progress`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
          * @summary List Non-Default Endpoint Costs
@@ -93,6 +124,37 @@ const AccountApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+         * @summary Upgrade Account API Usage Level
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upgradeAccountApiUsageLevel: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/account/api_usage_level/upgrade`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication kalshiAccessSignature required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
+            // authentication kalshiAccessKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
+            // authentication kalshiAccessTimestamp required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 exports.AccountApiAxiosParamCreator = AccountApiAxiosParamCreator;
@@ -103,7 +165,7 @@ const AccountApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.AccountApiAxiosParamCreator)(configuration);
     return {
         /**
-         *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+         * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
          * @summary Get Account API Limits
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -117,6 +179,21 @@ const AccountApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+         * @summary Get Account API Usage Level Volume Progress
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAccountApiUsageLevelVolumeProgress(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getAccountApiUsageLevelVolumeProgress(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
          * @summary List Non-Default Endpoint Costs
@@ -132,6 +209,21 @@ const AccountApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+         * @summary Upgrade Account API Usage Level
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upgradeAccountApiUsageLevel(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.upgradeAccountApiUsageLevel(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = undefined;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
     };
 };
 exports.AccountApiFp = AccountApiFp;
@@ -142,7 +234,7 @@ const AccountApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.AccountApiFp)(configuration);
     return {
         /**
-         *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+         * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
          * @summary Get Account API Limits
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -150,6 +242,15 @@ const AccountApiFactory = function (configuration, basePath, axios) {
         getAccountApiLimits(options) {
             return localVarFp.getAccountApiLimits(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+         * @summary Get Account API Usage Level Volume Progress
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAccountApiUsageLevelVolumeProgress(options) {
+            return localVarFp.getAccountApiUsageLevelVolumeProgress(options).then((request) => request(axios, basePath));
+        },
         /**
          * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
          * @summary List Non-Default Endpoint Costs
@@ -159,6 +260,15 @@ const AccountApiFactory = function (configuration, basePath, axios) {
         getAccountEndpointCosts(options) {
             return localVarFp.getAccountEndpointCosts(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+         * @summary Upgrade Account API Usage Level
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upgradeAccountApiUsageLevel(options) {
+            return localVarFp.upgradeAccountApiUsageLevel(options).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.AccountApiFactory = AccountApiFactory;
@@ -167,7 +277,7 @@ exports.AccountApiFactory = AccountApiFactory;
  */
 class AccountApi extends base_1.BaseAPI {
     /**
-     *  Endpoint to retrieve the API tier limits associated with the authenticated user.
+     * Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
      * @summary Get Account API Limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -175,6 +285,15 @@ class AccountApi extends base_1.BaseAPI {
     getAccountApiLimits(options) {
         return (0, exports.AccountApiFp)(this.configuration).getAccountApiLimits(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
+     * @summary Get Account API Usage Level Volume Progress
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountApiUsageLevelVolumeProgress(options) {
+        return (0, exports.AccountApiFp)(this.configuration).getAccountApiUsageLevelVolumeProgress(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
      * @summary List Non-Default Endpoint Costs
@@ -184,5 +303,14 @@ class AccountApi extends base_1.BaseAPI {
     getAccountEndpointCosts(options) {
         return (0, exports.AccountApiFp)(this.configuration).getAccountEndpointCosts(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
+     * @summary Upgrade Account API Usage Level
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeAccountApiUsageLevel(options) {
+        return (0, exports.AccountApiFp)(this.configuration).upgradeAccountApiUsageLevel(options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.AccountApi = AccountApi;

package/dist/api/api-keys-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.19.0
+ * The version of the OpenAPI document: 3.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/api-keys-api.js

@@ -5,7 +5,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.19.0
+ * The version of the OpenAPI document: 3.21.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).