kalshi-typescript 2.1.3 → 3.0.0

package/api/api-keys-api.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Kalshi Trading API
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ * 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
- * Contact: support@kalshi.com
+ * The version of the OpenAPI document: 3.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -29,8 +29,6 @@ import type { CreateApiKeyRequest } from '../models';
 // @ts-ignore
 import type { CreateApiKeyResponse } from '../models';
 // @ts-ignore
-import type { ErrorResponse } from '../models';
-// @ts-ignore
 import type { GenerateApiKeyRequest } from '../models';
 // @ts-ignore
 import type { GenerateApiKeyResponse } from '../models';
@@ -42,7 +40,7 @@ import type { GetApiKeysResponse } from '../models';
 export const ApiKeysApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests. 
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -63,9 +61,14 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
-            // authentication bearerAuth required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
 
 
     
@@ -82,7 +85,7 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone. 
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -104,9 +107,14 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
-            // authentication bearerAuth required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
 
 
     
@@ -120,7 +128,7 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again. 
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -141,9 +149,14 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
-            // authentication bearerAuth required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
 
 
     
@@ -160,7 +173,7 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name. 
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -178,9 +191,14 @@ export const ApiKeysApiAxiosParamCreator = function (configuration?: Configurati
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
-            // authentication bearerAuth required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+            // authentication kalshiAccessSignature required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
+
+            // authentication kalshiAccessKey required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
+
+            // authentication kalshiAccessTimestamp required
+            await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
 
 
     
@@ -203,7 +221,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = ApiKeysApiAxiosParamCreator(configuration)
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests. 
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -216,7 +234,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone. 
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -229,7 +247,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again. 
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -242,7 +260,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name. 
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -263,7 +281,7 @@ export const ApiKeysApiFactory = function (configuration?: Configuration, basePa
     const localVarFp = ApiKeysApiFp(configuration)
     return {
         /**
-         * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests. 
+         *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
          * @summary Create API Key
          * @param {CreateApiKeyRequest} createApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -273,7 +291,7 @@ export const ApiKeysApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.createApiKey(createApiKeyRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone. 
+         *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
          * @summary Delete API Key
          * @param {string} apiKey API key ID to delete
          * @param {*} [options] Override http request option.
@@ -283,7 +301,7 @@ export const ApiKeysApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.deleteApiKey(apiKey, options).then((request) => request(axios, basePath));
         },
         /**
-         * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again. 
+         *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
          * @summary Generate API Key
          * @param {GenerateApiKeyRequest} generateApiKeyRequest 
          * @param {*} [options] Override http request option.
@@ -293,7 +311,7 @@ export const ApiKeysApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.generateApiKey(generateApiKeyRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name. 
+         *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
          * @summary Get API Keys
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -309,7 +327,7 @@ export const ApiKeysApiFactory = function (configuration?: Configuration, basePa
  */
 export class ApiKeysApi extends BaseAPI {
     /**
-     * Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests. 
+     *  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
      * @summary Create API Key
      * @param {CreateApiKeyRequest} createApiKeyRequest 
      * @param {*} [options] Override http request option.
@@ -320,7 +338,7 @@ export class ApiKeysApi extends BaseAPI {
     }
 
     /**
-     * Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone. 
+     *  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
      * @summary Delete API Key
      * @param {string} apiKey API key ID to delete
      * @param {*} [options] Override http request option.
@@ -331,7 +349,7 @@ export class ApiKeysApi extends BaseAPI {
     }
 
     /**
-     * Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again. 
+     *  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
      * @summary Generate API Key
      * @param {GenerateApiKeyRequest} generateApiKeyRequest 
      * @param {*} [options] Override http request option.
@@ -342,7 +360,7 @@ export class ApiKeysApi extends BaseAPI {
     }
 
     /**
-     * Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name. 
+     *  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
      * @summary Get API Keys
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}