snaptrade-typescript-sdk 9.0.14 → 9.0.16

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

@@ -36,7 +36,7 @@ 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
          * @param {string} userId
          * @param {string} userSecret
@@ -154,7 +154,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Returns live quote(s) from the brokerage for the specified symbol(s).
          * @summary Get symbol quotes
          * @param {string} userId
          * @param {string} userSecret
@@ -275,64 +275,6 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         *
-         * @summary Place a OCO (One Cancels Other) order
-         * @param {string} userId
-         * @param {string} userSecret
-         * @param {TradingPlaceOCOOrderRequest} tradingPlaceOCOOrderRequest
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        placeOCOOrder: (userId, userSecret, tradingPlaceOCOOrderRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'userId' is not null or undefined
-            (0, common_1.assertParamExists)('placeOCOOrder', 'userId', userId);
-            // verify required parameter 'userSecret' is not null or undefined
-            (0, common_1.assertParamExists)('placeOCOOrder', 'userSecret', userSecret);
-            // verify required parameter 'tradingPlaceOCOOrderRequest' is not null or undefined
-            (0, common_1.assertParamExists)('placeOCOOrder', 'tradingPlaceOCOOrderRequest', tradingPlaceOCOOrderRequest);
-            const localVarPath = `/trade/oco`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new 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 = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
-            const localVarQueryParameter = {};
-            // authentication PartnerClientId required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
-            // authentication PartnerSignature required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
-            // authentication PartnerTimestamp required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
-            if (userId !== undefined) {
-                localVarQueryParameter['userId'] = userId;
-            }
-            if (userSecret !== undefined) {
-                localVarQueryParameter['userSecret'] = userSecret;
-            }
-            localVarHeaderParameter['Content-Type'] = 'application/json';
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-            (0, requestBeforeHook_1.requestBeforeHook)({
-                requestBody: tradingPlaceOCOOrderRequest,
-                queryParameters: localVarQueryParameter,
-                requestConfig: localVarRequestOptions,
-                path: localVarPath,
-                configuration,
-                pathTemplate: '/trade/oco',
-                httpMethod: 'POST'
-            });
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tradingPlaceOCOOrderRequest, localVarRequestOptions, configuration);
-            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
-            return {
-                url: (0, common_1.toPathString)(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        }),
         /**
          *
          * @summary Place order
@@ -403,7 +345,7 @@ 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
          * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -443,7 +385,7 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Returns live quote(s) from the brokerage for the specified symbol(s).
          * @summary Get symbol quotes
          * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -479,24 +421,6 @@ const TradingApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
-        /**
-         *
-         * @summary Place a OCO (One Cancels Other) order
-         * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        placeOCOOrder(requestParameters, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const tradingPlaceOCOOrderRequest = {
-                    first_trade_id: requestParameters.first_trade_id,
-                    second_trade_id: requestParameters.second_trade_id
-                };
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.placeOCOOrder(requestParameters.userId, requestParameters.userSecret, tradingPlaceOCOOrderRequest, options);
-                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          *
          * @summary Place order
@@ -524,7 +448,7 @@ 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
          * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -544,7 +468,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Returns live quote(s) from the brokerage for the specified symbol(s).
          * @summary Get symbol quotes
          * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -563,17 +487,6 @@ const TradingApiFactory = function (configuration, basePath, axios) {
         placeForceOrder(requestParameters, options) {
             return localVarFp.placeForceOrder(requestParameters, options).then((request) => request(axios, basePath));
         },
-        /**
-         *
-         * @summary Place a OCO (One Cancels Other) order
-         * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        placeOCOOrder(requestParameters, options) {
-            return localVarFp.placeOCOOrder(requestParameters, options).then((request) => request(axios, basePath));
-        },
         /**
          *
          * @summary Place order
@@ -595,7 +508,7 @@ 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
      * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -617,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 live quote(s) from the brokerage for the specified symbol(s).
      * @summary Get symbol quotes
      * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -638,18 +551,6 @@ class TradingApiGenerated extends base_1.BaseAPI {
     placeForceOrder(requestParameters, options) {
         return (0, exports.TradingApiFp)(this.configuration).placeForceOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
-    /**
-     *
-     * @summary Place a OCO (One Cancels Other) order
-     * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     * @memberof TradingApiGenerated
-     */
-    placeOCOOrder(requestParameters, options) {
-        return (0, exports.TradingApiFp)(this.configuration).placeOCOOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
-    }
     /**
      *
      * @summary Place order