snaptrade-typescript-sdk 9.0.18 → 9.0.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,8 +36,8 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const ReferenceDataApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- *
40
- * @summary Return the exchange rate of a currency pair
39
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
40
+ * @summary Get exchange rate of a currency pair
41
41
  * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
42
42
  * @param {*} [options] Override http request option.
43
43
  * @throws {RequiredError}
@@ -157,8 +157,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
157
157
  };
158
158
  }),
159
159
  /**
160
- *
161
- * @summary List exchanges
160
+ * Returns a list of all supported Exchanges.
161
+ * @summary Get exchanges
162
162
  * @param {*} [options] Override http request option.
163
163
  * @throws {RequiredError}
164
164
  */
@@ -196,7 +196,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
196
196
  };
197
197
  }),
198
198
  /**
199
- *
199
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
200
200
  * @summary Search for symbols
201
201
  * @param {SymbolQuery} [symbolQuery]
202
202
  * @param {*} [options] Override http request option.
@@ -239,8 +239,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
239
239
  };
240
240
  }),
241
241
  /**
242
- *
243
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
242
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
243
+ * @summary Get details of a symbol
244
244
  * @param {string} query The ticker or universal_symbol_id of the UniversalSymbol to get.
245
245
  * @param {*} [options] Override http request option.
246
246
  * @throws {RequiredError}
@@ -282,8 +282,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
282
282
  };
283
283
  }),
284
284
  /**
285
- *
286
- * @summary List of all brokerage authorization types
285
+ * Returns a list of all defined Brokerage authorization Type objects.
286
+ * @summary Get all brokerage authorization types
287
287
  * @param {string} [brokerage] Comma separated value of brokerage slugs
288
288
  * @param {*} [options] Override http request option.
289
289
  * @throws {RequiredError}
@@ -325,8 +325,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
325
325
  };
326
326
  }),
327
327
  /**
328
- *
329
- * @summary List brokerages
328
+ * Returns a list of all defined Brokerage objects.
329
+ * @summary Get brokerages
330
330
  * @param {*} [options] Override http request option.
331
331
  * @throws {RequiredError}
332
332
  */
@@ -364,8 +364,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
364
364
  };
365
365
  }),
366
366
  /**
367
- *
368
- * @summary List currencies
367
+ * Returns a list of all defined Currency objects.
368
+ * @summary Get currencies
369
369
  * @param {*} [options] Override http request option.
370
370
  * @throws {RequiredError}
371
371
  */
@@ -403,8 +403,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
403
403
  };
404
404
  }),
405
405
  /**
406
- *
407
- * @summary List currency exchange rates
406
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
407
+ * @summary Get currency exchange rates
408
408
  * @param {*} [options] Override http request option.
409
409
  * @throws {RequiredError}
410
410
  */
@@ -511,8 +511,8 @@ const ReferenceDataApiFp = function (configuration) {
511
511
  const localVarAxiosParamCreator = (0, exports.ReferenceDataApiAxiosParamCreator)(configuration);
512
512
  return {
513
513
  /**
514
- *
515
- * @summary Return the exchange rate of a currency pair
514
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
515
+ * @summary Get exchange rate of a currency pair
516
516
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
517
517
  * @param {*} [options] Override http request option.
518
518
  * @throws {RequiredError}
@@ -548,8 +548,8 @@ const ReferenceDataApiFp = function (configuration) {
548
548
  });
549
549
  },
550
550
  /**
551
- *
552
- * @summary List exchanges
551
+ * Returns a list of all supported Exchanges.
552
+ * @summary Get exchanges
553
553
  * @param {*} [options] Override http request option.
554
554
  * @throws {RequiredError}
555
555
  */
@@ -560,7 +560,7 @@ const ReferenceDataApiFp = function (configuration) {
560
560
  });
561
561
  },
