snaptrade-typescript-sdk 9.0.17 → 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.
@@ -16,8 +16,8 @@ import { UniversalSymbol } from '../models';
16
16
  */
17
17
  export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
18
18
  /**
19
- *
20
- * @summary Return the exchange rate of a currency pair
19
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
20
+ * @summary Get exchange rate of a currency pair
21
21
  * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
22
22
  * @param {*} [options] Override http request option.
23
23
  * @throws {RequiredError}
@@ -38,14 +38,14 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
38
38
  */
39
39
  getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
40
  /**
41
- *
42
- * @summary List exchanges
41
+ * Returns a list of all supported Exchanges.
42
+ * @summary Get exchanges
43
43
  * @param {*} [options] Override http request option.
44
44
  * @throws {RequiredError}
45
45
  */
46
46
  getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
47
  /**
48
- *
48
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
49
49
  * @summary Search for symbols
50
50
  * @param {SymbolQuery} [symbolQuery]
51
51
  * @param {*} [options] Override http request option.
@@ -53,38 +53,38 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
53
53
  */
54
54
  getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
55
  /**
56
- *
57
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
56
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
57
+ * @summary Get details of a symbol
58
58
  * @param {string} query The ticker or universal_symbol_id of the UniversalSymbol to get.
59
59
  * @param {*} [options] Override http request option.
60
60
  * @throws {RequiredError}
61
61
  */
