snaptrade 1.7.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (296) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -10
  3. data/Gemfile.lock +14 -12
  4. data/README.md +218 -254
  5. data/docs/APIStatusApi.md +57 -57
  6. data/docs/AccountInformationApi.md +535 -535
  7. data/docs/AuthenticationApi.md +314 -314
  8. data/docs/ConnectionsApi.md +265 -265
  9. data/docs/ErrorLogsApi.md +68 -68
  10. data/docs/OptionsApi.md +378 -378
  11. data/docs/ReferenceDataApi.md +595 -595
  12. data/docs/TradingApi.md +478 -799
  13. data/docs/TransactionsAndReportingApi.md +183 -183
  14. data/lib/snaptrade/api/account_information_api.rb +801 -801
  15. data/lib/snaptrade/api/api_status_api.rb +98 -98
  16. data/lib/snaptrade/api/authentication_api.rb +481 -481
  17. data/lib/snaptrade/api/connections_api.rb +398 -398
  18. data/lib/snaptrade/api/error_logs_api.rb +112 -112
  19. data/lib/snaptrade/api/options_api.rb +591 -591
  20. data/lib/snaptrade/api/reference_data_api.rb +894 -894
  21. data/lib/snaptrade/api/trading_api.rb +741 -1150
  22. data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
  23. data/lib/snaptrade/api_client.rb +427 -427
  24. data/lib/snaptrade/api_client_custom.rb +32 -32
  25. data/lib/snaptrade/api_error.rb +6 -6
  26. data/lib/snaptrade/configuration.rb +334 -334
  27. data/lib/snaptrade/models/account.rb +6 -6
  28. data/lib/snaptrade/models/account_holdings.rb +251 -249
  29. data/lib/snaptrade/models/account_holdings_account.rb +263 -260
  30. data/lib/snaptrade/models/account_order_record.rb +6 -6
  31. data/lib/snaptrade/models/account_order_record_status.rb +6 -6
  32. data/lib/snaptrade/models/account_simple.rb +6 -6
  33. data/lib/snaptrade/models/account_sync_status.rb +6 -6
  34. data/lib/snaptrade/models/action.rb +6 -6
  35. data/lib/snaptrade/models/auth_type.rb +6 -6
  36. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
  37. data/lib/snaptrade/models/balance.rb +6 -6
  38. data/lib/snaptrade/models/brokerage.rb +6 -6
  39. data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
  40. data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
  41. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
  42. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
  43. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
  44. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
  45. data/lib/snaptrade/models/brokerage_symbol.rb +6 -6
  46. data/lib/snaptrade/models/brokerage_type.rb +6 -6
  47. data/lib/snaptrade/models/calculated_trade.rb +6 -6
  48. data/lib/snaptrade/models/cash_restriction.rb +6 -6
  49. data/lib/snaptrade/models/connection_type.rb +6 -6
  50. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
  51. data/lib/snaptrade/models/currency.rb +6 -6
  52. data/lib/snaptrade/models/delete_user_response.rb +6 -6
  53. data/lib/snaptrade/models/dividend_at_date.rb +6 -6
  54. data/lib/snaptrade/models/encrypted_response.rb +6 -6
  55. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
  56. data/lib/snaptrade/models/exchange.rb +6 -6
  57. data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
  58. data/lib/snaptrade/models/excluded_asset.rb +6 -6
  59. data/lib/snaptrade/models/jwt.rb +6 -6
  60. data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
  61. data/lib/snaptrade/models/manual_trade.rb +6 -6
  62. data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
  63. data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
  64. data/lib/snaptrade/models/manual_trade_form.rb +6 -6
  65. data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
  66. data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
  67. data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
  68. data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
  69. data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
  70. data/lib/snaptrade/models/model_asset_class.rb +6 -6
  71. data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
  72. data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
  73. data/lib/snaptrade/models/model_portfolio.rb +6 -6
  74. data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
  75. data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
  76. data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
  77. data/lib/snaptrade/models/model_type.rb +6 -6
  78. data/lib/snaptrade/models/monthly_dividends.rb +6 -6
  79. data/lib/snaptrade/models/net_contributions.rb +6 -6
  80. data/lib/snaptrade/models/net_dividend.rb +6 -6
  81. data/lib/snaptrade/models/option_chain_inner.rb +6 -6
  82. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
  83. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
  84. data/lib/snaptrade/models/option_leg.rb +6 -6
  85. data/lib/snaptrade/models/option_leg_action.rb +6 -6
  86. data/lib/snaptrade/models/option_strategy.rb +6 -6
  87. data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
  88. data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
  89. data/lib/snaptrade/models/options_holdings.rb +6 -6
  90. data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
  91. data/lib/snaptrade/models/options_position.rb +6 -6
  92. data/lib/snaptrade/models/options_symbol.rb +6 -6
  93. data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
  94. data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
  95. data/lib/snaptrade/models/order_type.rb +6 -6
  96. data/lib/snaptrade/models/partner_data.rb +6 -6
  97. data/lib/snaptrade/models/past_value.rb +6 -6
  98. data/lib/snaptrade/models/performance_custom.rb +6 -6
  99. data/lib/snaptrade/models/portfolio_group.rb +6 -6
  100. data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
  101. data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
  102. data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
  103. data/lib/snaptrade/models/position.rb +6 -6
  104. data/lib/snaptrade/models/position_symbol.rb +6 -6
  105. data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
  106. data/lib/snaptrade/models/security_type.rb +6 -6
  107. data/lib/snaptrade/models/session_event.rb +6 -6
  108. data/lib/snaptrade/models/session_event_type.rb +6 -6
  109. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
  110. data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
  111. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
  112. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
  113. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
  114. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
  115. data/lib/snaptrade/models/state.rb +6 -6
  116. data/lib/snaptrade/models/status.rb +6 -6
  117. data/lib/snaptrade/models/strategy_impact.rb +6 -6
  118. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
  119. data/lib/snaptrade/models/strategy_order_place.rb +6 -6
  120. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
  121. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
  122. data/lib/snaptrade/models/strategy_order_record.rb +6 -6
  123. data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
  124. data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
  125. data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
  126. data/lib/snaptrade/models/strategy_quotes.rb +6 -6
  127. data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
  128. data/lib/snaptrade/models/strategy_type.rb +6 -6
  129. data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
  130. data/lib/snaptrade/models/symbol.rb +6 -6
  131. data/lib/snaptrade/models/symbol_query.rb +6 -6
  132. data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
  133. data/lib/snaptrade/models/target_asset.rb +6 -6
  134. data/lib/snaptrade/models/time_in_force.rb +6 -6
  135. data/lib/snaptrade/models/trade.rb +6 -6
  136. data/lib/snaptrade/models/trade_action.rb +6 -6
  137. data/lib/snaptrade/models/trade_execution_status.rb +6 -6
  138. data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
  139. data/lib/snaptrade/models/trade_impact.rb +6 -6
  140. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
  141. data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
  142. data/lib/snaptrade/models/transactions_status.rb +6 -6
  143. data/lib/snaptrade/models/type.rb +6 -6
  144. data/lib/snaptrade/models/underlying_symbol.rb +6 -6
  145. data/lib/snaptrade/models/universal_activity.rb +6 -6
  146. data/lib/snaptrade/models/universal_symbol.rb +6 -6
  147. data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
  148. data/lib/snaptrade/models/us_exchange.rb +6 -6
  149. data/lib/snaptrade/models/user_error_log.rb +6 -6
  150. data/lib/snaptrade/models/user_i_dand_secret.rb +6 -6
  151. data/lib/snaptrade/models/user_settings.rb +6 -6
  152. data/lib/snaptrade/version.rb +13 -13
  153. data/lib/snaptrade.rb +211 -214
  154. data/snaptrade.gemspec +41 -41
  155. data/spec/api/account_information_api_spec.rb +135 -135
  156. data/spec/api/api_status_api_spec.rb +42 -42
  157. data/spec/api/authentication_api_spec.rb +88 -88
  158. data/spec/api/connections_api_spec.rb +82 -82
  159. data/spec/api/error_logs_api_spec.rb +43 -43
  160. data/spec/api/options_api_spec.rb +101 -101
  161. data/spec/api/reference_data_api_spec.rb +150 -150
  162. data/spec/api/trading_api_spec.rb +112 -163
  163. data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
  164. data/spec/api_client_spec.rb +193 -193
  165. data/spec/configuration_spec.rb +6 -6
  166. data/spec/getting_started_spec.rb +108 -144
  167. data/spec/models/account_holdings_account_spec.rb +54 -54
  168. data/spec/models/account_holdings_spec.rb +48 -48
  169. data/spec/models/account_order_record_spec.rb +132 -132
  170. data/spec/models/account_order_record_status_spec.rb +24 -24
  171. data/spec/models/account_simple_spec.rb +48 -48
  172. data/spec/models/account_spec.rb +84 -84
  173. data/spec/models/account_sync_status_spec.rb +30 -30
  174. data/spec/models/action_spec.rb +24 -24
  175. data/spec/models/auth_type_spec.rb +24 -24
  176. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
  177. data/spec/models/balance_spec.rb +36 -36
  178. data/spec/models/brokerage_authorization_spec.rb +78 -78
  179. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
  180. data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
  181. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
  182. data/spec/models/brokerage_authorization_type_spec.rb +30 -30
  183. data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
  184. data/spec/models/brokerage_spec.rb +132 -132
  185. data/spec/models/brokerage_symbol_spec.rb +54 -54
  186. data/spec/models/brokerage_type_spec.rb +36 -36
  187. data/spec/models/calculated_trade_spec.rb +36 -36
  188. data/spec/models/cash_restriction_spec.rb +54 -54
  189. data/spec/models/connection_type_spec.rb +24 -24
  190. data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
  191. data/spec/models/currency_spec.rb +42 -42
  192. data/spec/models/delete_user_response_spec.rb +36 -36
  193. data/spec/models/dividend_at_date_spec.rb +42 -42
  194. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
  195. data/spec/models/encrypted_response_spec.rb +36 -36
  196. data/spec/models/exchange_rate_pairs_spec.rb +42 -42
  197. data/spec/models/exchange_spec.rb +72 -72
  198. data/spec/models/excluded_asset_spec.rb +30 -30
  199. data/spec/models/jwt_spec.rb +30 -30
  200. data/spec/models/login_redirect_uri_spec.rb +36 -36
  201. data/spec/models/manual_trade_and_impact_spec.rb +42 -42
  202. data/spec/models/manual_trade_balance_spec.rb +42 -42
  203. data/spec/models/manual_trade_form_spec.rb +72 -72
  204. data/spec/models/manual_trade_spec.rb +72 -72
  205. data/spec/models/manual_trade_symbol_spec.rb +60 -60
  206. data/spec/models/model400_failed_request_response_spec.rb +36 -36
  207. data/spec/models/model401_failed_request_response_spec.rb +36 -36
  208. data/spec/models/model403_failed_request_response_spec.rb +36 -36
  209. data/spec/models/model404_failed_request_response_spec.rb +36 -36
  210. data/spec/models/model_asset_class_details_spec.rb +36 -36
  211. data/spec/models/model_asset_class_spec.rb +36 -36
  212. data/spec/models/model_asset_class_target_spec.rb +30 -30
  213. data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
  214. data/spec/models/model_portfolio_details_spec.rb +42 -42
  215. data/spec/models/model_portfolio_security_spec.rb +36 -36
  216. data/spec/models/model_portfolio_spec.rb +42 -42
  217. data/spec/models/model_type_spec.rb +24 -24
  218. data/spec/models/monthly_dividends_spec.rb +36 -36
  219. data/spec/models/net_contributions_spec.rb +42 -42
  220. data/spec/models/net_dividend_spec.rb +42 -42
  221. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
  222. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
  223. data/spec/models/option_chain_inner_spec.rb +54 -54
  224. data/spec/models/option_leg_action_spec.rb +24 -24
  225. data/spec/models/option_leg_spec.rb +42 -42
  226. data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
  227. data/spec/models/option_strategy_spec.rb +54 -54
  228. data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
  229. data/spec/models/options_holdings_spec.rb +60 -60
  230. data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
  231. data/spec/models/options_position_spec.rb +66 -66
  232. data/spec/models/options_symbol_spec.rb +90 -90
  233. data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
  234. data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
  235. data/spec/models/order_type_spec.rb +24 -24
  236. data/spec/models/partner_data_spec.rb +96 -96
  237. data/spec/models/past_value_spec.rb +42 -42
  238. data/spec/models/performance_custom_spec.rb +138 -138
  239. data/spec/models/portfolio_group_info_spec.rb +90 -90
  240. data/spec/models/portfolio_group_position_spec.rb +42 -42
  241. data/spec/models/portfolio_group_settings_spec.rb +54 -54
  242. data/spec/models/portfolio_group_spec.rb +36 -36
  243. data/spec/models/position_spec.rb +60 -60
  244. data/spec/models/position_symbol_spec.rb +60 -60
  245. data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
  246. data/spec/models/security_type_spec.rb +48 -48
  247. data/spec/models/session_event_spec.rb +66 -66
  248. data/spec/models/session_event_type_spec.rb +24 -24
  249. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
  250. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
  251. data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
  252. data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
  253. data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
  254. data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
  255. data/spec/models/state_spec.rb +24 -24
  256. data/spec/models/status_spec.rb +42 -42
  257. data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
  258. data/spec/models/strategy_impact_spec.rb +90 -90
  259. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
  260. data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
  261. data/spec/models/strategy_order_place_spec.rb +36 -36
  262. data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
  263. data/spec/models/strategy_order_record_spec.rb +90 -90
  264. data/spec/models/strategy_order_record_status_spec.rb +24 -24
  265. data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
  266. data/spec/models/strategy_quotes_greek_spec.rb +54 -54
  267. data/spec/models/strategy_quotes_spec.rb +60 -60
  268. data/spec/models/strategy_type_spec.rb +24 -24
  269. data/spec/models/sub_period_return_rate_spec.rb +42 -42
  270. data/spec/models/symbol_query_spec.rb +30 -30
  271. data/spec/models/symbol_spec.rb +66 -66
  272. data/spec/models/symbols_quotes_inner_spec.rb +60 -60
  273. data/spec/models/target_asset_spec.rb +60 -60
  274. data/spec/models/time_in_force_spec.rb +24 -24
  275. data/spec/models/trade_action_spec.rb +24 -24
  276. data/spec/models/trade_execution_status_action_spec.rb +24 -24
  277. data/spec/models/trade_execution_status_spec.rb +78 -78
  278. data/spec/models/trade_impact_spec.rb +54 -54
  279. data/spec/models/trade_spec.rb +72 -72
  280. data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
  281. data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
  282. data/spec/models/transactions_status_spec.rb +36 -36
  283. data/spec/models/type_spec.rb +24 -24
  284. data/spec/models/underlying_symbol_spec.rb +66 -66
  285. data/spec/models/universal_activity_spec.rb +120 -120
  286. data/spec/models/universal_symbol_spec.rb +72 -72
  287. data/spec/models/universal_symbol_ticker_spec.rb +72 -72
  288. data/spec/models/us_exchange_spec.rb +78 -78
  289. data/spec/models/user_error_log_spec.rb +60 -60
  290. data/spec/models/user_i_dand_secret_spec.rb +36 -36
  291. data/spec/models/user_settings_spec.rb +84 -84
  292. data/spec/spec_helper.rb +6 -6
  293. metadata +113 -117
  294. data/docs/PortfolioManagementApi.md +0 -2064
  295. data/lib/snaptrade/api/portfolio_management_api.rb +0 -2867
  296. data/spec/api/portfolio_management_api_spec.rb +0 -403
