snaptrade-typescript-sdk 9.0.17 → 9.0.19

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

@@ -24,8 +24,8 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      */
     cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, tradingCancelUserAccountOrderRequest: TradingCancelUserAccountOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Check impact of trades on account.
+     * 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
      * @param {string} userId
      * @param {string} userSecret
      * @param {ManualTradeForm} manualTradeForm
@@ -46,7 +46,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      */
     getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Places a specified trade in the specified account.
      * @summary Place a trade with NO validation.
      * @param {string} userId
      * @param {string} userSecret
@@ -56,7 +56,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      */
     placeForceOrder: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * 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
      * @param {string} userId
@@ -81,8 +81,8 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      */
     cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
     /**
-     *
-     * @summary Check impact of trades on account.
+     * 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
      * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -97,7 +97,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
     /**
-     *
+     * Places a specified trade in the specified account.
      * @summary Place a trade with NO validation.
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -105,7 +105,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      */
     placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
     /**
-     *
+     * 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 {TradingApiPlaceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -127,8 +127,8 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      */
     cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
     /**
-     *
-     * @summary Check impact of trades on account.
+     * 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
      * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -143,7 +143,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
     /**
-     *
+     * Places a specified trade in the specified account.
      * @summary Place a trade with NO validation.
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -151,7 +151,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      */
     placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
     /**
-     *
+     * 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 {TradingApiPlaceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -301,8 +301,8 @@ export declare class TradingApiGenerated extends BaseAPI {
      */
     cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
     /**
-     *
-     * @summary Check impact of trades on account.
+     * 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
      * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -319,7 +319,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
     /**
-     *
+     * Places a specified trade in the specified account.
      * @summary Place a trade with NO validation.
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -328,7 +328,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      */
     placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
     /**
-     *
+     * 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 {TradingApiPlaceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -97,8 +97,8 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary Check impact of trades on account.
+         * 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
          * @param {string} userId
          * @param {string} userSecret
          * @param {ManualTradeForm} manualTradeForm
@@ -219,7 +219,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Places a specified trade in the specified account.
          * @summary Place a trade with NO validation.
          * @param {string} userId
          * @param {string} userSecret
@@ -276,7 +276,7 @@ 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
          * @param {string} userId
@@ -361,8 +361,8 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary Check impact of trades on account.
+         * 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
          * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -398,7 +398,7 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Places a specified trade in the specified account.
          * @summary Place a trade with NO validation.
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -422,7 +422,7 @@ 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
          * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -458,8 +458,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.cancelUserAccountOrder(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary Check impact of trades on account.
+         * 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
          * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -478,7 +478,7 @@ 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.
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -488,7 +488,7 @@ 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
          * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -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));
     }
     /**
-     *
-     * @summary Check impact of trades on account.
+     * 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
      * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -541,7 +541,7 @@ 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.
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -552,7 +552,7 @@ 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
      * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.