62
62
  getSymbolsByTicker: (query: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
63
  /**
64
- *
65
- * @summary List of all brokerage authorization types
64
+ * Returns a list of all defined Brokerage authorization Type objects.
65
+ * @summary Get all brokerage authorization types
66
66
  * @param {string} [brokerage] Comma separated value of brokerage slugs
67
67
  * @param {*} [options] Override http request option.
68
68
  * @throws {RequiredError}
69
69
  */
70
70
  listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
71
71
  /**
72
- *
73
- * @summary List brokerages
72
+ * Returns a list of all defined Brokerage objects.
73
+ * @summary Get brokerages
74
74
  * @param {*} [options] Override http request option.
75
75
  * @throws {RequiredError}
76
76
  */
77
77
  listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
78
  /**
79
- *
80
- * @summary List currencies
79
+ * Returns a list of all defined Currency objects.
80
+ * @summary Get currencies
81
81
  * @param {*} [options] Override http request option.
82
82
  * @throws {RequiredError}
83
83
  */
84
84
  listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
85
85
  /**
86
- *
87
- * @summary List currency exchange rates
86
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
87
+ * @summary Get currency exchange rates
88
88
  * @param {*} [options] Override http request option.
89
89
  * @throws {RequiredError}
90
90
  */
@@ -107,8 +107,8 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
107
107
  */
108
108
  export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
109
109
  /**
110
- *
111
- * @summary Return the exchange rate of a currency pair
110
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
111
+ * @summary Get exchange rate of a currency pair
112
112
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
113
113
  * @param {*} [options] Override http request option.
114
114
  * @throws {RequiredError}
@@ -129,14 +129,14 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
129
129
  */
130
130
  getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
131
131
  /**
132
- *
133
- * @summary List exchanges
132
+ * Returns a list of all supported Exchanges.
133
+ * @summary Get exchanges
134
134
  * @param {*} [options] Override http request option.
135
135
  * @throws {RequiredError}
136
136
  */
137
137
  getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
138
138
  /**
139
- *
139
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
140
140
  * @summary Search for symbols
141
141
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
142
142
  * @param {*} [options] Override http request option.
@@ -144,38 +144,38 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
144
144
  */
145
145
  getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
146
146
  /**
147
- *
148
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
147
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
148
+ * @summary Get details of a symbol
149
149
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
150
150
  * @param {*} [options] Override http request option.
151
151
  * @throws {RequiredError}
152
152
  */
153
153
  getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
154
154
  /**
155
- *
156
- * @summary List of all brokerage authorization types
155
+ * Returns a list of all defined Brokerage authorization Type objects.
156
+ * @summary Get all brokerage authorization types
157
157
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
158
158
  * @param {*} [options] Override http request option.
159
159
  * @throws {RequiredError}
160
160
  */
161
161
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
162
162
  /**
163
- *
164
- * @summary List brokerages
163
+ * Returns a list of all defined Brokerage objects.
164
+ * @summary Get brokerages
165
165
  * @param {*} [options] Override http request option.
166
166
  * @throws {RequiredError}
167
167
  */
168
168
  listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
169
169
  /**
170
- *
171
- * @summary List currencies
170
+ * Returns a list of all defined Currency objects.
171
+ * @summary Get currencies
172
172
  * @param {*} [options] Override http request option.
173
173
  * @throws {RequiredError}
174
174
  */
175
175
  listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
176
176
  /**
177
- *
178
- * @summary List currency exchange rates
177
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
178
+ * @summary Get currency exchange rates
179
179
  * @param {*} [options] Override http request option.
180
180
  * @throws {RequiredError}
181
181
  */
@@ -195,8 +195,8 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
195
195
  */
196
196
  export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
197
197
  /**
198
- *
199
- * @summary Return the exchange rate of a currency pair
198
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
199
+ * @summary Get exchange rate of a currency pair
200
200
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
201
201
  * @param {*} [options] Override http request option.
202
202
  * @throws {RequiredError}
@@ -217,14 +217,14 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
217
217
  */
218
218
  getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
219
219
  /**
220
- *
221
- * @summary List exchanges
220
+ * Returns a list of all supported Exchanges.
221
+ * @summary Get exchanges
222
222
  * @param {*} [options] Override http request option.
223
223
  * @throws {RequiredError}
224
224
  */
225
225
  getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
226
226
  /**
227
- *
227
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
228
228
  * @summary Search for symbols
229
229
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
230
230
  * @param {*} [options] Override http request option.
@@ -232,38 +232,38 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
232
232
  */
233
233
  getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
234
234
  /**
235
- *
236
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
235
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
236
+ * @summary Get details of a symbol
237
237
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
238
238
  * @param {*} [options] Override http request option.
239
239
  * @throws {RequiredError}
240
240
  */
241
241
  getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
242
242
  /**
243
- *
244
- * @summary List of all brokerage authorization types
243
+ * Returns a list of all defined Brokerage authorization Type objects.
244
+ * @summary Get all brokerage authorization types
245
245
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
246
246
  * @param {*} [options] Override http request option.
247
247
  * @throws {RequiredError}
248
248
  */
249
249
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
250
250
  /**
251
- *
252
- * @summary List brokerages
251
+ * Returns a list of all defined Brokerage objects.
252
+ * @summary Get brokerages
253
253
  * @param {*} [options] Override http request option.
254
254
  * @throws {RequiredError}
255
255
  */
256
256
  listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
257
257
  /**
258
- *
259
- * @summary List currencies
258
+ * Returns a list of all defined Currency objects.
259
+ * @summary Get currencies
260
260
  * @param {*} [options] Override http request option.
261
261
  * @throws {RequiredError}
262
262
  */
263
263
  listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
264
264
  /**
265
- *
266
- * @summary List currency exchange rates
265
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
266
+ * @summary Get currency exchange rates
267
267
  * @param {*} [options] Override http request option.
268
268
  * @throws {RequiredError}
269
269
  */
@@ -355,8 +355,8 @@ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
355
355
  */
356
356
  export declare class ReferenceDataApiGenerated extends BaseAPI {
357
357
  /**
358
- *
359
- * @summary Return the exchange rate of a currency pair
358
+ * Returns an Exchange Rate Pair object for the specified Currency Pair.
359
+ * @summary Get exchange rate of a currency pair
360
360
  * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
361
361
  * @param {*} [options] Override http request option.
362
362
  * @throws {RequiredError}
@@ -380,15 +380,15 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
380
380
  */
381
381
  getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
382
382
  /**
383
- *
384
- * @summary List exchanges
383
+ * Returns a list of all supported Exchanges.
384
+ * @summary Get exchanges
385
385
  * @param {*} [options] Override http request option.
386
386
  * @throws {RequiredError}
387
387
  * @memberof ReferenceDataApiGenerated
388
388
  */
389
389
  getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
390
390
  /**
391
- *
391
+ * Returns a list of Universal Symbol objects that match a defined string. Matches on ticker or name.
392
392
  * @summary Search for symbols
393
393
  * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
394
394
  * @param {*} [options] Override http request option.
@@ -397,8 +397,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
397
397
  */
398
398
  getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
399
399
  /**
400
- *
401
- * @summary Get details of a symbol by the ticker or the universal_symbol_id
400
+ * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
401
+ * @summary Get details of a symbol
402
402
  * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
403
403
  * @param {*} [options] Override http request option.
404
404
  * @throws {RequiredError}
@@ -406,8 +406,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
406
406
  */
407
407
  getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
408
408
  /**
409
- *
410
- * @summary List of all brokerage authorization types
409
+ * Returns a list of all defined Brokerage authorization Type objects.
410
+ * @summary Get all brokerage authorization types
411
411
  * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
412
412
  * @param {*} [options] Override http request option.
413
413
  * @throws {RequiredError}
@@ -415,24 +415,24 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
415
415
  */
416
416
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
417
417
  /**
418
- *
419
- * @summary List brokerages
418
+ * Returns a list of all defined Brokerage objects.
419
+ * @summary Get brokerages
420
420
  * @param {*} [options] Override http request option.
421
421
  * @throws {RequiredError}
422
422
  * @memberof ReferenceDataApiGenerated
423
423
  */
424
424
  listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
425
425
  /**
426
- *
427
- * @summary List currencies
426
+ * Returns a list of all defined Currency objects.
427
+ * @summary Get currencies
428
428
  * @param {*} [options] Override http request option.
429
429
  * @throws {RequiredError}
430
430
  * @memberof ReferenceDataApiGenerated
431
431
  */
432
432
  listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
433
433
  /**
434
- *
435
- * @summary List currency exchange rates
434
+ * Returns a list of all Exchange Rate Pairs for all supported Currencies.
435
+ * @summary Get currency exchange rates
436
436
  * @param {*} [options] Override http request option.
437
437
  * @throws {RequiredError}
438
438
  * @memberof ReferenceDataApiGenerated
@@ -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