snaptrade-typescript-sdk 8.24.0 → 8.26.0

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.
Files changed (294) hide show
  1. package/README.md +147 -147
  2. package/dist/api/account-information-api-generated.d.ts +525 -525
  3. package/dist/api/account-information-api-generated.js +765 -765
  4. package/dist/api/account-information-api.d.ts +4 -4
  5. package/dist/api/account-information-api.js +22 -22
  6. package/dist/api/api-status-api-generated.d.ts +69 -69
  7. package/dist/api/api-status-api-generated.js +131 -131
  8. package/dist/api/api-status-api.d.ts +4 -4
  9. package/dist/api/api-status-api.js +22 -22
  10. package/dist/api/authentication-api-generated.d.ts +266 -266
  11. package/dist/api/authentication-api-generated.js +461 -461
  12. package/dist/api/authentication-api.d.ts +4 -4
  13. package/dist/api/authentication-api.js +22 -22
  14. package/dist/api/connections-api-generated.d.ts +274 -274
  15. package/dist/api/connections-api-generated.js +411 -411
  16. package/dist/api/connections-api.d.ts +4 -4
  17. package/dist/api/connections-api.js +22 -22
  18. package/dist/api/error-logs-api-generated.d.ts +93 -93
  19. package/dist/api/error-logs-api-generated.js +152 -152
  20. package/dist/api/error-logs-api.d.ts +4 -4
  21. package/dist/api/error-logs-api.js +22 -22
  22. package/dist/api/options-api-generated.d.ts +368 -368
  23. package/dist/api/options-api-generated.js +530 -530
  24. package/dist/api/options-api.d.ts +4 -4
  25. package/dist/api/options-api.js +22 -22
  26. package/dist/api/reference-data-api-generated.d.ts +467 -467
  27. package/dist/api/reference-data-api-generated.js +872 -872
  28. package/dist/api/reference-data-api.d.ts +4 -4
  29. package/dist/api/reference-data-api.js +22 -22
  30. package/dist/api/trading-api-generated.d.ts +402 -402
  31. package/dist/api/trading-api-generated.js +613 -613
  32. package/dist/api/trading-api.d.ts +4 -4
  33. package/dist/api/trading-api.js +22 -22
  34. package/dist/api/transactions-and-reporting-api-generated.d.ts +217 -217
  35. package/dist/api/transactions-and-reporting-api-generated.js +287 -287
  36. package/dist/api/transactions-and-reporting-api.d.ts +4 -4
  37. package/dist/api/transactions-and-reporting-api.js +22 -22
  38. package/dist/api.d.ts +19 -19
  39. package/dist/api.js +37 -37
  40. package/dist/base.d.ts +54 -54
  41. package/dist/base.js +60 -60
  42. package/dist/client-custom.d.ts +4 -4
  43. package/dist/client-custom.js +7 -7
  44. package/dist/client.d.ts +25 -25
  45. package/dist/client.js +32 -32
  46. package/dist/common.d.ts +67 -67
  47. package/dist/common.js +191 -177
  48. package/dist/configuration.d.ts +99 -99
  49. package/dist/configuration.js +53 -53
  50. package/dist/error.d.ts +56 -56
  51. package/dist/error.js +104 -104
  52. package/dist/index.d.ts +15 -15
  53. package/dist/index.js +33 -33
  54. package/dist/jest.config.d.ts +3 -3
  55. package/dist/jest.config.js +13 -13
  56. package/dist/models/account-holdings-account.d.ts +53 -53
  57. package/dist/models/account-holdings-account.js +14 -14
  58. package/dist/models/account-holdings.d.ts +46 -46
  59. package/dist/models/account-holdings.js +14 -14
  60. package/dist/models/account-order-record-status.d.ts +16 -16
  61. package/dist/models/account-order-record-status.js +14 -14
  62. package/dist/models/account-order-record.d.ts +132 -132
  63. package/dist/models/account-order-record.js +14 -14
  64. package/dist/models/account-simple.d.ts +43 -43
  65. package/dist/models/account-simple.js +14 -14
  66. package/dist/models/account-sync-status.d.ts +24 -24
  67. package/dist/models/account-sync-status.js +14 -14
  68. package/dist/models/account.d.ts +82 -82
  69. package/dist/models/account.js +14 -14
  70. package/dist/models/action.d.ts +16 -16
  71. package/dist/models/action.js +14 -14
  72. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -17
  73. package/dist/models/authentication-login-snap-trade-user200-response.js +14 -14
  74. package/dist/models/balance.d.ts +31 -31
  75. package/dist/models/balance.js +14 -14
  76. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -36
  77. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -14
  78. package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -46
  79. package/dist/models/brokerage-authorization-type-read-only.js +14 -14
  80. package/dist/models/brokerage-authorization-type.d.ts +26 -26
  81. package/dist/models/brokerage-authorization-type.js +14 -14
  82. package/dist/models/brokerage-authorization.d.ts +75 -75
  83. package/dist/models/brokerage-authorization.js +14 -14
  84. package/dist/models/brokerage-symbol-option-symbol.d.ts +66 -84
  85. package/dist/models/brokerage-symbol-option-symbol.js +14 -14
  86. package/dist/models/brokerage-symbol-symbol.d.ts +68 -68
  87. package/dist/models/brokerage-symbol-symbol.js +14 -14
  88. package/dist/models/brokerage-symbol.d.ts +57 -57
  89. package/dist/models/brokerage-symbol.js +14 -14
  90. package/dist/models/brokerage-type.d.ts +30 -30
  91. package/dist/models/brokerage-type.js +14 -14
  92. package/dist/models/brokerage.d.ts +127 -127
  93. package/dist/models/brokerage.js +14 -14
  94. package/dist/models/calculated-trade.d.ts +31 -31
  95. package/dist/models/calculated-trade.js +14 -14
  96. package/dist/models/cash-restriction.d.ts +50 -50
  97. package/dist/models/cash-restriction.js +14 -14
  98. package/dist/models/connections-session-events200-response-inner.d.ts +16 -16
  99. package/dist/models/connections-session-events200-response-inner.js +14 -14
  100. package/dist/models/currency.d.ts +36 -36
  101. package/dist/models/currency.js +14 -14
  102. package/dist/models/delete-user-response.d.ts +30 -30
  103. package/dist/models/delete-user-response.js +14 -14
  104. package/dist/models/dividend-at-date.d.ts +36 -36
  105. package/dist/models/dividend-at-date.js +14 -14
  106. package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -36
  107. package/dist/models/encrypted-response-encrypted-message-data.js +14 -14
  108. package/dist/models/encrypted-response.d.ts +30 -30
  109. package/dist/models/encrypted-response.js +14 -14
  110. package/dist/models/exchange-rate-pairs.d.ts +37 -37
  111. package/dist/models/exchange-rate-pairs.js +14 -14
  112. package/dist/models/exchange.d.ts +66 -66
  113. package/dist/models/exchange.js +14 -14
  114. package/dist/models/excluded-asset.d.ts +25 -25
  115. package/dist/models/excluded-asset.js +14 -14
  116. package/dist/models/index.d.ts +111 -110
  117. package/dist/models/index.js +127 -126
  118. package/dist/models/jwt.d.ts +24 -24
  119. package/dist/models/jwt.js +14 -14
  120. package/dist/models/login-redirect-uri.d.ts +29 -29
  121. package/dist/models/login-redirect-uri.js +14 -14
  122. package/dist/models/manual-trade-and-impact.d.ts +38 -38
  123. package/dist/models/manual-trade-and-impact.js +14 -14
  124. package/dist/models/manual-trade-balance.d.ts +38 -38
  125. package/dist/models/manual-trade-balance.js +14 -14
  126. package/dist/models/manual-trade-form.d.ts +68 -68
  127. package/dist/models/manual-trade-form.js +14 -14
  128. package/dist/models/manual-trade-symbol.d.ts +55 -55
  129. package/dist/models/manual-trade-symbol.js +14 -14
  130. package/dist/models/manual-trade.d.ts +70 -70
  131. package/dist/models/manual-trade.js +14 -14
  132. package/dist/models/model-asset-class-details.d.ts +32 -32
  133. package/dist/models/model-asset-class-details.js +14 -14
  134. package/dist/models/model-asset-class-target.d.ts +25 -25
  135. package/dist/models/model-asset-class-target.js +14 -14
  136. package/dist/models/model-asset-class.d.ts +30 -30
  137. package/dist/models/model-asset-class.js +14 -14
  138. package/dist/models/model-portfolio-asset-class.d.ts +31 -31
  139. package/dist/models/model-portfolio-asset-class.js +14 -14
  140. package/dist/models/model-portfolio-details.d.ts +39 -39
  141. package/dist/models/model-portfolio-details.js +14 -14
  142. package/dist/models/model-portfolio-security.d.ts +31 -31
  143. package/dist/models/model-portfolio-security.js +14 -14
  144. package/dist/models/model-portfolio.d.ts +38 -38
  145. package/dist/models/model-portfolio.js +14 -14
  146. package/dist/models/model400-failed-request-response.d.ts +30 -30
  147. package/dist/models/model400-failed-request-response.js +14 -14
  148. package/dist/models/model401-failed-request-response.d.ts +30 -30
  149. package/dist/models/model401-failed-request-response.js +14 -14
  150. package/dist/models/model403-failed-request-response.d.ts +30 -30
  151. package/dist/models/model403-failed-request-response.js +14 -14
  152. package/dist/models/model404-failed-request-response.d.ts +30 -30
  153. package/dist/models/model404-failed-request-response.js +14 -14
  154. package/dist/models/monthly-dividends.d.ts +31 -31
  155. package/dist/models/monthly-dividends.js +14 -14
  156. package/dist/models/net-contributions.d.ts +36 -36
  157. package/dist/models/net-contributions.js +14 -14
  158. package/dist/models/net-dividend.d.ts +37 -37
  159. package/dist/models/net-dividend.js +14 -14
  160. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -36
  161. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -14
  162. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -37
  163. package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -14
  164. package/dist/models/option-chain-inner.d.ts +49 -49
  165. package/dist/models/option-chain-inner.js +14 -14
  166. package/dist/models/option-leg.d.ts +38 -38
  167. package/dist/models/option-leg.js +14 -14
  168. package/dist/models/option-strategy-legs-inner.d.ts +41 -41
  169. package/dist/models/option-strategy-legs-inner.js +14 -14
  170. package/dist/models/option-strategy.d.ts +50 -50
  171. package/dist/models/option-strategy.js +14 -14
  172. package/dist/models/options-get-option-strategy-request.d.ts +38 -38
  173. package/dist/models/options-get-option-strategy-request.js +14 -14
  174. package/dist/models/options-holdings.d.ts +56 -56
  175. package/dist/models/options-holdings.js +14 -14
  176. package/dist/models/options-place-option-strategy-request.d.ts +38 -38
  177. package/dist/models/options-place-option-strategy-request.js +14 -14
  178. package/dist/models/options-position-currency.d.ts +35 -0
  179. package/dist/models/options-position-currency.js +14 -0
  180. package/dist/models/options-position.d.ts +68 -62
  181. package/dist/models/options-position.js +14 -14
  182. package/dist/models/options-symbol.d.ts +67 -85
  183. package/dist/models/options-symbol.js +14 -14
  184. package/dist/models/order-type.d.ts +16 -16
  185. package/dist/models/order-type.js +14 -14
  186. package/dist/models/partner-data.d.ts +91 -91
  187. package/dist/models/partner-data.js +14 -14
  188. package/dist/models/past-value.d.ts +36 -36
  189. package/dist/models/past-value.js +14 -14
  190. package/dist/models/performance-custom.d.ts +137 -137
  191. package/dist/models/performance-custom.js +14 -14
  192. package/dist/models/portfolio-group-info.d.ts +92 -92
  193. package/dist/models/portfolio-group-info.js +14 -14
  194. package/dist/models/portfolio-group-position.d.ts +37 -37
  195. package/dist/models/portfolio-group-position.js +14 -14
  196. package/dist/models/portfolio-group-settings.d.ts +49 -49
  197. package/dist/models/portfolio-group-settings.js +14 -14
  198. package/dist/models/portfolio-group.d.ts +30 -30
  199. package/dist/models/portfolio-group.js +14 -14
  200. package/dist/models/position-symbol.d.ts +55 -55
  201. package/dist/models/position-symbol.js +14 -14
  202. package/dist/models/position.d.ts +61 -55
  203. package/dist/models/position.js +14 -14
  204. package/dist/models/redirect-tokenand-pin.d.ts +30 -30
  205. package/dist/models/redirect-tokenand-pin.js +14 -14
  206. package/dist/models/security-type.d.ts +42 -42
  207. package/dist/models/security-type.js +14 -14
  208. package/dist/models/session-event.d.ts +62 -62
  209. package/dist/models/session-event.js +14 -14
  210. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -30
  211. package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -14
  212. package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -75
  213. package/dist/models/snap-trade-holdings-account-account-id.js +14 -14
  214. package/dist/models/snap-trade-holdings-account.d.ts +70 -70
  215. package/dist/models/snap-trade-holdings-account.js +14 -14
  216. package/dist/models/snap-trade-holdings-total-value.d.ts +30 -30
  217. package/dist/models/snap-trade-holdings-total-value.js +14 -14
  218. package/dist/models/snap-trade-login-user-request-body.d.ts +49 -49
  219. package/dist/models/snap-trade-login-user-request-body.js +14 -14
  220. package/dist/models/snap-trade-register-user-request-body.d.ts +29 -29
  221. package/dist/models/snap-trade-register-user-request-body.js +14 -14
  222. package/dist/models/status.d.ts +36 -36
  223. package/dist/models/status.js +14 -14
  224. package/dist/models/strategy-impact-legs-inner.d.ts +60 -60
  225. package/dist/models/strategy-impact-legs-inner.js +14 -14
  226. package/dist/models/strategy-impact.d.ts +85 -85
  227. package/dist/models/strategy-impact.js +14 -14
  228. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -60
  229. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -14
  230. package/dist/models/strategy-order-place-orders-inner.d.ts +277 -277
  231. package/dist/models/strategy-order-place-orders-inner.js +14 -14
  232. package/dist/models/strategy-order-place.d.ts +31 -31
  233. package/dist/models/strategy-order-place.js +14 -14
  234. package/dist/models/strategy-order-record.d.ts +89 -89
  235. package/dist/models/strategy-order-record.js +14 -14
  236. package/dist/models/strategy-quotes-greek.d.ts +48 -48
  237. package/dist/models/strategy-quotes-greek.js +14 -14
  238. package/dist/models/strategy-quotes.d.ts +56 -56
  239. package/dist/models/strategy-quotes.js +14 -14
  240. package/dist/models/sub-period-return-rate.d.ts +36 -36
  241. package/dist/models/sub-period-return-rate.js +14 -14
  242. package/dist/models/symbol-query.d.ts +23 -23
  243. package/dist/models/symbol-query.js +14 -14
  244. package/dist/models/symbol.d.ts +63 -63
  245. package/dist/models/symbol.js +14 -14
  246. package/dist/models/symbols-quotes-inner.d.ts +54 -54
  247. package/dist/models/symbols-quotes-inner.js +14 -14
  248. package/dist/models/target-asset.d.ts +57 -57
  249. package/dist/models/target-asset.js +14 -14
  250. package/dist/models/time-in-force.d.ts +16 -16
  251. package/dist/models/time-in-force.js +14 -14
  252. package/dist/models/trade-execution-status.d.ts +80 -80
  253. package/dist/models/trade-execution-status.js +14 -14
  254. package/dist/models/trade-impact.d.ts +50 -50
  255. package/dist/models/trade-impact.js +14 -14
  256. package/dist/models/trade.d.ts +71 -71
  257. package/dist/models/trade.js +14 -14
  258. package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -23
  259. package/dist/models/trading-cancel-user-account-order-request.js +14 -14
  260. package/dist/models/trading-place-ocoorder-request.d.ts +29 -29
  261. package/dist/models/trading-place-ocoorder-request.js +14 -14
  262. package/dist/models/transactions-status.d.ts +29 -29
  263. package/dist/models/transactions-status.js +14 -14
  264. package/dist/models/underlying-symbol.d.ts +63 -63
  265. package/dist/models/underlying-symbol.js +14 -14
  266. package/dist/models/universal-activity.d.ts +118 -118
  267. package/dist/models/universal-activity.js +14 -14
  268. package/dist/models/universal-symbol-ticker.d.ts +69 -69
  269. package/dist/models/universal-symbol-ticker.js +14 -14
  270. package/dist/models/universal-symbol.d.ts +69 -69
  271. package/dist/models/universal-symbol.js +14 -14
  272. package/dist/models/user-error-log.d.ts +54 -54
  273. package/dist/models/user-error-log.js +14 -14
  274. package/dist/models/user-idand-secret.d.ts +30 -30
  275. package/dist/models/user-idand-secret.js +14 -14
  276. package/dist/models/user-settings.d.ts +79 -79
  277. package/dist/models/user-settings.js +14 -14
  278. package/dist/models/usexchange.d.ts +72 -72
  279. package/dist/models/usexchange.js +14 -14
  280. package/dist/pagination/page-types.d.ts +26 -26
  281. package/dist/pagination/page-types.js +12 -12
  282. package/dist/pagination/page.d.ts +35 -35
  283. package/dist/pagination/page.js +32 -32
  284. package/dist/pagination/pageable.d.ts +57 -57
  285. package/dist/pagination/pageable.js +70 -70
  286. package/dist/pagination/paginate.d.ts +16 -16
  287. package/dist/pagination/paginate.js +39 -39
  288. package/dist/requestAfterHook.d.ts +8 -8
  289. package/dist/requestAfterHook.js +45 -45
  290. package/dist/requestBeforeHook.d.ts +9 -9
  291. package/dist/requestBeforeHook.js +8 -8
  292. package/dist/requestBeforeUrlHook.d.ts +7 -7
  293. package/dist/requestBeforeUrlHook.js +5 -5
  294. package/package.json +42 -42