@@ -1,150 +1,150 @@
1
- =begin
2
- #SnapTrade
3
-
4
- #Connect brokerage accounts to your app for live positions and trading
5
-
6
- The version of the OpenAPI document: 1.0.0
7
- Contact: api@snaptrade.com
8
-
9
- =end
10
-
11
- require 'spec_helper'
12
- require 'json'
13
-
14
- # Unit tests for SnapTrade::ReferenceDataApi
15
- describe 'ReferenceDataApi' do
16
- before do
17
- # run before each test
18
- @api_instance = SnapTrade::ReferenceDataApi.new
19
- end
20
-
21
- after do
22
- # run after each test
23
- end
24
-
25
- describe 'test an instance of ReferenceDataApi' do
26
- it 'should create an instance of ReferenceDataApi' do
27
- expect(@api_instance).to be_instance_of(SnapTrade::ReferenceDataApi)
28
- end
29
- end
30
-
31
- # unit tests for get_currency_exchange_rate_pair
32
- # Return the exchange rate of a currency pair
33
- # @param currency_pair A currency pair based on currency code for example, {CAD-USD}
34
- # @param [Hash] opts the optional parameters
35
- # @return [ExchangeRatePairs]
36
- describe 'get_currency_exchange_rate_pair test' do
37
- it 'should work' do
38
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
39
- end
40
- end
41
-
42
- # unit tests for get_partner_info
43
- # Get metadata related to Snaptrade partner
44
- # @param [Hash] opts the optional parameters
45
- # @return [PartnerData]
46
- describe 'get_partner_info test' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- # unit tests for get_security_types
53
- # List of all security types.
54
- # @param [Hash] opts the optional parameters
55
- # @return [Array<SecurityType>]
56
- describe 'get_security_types test' do
57
- it 'should work' do
58
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
- end
60
- end
61
-
62
- # unit tests for get_stock_exchanges
63
- # Return list of stock exchanges on Passiv and their suffixes
64
- # @param [Hash] opts the optional parameters
65
- # @return [Array<Exchange>]
66
- describe 'get_stock_exchanges test' do
67
- it 'should work' do
68
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
69
- end
70
- end
71
-
72
- # unit tests for get_symbols
73
- # Search for symbols
74
- # @param [Hash] opts the optional parameters
75
- # @option opts [SymbolQuery] :symbol_query
76
- # @return [Array<UniversalSymbol>]
77
- describe 'get_symbols test' do
78
- it 'should work' do
79
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
- end
81
- end
82
-
83
- # unit tests for get_symbols_by_ticker
84
- # Get details of a symbol by the ticker
85
- # @param ticker The ticker of the UniversalSymbol to get.
86
- # @param [Hash] opts the optional parameters
87
- # @option opts [String] :symbol_id OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
88
- # @return [UniversalSymbol]
89
- describe 'get_symbols_by_ticker test' do
90
- it 'should work' do
91
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
- end
93
- end
94
-
95
- # unit tests for list_all_brokerage_authorization_type
96
- # List of all brokerage authorization types
97
- # @param [Hash] opts the optional parameters
98
- # @option opts [String] :brokerage Comma separated value of brokerage slugs
99
- # @return [Array<BrokerageAuthorizationTypeReadOnly>]
100
- describe 'list_all_brokerage_authorization_type test' do
101
- it 'should work' do
102
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
103
- end
104
- end
105
-
106
- # unit tests for list_all_brokerages
107
- # List of all brokerages.
108
- # @param [Hash] opts the optional parameters
109
- # @return [Array<Brokerage>]
110
- describe 'list_all_brokerages test' do
111
- it 'should work' do
112
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
113
- end
114
- end
115
-
116
- # unit tests for list_all_currencies
117
- # List of all supported currencies
118
- # @param [Hash] opts the optional parameters
119
- # @return [Array<Currency>]
120
- describe 'list_all_currencies test' do
121
- it 'should work' do
122
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
123
- end
124
- end
125
-
126
- # unit tests for list_all_currencies_rates
127
- # Return the exchange rates of all supported currencies
128
- # @param [Hash] opts the optional parameters
129
- # @return [Array<ExchangeRatePairs>]
130
- describe 'list_all_currencies_rates test' do
131
- it 'should work' do
132
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
133
- end
134
- end
135
-
136
- # unit tests for symbol_search_user_account
137
- # Search for symbols that are supported by a brokerage account using a substring
138
- # @param user_id
139
- # @param user_secret
140
- # @param account_id The ID of the account get positions.
141
- # @param [Hash] opts the optional parameters
142
- # @option opts [SymbolQuery] :symbol_query
143
- # @return [Array<UniversalSymbol>]
144
- describe 'symbol_search_user_account test' do
145
- it 'should work' do
146
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
147
- end
148
- end
149
-
150
- end
1
+ =begin
2
+ #SnapTrade
3
+
4
+ #Connect brokerage accounts to your app for live positions and trading
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@snaptrade.com
8
+
9
+ =end
10
+
11
+ require 'spec_helper'
12
+ require 'json'
13
+
14
+ # Unit tests for SnapTrade::ReferenceDataApi
15
+ describe 'ReferenceDataApi' do
16
+ before do
17
+ # run before each test
18
+ @api_instance = SnapTrade::ReferenceDataApi.new
19
+ end
20
+
21
+ after do
22
+ # run after each test
23
+ end
24
+
25
+ describe 'test an instance of ReferenceDataApi' do
26
+ it 'should create an instance of ReferenceDataApi' do
27
+ expect(@api_instance).to be_instance_of(SnapTrade::ReferenceDataApi)
28
+ end
29
+ end
30
+
31
+ # unit tests for get_currency_exchange_rate_pair
32
+ # Return the exchange rate of a currency pair
33
+ # @param currency_pair A currency pair based on currency code for example, {CAD-USD}
34
+ # @param [Hash] opts the optional parameters
35
+ # @return [ExchangeRatePairs]
36
+ describe 'get_currency_exchange_rate_pair test' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
39
+ end
40
+ end
41
+
42
+ # unit tests for get_partner_info
43
+ # Get metadata related to Snaptrade partner
44
+ # @param [Hash] opts the optional parameters
45
+ # @return [PartnerData]
46
+ describe 'get_partner_info test' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ # unit tests for get_security_types
53
+ # List of all security types.
54
+ # @param [Hash] opts the optional parameters
55
+ # @return [Array<SecurityType>]
56
+ describe 'get_security_types test' do
57
+ it 'should work' do
58
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
+ end
60
+ end
61
+
62
+ # unit tests for get_stock_exchanges
63
+ # Return list of stock exchanges on Passiv and their suffixes
64
+ # @param [Hash] opts the optional parameters
65
+ # @return [Array<Exchange>]
66
+ describe 'get_stock_exchanges test' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
69
+ end
70
+ end
71
+
72
+ # unit tests for get_symbols
73
+ # Search for symbols
74
+ # @param [Hash] opts the optional parameters
75
+ # @option opts [SymbolQuery] :symbol_query
76
+ # @return [Array<UniversalSymbol>]
77
+ describe 'get_symbols test' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
83
+ # unit tests for get_symbols_by_ticker
84
+ # Get details of a symbol by the ticker
85
+ # @param ticker The ticker of the UniversalSymbol to get.
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [String] :symbol_id OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
88
+ # @return [UniversalSymbol]
89
+ describe 'get_symbols_by_ticker test' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
+ end
93
+ end
94
+
95
+ # unit tests for list_all_brokerage_authorization_type
96
+ # List of all brokerage authorization types
97
+ # @param [Hash] opts the optional parameters
98
+ # @option opts [String] :brokerage Comma separated value of brokerage slugs
99
+ # @return [Array<BrokerageAuthorizationTypeReadOnly>]
100
+ describe 'list_all_brokerage_authorization_type test' do
101
+ it 'should work' do
102
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
103
+ end
104
+ end
105
+
106
+ # unit tests for list_all_brokerages
107
+ # List of all brokerages.
108
+ # @param [Hash] opts the optional parameters
109
+ # @return [Array<Brokerage>]
110
+ describe 'list_all_brokerages test' do
111
+ it 'should work' do
112
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
113
+ end
114
+ end
115
+
116
+ # unit tests for list_all_currencies
117
+ # List of all supported currencies
118
+ # @param [Hash] opts the optional parameters
119
+ # @return [Array<Currency>]
120
+ describe 'list_all_currencies test' do
121
+ it 'should work' do
122
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
123
+ end
124
+ end
125
+
126
+ # unit tests for list_all_currencies_rates
127
+ # Return the exchange rates of all supported currencies
128
+ # @param [Hash] opts the optional parameters
129
+ # @return [Array<ExchangeRatePairs>]
130
+ describe 'list_all_currencies_rates test' do
131
+ it 'should work' do
132
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
133
+ end
134
+ end
135
+
136
+ # unit tests for symbol_search_user_account
137
+ # Search for symbols that are supported by a brokerage account using a substring
138
+ # @param user_id
139
+ # @param user_secret
140
+ # @param account_id The ID of the account get positions.
141
+ # @param [Hash] opts the optional parameters
142
+ # @option opts [SymbolQuery] :symbol_query
143
+ # @return [Array<UniversalSymbol>]
144
+ describe 'symbol_search_user_account test' do
145
+ it 'should work' do
146
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
147
+ end
148
+ end
149
+
150
+ end
@@ -1,163 +1,112 @@
1
- =begin
2
- #SnapTrade
3
-
4
- #Connect brokerage accounts to your app for live positions and trading
5
-
6
- The version of the OpenAPI document: 1.0.0
7
- Contact: api@snaptrade.com
8
-
9
- =end
10
-
11
- require 'spec_helper'
12
- require 'json'
13
-
14
- # Unit tests for SnapTrade::TradingApi
15
- describe 'TradingApi' do
16
- before do
17
- # run before each test
18
- @api_instance = SnapTrade::TradingApi.new
19
- end
20
-
21
- after do
22
- # run after each test
23
- end
24
-
25
- describe 'test an instance of TradingApi' do
26
- it 'should create an instance of TradingApi' do
27
- expect(@api_instance).to be_instance_of(SnapTrade::TradingApi)
28
- end
29
- end
30
-
31
- # unit tests for cancel_user_account_order
32
- # Cancel open order in account
33
- # @param user_id
34
- # @param user_secret
35
- # @param account_id The ID of the account get positions.
36
- # @param trading_cancel_user_account_order_request The Order ID to be canceled
37
- # @param [Hash] opts the optional parameters
38
- # @return [AccountOrderRecord]
39
- describe 'cancel_user_account_order test' do
40
- it 'should work' do
41
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
42
- end
43
- end
44
-
45
- # unit tests for get_calculated_trade_impact_by_id
46
- # Return details of a specific trade before it&#39;s placed
47
- # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
48
- # @param calculated_trade_id The ID of calculated trade to get account impact
49
- # @param trade_id The ID of trade object
50
- # @param [Hash] opts the optional parameters
51
- # @return [Trade]
52
- describe 'get_calculated_trade_impact_by_id test' do
53
- it 'should work' do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- # unit tests for get_calculated_trades_impact
59
- # Return the impact of placing a series of trades on the portfolio
60
- # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
61
- # @param calculated_trade_id The ID of calculated trade to get account impact
62
- # @param [Hash] opts the optional parameters
63
- # @return [Array<TradeImpact>]
64
- describe 'get_calculated_trades_impact test' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- # unit tests for get_order_impact
71
- # Check impact of trades on account.
72
- # @param user_id
73
- # @param user_secret
74
- # @param manual_trade_form
75
- # @param [Hash] opts the optional parameters
76
- # @return [ManualTradeAndImpact]
77
- describe 'get_order_impact test' do
78
- it 'should work' do
79
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
- end
81
- end
82
-
83
- # unit tests for get_user_account_quotes
84
- # Get symbol quotes
85
- # @param user_id
86
- # @param user_secret
87
- # @param symbols List of universal_symbol_id or tickers to get quotes for.
88
- # @param account_id The ID of the account to get quotes.
89
- # @param [Hash] opts the optional parameters
90
- # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
91
- # @return [Array<SymbolsQuotesInner>]
92
- describe 'get_user_account_quotes test' do
93
- it 'should work' do
94
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
- end
96
- end
97
-
98
- # unit tests for modify_calculated_trade_by_id
99
- # Modify units of a trade before it is placed
100
- # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
101
- # @param calculated_trade_id The ID of calculated trade to get account impact
102
- # @param trade_id The ID of trade object
103
- # @param [Hash] opts the optional parameters
104
- # @option opts [Trade] :trade
105
- # @return [Trade]
106
- describe 'modify_calculated_trade_by_id test' do
107
- it 'should work' do
108
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
109
- end
110
- end
111
-
112
- # unit tests for place_calculated_trades
113
- # Place orders for the CalculatedTrades in series
114
- # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
115
- # @param calculated_trade_id The ID of calculated trade to get account impact
116
- # @param [Hash] opts the optional parameters
117
- # @return [Array<TradeExecutionStatus>]
118
- describe 'place_calculated_trades test' do
119
- it 'should work' do
120
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
121
- end
122
- end
123
-
124
- # unit tests for place_force_order
125
- # Place a trade with NO validation.
126
- # @param user_id
127
- # @param user_secret
128
- # @param manual_trade_form
129
- # @param [Hash] opts the optional parameters
130
- # @return [AccountOrderRecord]
131
- describe 'place_force_order test' do
132
- it 'should work' do
133
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
- end
135
- end
136
-
137
- # unit tests for place_oco_order
138
- # Place a OCO (One Cancels Other) order
139
- # @param user_id
140
- # @param user_secret
141
- # @param trading_place_oco_order_request
142
- # @param [Hash] opts the optional parameters
143
- # @return [AccountOrderRecord]
144
- describe 'place_oco_order test' do
145
- it 'should work' do
146
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
147
- end
148
- end
149
-
150
- # unit tests for place_order
151
- # Place order
152
- # @param trade_id The ID of trade object obtained from trade/impact endpoint
153
- # @param user_id
154
- # @param user_secret
155
- # @param [Hash] opts the optional parameters
156
- # @return [AccountOrderRecord]
157
- describe 'place_order test' do
158
- it 'should work' do
159
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
160
- end
161
- end
162
-
163
- end
1
+ =begin
2
+ #SnapTrade
3
+
4
+ #Connect brokerage accounts to your app for live positions and trading
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@snaptrade.com
8
+
9
+ =end
10
+
11
+ require 'spec_helper'
12
+ require 'json'
13
+
14
+ # Unit tests for SnapTrade::TradingApi
15
+ describe 'TradingApi' do
16
+ before do
17
+ # run before each test
18
+ @api_instance = SnapTrade::TradingApi.new
19
+ end
20
+
21
+ after do
22
+ # run after each test
23
+ end
24
+
25
+ describe 'test an instance of TradingApi' do
26
+ it 'should create an instance of TradingApi' do
27
+ expect(@api_instance).to be_instance_of(SnapTrade::TradingApi)
28
+ end
29
+ end
30
+
31
+ # unit tests for cancel_user_account_order
32
+ # Cancel open order in account
33
+ # @param user_id
34
+ # @param user_secret
35
+ # @param account_id The ID of the account get positions.
36
+ # @param trading_cancel_user_account_order_request The Order ID to be canceled
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [AccountOrderRecord]
39
+ describe 'cancel_user_account_order test' do
40
+ it 'should work' do
41
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
42
+ end
43
+ end
44
+
45
+ # unit tests for get_order_impact
46
+ # Check impact of trades on account.
47
+ # @param user_id
48
+ # @param user_secret
49
+ # @param manual_trade_form
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [ManualTradeAndImpact]
52
+ describe 'get_order_impact test' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
+ end
56
+ end
57
+
58
+ # unit tests for get_user_account_quotes
59
+ # Get symbol quotes
60
+ # @param user_id
61
+ # @param user_secret
62
+ # @param symbols List of universal_symbol_id or tickers to get quotes for.
63
+ # @param account_id The ID of the account to get quotes.
64
+ # @param [Hash] opts the optional parameters
65
+ # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
66
+ # @return [Array<SymbolsQuotesInner>]
67
+ describe 'get_user_account_quotes test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
+ end
71
+ end
72
+
73
+ # unit tests for place_force_order
74
+ # Place a trade with NO validation.
75
+ # @param user_id
76
+ # @param user_secret
77
+ # @param manual_trade_form
78
+ # @param [Hash] opts the optional parameters
79
+ # @return [AccountOrderRecord]
80
+ describe 'place_force_order test' do
81
+ it 'should work' do
82
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
83
+ end
84
+ end
85
+
86
+ # unit tests for place_oco_order
87
+ # Place a OCO (One Cancels Other) order
88
+ # @param user_id
89
+ # @param user_secret
90
+ # @param trading_place_oco_order_request
91
+ # @param [Hash] opts the optional parameters
92
+ # @return [AccountOrderRecord]
93
+ describe 'place_oco_order test' do
94
+ it 'should work' do
95
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
96
+ end
97
+ end
98
+
99
+ # unit tests for place_order
100
+ # Place order
101
+ # @param trade_id The ID of trade object obtained from trade/impact endpoint
102
+ # @param user_id
103
+ # @param user_secret
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [AccountOrderRecord]
106
+ describe 'place_order test' do
107
+ it 'should work' do
108
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
109
+ end
110
+ end
111
+
112
+ end