562
562
  /**
563
- *
563
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
564
564
  * @summary Search for symbols
565
565
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
566
566
  * @param {*} [options] Override http request option.
@@ -576,8 +576,8 @@ const ReferenceDataApiFp = function (configuration) {
576
576
  });
577
577
  },
578
578
  /**
579
- *
580
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
579
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
580
+ * @summary Get details of a symbol
581
581
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
582
582
  * @param {*} [options] Override http request option.
583
583
  * @throws {RequiredError}
@@ -589,8 +589,8 @@ const ReferenceDataApiFp = function (configuration) {
589
589
  });
590
590
  },
591
591
  /**
592
- *
593
- * @summary List of all brokerage authorization types
592
+ * Returns a list of all defined Brokerage authorization Type objects.
593
+ * @summary Get all brokerage authorization types
594
594
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
595
595
  * @param {*} [options] Override http request option.
596
596
  * @throws {RequiredError}
@@ -602,8 +602,8 @@ const ReferenceDataApiFp = function (configuration) {
602
602
  });
603
603
  },
604
604
  /**
605
- *
606
- * @summary List brokerages
605
+ * Returns a list of all defined Brokerage objects.
606
+ * @summary Get brokerages
607
607
  * @param {*} [options] Override http request option.
608
608
  * @throws {RequiredError}
609
609
  */
@@ -614,8 +614,8 @@ const ReferenceDataApiFp = function (configuration) {
614
614
  });
615
615
  },
616
616
  /**
617
- *
618
- * @summary List currencies
617
+ * Returns a list of all defined Currency objects.
618
+ * @summary Get currencies
619
619
  * @param {*} [options] Override http request option.
620
620
  * @throws {RequiredError}
621
621
  */
@@ -626,8 +626,8 @@ const ReferenceDataApiFp = function (configuration) {
626
626
  });
627
627
  },
628
628
  /**
629
- *
630
- * @summary List currency exchange rates
629
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
630
+ * @summary Get currency exchange rates
631
631
  * @param {*} [options] Override http request option.
632
632
  * @throws {RequiredError}
633
633
  */
@@ -664,8 +664,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
664
664
  const localVarFp = (0, exports.ReferenceDataApiFp)(configuration);
665
665
  return {
666
666
  /**
667
- *
668
- * @summary Return the exchange rate of a currency pair
667
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
668
+ * @summary Get exchange rate of a currency pair
669
669
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
670
670
  * @param {*} [options] Override http request option.
671
671
  * @throws {RequiredError}
@@ -692,8 +692,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
692
692
  return localVarFp.getSecurityTypes(options).then((request) => request(axios, basePath));
693
693
  },
694
694
  /**
695
- *
696
- * @summary List exchanges
695
+ * Returns a list of all supported Exchanges.
696
+ * @summary Get exchanges
697
697
  * @param {*} [options] Override http request option.
698
698
  * @throws {RequiredError}
699
699
  */
@@ -701,7 +701,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
701
701
  return localVarFp.getStockExchanges(options).then((request) => request(axios, basePath));
702
702
  },
703
703
  /**
704
- *
704
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
705
705
  * @summary Search for symbols
706
706
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
707
707
  * @param {*} [options] Override http request option.
@@ -711,8 +711,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
711
711
  return localVarFp.getSymbols(requestParameters, options).then((request) => request(axios, basePath));
712
712
  },
713
713
  /**
714
- *
715
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
714
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
715
+ * @summary Get details of a symbol
716
716
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
717
717
  * @param {*} [options] Override http request option.
718
718
  * @throws {RequiredError}
@@ -721,8 +721,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
721
721
  return localVarFp.getSymbolsByTicker(requestParameters, options).then((request) => request(axios, basePath));
722
722
  },
723
723
  /**
724
- *
725
- * @summary List of all brokerage authorization types
724
+ * Returns a list of all defined Brokerage authorization Type objects.
725
+ * @summary Get all brokerage authorization types
726
726
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
727
727
  * @param {*} [options] Override http request option.
728
728
  * @throws {RequiredError}
@@ -731,8 +731,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
731
731
  return localVarFp.listAllBrokerageAuthorizationType(requestParameters, options).then((request) => request(axios, basePath));
732
732
  },
733
733
  /**
734
- *
735
- * @summary List brokerages
734
+ * Returns a list of all defined Brokerage objects.
735
+ * @summary Get brokerages
736
736
  * @param {*} [options] Override http request option.
737
737
  * @throws {RequiredError}
738
738
  */
@@ -740,8 +740,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
740
740
  return localVarFp.listAllBrokerages(options).then((request) => request(axios, basePath));
741
741
  },