@@ -1,467 +1,467 @@
1
- /**
2
- * SnapTrade
3
- * Connect brokerage accounts to your app for live positions and trading
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- * Contact: api@snaptrade.com
7
- *
8
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
9
- * Do not edit the class manually.
10
- */
11
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
- import { Configuration } from '../configuration';
13
- import { RequestArgs, BaseAPI } from '../base';
14
- import { Brokerage } from '../models';
15
- import { BrokerageAuthorizationTypeReadOnly } from '../models';
16
- import { Currency } from '../models';
17
- import { Exchange } from '../models';
18
- import { ExchangeRatePairs } from '../models';
19
- import { PartnerData } from '../models';
20
- import { SecurityType } from '../models';
21
- import { SymbolQuery } from '../models';
22
- import { UniversalSymbol } from '../models';
23
- /**
24
- * ReferenceDataApi - axios parameter creator
25
- * @export
26
- */
27
- export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
28
- /**
29
- *
30
- * @summary Return the exchange rate of a currency pair
31
- * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
32
- * @param {*} [options] Override http request option.
33
- * @throws {RequiredError}
34
- */
35
- getCurrencyExchangeRatePair: (currencyPair: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
- /**
37
- *
38
- * @summary Get metadata related to Snaptrade partner
39
- * @param {*} [options] Override http request option.
40
- * @throws {RequiredError}
41
- */
42
- getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
- /**
44
- *
45
- * @summary List of all security types.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
- /**
51
- *
52
- * @summary List exchanges
53
- * @param {*} [options] Override http request option.
54
- * @throws {RequiredError}
55
- */
56
- getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
- /**
58
- *
59
- * @summary Search for symbols
60
- * @param {SymbolQuery} [symbolQuery]
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- */
64
- getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
- /**
66
- *
67
- * @summary Get details of a symbol by the ticker
68
- * @param {string} ticker The ticker of the UniversalSymbol to get.
69
- * @param {string} [symbolId] OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
70
- * @param {*} [options] Override http request option.
71
- * @throws {RequiredError}
72
- */
73
- getSymbolsByTicker: (ticker: string, symbolId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
- /**
75
- *
76
- * @summary List of all brokerage authorization types
77
- * @param {string} [brokerage] Comma separated value of brokerage slugs
78
- * @param {*} [options] Override http request option.
79
- * @throws {RequiredError}
80
- */
81
- listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
- /**
83
- *
84
- * @summary List brokerages
85
- * @param {*} [options] Override http request option.
86
- * @throws {RequiredError}
87
- */
88
- listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
89
- /**
90
- *
91
- * @summary List currencies
92
- * @param {*} [options] Override http request option.
93
- * @throws {RequiredError}
94
- */
95
- listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
- /**
97
- *
98
- * @summary List currency exchange rates
99
- * @param {*} [options] Override http request option.
100
- * @throws {RequiredError}
101
- */
102
- listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
103
- /**
104
- *
105
- * @summary Search for symbols available in an account
106
- * @param {string} userId
107
- * @param {string} userSecret
108
- * @param {string} accountId The ID of the account get positions.
109
- * @param {SymbolQuery} [symbolQuery]
110
- * @param {*} [options] Override http request option.
111
- * @throws {RequiredError}
112
- */
113
- symbolSearchUserAccount: (userId: string, userSecret: string, accountId: string, symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
114
- };
115
- /**
116
- * ReferenceDataApi - functional programming interface
117
- * @export
118
- */
119
- export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
120
- /**
121
- *
122
- * @summary Return the exchange rate of a currency pair
123
- * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
124
- * @param {*} [options] Override http request option.
125
- * @throws {RequiredError}
126
- */
127
- getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeRatePairs>>;
128
- /**
129
- *
130
- * @summary Get metadata related to Snaptrade partner
131
- * @param {*} [options] Override http request option.
132
- * @throws {RequiredError}
133
- */
134
- getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
135
- /**
136
- *
137
- * @summary List of all security types.
138
- * @param {*} [options] Override http request option.
139
- * @throws {RequiredError}
140
- */
141
- getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
142
- /**
143
- *
144
- * @summary List exchanges
145
- * @param {*} [options] Override http request option.
146
- * @throws {RequiredError}
147
- */
148
- getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
149
- /**
150
- *
151
- * @summary Search for symbols
152
- * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
153
- * @param {*} [options] Override http request option.
154
- * @throws {RequiredError}
155
- */
156
- getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
157
- /**
158
- *
159
- * @summary Get details of a symbol by the ticker
160
- * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
161
- * @param {*} [options] Override http request option.
162
- * @throws {RequiredError}
163
- */
164
- getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
165
- /**
166
- *
167
- * @summary List of all brokerage authorization types
168
- * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
169
- * @param {*} [options] Override http request option.
170
- * @throws {RequiredError}
171
- */
172
- listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
173
- /**
174
- *
175
- * @summary List brokerages
176
- * @param {*} [options] Override http request option.
177
- * @throws {RequiredError}
178
- */
179
- listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
180
- /**
181
- *
182
- * @summary List currencies
183
- * @param {*} [options] Override http request option.
184
- * @throws {RequiredError}
185
- */
186
- listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
187
- /**
188
- *
189
- * @summary List currency exchange rates
190
- * @param {*} [options] Override http request option.
191
- * @throws {RequiredError}
192
- */
193
- listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
194
- /**
195
- *
196
- * @summary Search for symbols available in an account
197
- * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
198
- * @param {*} [options] Override http request option.
199
- * @throws {RequiredError}
200
- */
201
- symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
202
- };
203
- /**
204
- * ReferenceDataApi - factory interface
205
- * @export
206
- */
207
- export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
208
- /**
209
- *
210
- * @summary Return the exchange rate of a currency pair
211
- * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
212
- * @param {*} [options] Override http request option.
213
- * @throws {RequiredError}
214
- */
215
- getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): AxiosPromise<ExchangeRatePairs>;
216
- /**
217
- *
218
- * @summary Get metadata related to Snaptrade partner
219
- * @param {*} [options] Override http request option.
220
- * @throws {RequiredError}
221
- */
222
- getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
223
- /**
224
- *
225
- * @summary List of all security types.
226
- * @param {*} [options] Override http request option.
227
- * @throws {RequiredError}
228
- */
229
- getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
230
- /**
231
- *
232
- * @summary List exchanges
233
- * @param {*} [options] Override http request option.
234
- * @throws {RequiredError}
235
- */
236
- getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
237
- /**
238
- *
239
- * @summary Search for symbols
240
- * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
241
- * @param {*} [options] Override http request option.
242
- * @throws {RequiredError}
243
- */
244
- getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
245
- /**
246
- *
247
- * @summary Get details of a symbol by the ticker
248
- * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
249
- * @param {*} [options] Override http request option.
250
- * @throws {RequiredError}
251
- */
252
- getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
253
- /**
254
- *
255
- * @summary List of all brokerage authorization types
256
- * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
257
- * @param {*} [options] Override http request option.
258
- * @throws {RequiredError}
259
- */
260
- listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
261
- /**
262
- *
263
- * @summary List brokerages
264
- * @param {*} [options] Override http request option.
265
- * @throws {RequiredError}
266
- */
267
- listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
268
- /**
269
- *
270
- * @summary List currencies
271
- * @param {*} [options] Override http request option.
272
- * @throws {RequiredError}
273
- */
274
- listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
275
- /**
276
- *
277
- * @summary List currency exchange rates
278
- * @param {*} [options] Override http request option.
279
- * @throws {RequiredError}
280
- */
281
- listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
282
- /**
283
- *
284
- * @summary Search for symbols available in an account
285
- * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
286
- * @param {*} [options] Override http request option.
287
- * @throws {RequiredError}
288
- */
289
- symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
290
- };
291
- /**
292
- * Request parameters for getCurrencyExchangeRatePair operation in ReferenceDataApi.
293
- * @export
294
- * @interface ReferenceDataApiGetCurrencyExchangeRatePairRequest
295
- */
296
- export type ReferenceDataApiGetCurrencyExchangeRatePairRequest = {
297
- /**
298
- * A currency pair based on currency code for example, {CAD-USD}
299
- * @type {string}
300
- * @memberof ReferenceDataApiGetCurrencyExchangeRatePair
301
- */
302
- readonly currencyPair: string;
303
- };
304
- /**
305
- * Request parameters for getSymbols operation in ReferenceDataApi.
306
- * @export
307
- * @interface ReferenceDataApiGetSymbolsRequest
308
- */
309
- export type ReferenceDataApiGetSymbolsRequest = {} & SymbolQuery;
310
- /**
311
- * Request parameters for getSymbolsByTicker operation in ReferenceDataApi.
312
- * @export
313
- * @interface ReferenceDataApiGetSymbolsByTickerRequest
314
- */
315
- export type ReferenceDataApiGetSymbolsByTickerRequest = {
316
- /**
317
- * The ticker of the UniversalSymbol to get.
318
- * @type {string}
319
- * @memberof ReferenceDataApiGetSymbolsByTicker
320
- */
321
- readonly ticker: string;
322
- /**
323
- * OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
324
- * @type {string}
325
- * @memberof ReferenceDataApiGetSymbolsByTicker
326
- */
327
- readonly symbolId?: string;
328
- };
329
- /**
330
- * Request parameters for listAllBrokerageAuthorizationType operation in ReferenceDataApi.
331
- * @export
332
- * @interface ReferenceDataApiListAllBrokerageAuthorizationTypeRequest
333
- */
334
- export type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest = {
335
- /**
336
- * Comma separated value of brokerage slugs
337
- * @type {string}
338
- * @memberof ReferenceDataApiListAllBrokerageAuthorizationType
339
- */
340
- readonly brokerage?: string;
341
- };
342
- /**
343
- * Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.
344
- * @export
345
- * @interface ReferenceDataApiSymbolSearchUserAccountRequest
346
- */
347
- export type ReferenceDataApiSymbolSearchUserAccountRequest = {
348
- /**
349
- *
350
- * @type {string}
351
- * @memberof ReferenceDataApiSymbolSearchUserAccount
352
- */
353
- readonly userId: string;
354
- /**
355
- *
356
- * @type {string}
357
- * @memberof ReferenceDataApiSymbolSearchUserAccount
358
- */
359
- readonly userSecret: string;
360
- /**
361
- * The ID of the account get positions.
362
- * @type {string}
363
- * @memberof ReferenceDataApiSymbolSearchUserAccount
364
- */
365
- readonly accountId: string;
366
- } & SymbolQuery;
367
- /**
368
- * ReferenceDataApiGenerated - object-oriented interface
369
- * @export
370
- * @class ReferenceDataApiGenerated
371
- * @extends {BaseAPI}
372
- */
373
- export declare class ReferenceDataApiGenerated extends BaseAPI {
374
- /**
375
- *
376
- * @summary Return the exchange rate of a currency pair
377
- * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
378
- * @param {*} [options] Override http request option.
379
- * @throws {RequiredError}
380
- * @memberof ReferenceDataApiGenerated
381
- */
382
- getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any>>;
383
- /**
384
- *
385
- * @summary Get metadata related to Snaptrade partner
386
- * @param {*} [options] Override http request option.
387
- * @throws {RequiredError}
388
- * @memberof ReferenceDataApiGenerated
389
- */
390
- getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
391
- /**
392
- *
393
- * @summary List of all security types.
394
- * @param {*} [options] Override http request option.
395
- * @throws {RequiredError}
396
- * @memberof ReferenceDataApiGenerated
397
- */
398
- getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
399
- /**
400
- *
401
- * @summary List exchanges
402
- * @param {*} [options] Override http request option.
403
- * @throws {RequiredError}
404
- * @memberof ReferenceDataApiGenerated
405
- */
406
- getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
407
- /**
408
- *
409
- * @summary Search for symbols
410
- * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
411
- * @param {*} [options] Override http request option.
412
- * @throws {RequiredError}
413
- * @memberof ReferenceDataApiGenerated
414
- */
415
- getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
416
- /**
417
- *
418
- * @summary Get details of a symbol by the ticker
419
- * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
420
- * @param {*} [options] Override http request option.
421
- * @throws {RequiredError}
422
- * @memberof ReferenceDataApiGenerated
423
- */
424
- getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
425
- /**
426
- *
427
- * @summary List of all brokerage authorization types
428
- * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
429
- * @param {*} [options] Override http request option.
430
- * @throws {RequiredError}
431
- * @memberof ReferenceDataApiGenerated
432
- */
433
- listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
434
- /**
435
- *
436
- * @summary List brokerages
437
- * @param {*} [options] Override http request option.
438
- * @throws {RequiredError}
439
- * @memberof ReferenceDataApiGenerated
440
- */
441
- listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
442
- /**
443
- *
444
- * @summary List currencies
445
- * @param {*} [options] Override http request option.
446
- * @throws {RequiredError}
447
- * @memberof ReferenceDataApiGenerated
448
- */
449
- listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
450
- /**
451
- *
452
- * @summary List currency exchange rates
453
- * @param {*} [options] Override http request option.
454
- * @throws {RequiredError}
455
- * @memberof ReferenceDataApiGenerated
456
- */
457
- listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
458
- /**
459
- *
460
- * @summary Search for symbols available in an account
461
- * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
462
- * @param {*} [options] Override http request option.
463
- * @throws {RequiredError}
464
- * @memberof ReferenceDataApiGenerated
465
- */
466
- symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
467
- }
1
+ /**
2
+ * SnapTrade
3
+ * Connect brokerage accounts to your app for live positions and trading
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: api@snaptrade.com
7
+ *
8
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
9
+ * Do not edit the class manually.
10
+ */
11
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
+ import { Configuration } from '../configuration';
13
+ import { RequestArgs, BaseAPI } from '../base';
14
+ import { Brokerage } from '../models';
15
+ import { BrokerageAuthorizationTypeReadOnly } from '../models';
16
+ import { Currency } from '../models';
17
+ import { Exchange } from '../models';
18
+ import { ExchangeRatePairs } from '../models';
19
+ import { PartnerData } from '../models';
20
+ import { SecurityType } from '../models';
21
+ import { SymbolQuery } from '../models';
22
+ import { UniversalSymbol } from '../models';
23
+ /**
24
+ * ReferenceDataApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ *
30
+ * @summary Return the exchange rate of a currency pair
31
+ * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ getCurrencyExchangeRatePair: (currencyPair: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ *
38
+ * @summary Get metadata related to Snaptrade partner
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ *
45
+ * @summary List of all security types.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
+ /**
51
+ *
52
+ * @summary List exchanges
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
+ /**
58
+ *
59
+ * @summary Search for symbols
60
+ * @param {SymbolQuery} [symbolQuery]
61
+ * @param {*} [options] Override http request option.
62
+ * @throws {RequiredError}
63
+ */
64
+ getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ /**
66
+ *
67
+ * @summary Get details of a symbol by the ticker
68
+ * @param {string} ticker The ticker of the UniversalSymbol to get.
69
+ * @param {string} [symbolId] OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ getSymbolsByTicker: (ticker: string, symbolId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
+ /**
75
+ *
76
+ * @summary List of all brokerage authorization types
77
+ * @param {string} [brokerage] Comma separated value of brokerage slugs
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ *
84
+ * @summary List brokerages
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
89
+ /**
90
+ *
91
+ * @summary List currencies
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
+ /**
97
+ *
98
+ * @summary List currency exchange rates
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
103
+ /**
104
+ *
105
+ * @summary Search for symbols available in an account
106
+ * @param {string} userId
107
+ * @param {string} userSecret
108
+ * @param {string} accountId The ID of the account get positions.
109
+ * @param {SymbolQuery} [symbolQuery]
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ symbolSearchUserAccount: (userId: string, userSecret: string, accountId: string, symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
114
+ };
115
+ /**
116
+ * ReferenceDataApi - functional programming interface
117
+ * @export
118
+ */
119
+ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
120
+ /**
121
+ *
122
+ * @summary Return the exchange rate of a currency pair
123
+ * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
124
+ * @param {*} [options] Override http request option.
125
+ * @throws {RequiredError}
126
+ */
127
+ getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeRatePairs>>;
128
+ /**
129
+ *
130
+ * @summary Get metadata related to Snaptrade partner
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
135
+ /**
136
+ *
137
+ * @summary List of all security types.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
142
+ /**
143
+ *
144
+ * @summary List exchanges
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
149
+ /**
150
+ *
151
+ * @summary Search for symbols
152
+ * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
157
+ /**
158
+ *
159
+ * @summary Get details of a symbol by the ticker
160
+ * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
165
+ /**
166
+ *
167
+ * @summary List of all brokerage authorization types
168
+ * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
173
+ /**
174
+ *
175
+ * @summary List brokerages
176
+ * @param {*} [options] Override http request option.
177
+ * @throws {RequiredError}
178
+ */
179
+ listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
180
+ /**
181
+ *
182
+ * @summary List currencies
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
187
+ /**
188
+ *
189
+ * @summary List currency exchange rates
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
194
+ /**
195
+ *
196
+ * @summary Search for symbols available in an account
197
+ * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ */
201
+ symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
202
+ };
203
+ /**
204
+ * ReferenceDataApi - factory interface
205
+ * @export
206
+ */
207
+ export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
208
+ /**
209
+ *
210
+ * @summary Return the exchange rate of a currency pair
211
+ * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ */
215
+ getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): AxiosPromise<ExchangeRatePairs>;
216
+ /**
217
+ *
218
+ * @summary Get metadata related to Snaptrade partner
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
223
+ /**
224
+ *
225
+ * @summary List of all security types.
226
+ * @param {*} [options] Override http request option.
227
+ * @throws {RequiredError}
228
+ */
229
+ getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
230
+ /**
231
+ *
232
+ * @summary List exchanges
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
236
+ getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
237
+ /**
238
+ *
239
+ * @summary Search for symbols
240
+ * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ */
244
+ getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
245
+ /**
246
+ *
247
+ * @summary Get details of a symbol by the ticker
248
+ * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
249
+ * @param {*} [options] Override http request option.
250
+ * @throws {RequiredError}
251
+ */
252
+ getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
253
+ /**
254
+ *
255
+ * @summary List of all brokerage authorization types
256
+ * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
257
+ * @param {*} [options] Override http request option.
258
+ * @throws {RequiredError}
259
+ */
260
+ listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
261
+ /**
262
+ *
263
+ * @summary List brokerages
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
268
+ /**
269
+ *
270
+ * @summary List currencies
271
+ * @param {*} [options] Override http request option.
272
+ * @throws {RequiredError}
273
+ */
274
+ listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
275
+ /**
276
+ *
277
+ * @summary List currency exchange rates
278
+ * @param {*} [options] Override http request option.
279
+ * @throws {RequiredError}
280
+ */
281
+ listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
282
+ /**
283
+ *
284
+ * @summary Search for symbols available in an account
285
+ * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
290
+ };
291
+ /**
292
+ * Request parameters for getCurrencyExchangeRatePair operation in ReferenceDataApi.
293
+ * @export
294
+ * @interface ReferenceDataApiGetCurrencyExchangeRatePairRequest
295
+ */
296
+ export type ReferenceDataApiGetCurrencyExchangeRatePairRequest = {
297
+ /**
298
+ * A currency pair based on currency code for example, {CAD-USD}
299
+ * @type {string}
300
+ * @memberof ReferenceDataApiGetCurrencyExchangeRatePair
301
+ */
302
+ readonly currencyPair: string;
303
+ };
304
+ /**
305
+ * Request parameters for getSymbols operation in ReferenceDataApi.
306
+ * @export
307
+ * @interface ReferenceDataApiGetSymbolsRequest
308
+ */
309
+ export type ReferenceDataApiGetSymbolsRequest = {} & SymbolQuery;
310
+ /**
311
+ * Request parameters for getSymbolsByTicker operation in ReferenceDataApi.
312
+ * @export
313
+ * @interface ReferenceDataApiGetSymbolsByTickerRequest
314
+ */
315
+ export type ReferenceDataApiGetSymbolsByTickerRequest = {
316
+ /**
317
+ * The ticker of the UniversalSymbol to get.
318
+ * @type {string}
319
+ * @memberof ReferenceDataApiGetSymbolsByTicker
320
+ */
321
+ readonly ticker: string;
322
+ /**
323
+ * OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
324
+ * @type {string}
325
+ * @memberof ReferenceDataApiGetSymbolsByTicker
326
+ */
327
+ readonly symbolId?: string;
328
+ };
329
+ /**
330
+ * Request parameters for listAllBrokerageAuthorizationType operation in ReferenceDataApi.
331
+ * @export
332
+ * @interface ReferenceDataApiListAllBrokerageAuthorizationTypeRequest
333
+ */
334
+ export type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest = {
335
+ /**
336
+ * Comma separated value of brokerage slugs
337
+ * @type {string}
338
+ * @memberof ReferenceDataApiListAllBrokerageAuthorizationType
339
+ */
340
+ readonly brokerage?: string;
341
+ };
342
+ /**
343
+ * Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.
344
+ * @export
345
+ * @interface ReferenceDataApiSymbolSearchUserAccountRequest
346
+ */
347
+ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
348
+ /**
349
+ *
350
+ * @type {string}
351
+ * @memberof ReferenceDataApiSymbolSearchUserAccount
352
+ */
353
+ readonly userId: string;
354
+ /**
355
+ *
356
+ * @type {string}
357
+ * @memberof ReferenceDataApiSymbolSearchUserAccount
358
+ */
359
+ readonly userSecret: string;
360
+ /**
361
+ * The ID of the account get positions.
362
+ * @type {string}
363
+ * @memberof ReferenceDataApiSymbolSearchUserAccount
364
+ */
365
+ readonly accountId: string;
366
+ } & SymbolQuery;
367
+ /**
368
+ * ReferenceDataApiGenerated - object-oriented interface
369
+ * @export
370
+ * @class ReferenceDataApiGenerated
371
+ * @extends {BaseAPI}
372
+ */
373
+ export declare class ReferenceDataApiGenerated extends BaseAPI {
374
+ /**
375
+ *
376
+ * @summary Return the exchange rate of a currency pair
377
+ * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ * @memberof ReferenceDataApiGenerated
381
+ */
382
+ getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any>>;
383
+ /**
384
+ *
385
+ * @summary Get metadata related to Snaptrade partner
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ * @memberof ReferenceDataApiGenerated
389
+ */
390
+ getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
391
+ /**
392
+ *
393
+ * @summary List of all security types.
394
+ * @param {*} [options] Override http request option.
395
+ * @throws {RequiredError}
396
+ * @memberof ReferenceDataApiGenerated
397
+ */
398
+ getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
399
+ /**
400
+ *
401
+ * @summary List exchanges
402
+ * @param {*} [options] Override http request option.
403
+ * @throws {RequiredError}
404
+ * @memberof ReferenceDataApiGenerated
405
+ */
406
+ getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
407
+ /**
408
+ *
409
+ * @summary Search for symbols
410
+ * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
411
+ * @param {*} [options] Override http request option.
412
+ * @throws {RequiredError}
413
+ * @memberof ReferenceDataApiGenerated
414
+ */
415
+ getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
416
+ /**
417
+ *
418
+ * @summary Get details of a symbol by the ticker
419
+ * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
420
+ * @param {*} [options] Override http request option.
421
+ * @throws {RequiredError}
422
+ * @memberof ReferenceDataApiGenerated
423
+ */
424
+ getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
425
+ /**
426
+ *
427
+ * @summary List of all brokerage authorization types
428
+ * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ * @memberof ReferenceDataApiGenerated
432
+ */
433
+ listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
434
+ /**
435
+ *
436
+ * @summary List brokerages
437
+ * @param {*} [options] Override http request option.
438
+ * @throws {RequiredError}
439
+ * @memberof ReferenceDataApiGenerated
440
+ */
441
+ listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
442
+ /**
443
+ *
444
+ * @summary List currencies
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ * @memberof ReferenceDataApiGenerated
448
+ */
449
+ listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
450
+ /**
451
+ *
452
+ * @summary List currency exchange rates
453
+ * @param {*} [options] Override http request option.
454
+ * @throws {RequiredError}
455
+ * @memberof ReferenceDataApiGenerated
456
+ */
457
+ listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
458
+ /**
459
+ *
460
+ * @summary Search for symbols available in an account
461
+ * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
462
+ * @param {*} [options] Override http request option.
463
+ * @throws {RequiredError}
464
+ * @memberof ReferenceDataApiGenerated
465
+ */
466
+ symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
467
+ }