snaptrade-typescript-sdk 9.0.87 → 9.0.89

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v9.0.87-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.87)
+[![npm](https://img.shields.io/badge/npm-v9.0.89-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.89)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -1162,7 +1162,7 @@ Order ID returned by brokerage. This is the unique identifier for the order in t
 
 #### 🔄 Return<a id="🔄-return"></a>
 
-[AccountOrderRecord](./models/account-order-record.ts)
+[OrderUpdatedResponse](./models/order-updated-response.ts)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
@@ -1189,7 +1189,7 @@ const cryptoSpotPlaceOrderResponse =
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     symbol: {
       base: "BTC",
-      quote: "BTC",
+      quote: "USD",
     },
     side: "BUY",
     type: "MARKET",
@@ -1238,7 +1238,7 @@ The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT,
 
 ##### post_only: `boolean`<a id="post_only-boolean"></a>
 
-Required for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
+Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
 
 ##### expiration_date: `string`<a id="expiration_date-string"></a>
 
@@ -1246,7 +1246,7 @@ The expiration date of the order. Required if the time_in_force is GTD.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
-[AccountOrderRecord](./models/account-order-record.ts)
+[OrderUpdatedResponse](./models/order-updated-response.ts)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
@@ -1272,7 +1272,7 @@ const cryptoSpotPreviewOrderResponse =
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     symbol: {
       base: "BTC",
-      quote: "BTC",
+      quote: "USD",
     },
     side: "BUY",
     type: "MARKET",
@@ -1321,7 +1321,7 @@ The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT,
 
 ##### post_only: `boolean`<a id="post_only-boolean"></a>
 
-Required for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
+Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
 
 ##### expiration_date: `string`<a id="expiration_date-string"></a>
 
@@ -1354,7 +1354,7 @@ const cryptoSpotQuoteResponse =
     userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     base: "BTC",
-    quote: "BTC",
+    quote: "USD",
   });
 ```
 
@@ -1397,7 +1397,7 @@ const cryptoSpotSymbolsResponse =
     userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     base: "BTC",
-    quote: "BTC",
+    quote: "USD",
   });
 ```
 

package/dist/api/crypto-spot-trading-api-generated.d.ts

@@ -1,9 +1,9 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
-import { AccountOrderRecord } from '../models';
 import { CryptoSpotOrderPreview } from '../models';
 import { CryptoSpotQuote } from '../models';
+import { OrderUpdatedResponse } from '../models';
 import { TradingCryptoSpotCancelOrderRequest } from '../models';
 import { TradingCryptoSpotPlaceOrderRequest } from '../models';
 import { TradingCryptoSpotSymbols200Response } from '../models';