742
742
  /**
743
- *
744
- * @summary List currencies
743
+ * Returns a list of all defined Currency objects.
744
+ * @summary Get currencies
745
745
  * @param {*} [options] Override http request option.
746
746
  * @throws {RequiredError}
747
747
  */
@@ -749,8 +749,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
749
749
  return localVarFp.listAllCurrencies(options).then((request) => request(axios, basePath));
750
750
  },
751
751
  /**
752
- *
753
- * @summary List currency exchange rates
752
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
753
+ * @summary Get currency exchange rates
754
754
  * @param {*} [options] Override http request option.
755
755
  * @throws {RequiredError}
756
756
  */
@@ -778,8 +778,8 @@ exports.ReferenceDataApiFactory = ReferenceDataApiFactory;
778
778
  */
779
779
  class ReferenceDataApiGenerated extends base_1.BaseAPI {
780
780
  /**
781
- *
782
- * @summary Return the exchange rate of a currency pair
781
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
782
+ * @summary Get exchange rate of a currency pair
783
783
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
784
784
  * @param {*} [options] Override http request option.
785
785
  * @throws {RequiredError}
@@ -809,8 +809,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
809
809
  return (0, exports.ReferenceDataApiFp)(this.configuration).getSecurityTypes(options).then((request) => request(this.axios, this.basePath));
810
810
  }
811
811
  /**
812
- *
813
- * @summary List exchanges
812
+ * Returns a list of all supported Exchanges.
813
+ * @summary Get exchanges
814
814
  * @param {*} [options] Override http request option.
815
815
  * @throws {RequiredError}
816
816
  * @memberof ReferenceDataApiGenerated
@@ -819,7 +819,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
819
819
  return (0, exports.ReferenceDataApiFp)(this.configuration).getStockExchanges(options).then((request) => request(this.axios, this.basePath));
820
820
  }
821
821
  /**
822
- *
822
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
823
823
  * @summary Search for symbols
824
824
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
825
825
  * @param {*} [options] Override http request option.
@@ -830,8 +830,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
830
830
  return (0, exports.ReferenceDataApiFp)(this.configuration).getSymbols(requestParameters, options).then((request) => request(this.axios, this.basePath));
831
831
  }
832
832
  /**
833
- *
834
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
833
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
834
+ * @summary Get details of a symbol
835
835
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
836
836
  * @param {*} [options] Override http request option.
837
837
  * @throws {RequiredError}
@@ -841,8 +841,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
841
841
  return (0, exports.ReferenceDataApiFp)(this.configuration).getSymbolsByTicker(requestParameters, options).then((request) => request(this.axios, this.basePath));
842
842
  }
843
843
  /**
844
- *
845
- * @summary List of all brokerage authorization types
844
+ * Returns a list of all defined Brokerage authorization Type objects.
845
+ * @summary Get all brokerage authorization types
846
846
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
847
847
  * @param {*} [options] Override http request option.
848
848
  * @throws {RequiredError}
@@ -852,8 +852,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
852
852
  return (0, exports.ReferenceDataApiFp)(this.configuration).listAllBrokerageAuthorizationType(requestParameters, options).then((request) => request(this.axios, this.basePath));
853
853
  }
854
854
  /**
855
- *
856
- * @summary List brokerages
855
+ * Returns a list of all defined Brokerage objects.
856
+ * @summary Get brokerages
857
857
  * @param {*} [options] Override http request option.
858
858
  * @throws {RequiredError}
859
859
  * @memberof ReferenceDataApiGenerated
@@ -862,8 +862,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
862
862
  return (0, exports.ReferenceDataApiFp)(this.configuration).listAllBrokerages(options).then((request) => request(this.axios, this.basePath));
863
863
  }
864
864
  /**
865
- *
866
- * @summary List currencies
865
+ * Returns a list of all defined Currency objects.
866
+ * @summary Get currencies
867
867
  * @param {*} [options] Override http request option.
868
868
  * @throws {RequiredError}
869
869
  * @memberof ReferenceDataApiGenerated
@@ -872,8 +872,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
872
872
  return (0, exports.ReferenceDataApiFp)(this.configuration).listAllCurrencies(options).then((request) => request(this.axios, this.basePath));
873
873
  }
874
874
  /**
875
- *
876
- * @summary List currency exchange rates
875
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
876
+ * @summary Get currency exchange rates
877
877
  * @param {*} [options] Override http request option.
878
878
  * @throws {RequiredError}
879
879
  * @memberof ReferenceDataApiGenerated
@@ -24,8 +24,8 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
24
24
  */
25
25
  cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, tradingCancelUserAccountOrderRequest: TradingCancelUserAccountOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
26
26
  /**
27
- *
28
- * @summary Check impact of trades on account.
27
+ * Return the trade object and it\'s impact on the account for the specified order.
28
+ * @summary Check the impact of a trade on an account
29
29
  * @param {string} userId
30
30
  * @param {string} userSecret
31
31
  * @param {ManualTradeForm} manualTradeForm
@@ -46,7 +46,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
46
46
  */
47
47
  getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
48
  /**
49
- *
49
+ * Places a specified trade in the specified account.
50
50
  * @summary Place a trade with NO validation.
51
51
  * @param {string} userId
52
52
  * @param {string} userSecret
@@ -56,7 +56,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
56
56
  */
57
57
  placeForceOrder: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
58
58
  /**
59
- *
59
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
60
60
  * @summary Place order
61
61
  * @param {string} tradeId The ID of trade object obtained from trade/impact endpoint
62
62
  * @param {string} userId
@@ -81,8 +81,8 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
81
81
  */
82
82
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
83
83
  /**
84
- *
85
- * @summary Check impact of trades on account.
84
+ * Return the trade object and it\'s impact on the account for the specified order.
85
+ * @summary Check the impact of a trade on an account
86
86
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
87
87
  * @param {*} [options] Override http request option.
88
88
  * @throws {RequiredError}
@@ -97,7 +97,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
97
97
  */
98
98
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
99
99
  /**
100
- *
100
+ * Places a specified trade in the specified account.
101
101
  * @summary Place a trade with NO validation.
102
102
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
103
103
  * @param {*} [options] Override http request option.
@@ -105,7 +105,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
105
105
  */
106
106
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
107
107
  /**
108
- *
108
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
109
109
  * @summary Place order
110
110
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
111
111
  * @param {*} [options] Override http request option.
@@ -127,8 +127,8 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
127
127
  */
128
128
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
129
129
  /**
130
- *
131
- * @summary Check impact of trades on account.
130
+ * Return the trade object and it\'s impact on the account for the specified order.
131
+ * @summary Check the impact of a trade on an account
132
132
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
@@ -143,7 +143,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
143
143
  */
144
144
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
145
145
  /**
146
- *
146
+ * Places a specified trade in the specified account.
147
147
  * @summary Place a trade with NO validation.
148
148
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
149
149
  * @param {*} [options] Override http request option.
@@ -151,7 +151,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
151
151
  */
152
152
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
153
153
  /**
154
- *
154
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
155
155
  * @summary Place order
156
156
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
157
157
  * @param {*} [options] Override http request option.
@@ -301,8 +301,8 @@ export declare class TradingApiGenerated extends BaseAPI {
301
301
  */
302
302
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
303
303
  /**
304
- *
305
- * @summary Check impact of trades on account.
304
+ * Return the trade object and it\'s impact on the account for the specified order.
305
+ * @summary Check the impact of a trade on an account
306
306
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
307
307
  * @param {*} [options] Override http request option.
308
308
  * @throws {RequiredError}
@@ -319,7 +319,7 @@ export declare class TradingApiGenerated extends BaseAPI {
319
319
  */
320
320
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
321
321
  /**
322
- *
322
+ * Places a specified trade in the specified account.
323
323
  * @summary Place a trade with NO validation.
324
324
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
325
325
  * @param {*} [options] Override http request option.
@@ -328,7 +328,7 @@ export declare class TradingApiGenerated extends BaseAPI {
328
328
  */
329
329
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
330
330
  /**
331
- *
331
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
332
332
  * @summary Place order
333
333
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
334
334
  * @param {*} [options] Override http request option.
@@ -97,8 +97,8 @@ const TradingApiAxiosParamCreator = function (configuration) {
97
97
  };
98
98
  }),
99
99
  /**
100
- *
101
- * @summary Check impact of trades on account.
100
+ * Return the trade object and it\'s impact on the account for the specified order.
101
+ * @summary Check the impact of a trade on an account
102
102
  * @param {string} userId
103
103
  * @param {string} userSecret
104
104
  * @param {ManualTradeForm} manualTradeForm
@@ -219,7 +219,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
219
219
  };
220
220
  }),
221
221
  /**
222
- *
222
+ * Places a specified trade in the specified account.
223
223
  * @summary Place a trade with NO validation.
224
224
  * @param {string} userId
225
225
  * @param {string} userSecret
@@ -276,7 +276,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
276
276
  };
277
277
  }),
278
278
  /**
279
- *
279
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
280
280
  * @summary Place order
281
281
  * @param {string} tradeId The ID of trade object obtained from trade/impact endpoint
282
282
  * @param {string} userId
@@ -361,8 +361,8 @@ const TradingApiFp = function (configuration) {
361
361
  });
362
362
  },
363
363
  /**
364
- *
365
- * @summary Check impact of trades on account.
364
+ * Return the trade object and it\'s impact on the account for the specified order.
365
+ * @summary Check the impact of a trade on an account
366
366
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
367
367
  * @param {*} [options] Override http request option.
368
368
  * @throws {RequiredError}
@@ -398,7 +398,7 @@ const TradingApiFp = function (configuration) {
398
398
  });
399
399
  },
400
400
  /**
401
- *
401
+ * Places a specified trade in the specified account.
402
402
  * @summary Place a trade with NO validation.
403
403
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
404
404
  * @param {*} [options] Override http request option.
@@ -422,7 +422,7 @@ const TradingApiFp = function (configuration) {
422
422
  });
423
423
  },
424
424
  /**
425
- *
425
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
426
426
  * @summary Place order
427
427
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
428
428
  * @param {*} [options] Override http request option.
@@ -458,8 +458,8 @@ const TradingApiFactory = function (configuration, basePath, axios) {
458
458
  return localVarFp.cancelUserAccountOrder(requestParameters, options).then((request) => request(axios, basePath));
459
459
  },
460
460
  /**
461
- *
462
- * @summary Check impact of trades on account.
461
+ * Return the trade object and it\'s impact on the account for the specified order.
462
+ * @summary Check the impact of a trade on an account
463
463
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
464
464
  * @param {*} [options] Override http request option.
465
465
  * @throws {RequiredError}
@@ -478,7 +478,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
478
478
  return localVarFp.getUserAccountQuotes(requestParameters, options).then((request) => request(axios, basePath));
479
479
  },
480
480
  /**
481
- *
481
+ * Places a specified trade in the specified account.
482
482
  * @summary Place a trade with NO validation.
483
483
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
484
484
  * @param {*} [options] Override http request option.
@@ -488,7 +488,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
488
488
  return localVarFp.placeForceOrder(requestParameters, options).then((request) => request(axios, basePath));
489
489
  },
490
490
  /**
491
- *
491
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
492
492
  * @summary Place order
493
493
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
494
494
  * @param {*} [options] Override http request option.
@@ -519,8 +519,8 @@ class TradingApiGenerated extends base_1.BaseAPI {
519
519
  return (0, exports.TradingApiFp)(this.configuration).cancelUserAccountOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
520
520
  }
521
521
  /**
522
- *
523
- * @summary Check impact of trades on account.
522
+ * Return the trade object and it\'s impact on the account for the specified order.
523
+ * @summary Check the impact of a trade on an account
524
524
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
525
525
  * @param {*} [options] Override http request option.
526
526
  * @throws {RequiredError}
@@ -541,7 +541,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
541
541
  return (0, exports.TradingApiFp)(this.configuration).getUserAccountQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
542
542
  }
543
543
  /**
544
- *
544
+ * Places a specified trade in the specified account.
545
545
  * @summary Place a trade with NO validation.
546
546
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
547
547
  * @param {*} [options] Override http request option.
@@ -552,7 +552,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
552
552
  return (0, exports.TradingApiFp)(this.configuration).placeForceOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
553
553
  }
554
554
  /**
555
- *
555
+ * Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.
556
556
  * @summary Place order
557
557
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
558
558
  * @param {*} [options] Override http request option.