snaptrade-typescript-sdk 9.0.39 → 9.0.40

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

@@ -36,12 +36,12 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const TradingApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed.
-         * @summary Cancel open order in account
+         * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
+         * @summary Cancel order
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to cancel the order in.
-         * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
+         * @param {string} accountId
+         * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -97,8 +97,8 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Return the trade object and it\'s impact on the account for the specified order.
-         * @summary Check the impact of a trade on an account
+         * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
+         * @summary Check order impact
          * @param {string} userId
          * @param {string} userSecret
          * @param {ManualTradeForm} manualTradeForm
@@ -154,13 +154,13 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns quote(s) from the brokerage for the specified symbol(s).
+         * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
          * @summary Get symbol quotes
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} symbols List of universal_symbol_id or tickers to get quotes for.
-         * @param {string} accountId The ID of the account to get quotes.
-         * @param {boolean} [useTicker] Should be set to True if providing tickers.
+         * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for.
+         * @param {string} accountId
+         * @param {boolean} [useTicker] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -219,8 +219,8 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Places a specified trade in the specified account.
-         * @summary Place a trade with NO validation.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
+         * @summary Place order
          * @param {string} userId
          * @param {string} userSecret
          * @param {ManualTradeForm} manualTradeForm
@@ -276,9 +276,9 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
-         * @summary Place order
-         * @param {string} tradeId The ID of trade object obtained from trade/impact endpoint
+         * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
+         * @summary Place checked order
+         * @param {string} tradeId Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
          * @param {string} userId
          * @param {string} userSecret
          * @param {ValidatedTradeBody} [validatedTradeBody]
@@ -345,8 +345,8 @@ const TradingApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.TradingApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed.
-         * @summary Cancel open order in account
+         * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
+         * @summary Cancel order
          * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -361,8 +361,8 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         * Return the trade object and it\'s impact on the account for the specified order.
-         * @summary Check the impact of a trade on an account
+         * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
+         * @summary Check order impact
          * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -372,12 +372,12 @@ const TradingApiFp = function (configuration) {
                 const manualTradeForm = {
                     account_id: requestParameters.account_id,
                     action: requestParameters.action,
+                    universal_symbol_id: requestParameters.universal_symbol_id,
                     order_type: requestParameters.order_type,
+                    time_in_force: requestParameters.time_in_force,
                     price: requestParameters.price,
                     stop: requestParameters.stop,
-                    time_in_force: requestParameters.time_in_force,
                     units: requestParameters.units,
-                    universal_symbol_id: requestParameters.universal_symbol_id,
                     notional_value: requestParameters.notional_value
                 };
                 const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderImpact(requestParameters.userId, requestParameters.userSecret, manualTradeForm, options);
@@ -385,7 +385,7 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         * Returns quote(s) from the brokerage for the specified symbol(s).
+         * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
          * @summary Get symbol quotes
          * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -398,8 +398,8 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         * Places a specified trade in the specified account.
-         * @summary Place a trade with NO validation.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
+         * @summary Place order
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -409,12 +409,12 @@ const TradingApiFp = function (configuration) {
                 const manualTradeForm = {
                     account_id: requestParameters.account_id,
                     action: requestParameters.action,
+                    universal_symbol_id: requestParameters.universal_symbol_id,
                     order_type: requestParameters.order_type,
+                    time_in_force: requestParameters.time_in_force,
                     price: requestParameters.price,
                     stop: requestParameters.stop,
-                    time_in_force: requestParameters.time_in_force,
                     units: requestParameters.units,
-                    universal_symbol_id: requestParameters.universal_symbol_id,
                     notional_value: requestParameters.notional_value
                 };
                 const localVarAxiosArgs = yield localVarAxiosParamCreator.placeForceOrder(requestParameters.userId, requestParameters.userSecret, manualTradeForm, options);
@@ -422,8 +422,8 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
-         * @summary Place order
+         * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
+         * @summary Place checked order
          * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -448,8 +448,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.TradingApiFp)(configuration);
     return {
         /**
-         * Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed.
-         * @summary Cancel open order in account
+         * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
+         * @summary Cancel order
          * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -458,8 +458,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.cancelUserAccountOrder(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return the trade object and it\'s impact on the account for the specified order.
-         * @summary Check the impact of a trade on an account
+         * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
+         * @summary Check order impact
          * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -468,7 +468,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns quote(s) from the brokerage for the specified symbol(s).
+         * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
          * @summary Get symbol quotes
          * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -478,8 +478,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountQuotes(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Places a specified trade in the specified account.
-         * @summary Place a trade with NO validation.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
+         * @summary Place order
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -488,8 +488,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.placeForceOrder(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
-         * @summary Place order
+         * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
+         * @summary Place checked order
          * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -508,8 +508,8 @@ exports.TradingApiFactory = TradingApiFactory;
  */
 class TradingApiGenerated extends base_1.BaseAPI {
     /**
-     * Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed.
-     * @summary Cancel open order in account
+     * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
+     * @summary Cancel order
      * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -519,8 +519,8 @@ class TradingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TradingApiFp)(this.configuration).cancelUserAccountOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Return the trade object and it\'s impact on the account for the specified order.
-     * @summary Check the impact of a trade on an account
+     * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
+     * @summary Check order impact
      * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -530,7 +530,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TradingApiFp)(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns quote(s) from the brokerage for the specified symbol(s).
+     * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
      * @summary Get symbol quotes
      * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -541,8 +541,8 @@ class TradingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TradingApiFp)(this.configuration).getUserAccountQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Places a specified trade in the specified account.
-     * @summary Place a trade with NO validation.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
+     * @summary Place order
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -552,8 +552,8 @@ class TradingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TradingApiFp)(this.configuration).placeForceOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
-     * @summary Place order
+     * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
+     * @summary Place checked order
      * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}