@@ -36,7 +36,7 @@ export declare const CryptoSpotTradingApiAxiosParamCreator: (configuration?: Con
     cryptoSpotPlaceOrder: (userId: string, userSecret: string, accountId: string, tradingCryptoSpotPlaceOrderRequest: TradingCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Previews a cryptocurrency spot order using the specified account.
-     * @summary Place a spot order on a crypto exchange
+     * @summary Preview a crypto spot order
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
@@ -47,7 +47,7 @@ export declare const CryptoSpotTradingApiAxiosParamCreator: (configuration?: Con
     cryptoSpotPreviewOrder: (userId: string, userSecret: string, accountId: string, tradingCryptoSpotPlaceOrderRequest: TradingCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Gets a quote for the specified account.
-     * @summary Get a quote for a cyrptocurrency market
+     * @summary Get a cryptocurrency spot market quote
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
@@ -82,7 +82,7 @@ export declare const CryptoSpotTradingApiFp: (configuration?: Configuration) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
+    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
     /**
      * Places a spot cryptocurrency order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order to the exchange.
      * @summary Place a spot order on a crypto exchange
@@ -90,10 +90,10 @@ export declare const CryptoSpotTradingApiFp: (configuration?: Configuration) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
+    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
     /**
      * Previews a cryptocurrency spot order using the specified account.
-     * @summary Place a spot order on a crypto exchange
+     * @summary Preview a crypto spot order
      * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -101,7 +101,7 @@ export declare const CryptoSpotTradingApiFp: (configuration?: Configuration) =>
     cryptoSpotPreviewOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPreviewOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptoSpotOrderPreview>>;
     /**
      * Gets a quote for the specified account.
-     * @summary Get a quote for a cyrptocurrency market
+     * @summary Get a cryptocurrency spot market quote
      * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -128,7 +128,7 @@ export declare const CryptoSpotTradingApiFactory: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
+    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
     /**
      * Places a spot cryptocurrency order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order to the exchange.
      * @summary Place a spot order on a crypto exchange
@@ -136,10 +136,10 @@ export declare const CryptoSpotTradingApiFactory: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
+    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
     /**
      * Previews a cryptocurrency spot order using the specified account.
-     * @summary Place a spot order on a crypto exchange
+     * @summary Preview a crypto spot order
      * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -147,7 +147,7 @@ export declare const CryptoSpotTradingApiFactory: (configuration?: Configuration
     cryptoSpotPreviewOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPreviewOrderRequest, options?: AxiosRequestConfig): AxiosPromise<CryptoSpotOrderPreview>;
     /**
      * Gets a quote for the specified account.
-     * @summary Get a quote for a cyrptocurrency market
+     * @summary Get a cryptocurrency spot market quote
      * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -326,7 +326,7 @@ export declare class CryptoSpotTradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CryptoSpotTradingApiGenerated
      */
-    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    cryptoSpotCancelOrder(requestParameters: CryptoSpotTradingApiCryptoSpotCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
     /**
      * Places a spot cryptocurrency order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order to the exchange.
      * @summary Place a spot order on a crypto exchange
@@ -335,10 +335,10 @@ export declare class CryptoSpotTradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CryptoSpotTradingApiGenerated
      */
-    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    cryptoSpotPlaceOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
     /**
      * Previews a cryptocurrency spot order using the specified account.
-     * @summary Place a spot order on a crypto exchange
+     * @summary Preview a crypto spot order
      * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -347,7 +347,7 @@ export declare class CryptoSpotTradingApiGenerated extends BaseAPI {
     cryptoSpotPreviewOrder(requestParameters: CryptoSpotTradingApiCryptoSpotPreviewOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptoSpotOrderPreview, any>>;
     /**
      * Gets a quote for the specified account.
-     * @summary Get a quote for a cyrptocurrency market
+     * @summary Get a cryptocurrency spot market quote
      * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/crypto-spot-trading-api-generated.js

@@ -159,7 +159,7 @@ const CryptoSpotTradingApiAxiosParamCreator = function (configuration) {
         }),
         /**
          * Previews a cryptocurrency spot order using the specified account.
-         * @summary Place a spot order on a crypto exchange
+         * @summary Preview a crypto spot order
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
@@ -220,7 +220,7 @@ const CryptoSpotTradingApiAxiosParamCreator = function (configuration) {
         }),
         /**
          * Gets a quote for the specified account.
-         * @summary Get a quote for a cyrptocurrency market
+         * @summary Get a cryptocurrency spot market quote
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
@@ -400,7 +400,7 @@ const CryptoSpotTradingApiFp = function (configuration) {
         },
         /**
          * Previews a cryptocurrency spot order using the specified account.
-         * @summary Place a spot order on a crypto exchange
+         * @summary Preview a crypto spot order
          * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -424,7 +424,7 @@ const CryptoSpotTradingApiFp = function (configuration) {
         },
         /**
          * Gets a quote for the specified account.
-         * @summary Get a quote for a cyrptocurrency market
+         * @summary Get a cryptocurrency spot market quote
          * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -480,7 +480,7 @@ const CryptoSpotTradingApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * Previews a cryptocurrency spot order using the specified account.
-         * @summary Place a spot order on a crypto exchange
+         * @summary Preview a crypto spot order
          * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -490,7 +490,7 @@ const CryptoSpotTradingApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * Gets a quote for the specified account.
-         * @summary Get a quote for a cyrptocurrency market
+         * @summary Get a cryptocurrency spot market quote
          * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -542,7 +542,7 @@ class CryptoSpotTradingApiGenerated extends base_1.BaseAPI {
     }
     /**
      * Previews a cryptocurrency spot order using the specified account.
-     * @summary Place a spot order on a crypto exchange
+     * @summary Preview a crypto spot order
      * @param {CryptoSpotTradingApiCryptoSpotPreviewOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -553,7 +553,7 @@ class CryptoSpotTradingApiGenerated extends base_1.BaseAPI {
     }
     /**
      * Gets a quote for the specified account.
-     * @summary Get a quote for a cyrptocurrency market
+     * @summary Get a cryptocurrency spot market quote
      * @param {CryptoSpotTradingApiCryptoSpotQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}