snaptrade 1.17.10 → 2.0.77

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 (462) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +31 -28
  4. data/README.md +1995 -208
  5. data/lib/snaptrade/api/account_information_api.rb +535 -71
  6. data/lib/snaptrade/api/api_status_api.rb +6 -3
  7. data/lib/snaptrade/api/authentication_api.rb +180 -140
  8. data/lib/snaptrade/api/connections_api.rb +401 -41
  9. data/lib/snaptrade/api/options_api.rb +82 -39
  10. data/lib/snaptrade/api/reference_data_api.rb +181 -101
  11. data/lib/snaptrade/api/trading_api.rb +200 -228
  12. data/lib/snaptrade/api/transactions_and_reporting_api.rb +48 -33
  13. data/lib/snaptrade/api_client.rb +24 -14
  14. data/lib/snaptrade/api_error.rb +0 -1
  15. data/lib/snaptrade/configuration.rb +11 -29
  16. data/lib/snaptrade/models/account.rb +84 -29
  17. data/lib/snaptrade/models/account_balance.rb +1 -2
  18. data/lib/snaptrade/models/account_balance_total.rb +3 -9
  19. data/lib/snaptrade/models/account_holdings.rb +0 -1
  20. data/lib/snaptrade/models/account_holdings_account.rb +19 -4
  21. data/lib/snaptrade/models/account_order_record.rb +52 -33
  22. data/lib/snaptrade/models/{brokerage_symbol_option_symbol.rb → account_order_record_option_symbol.rb} +15 -27
  23. data/lib/snaptrade/models/account_order_record_status.rb +0 -1
  24. data/lib/snaptrade/models/{brokerage_symbol_symbol.rb → account_order_record_universal_symbol.rb} +33 -7
  25. data/lib/snaptrade/models/account_simple.rb +4 -2
  26. data/lib/snaptrade/models/account_sync_status.rb +14 -6
  27. data/lib/snaptrade/models/account_universal_activity.rb +371 -0
  28. data/lib/snaptrade/models/account_universal_activity_currency.rb +245 -0
  29. data/lib/snaptrade/models/{target_asset.rb → account_universal_activity_option_symbol.rb} +83 -59
  30. data/lib/snaptrade/models/{universal_symbol_ticker.rb → account_universal_activity_symbol.rb} +37 -16
  31. data/lib/snaptrade/models/{trade_action.rb → action_strict.rb} +3 -4
  32. data/lib/snaptrade/models/{trade_execution_status_action.rb → action_strict_with_options.rb} +8 -5
  33. data/lib/snaptrade/models/auth_type.rb +0 -1
  34. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +0 -1
  35. data/lib/snaptrade/models/balance.rb +19 -8
  36. data/lib/snaptrade/models/{model_portfolio.rb → balance_currency.rb} +27 -19
  37. data/lib/snaptrade/models/brokerage.rb +57 -50
  38. data/lib/snaptrade/models/brokerage_authorization.rb +24 -21
  39. data/lib/snaptrade/models/{model_asset_class.rb → brokerage_authorization_disabled_confirmation.rb} +12 -20
  40. data/lib/snaptrade/models/{jwt.rb → brokerage_authorization_refresh_confirmation.rb} +12 -12
  41. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +1 -2
  42. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +2 -3
  43. data/lib/snaptrade/models/brokerage_type.rb +1 -2
  44. data/lib/snaptrade/models/connection_portal_version.rb +3 -3
  45. data/lib/snaptrade/models/connection_type.rb +0 -1
  46. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +1 -2
  47. data/lib/snaptrade/models/currency.rb +4 -2
  48. data/lib/snaptrade/models/delete_user_response.rb +13 -5
  49. data/lib/snaptrade/models/dividend_at_date.rb +0 -1
  50. data/lib/snaptrade/models/encrypted_response.rb +0 -1
  51. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +0 -1
  52. data/lib/snaptrade/models/exchange.rb +9 -2
  53. data/lib/snaptrade/models/exchange_rate_pairs.rb +0 -1
  54. data/lib/snaptrade/models/figi_instrument.rb +230 -0
  55. data/lib/snaptrade/models/holdings_status.rb +229 -0
  56. data/lib/snaptrade/models/login_redirect_uri.rb +3 -3
  57. data/lib/snaptrade/models/manual_trade.rb +10 -6
  58. data/lib/snaptrade/models/manual_trade_and_impact.rb +2 -3
  59. data/lib/snaptrade/models/manual_trade_balance.rb +3 -4
  60. data/lib/snaptrade/models/manual_trade_form.rb +56 -28
  61. data/lib/snaptrade/models/{model_asset_class_target.rb → manual_trade_form_notional_value.rb} +12 -15
  62. data/lib/snaptrade/models/{trade.rb → manual_trade_form_with_options.rb} +126 -43
  63. data/lib/snaptrade/models/{snap_trade_api_disclaimer_accept_status.rb → manual_trade_form_with_options_stop_loss.rb} +24 -18
  64. data/lib/snaptrade/models/manual_trade_form_with_options_take_profit.rb +223 -0
  65. data/lib/snaptrade/models/{trade_impact.rb → manual_trade_impact.rb} +20 -17
  66. data/lib/snaptrade/models/manual_trade_symbol.rb +19 -15
  67. data/lib/snaptrade/models/model400_failed_request_response.rb +0 -1
  68. data/lib/snaptrade/models/model401_failed_request_response.rb +0 -1
  69. data/lib/snaptrade/models/model402_brokerage_auth_already_disabled_exception.rb +228 -0
  70. data/lib/snaptrade/models/{amount.rb → model402_brokerage_auth_disabled_response.rb} +19 -18
  71. data/lib/snaptrade/models/model403_failed_request_response.rb +0 -1
  72. data/lib/snaptrade/models/model403_feature_not_enabled_response.rb +228 -0
  73. data/lib/snaptrade/models/model404_failed_request_response.rb +0 -1
  74. data/lib/snaptrade/models/{calculated_trade.rb → model425_failed_request_response.rb} +19 -20
  75. data/lib/snaptrade/models/model500_unexpected_exception_response.rb +0 -1
  76. data/lib/snaptrade/models/monthly_dividends.rb +1 -2
  77. data/lib/snaptrade/models/net_contributions.rb +1 -2
  78. data/lib/snaptrade/models/net_dividend.rb +0 -1
  79. data/lib/snaptrade/models/notional_value.rb +103 -0
  80. data/lib/snaptrade/models/{options_holdings.rb → option_brokerage_symbol.rb} +19 -50
  81. data/lib/snaptrade/models/option_chain_inner.rb +0 -1
  82. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +0 -1
  83. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +0 -1
  84. data/lib/snaptrade/models/option_leg.rb +0 -1
  85. data/lib/snaptrade/models/option_leg_action.rb +0 -1
  86. data/lib/snaptrade/models/option_strategy.rb +0 -1
  87. data/lib/snaptrade/models/option_strategy_legs_inner.rb +0 -1
  88. data/lib/snaptrade/models/option_type.rb +0 -1
  89. data/lib/snaptrade/models/options_get_option_strategy_request.rb +0 -1
  90. data/lib/snaptrade/models/options_place_option_strategy_request.rb +4 -3
  91. data/lib/snaptrade/models/options_position.rb +20 -20
  92. data/lib/snaptrade/models/options_position_currency.rb +4 -1
  93. data/lib/snaptrade/models/options_symbol.rb +12 -25
  94. data/lib/snaptrade/models/{model_type.rb → order_class.rb} +6 -8
  95. data/lib/snaptrade/models/{order_type.rb → order_type_strict.rb} +5 -6
  96. data/lib/snaptrade/models/paginated_universal_activity.rb +228 -0
  97. data/lib/snaptrade/models/pagination_details.rb +228 -0
  98. data/lib/snaptrade/models/partner_data.rb +49 -50
  99. data/lib/snaptrade/models/past_value.rb +1 -2
  100. data/lib/snaptrade/models/performance_custom.rb +0 -1
  101. data/lib/snaptrade/models/position.rb +21 -20
  102. data/lib/snaptrade/models/position_symbol.rb +16 -12
  103. data/lib/snaptrade/models/{portfolio_group_position.rb → rate_of_return_object.rb} +26 -26
  104. data/lib/snaptrade/models/{brokerage_authorization_type.rb → rate_of_return_response.rb} +14 -11
  105. data/lib/snaptrade/models/{strategy_order_place.rb → recent_orders_response.rb} +7 -16
  106. data/lib/snaptrade/models/security_type.rb +5 -2
  107. data/lib/snaptrade/models/session_event.rb +1 -2
  108. data/lib/snaptrade/models/session_event_type.rb +11 -4
  109. data/lib/snaptrade/models/snap_trade_holdings_account.rb +0 -1
  110. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +3 -2
  111. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +10 -5
  112. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +1 -2
  113. data/lib/snaptrade/models/status.rb +0 -1
  114. data/lib/snaptrade/models/stop_loss.rb +227 -0
  115. data/lib/snaptrade/models/strategy_order_record.rb +5 -3
  116. data/lib/snaptrade/models/strategy_order_record_status.rb +0 -1
  117. data/lib/snaptrade/models/strategy_quotes.rb +0 -1
  118. data/lib/snaptrade/models/strategy_quotes_greek.rb +0 -1
  119. data/lib/snaptrade/models/strategy_type.rb +0 -1
  120. data/lib/snaptrade/models/sub_period_return_rate.rb +2 -3
  121. data/lib/snaptrade/models/symbol.rb +39 -14
  122. data/lib/snaptrade/models/{portfolio_group.rb → symbol_currency.rb} +24 -5
  123. data/lib/snaptrade/models/symbol_exchange.rb +296 -0
  124. data/lib/snaptrade/models/{model_portfolio_security.rb → symbol_figi_instrument.rb} +27 -41
  125. data/lib/snaptrade/models/symbol_query.rb +1 -2
  126. data/lib/snaptrade/models/symbols_quotes_inner.rb +15 -11
  127. data/lib/snaptrade/models/{excluded_asset.rb → take_profit.rb} +11 -12
  128. data/lib/snaptrade/models/{time_in_force.rb → time_in_force_strict.rb} +5 -6
  129. data/lib/snaptrade/models/{brokerage_authorization_type_type.rb → timeframe.rb} +9 -7
  130. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +1 -1
  131. data/lib/snaptrade/models/transactions_status.rb +19 -8
  132. data/lib/snaptrade/models/type.rb +3 -4
  133. data/lib/snaptrade/models/underlying_symbol.rb +40 -6
  134. data/lib/snaptrade/models/{snap_trade_holdings_account_account_id.rb → underlying_symbol_exchange.rb} +55 -54
  135. data/lib/snaptrade/models/{brokerage_symbol.rb → underlying_symbol_type.rb} +28 -39
  136. data/lib/snaptrade/models/universal_activity.rb +91 -82
  137. data/lib/snaptrade/models/universal_symbol.rb +30 -5
  138. data/lib/snaptrade/models/us_exchange.rb +0 -1
  139. data/lib/snaptrade/models/user_i_dand_secret.rb +2 -4
  140. data/lib/snaptrade/models/validated_trade_body.rb +218 -0
  141. data/lib/snaptrade/version.rb +1 -2
  142. data/lib/snaptrade.rb +90 -66
  143. data/snaptrade.gemspec +0 -1
  144. data/spec/api/account_information_api_spec.rb +66 -13
  145. data/spec/api/api_status_api_spec.rb +0 -1
  146. data/spec/api/authentication_api_spec.rb +20 -20
  147. data/spec/api/connections_api_spec.rb +54 -9
  148. data/spec/api/options_api_spec.rb +11 -7
  149. data/spec/api/reference_data_api_spec.rb +24 -16
  150. data/spec/api/trading_api_spec.rb +17 -25
  151. data/spec/api/transactions_and_reporting_api_spec.rb +7 -8
  152. data/spec/api_client_spec.rb +0 -1
  153. data/spec/configuration_spec.rb +0 -1
  154. data/spec/models/account_balance_spec.rb +0 -1
  155. data/spec/models/account_balance_total_spec.rb +0 -1
  156. data/spec/models/account_holdings_account_spec.rb +6 -1
  157. data/spec/models/account_holdings_spec.rb +0 -1
  158. data/spec/models/{strategy_impact_legs_inner_spec.rb → account_order_record_option_symbol_spec.rb} +13 -14
  159. data/spec/models/account_order_record_spec.rb +12 -7
  160. data/spec/models/account_order_record_status_spec.rb +0 -1
  161. data/spec/models/{brokerage_symbol_symbol_spec.rb → account_order_record_universal_symbol_spec.rb} +18 -7
  162. data/spec/models/account_simple_spec.rb +0 -1
  163. data/spec/models/account_spec.rb +14 -9
  164. data/spec/models/account_sync_status_spec.rb +6 -1
  165. data/spec/models/account_universal_activity_currency_spec.rb +41 -0
  166. data/spec/models/{brokerage_symbol_option_symbol_spec.rb → account_universal_activity_option_symbol_spec.rb} +6 -19
  167. data/spec/models/{portfolio_group_info_spec.rb → account_universal_activity_spec.rb} +47 -18
  168. data/spec/models/{universal_symbol_ticker_spec.rb → account_universal_activity_symbol_spec.rb} +13 -8
  169. data/spec/models/action_strict_spec.rb +23 -0
  170. data/spec/models/action_strict_with_options_spec.rb +23 -0
  171. data/spec/models/auth_type_spec.rb +0 -1
  172. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +0 -1
  173. data/spec/models/{model_portfolio_spec.rb → balance_currency_spec.rb} +8 -9
  174. data/spec/models/balance_spec.rb +6 -1
  175. data/spec/models/brokerage_authorization_disabled_confirmation_spec.rb +29 -0
  176. data/spec/models/{brokerage_authorization_type_spec.rb → brokerage_authorization_refresh_confirmation_spec.rb} +7 -8
  177. data/spec/models/brokerage_authorization_spec.rb +6 -7
  178. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +0 -1
  179. data/spec/models/brokerage_authorization_type_read_only_spec.rb +0 -1
  180. data/spec/models/brokerage_spec.rb +12 -19
  181. data/spec/models/brokerage_type_spec.rb +0 -1
  182. data/spec/models/connection_portal_version_spec.rb +0 -1
  183. data/spec/models/connection_type_spec.rb +0 -1
  184. data/spec/models/connections_session_events200_response_inner_spec.rb +0 -1
  185. data/spec/models/currency_spec.rb +0 -1
  186. data/spec/models/delete_user_response_spec.rb +6 -1
  187. data/spec/models/dividend_at_date_spec.rb +0 -1
  188. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +0 -1
  189. data/spec/models/encrypted_response_spec.rb +0 -1
  190. data/spec/models/exchange_rate_pairs_spec.rb +0 -1
  191. data/spec/models/exchange_spec.rb +0 -1
  192. data/spec/models/{portfolio_group_spec.rb → figi_instrument_spec.rb} +8 -9
  193. data/spec/models/{calculated_trade_spec.rb → holdings_status_spec.rb} +8 -9
  194. data/spec/models/login_redirect_uri_spec.rb +0 -1
  195. data/spec/models/manual_trade_and_impact_spec.rb +0 -1
  196. data/spec/models/manual_trade_balance_spec.rb +0 -1
  197. data/spec/models/manual_trade_form_notional_value_spec.rb +23 -0
  198. data/spec/models/manual_trade_form_spec.rb +6 -7
  199. data/spec/models/{strategy_impact_spec.rb → manual_trade_form_with_options_spec.rb} +29 -18
  200. data/spec/models/{snap_trade_api_disclaimer_accept_status_spec.rb → manual_trade_form_with_options_stop_loss_spec.rb} +8 -9
  201. data/spec/models/manual_trade_form_with_options_take_profit_spec.rb +29 -0
  202. data/spec/models/{trade_impact_spec.rb → manual_trade_impact_spec.rb} +7 -8
  203. data/spec/models/manual_trade_spec.rb +0 -1
  204. data/spec/models/manual_trade_symbol_spec.rb +6 -7
  205. data/spec/models/model400_failed_request_response_spec.rb +0 -1
  206. data/spec/models/model401_failed_request_response_spec.rb +0 -1
  207. data/spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb +35 -0
  208. data/spec/models/model402_brokerage_auth_disabled_response_spec.rb +35 -0
  209. data/spec/models/model403_failed_request_response_spec.rb +0 -1
  210. data/spec/models/{model_asset_class_details_spec.rb → model403_feature_not_enabled_response_spec.rb} +8 -9
  211. data/spec/models/model404_failed_request_response_spec.rb +0 -1
  212. data/spec/models/model425_failed_request_response_spec.rb +35 -0
  213. data/spec/models/model500_unexpected_exception_response_spec.rb +0 -1
  214. data/spec/models/monthly_dividends_spec.rb +0 -1
  215. data/spec/models/net_contributions_spec.rb +0 -1
  216. data/spec/models/net_dividend_spec.rb +0 -1
  217. data/spec/models/notional_value_spec.rb +26 -0
  218. data/spec/models/{model_portfolio_details_spec.rb → option_brokerage_symbol_spec.rb} +9 -10
  219. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +0 -1
  220. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +0 -1
  221. data/spec/models/option_chain_inner_spec.rb +0 -1
  222. data/spec/models/option_leg_action_spec.rb +0 -1
  223. data/spec/models/option_leg_spec.rb +0 -1
  224. data/spec/models/option_strategy_legs_inner_spec.rb +0 -1
  225. data/spec/models/option_strategy_spec.rb +0 -1
  226. data/spec/models/option_type_spec.rb +0 -1
  227. data/spec/models/options_get_option_strategy_request_spec.rb +0 -1
  228. data/spec/models/options_place_option_strategy_request_spec.rb +0 -1
  229. data/spec/models/options_position_currency_spec.rb +0 -1
  230. data/spec/models/options_position_spec.rb +2 -3
  231. data/spec/models/options_symbol_spec.rb +0 -13
  232. data/spec/models/order_class_spec.rb +23 -0
  233. data/spec/models/order_type_strict_spec.rb +23 -0
  234. data/spec/models/{model_portfolio_asset_class_spec.rb → paginated_universal_activity_spec.rb} +8 -9
  235. data/spec/models/{model_asset_class_spec.rb → pagination_details_spec.rb} +8 -9
  236. data/spec/models/partner_data_spec.rb +12 -13
  237. data/spec/models/past_value_spec.rb +0 -1
  238. data/spec/models/performance_custom_spec.rb +0 -1
  239. data/spec/models/position_spec.rb +2 -3
  240. data/spec/models/position_symbol_spec.rb +3 -4
  241. data/spec/models/{portfolio_group_position_spec.rb → rate_of_return_object_spec.rb} +9 -10
  242. data/spec/models/rate_of_return_response_spec.rb +29 -0
  243. data/spec/models/recent_orders_response_spec.rb +29 -0
  244. data/spec/models/security_type_spec.rb +0 -1
  245. data/spec/models/session_event_spec.rb +0 -1
  246. data/spec/models/session_event_type_spec.rb +0 -1
  247. data/spec/models/snap_trade_holdings_account_spec.rb +0 -1
  248. data/spec/models/snap_trade_holdings_total_value_spec.rb +0 -1
  249. data/spec/models/snap_trade_login_user_request_body_spec.rb +0 -1
  250. data/spec/models/snap_trade_register_user_request_body_spec.rb +0 -1
  251. data/spec/models/status_spec.rb +0 -1
  252. data/spec/models/{amount_spec.rb → stop_loss_spec.rb} +8 -9
  253. data/spec/models/strategy_order_record_spec.rb +0 -1
  254. data/spec/models/strategy_order_record_status_spec.rb +0 -1
  255. data/spec/models/strategy_quotes_greek_spec.rb +0 -1
  256. data/spec/models/strategy_quotes_spec.rb +0 -1
  257. data/spec/models/strategy_type_spec.rb +0 -1
  258. data/spec/models/sub_period_return_rate_spec.rb +0 -1
  259. data/spec/models/symbol_currency_spec.rb +41 -0
  260. data/spec/models/{trade_spec.rb → symbol_exchange_spec.rb} +13 -14
  261. data/spec/models/symbol_figi_instrument_spec.rb +35 -0
  262. data/spec/models/symbol_query_spec.rb +0 -1
  263. data/spec/models/symbol_spec.rb +13 -2
  264. data/spec/models/symbols_quotes_inner_spec.rb +3 -4
  265. data/spec/models/{jwt_spec.rb → take_profit_spec.rb} +7 -8
  266. data/spec/models/time_in_force_strict_spec.rb +23 -0
  267. data/spec/models/timeframe_spec.rb +23 -0
  268. data/spec/models/trading_cancel_user_account_order_request_spec.rb +0 -1
  269. data/spec/models/transactions_status_spec.rb +6 -1
  270. data/spec/models/type_spec.rb +0 -1
  271. data/spec/models/{snap_trade_holdings_account_account_id_spec.rb → underlying_symbol_exchange_spec.rb} +13 -14
  272. data/spec/models/underlying_symbol_spec.rb +18 -1
  273. data/spec/models/{cash_restriction_spec.rb → underlying_symbol_type_spec.rb} +9 -16
  274. data/spec/models/universal_activity_spec.rb +15 -16
  275. data/spec/models/universal_symbol_spec.rb +12 -1
  276. data/spec/models/us_exchange_spec.rb +0 -1
  277. data/spec/models/user_i_dand_secret_spec.rb +0 -1
  278. data/spec/models/{excluded_asset_spec.rb → validated_trade_body_spec.rb} +7 -8
  279. data/spec/spec_helper.rb +0 -1
  280. metadata +203 -360
  281. data/docs/APIStatusApi.md +0 -57
  282. data/docs/Account.md +0 -38
  283. data/docs/AccountBalance.md +0 -18
  284. data/docs/AccountBalanceTotal.md +0 -20
  285. data/docs/AccountHoldings.md +0 -24
  286. data/docs/AccountHoldingsAccount.md +0 -26
  287. data/docs/AccountInformationApi.md +0 -544
  288. data/docs/AccountOrderRecord.md +0 -52
  289. data/docs/AccountOrderRecordStatus.md +0 -15
  290. data/docs/AccountSimple.md +0 -24
  291. data/docs/AccountSyncStatus.md +0 -18
  292. data/docs/Action.md +0 -15
  293. data/docs/Amount.md +0 -20
  294. data/docs/AuthType.md +0 -15
  295. data/docs/AuthenticationApi.md +0 -320
  296. data/docs/AuthenticationLoginSnapTradeUser200Response.md +0 -49
  297. data/docs/Balance.md +0 -20
  298. data/docs/Brokerage.md +0 -52
  299. data/docs/BrokerageAuthorization.md +0 -34
  300. data/docs/BrokerageAuthorizationType.md +0 -18
  301. data/docs/BrokerageAuthorizationTypeReadOnly.md +0 -24
  302. data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md +0 -22
  303. data/docs/BrokerageAuthorizationTypeReadOnlyType.md +0 -15
  304. data/docs/BrokerageAuthorizationTypeType.md +0 -15
  305. data/docs/BrokerageSymbol.md +0 -28
  306. data/docs/BrokerageSymbolOptionSymbol.md +0 -34
  307. data/docs/BrokerageSymbolSymbol.md +0 -32
  308. data/docs/BrokerageType.md +0 -20
  309. data/docs/CalculatedTrade.md +0 -20
  310. data/docs/CashRestriction.md +0 -26
  311. data/docs/ConnectionPortalVersion.md +0 -15
  312. data/docs/ConnectionType.md +0 -15
  313. data/docs/ConnectionsApi.md +0 -265
  314. data/docs/ConnectionsSessionEvents200ResponseInner.md +0 -30
  315. data/docs/Currency.md +0 -22
  316. data/docs/DeleteUserResponse.md +0 -20
  317. data/docs/DividendAtDate.md +0 -22
  318. data/docs/EncryptedResponse.md +0 -20
  319. data/docs/EncryptedResponseEncryptedMessageData.md +0 -22
  320. data/docs/ErrorLogsApi.md +0 -68
  321. data/docs/Exchange.md +0 -32
  322. data/docs/ExchangeRatePairs.md +0 -22
  323. data/docs/ExcludedAsset.md +0 -18
  324. data/docs/JWT.md +0 -18
  325. data/docs/LoginRedirectURI.md +0 -20
  326. data/docs/ManualTrade.md +0 -32
  327. data/docs/ManualTradeAndImpact.md +0 -22
  328. data/docs/ManualTradeBalance.md +0 -22
  329. data/docs/ManualTradeForm.md +0 -34
  330. data/docs/ManualTradeSymbol.md +0 -28
  331. data/docs/Model400FailedRequestResponse.md +0 -20
  332. data/docs/Model401FailedRequestResponse.md +0 -20
  333. data/docs/Model403FailedRequestResponse.md +0 -20
  334. data/docs/Model404FailedRequestResponse.md +0 -20
  335. data/docs/Model500UnexpectedExceptionResponse.md +0 -22
  336. data/docs/ModelAssetClass.md +0 -20
  337. data/docs/ModelAssetClassDetails.md +0 -20
  338. data/docs/ModelAssetClassTarget.md +0 -18
  339. data/docs/ModelPortfolio.md +0 -22
  340. data/docs/ModelPortfolioAssetClass.md +0 -20
  341. data/docs/ModelPortfolioDetails.md +0 -22
  342. data/docs/ModelPortfolioSecurity.md +0 -20
  343. data/docs/ModelType.md +0 -15
  344. data/docs/MonthlyDividends.md +0 -20
  345. data/docs/NetContributions.md +0 -22
  346. data/docs/NetDividend.md +0 -22
  347. data/docs/OptionChainInner.md +0 -26
  348. data/docs/OptionChainInnerChainPerRootInner.md +0 -22
  349. data/docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md +0 -22
  350. data/docs/OptionLeg.md +0 -22
  351. data/docs/OptionLegAction.md +0 -15
  352. data/docs/OptionStrategy.md +0 -26
  353. data/docs/OptionStrategyLegsInner.md +0 -24
  354. data/docs/OptionType.md +0 -15
  355. data/docs/OptionsApi.md +0 -390
  356. data/docs/OptionsGetOptionStrategyRequest.md +0 -22
  357. data/docs/OptionsHoldings.md +0 -28
  358. data/docs/OptionsPlaceOptionStrategyRequest.md +0 -22
  359. data/docs/OptionsPosition.md +0 -26
  360. data/docs/OptionsPositionCurrency.md +0 -22
  361. data/docs/OptionsSymbol.md +0 -34
  362. data/docs/OrderType.md +0 -15
  363. data/docs/PartnerData.md +0 -40
  364. data/docs/PastValue.md +0 -22
  365. data/docs/PerformanceCustom.md +0 -54
  366. data/docs/PortfolioGroup.md +0 -20
  367. data/docs/PortfolioGroupInfo.md +0 -38
  368. data/docs/PortfolioGroupPosition.md +0 -22
  369. data/docs/PortfolioGroupSettings.md +0 -26
  370. data/docs/Position.md +0 -28
  371. data/docs/PositionSymbol.md +0 -28
  372. data/docs/RedirectTokenandPin.md +0 -20
  373. data/docs/ReferenceDataApi.md +0 -597
  374. data/docs/SecurityType.md +0 -24
  375. data/docs/SessionEvent.md +0 -30
  376. data/docs/SessionEventType.md +0 -15
  377. data/docs/SnapTradeAPIDisclaimerAcceptStatus.md +0 -20
  378. data/docs/SnapTradeHoldingsAccount.md +0 -32
  379. data/docs/SnapTradeHoldingsAccountAccountId.md +0 -34
  380. data/docs/SnapTradeHoldingsTotalValue.md +0 -20
  381. data/docs/SnapTradeLoginUserRequestBody.md +0 -28
  382. data/docs/SnapTradeRegisterUserRequestBody.md +0 -18
  383. data/docs/State.md +0 -15
  384. data/docs/Status.md +0 -22
  385. data/docs/StrategyImpact.md +0 -38
  386. data/docs/StrategyImpactLegsInner.md +0 -30
  387. data/docs/StrategyOrderPlace.md +0 -20
  388. data/docs/StrategyOrderPlaceOrdersInner.md +0 -102
  389. data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md +0 -30
  390. data/docs/StrategyOrderRecord.md +0 -38
  391. data/docs/StrategyOrderRecordStatus.md +0 -15
  392. data/docs/StrategyQuotes.md +0 -28
  393. data/docs/StrategyQuotesGreek.md +0 -26
  394. data/docs/StrategyType.md +0 -15
  395. data/docs/SubPeriodReturnRate.md +0 -22
  396. data/docs/Symbol.md +0 -30
  397. data/docs/SymbolQuery.md +0 -18
  398. data/docs/SymbolsQuotesInner.md +0 -28
  399. data/docs/TargetAsset.md +0 -28
  400. data/docs/TimeInForce.md +0 -15
  401. data/docs/Trade.md +0 -32
  402. data/docs/TradeAction.md +0 -15
  403. data/docs/TradeExecutionStatus.md +0 -34
  404. data/docs/TradeExecutionStatusAction.md +0 -15
  405. data/docs/TradeImpact.md +0 -26
  406. data/docs/TradingApi.md +0 -486
  407. data/docs/TradingCancelUserAccountOrderRequest.md +0 -18
  408. data/docs/TradingPlaceOCOOrderRequest.md +0 -20
  409. data/docs/TransactionsAndReportingApi.md +0 -183
  410. data/docs/TransactionsStatus.md +0 -20
  411. data/docs/Type.md +0 -15
  412. data/docs/USExchange.md +0 -34
  413. data/docs/UnderlyingSymbol.md +0 -30
  414. data/docs/UniversalActivity.md +0 -50
  415. data/docs/UniversalSymbol.md +0 -32
  416. data/docs/UniversalSymbolTicker.md +0 -32
  417. data/docs/UserErrorLog.md +0 -28
  418. data/docs/UserIDandSecret.md +0 -20
  419. data/docs/UserSettings.md +0 -36
  420. data/lib/snaptrade/api/error_logs_api.rb +0 -110
  421. data/lib/snaptrade/models/action.rb +0 -38
  422. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +0 -38
  423. data/lib/snaptrade/models/cash_restriction.rb +0 -254
  424. data/lib/snaptrade/models/model_asset_class_details.rb +0 -228
  425. data/lib/snaptrade/models/model_portfolio_asset_class.rb +0 -250
  426. data/lib/snaptrade/models/model_portfolio_details.rb +0 -239
  427. data/lib/snaptrade/models/portfolio_group_info.rb +0 -326
  428. data/lib/snaptrade/models/portfolio_group_settings.rb +0 -277
  429. data/lib/snaptrade/models/redirect_tokenand_pin.rb +0 -227
  430. data/lib/snaptrade/models/state.rb +0 -41
  431. data/lib/snaptrade/models/strategy_impact.rb +0 -310
  432. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +0 -271
  433. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +0 -597
  434. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +0 -271
  435. data/lib/snaptrade/models/trade_execution_status.rb +0 -296
  436. data/lib/snaptrade/models/trading_place_oco_order_request.rb +0 -230
  437. data/lib/snaptrade/models/user_error_log.rb +0 -263
  438. data/lib/snaptrade/models/user_settings.rb +0 -299
  439. data/spec/api/error_logs_api_spec.rb +0 -43
  440. data/spec/models/action_spec.rb +0 -24
  441. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +0 -24
  442. data/spec/models/brokerage_authorization_type_type_spec.rb +0 -24
  443. data/spec/models/brokerage_symbol_spec.rb +0 -60
  444. data/spec/models/model_asset_class_target_spec.rb +0 -30
  445. data/spec/models/model_portfolio_security_spec.rb +0 -36
  446. data/spec/models/model_type_spec.rb +0 -24
  447. data/spec/models/options_holdings_spec.rb +0 -60
  448. data/spec/models/order_type_spec.rb +0 -24
  449. data/spec/models/portfolio_group_settings_spec.rb +0 -54
  450. data/spec/models/redirect_tokenand_pin_spec.rb +0 -36
  451. data/spec/models/state_spec.rb +0 -24
  452. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +0 -66
  453. data/spec/models/strategy_order_place_orders_inner_spec.rb +0 -282
  454. data/spec/models/strategy_order_place_spec.rb +0 -36
  455. data/spec/models/target_asset_spec.rb +0 -60
  456. data/spec/models/time_in_force_spec.rb +0 -24
  457. data/spec/models/trade_action_spec.rb +0 -24
  458. data/spec/models/trade_execution_status_action_spec.rb +0 -24
  459. data/spec/models/trade_execution_status_spec.rb +0 -78
  460. data/spec/models/trading_place_oco_order_request_spec.rb +0 -36
  461. data/spec/models/user_error_log_spec.rb +0 -60
  462. data/spec/models/user_settings_spec.rb +0 -84
data/lib/snaptrade.rb CHANGED
@@ -5,7 +5,6 @@
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: api@snaptrade.com
8
-
9
8
  =end
10
9
 
11
10
  require 'forwardable'
@@ -23,27 +22,28 @@ require 'snaptrade/models/account_balance_total'
23
22
  require 'snaptrade/models/account_holdings'
24
23
  require 'snaptrade/models/account_holdings_account'
25
24
  require 'snaptrade/models/account_order_record'
25
+ require 'snaptrade/models/account_order_record_option_symbol'
26
26
  require 'snaptrade/models/account_order_record_status'
27
+ require 'snaptrade/models/account_order_record_universal_symbol'
27
28
  require 'snaptrade/models/account_simple'
28
29
  require 'snaptrade/models/account_sync_status'
29
- require 'snaptrade/models/action'
30
- require 'snaptrade/models/amount'
30
+ require 'snaptrade/models/account_universal_activity'
31
+ require 'snaptrade/models/account_universal_activity_currency'
32
+ require 'snaptrade/models/account_universal_activity_option_symbol'
33
+ require 'snaptrade/models/account_universal_activity_symbol'
34
+ require 'snaptrade/models/action_strict'
35
+ require 'snaptrade/models/action_strict_with_options'
31
36
  require 'snaptrade/models/auth_type'
32
37
  require 'snaptrade/models/authentication_login_snap_trade_user200_response'
33
38
  require 'snaptrade/models/balance'
39
+ require 'snaptrade/models/balance_currency'
34
40
  require 'snaptrade/models/brokerage'
35
41
  require 'snaptrade/models/brokerage_authorization'
36
- require 'snaptrade/models/brokerage_authorization_type'
42
+ require 'snaptrade/models/brokerage_authorization_disabled_confirmation'
43
+ require 'snaptrade/models/brokerage_authorization_refresh_confirmation'
37
44
  require 'snaptrade/models/brokerage_authorization_type_read_only'
38
45
  require 'snaptrade/models/brokerage_authorization_type_read_only_brokerage'
39
- require 'snaptrade/models/brokerage_authorization_type_read_only_type'
40
- require 'snaptrade/models/brokerage_authorization_type_type'
41
- require 'snaptrade/models/brokerage_symbol'
42
- require 'snaptrade/models/brokerage_symbol_option_symbol'
43
- require 'snaptrade/models/brokerage_symbol_symbol'
44
46
  require 'snaptrade/models/brokerage_type'
45
- require 'snaptrade/models/calculated_trade'
46
- require 'snaptrade/models/cash_restriction'
47
47
  require 'snaptrade/models/connection_portal_version'
48
48
  require 'snaptrade/models/connection_type'
49
49
  require 'snaptrade/models/connections_session_events200_response_inner'
@@ -54,30 +54,33 @@ require 'snaptrade/models/encrypted_response'
54
54
  require 'snaptrade/models/encrypted_response_encrypted_message_data'
55
55
  require 'snaptrade/models/exchange'
56
56
  require 'snaptrade/models/exchange_rate_pairs'
57
- require 'snaptrade/models/excluded_asset'
58
- require 'snaptrade/models/jwt'
57
+ require 'snaptrade/models/figi_instrument'
58
+ require 'snaptrade/models/holdings_status'
59
59
  require 'snaptrade/models/login_redirect_uri'
60
60
  require 'snaptrade/models/manual_trade'
61
61
  require 'snaptrade/models/manual_trade_and_impact'
62
62
  require 'snaptrade/models/manual_trade_balance'
63
63
  require 'snaptrade/models/manual_trade_form'
64
+ require 'snaptrade/models/manual_trade_form_notional_value'
65
+ require 'snaptrade/models/manual_trade_form_with_options'
66
+ require 'snaptrade/models/manual_trade_form_with_options_stop_loss'
67
+ require 'snaptrade/models/manual_trade_form_with_options_take_profit'
68
+ require 'snaptrade/models/manual_trade_impact'
64
69
  require 'snaptrade/models/manual_trade_symbol'
65
70
  require 'snaptrade/models/model400_failed_request_response'
66
71
  require 'snaptrade/models/model401_failed_request_response'
72
+ require 'snaptrade/models/model402_brokerage_auth_already_disabled_exception'
73
+ require 'snaptrade/models/model402_brokerage_auth_disabled_response'
67
74
  require 'snaptrade/models/model403_failed_request_response'
75
+ require 'snaptrade/models/model403_feature_not_enabled_response'
68
76
  require 'snaptrade/models/model404_failed_request_response'
77
+ require 'snaptrade/models/model425_failed_request_response'
69
78
  require 'snaptrade/models/model500_unexpected_exception_response'
70
- require 'snaptrade/models/model_asset_class'
71
- require 'snaptrade/models/model_asset_class_details'
72
- require 'snaptrade/models/model_asset_class_target'
73
- require 'snaptrade/models/model_portfolio'
74
- require 'snaptrade/models/model_portfolio_asset_class'
75
- require 'snaptrade/models/model_portfolio_details'
76
- require 'snaptrade/models/model_portfolio_security'
77
- require 'snaptrade/models/model_type'
78
79
  require 'snaptrade/models/monthly_dividends'
79
80
  require 'snaptrade/models/net_contributions'
80
81
  require 'snaptrade/models/net_dividend'
82
+ require 'snaptrade/models/notional_value'
83
+ require 'snaptrade/models/option_brokerage_symbol'
81
84
  require 'snaptrade/models/option_chain_inner'
82
85
  require 'snaptrade/models/option_chain_inner_chain_per_root_inner'
83
86
  require 'snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner'
@@ -87,38 +90,31 @@ require 'snaptrade/models/option_strategy'
87
90
  require 'snaptrade/models/option_strategy_legs_inner'
88
91
  require 'snaptrade/models/option_type'
89
92
  require 'snaptrade/models/options_get_option_strategy_request'
90
- require 'snaptrade/models/options_holdings'
91
93
  require 'snaptrade/models/options_place_option_strategy_request'
92
94
  require 'snaptrade/models/options_position'
93
95
  require 'snaptrade/models/options_position_currency'
94
96
  require 'snaptrade/models/options_symbol'
95
- require 'snaptrade/models/order_type'
97
+ require 'snaptrade/models/order_class'
98
+ require 'snaptrade/models/order_type_strict'
99
+ require 'snaptrade/models/paginated_universal_activity'
100
+ require 'snaptrade/models/pagination_details'
96
101
  require 'snaptrade/models/partner_data'
97
102
  require 'snaptrade/models/past_value'
98
103
  require 'snaptrade/models/performance_custom'
99
- require 'snaptrade/models/portfolio_group'
100
- require 'snaptrade/models/portfolio_group_info'
101
- require 'snaptrade/models/portfolio_group_position'
102
- require 'snaptrade/models/portfolio_group_settings'
103
104
  require 'snaptrade/models/position'
104
105
  require 'snaptrade/models/position_symbol'
105
- require 'snaptrade/models/redirect_tokenand_pin'
106
+ require 'snaptrade/models/rate_of_return_object'
107
+ require 'snaptrade/models/rate_of_return_response'
108
+ require 'snaptrade/models/recent_orders_response'
106
109
  require 'snaptrade/models/security_type'
107
110
  require 'snaptrade/models/session_event'
108
111
  require 'snaptrade/models/session_event_type'
109
- require 'snaptrade/models/snap_trade_api_disclaimer_accept_status'
110
112
  require 'snaptrade/models/snap_trade_holdings_account'
111
- require 'snaptrade/models/snap_trade_holdings_account_account_id'
112
113
  require 'snaptrade/models/snap_trade_holdings_total_value'
113
114
  require 'snaptrade/models/snap_trade_login_user_request_body'
114
115
  require 'snaptrade/models/snap_trade_register_user_request_body'
115
- require 'snaptrade/models/state'
116
116
  require 'snaptrade/models/status'
117
- require 'snaptrade/models/strategy_impact'
118
- require 'snaptrade/models/strategy_impact_legs_inner'
119
- require 'snaptrade/models/strategy_order_place'
120
- require 'snaptrade/models/strategy_order_place_orders_inner'
121
- require 'snaptrade/models/strategy_order_place_orders_inner_legs_inner'
117
+ require 'snaptrade/models/stop_loss'
122
118
  require 'snaptrade/models/strategy_order_record'
123
119
  require 'snaptrade/models/strategy_order_record_status'
124
120
  require 'snaptrade/models/strategy_quotes'
@@ -126,34 +122,31 @@ require 'snaptrade/models/strategy_quotes_greek'
126
122
  require 'snaptrade/models/strategy_type'
127
123
  require 'snaptrade/models/sub_period_return_rate'
128
124
  require 'snaptrade/models/symbol'
125
+ require 'snaptrade/models/symbol_currency'
126
+ require 'snaptrade/models/symbol_exchange'
127
+ require 'snaptrade/models/symbol_figi_instrument'
129
128
  require 'snaptrade/models/symbol_query'
130
129
  require 'snaptrade/models/symbols_quotes_inner'
131
- require 'snaptrade/models/target_asset'
132
- require 'snaptrade/models/time_in_force'
133
- require 'snaptrade/models/trade'
134
- require 'snaptrade/models/trade_action'
135
- require 'snaptrade/models/trade_execution_status'
136
- require 'snaptrade/models/trade_execution_status_action'
137
- require 'snaptrade/models/trade_impact'
130
+ require 'snaptrade/models/take_profit'
131
+ require 'snaptrade/models/time_in_force_strict'
132
+ require 'snaptrade/models/timeframe'
138
133
  require 'snaptrade/models/trading_cancel_user_account_order_request'
139
- require 'snaptrade/models/trading_place_oco_order_request'
140
134
  require 'snaptrade/models/transactions_status'
141
135
  require 'snaptrade/models/type'
142
136
  require 'snaptrade/models/us_exchange'
143
137
  require 'snaptrade/models/underlying_symbol'
138
+ require 'snaptrade/models/underlying_symbol_exchange'
139
+ require 'snaptrade/models/underlying_symbol_type'
144
140
  require 'snaptrade/models/universal_activity'
145
141
  require 'snaptrade/models/universal_symbol'
146
- require 'snaptrade/models/universal_symbol_ticker'
147
- require 'snaptrade/models/user_error_log'
148
142
  require 'snaptrade/models/user_i_dand_secret'
149
- require 'snaptrade/models/user_settings'
143
+ require 'snaptrade/models/validated_trade_body'
150
144
 
151
145
  # APIs
152
146
  require 'snaptrade/api/account_information_api'
153
147
  require 'snaptrade/api/api_status_api'
154
148
  require 'snaptrade/api/authentication_api'
155
149
  require 'snaptrade/api/connections_api'
156
- require 'snaptrade/api/error_logs_api'
157
150
  require 'snaptrade/api/options_api'
158
151
  require 'snaptrade/api/reference_data_api'
159
152
  require 'snaptrade/api/trading_api'
@@ -163,21 +156,54 @@ module SnapTrade
163
156
  @config = Configuration.default
164
157
  SENTINEL = Object.new
165
158
  class << self
166
- extend Forwardable
167
159
 
168
- def is_sentinel(value)
160
+ private def is_sentinel(value)
169
161
  value == SENTINEL
170
162
  end
171
163
 
172
- def_delegators :@config, :client_id, :client_id= # api key
173
- def_delegators :@config, :signature, :signature= # api key
174
- def_delegators :@config, :timestamp, :timestamp= # api key
175
- def_delegators :@config, :consumer_key, :consumer_key= # client state from konfig.yaml
164
+ def host
165
+ @config.host
166
+ end
167
+
168
+ def host=(value)
169
+ @config.host = value
170
+ end
171
+ # api key from OpenAPI spec
172
+ def client_id
173
+ @config.client_id
174
+ end
175
+
176
+ def client_id=(value)
177
+ @config.client_id = value
178
+ end
179
+ # api key from OpenAPI spec
180
+ def signature
181
+ @config.signature
182
+ end
183
+
184
+ def signature=(value)
185
+ @config.signature = value
186
+ end
187
+ # api key from OpenAPI spec
188
+ def timestamp
189
+ @config.timestamp
190
+ end
191
+
192
+ def timestamp=(value)
193
+ @config.timestamp = value
194
+ end
195
+ # client state from konfig.yaml
196
+ def consumer_key
197
+ @config.consumer_key
198
+ end
199
+
200
+ def consumer_key=(value)
201
+ @config.consumer_key = value
202
+ end
176
203
 
177
204
  # Customize default settings for the SDK using block.
178
205
  # SnapTrade.configure do |config|
179
- # config.username = "xxx"
180
- # config.password = "xxx"
206
+ # config.host = "http://example.com"
181
207
  # end
182
208
  # If no block given, return the default Configuration object.
183
209
  def configure
@@ -190,15 +216,14 @@ module SnapTrade
190
216
  end
191
217
 
192
218
  class Client
193
- attr_accessor :account_information
194
- attr_accessor :api_status
195
- attr_accessor :authentication
196
- attr_accessor :connections
197
- attr_accessor :error_logs
198
- attr_accessor :options
199
- attr_accessor :reference_data
200
- attr_accessor :trading
201
- attr_accessor :transactions_and_reporting
219
+ attr_reader :account_information
220
+ attr_reader :api_status
221
+ attr_reader :authentication
222
+ attr_reader :connections
223
+ attr_reader :options
224
+ attr_reader :reference_data
225
+ attr_reader :trading
226
+ attr_reader :transactions_and_reporting
202
227
 
203
228
  def initialize(config = Configuration.default)
204
229
  @api_client = ApiClient::new(config)
@@ -206,7 +231,6 @@ module SnapTrade
206
231
  @api_status = SnapTrade::APIStatusApi.new(@api_client)
207
232
  @authentication = SnapTrade::AuthenticationApi.new(@api_client)
208
233
  @connections = SnapTrade::ConnectionsApi.new(@api_client)
209
- @error_logs = SnapTrade::ErrorLogsApi.new(@api_client)
210
234
  @options = SnapTrade::OptionsApi.new(@api_client)
211
235
  @reference_data = SnapTrade::ReferenceDataApi.new(@api_client)
212
236
  @trading = SnapTrade::TradingApi.new(@api_client)
data/snaptrade.gemspec CHANGED
@@ -7,7 +7,6 @@
7
7
 
8
8
  The version of the OpenAPI document: 1.0.0
9
9
  Contact: api@snaptrade.com
10
-
11
10
  =end
12
11
 
13
12
  $:.push File.expand_path("../lib", __FILE__)
@@ -5,7 +5,6 @@
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: api@snaptrade.com
8
-
9
8
  =end
10
9
 
11
10
  require 'spec_helper'
@@ -28,12 +27,32 @@ describe 'AccountInformationApi' do
28
27
  end
29
28
  end
30
29
 
30
+ # unit tests for get_account_activities
31
+ # List account activities
32
+ # Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the &#x60;trade_date&#x60; field. The data returned here is always cached and refreshed once a day.
33
+ # @param account_id
34
+ # @param user_id
35
+ # @param user_secret
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on &#x60;trade_date&#x60;.
38
+ # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on &#x60;trade_date&#x60;.
39
+ # @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
40
+ # @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
41
+ # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - &#x60;BUY&#x60; - Asset bought. - &#x60;SELL&#x60; - Asset sold. - &#x60;DIVIDEND&#x60; - Dividend payout. - &#x60;CONTRIBUTION&#x60; - Cash contribution. - &#x60;WITHDRAWAL&#x60; - Cash withdrawal. - &#x60;REI&#x60; - Dividend reinvestment. - &#x60;STOCK_DIVIDEND&#x60; - A type of dividend where a company distributes shares instead of cash - &#x60;INTEREST&#x60; - Interest deposited into the account. - &#x60;FEE&#x60; - Fee withdrawn from the account. - &#x60;OPTIONEXPIRATION&#x60; - Option expiration event. - &#x60;OPTIONASSIGNMENT&#x60; - Option assignment event. - &#x60;OPTIONEXERCISE&#x60; - Option exercise event. - &#x60;TRANSFER&#x60; - Transfer of assets from one account to another
42
+ # @return [PaginatedUniversalActivity]
43
+ describe 'get_account_activities test' do
44
+ it 'should work' do
45
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
46
+ end
47
+ end
48
+
31
49
  # unit tests for get_all_user_holdings
32
50
  # List all accounts for the user, plus balances, positions, and orders for each account.
51
+ # **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
33
52
  # @param user_id
34
53
  # @param user_secret
35
54
  # @param [Hash] opts the optional parameters
36
- # @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
55
+ # @option opts [String] :brokerage_authorizations Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
37
56
  # @return [Array<AccountHoldings>]
38
57
  describe 'get_all_user_holdings test' do
39
58
  it 'should work' do
@@ -43,10 +62,10 @@ describe 'AccountInformationApi' do
43
62
 
44
63
  # unit tests for get_user_account_balance
45
64
  # List account balances
46
- # A list of account balances for the specified account (one per currency that the account holds).
65
+ # Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v&#x3D;d16c4c97b8d5438bbb2d8581ac53b11e) and look for \&quot;Cache Expiry Time\&quot; to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
47
66
  # @param user_id
48
67
  # @param user_secret
49
- # @param account_id The ID of the account to get balances.
68
+ # @param account_id
50
69
  # @param [Hash] opts the optional parameters
51
70
  # @return [Array<Balance>]
52
71
  describe 'get_user_account_balance test' do
@@ -56,10 +75,11 @@ describe 'AccountInformationApi' do
56
75
  end
57
76
 
58
77
  # unit tests for get_user_account_details
59
- # Return details of a specific investment account
78
+ # Get account detail
79
+ # Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
60
80
  # @param user_id
61
81
  # @param user_secret
62
- # @param account_id The ID of the account to get detail of.
82
+ # @param account_id
63
83
  # @param [Hash] opts the optional parameters
64
84
  # @return [Account]
65
85
  describe 'get_user_account_details test' do
@@ -69,14 +89,14 @@ describe 'AccountInformationApi' do
69
89
  end
70
90
 
71
91
  # unit tests for get_user_account_orders
72
- # List account orders
73
- # Fetch all recent orders from a user&#39;s account.
92
+ # List account recent orders
93
+ # Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v&#x3D;d16c4c97b8d5438bbb2d8581ac53b11e) and look for \&quot;Cache Expiry Time\&quot; to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
74
94
  # @param user_id
75
95
  # @param user_secret
76
- # @param account_id The ID of the account to get orders.
96
+ # @param account_id
77
97
  # @param [Hash] opts the optional parameters
78
98
  # @option opts [String] :state defaults value is set to \&quot;all\&quot;
79
- # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
99
+ # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
80
100
  # @return [Array<AccountOrderRecord>]
81
101
  describe 'get_user_account_orders test' do
82
102
  it 'should work' do
@@ -86,9 +106,10 @@ describe 'AccountInformationApi' do
86
106
 
87
107
  # unit tests for get_user_account_positions
88
108
  # List account positions
109
+ # Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v&#x3D;d16c4c97b8d5438bbb2d8581ac53b11e) and look for \&quot;Cache Expiry Time\&quot; to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
89
110
  # @param user_id
90
111
  # @param user_secret
91
- # @param account_id The ID of the account to get positions.
112
+ # @param account_id
92
113
  # @param [Hash] opts the optional parameters
93
114
  # @return [Array<Position>]
94
115
  describe 'get_user_account_positions test' do
@@ -97,9 +118,39 @@ describe 'AccountInformationApi' do
97
118
  end
98
119
  end
99
120
 
121
+ # unit tests for get_user_account_recent_orders
122
+ # List account recent orders (last 24 hours only)
123
+ # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false **Please contact support for access as this endpoint is not enabled by default.**
124
+ # @param user_id
125
+ # @param user_secret
126
+ # @param account_id
127
+ # @param [Hash] opts the optional parameters
128
+ # @option opts [Boolean] :only_executed Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
129
+ # @return [RecentOrdersResponse]
130
+ describe 'get_user_account_recent_orders 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 get_user_account_return_rates
137
+ # List account rate of returns
138
+ # Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \&quot;ALL\&quot;, \&quot;1Y\&quot;, \&quot;6M\&quot;, \&quot;3M\&quot;, \&quot;1M\&quot;
139
+ # @param user_id
140
+ # @param user_secret
141
+ # @param account_id
142
+ # @param [Hash] opts the optional parameters
143
+ # @return [RateOfReturnResponse]
144
+ describe 'get_user_account_return_rates 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
+
100
150
  # unit tests for get_user_holdings
101
- # List balances, positions and orders for the specified account
102
- # @param account_id The ID of the account to fetch holdings for.
151
+ # List account holdings
152
+ # Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v&#x3D;d16c4c97b8d5438bbb2d8581ac53b11e) and look for \&quot;Cache Expiry Time\&quot; to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
153
+ # @param account_id
103
154
  # @param user_id
104
155
  # @param user_secret
105
156
  # @param [Hash] opts the optional parameters
@@ -112,6 +163,7 @@ describe 'AccountInformationApi' do
112
163
 
113
164
  # unit tests for list_user_accounts
114
165
  # List accounts
166
+ # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
115
167
  # @param user_id
116
168
  # @param user_secret
117
169
  # @param [Hash] opts the optional parameters
@@ -124,6 +176,7 @@ describe 'AccountInformationApi' do
124
176
 
125
177
  # unit tests for update_user_account
126
178
  # Update details of an investment account
179
+ # Updates various properties of a specified account.
127
180
  # @param user_id
128
181
  # @param user_secret
129
182
  # @param account_id The ID of the account to update.
@@ -5,7 +5,6 @@
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: api@snaptrade.com
8
-
9
8
  =end
10
9
 
11
10
  require 'spec_helper'
@@ -5,7 +5,6 @@
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: api@snaptrade.com
8
-
9
8
  =end
10
9
 
11
10
  require 'spec_helper'
@@ -29,8 +28,8 @@ describe 'AuthenticationApi' do
29
28
  end
30
29
 
31
30
  # unit tests for delete_snap_trade_user
32
- # Delete SnapTrade user
33
- # Deletes a user you&#39;ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
31
+ # Delete user
32
+ # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a &#x60;USER_DELETED&#x60; webhook will be sent.
34
33
  # @param user_id
35
34
  # @param [Hash] opts the optional parameters
36
35
  # @return [DeleteUserResponse]
@@ -40,21 +39,9 @@ describe 'AuthenticationApi' do
40
39
  end
41
40
  end
42
41
 
43
- # unit tests for get_user_jwt
44
- # Generate encrypted JWT token
45
- # @param user_id
46
- # @param user_secret
47
- # @param [Hash] opts the optional parameters
48
- # @return [EncryptedResponse]
49
- describe 'get_user_jwt test' do
50
- it 'should work' do
51
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
52
- end
53
- end
54
-
55
42
  # unit tests for list_snap_trade_users
56
- # List SnapTrade users
57
- # Returns a list of users you&#39;ve registered over the SnapTrade API.
43
+ # List all users
44
+ # Returns a list of all registered user IDs. Please note that the response is not currently paginated.
58
45
  # @param [Hash] opts the optional parameters
59
46
  # @return [Array<String>]
60
47
  describe 'list_snap_trade_users test' do
@@ -64,8 +51,8 @@ describe 'AuthenticationApi' do
64
51
  end
65
52
 
66
53
  # unit tests for login_snap_trade_user
67
- # Login user &amp; generate connection link
68
- # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
54
+ # Generate Connection Portal URL
55
+ # Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app. Please note that the returned URL expires in 5 minutes.
69
56
  # @param user_id
70
57
  # @param user_secret
71
58
  # @param [Hash] opts the optional parameters
@@ -78,7 +65,8 @@ describe 'AuthenticationApi' do
78
65
  end
79
66
 
80
67
  # unit tests for register_snap_trade_user
81
- # Create SnapTrade user
68
+ # Register user
69
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
82
70
  # @param snap_trade_register_user_request_body
83
71
  # @param [Hash] opts the optional parameters
84
72
  # @return [UserIDandSecret]
@@ -88,4 +76,16 @@ describe 'AuthenticationApi' do
88
76
  end
89
77
  end
90
78
 
79
+ # unit tests for reset_snap_trade_user_secret
80
+ # Rotate user secret
81
+ # Rotates the secret for a SnapTrade user. You might use this if &#x60;userSecret&#x60; is compromised. Please note that if you call this endpoint and fail to save the new secret, you&#39;ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
82
+ # @param user_i_dand_secret
83
+ # @param [Hash] opts the optional parameters
84
+ # @return [UserIDandSecret]
85
+ describe 'reset_snap_trade_user_secret test' do
86
+ it 'should work' do
87
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
88
+ end
89
+ end
90
+
91
91
  end
@@ -5,7 +5,6 @@
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: api@snaptrade.com
8
-
9
8
  =end
10
9
 
11
10
  require 'spec_helper'
@@ -29,8 +28,9 @@ describe 'ConnectionsApi' do
29
28
  end
30
29
 
31
30
  # unit tests for detail_brokerage_authorization
32
- # Get brokerage authorization details
33
- # @param authorization_id The ID of a brokerage authorization object.
31
+ # Get connection detail
32
+ # Returns a single connection for the specified ID.
33
+ # @param authorization_id
34
34
  # @param user_id
35
35
  # @param user_secret
36
36
  # @param [Hash] opts the optional parameters
@@ -41,8 +41,23 @@ describe 'ConnectionsApi' do
41
41
  end
42
42
  end
43
43
 
44
+ # unit tests for disable_brokerage_authorization
45
+ # Force disable connection
46
+ # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [&#x60;CONNECTION_BROKEN&#x60; webhook](/docs/webhooks#webhooks-connection_broken) for the connection. *Please contact us in order to use this endpoint as it is disabled by default.*
47
+ # @param authorization_id
48
+ # @param user_id
49
+ # @param user_secret
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [BrokerageAuthorizationDisabledConfirmation]
52
+ describe 'disable_brokerage_authorization 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
+
44
58
  # unit tests for list_brokerage_authorizations
45
- # List all brokerage authorizations for the user
59
+ # List all connections
60
+ # Returns a list of all connections for the specified user. Note that &#x60;Connection&#x60; and &#x60;Brokerage Authorization&#x60; are interchangeable, but the term &#x60;Connection&#x60; is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
46
61
  # @param user_id
47
62
  # @param user_secret
48
63
  # @param [Hash] opts the optional parameters
@@ -53,9 +68,24 @@ describe 'ConnectionsApi' do
53
68
  end
54
69
  end
55
70
 
71
+ # unit tests for refresh_brokerage_authorization
72
+ # Refresh holdings for a connection
73
+ # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [&#x60;ACCOUNT_HOLDINGS_UPDATED&#x60; webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
74
+ # @param authorization_id
75
+ # @param user_id
76
+ # @param user_secret
77
+ # @param [Hash] opts the optional parameters
78
+ # @return [BrokerageAuthorizationRefreshConfirmation]
79
+ describe 'refresh_brokerage_authorization test' do
80
+ it 'should work' do
81
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
82
+ end
83
+ end
84
+
56
85
  # unit tests for remove_brokerage_authorization
57
- # Delete brokerage authorization
58
- # @param authorization_id The ID of the Authorization to delete.
86
+ # Delete connection
87
+ # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
88
+ # @param authorization_id
59
89
  # @param user_id
60
90
  # @param user_secret
61
91
  # @param [Hash] opts the optional parameters
@@ -66,12 +96,27 @@ describe 'ConnectionsApi' do
66
96
  end
67
97
  end
68
98
 
99
+ # unit tests for return_rates
100
+ # List connection rate of returns
101
+ # Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \&quot;ALL\&quot;, \&quot;1Y\&quot;, \&quot;6M\&quot;, \&quot;3M\&quot;, \&quot;1M\&quot;
102
+ # @param user_id
103
+ # @param user_secret
104
+ # @param authorization_id
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [RateOfReturnResponse]
107
+ describe 'return_rates test' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
69
113
  # unit tests for session_events
70
- # List all session events for the partner
114
+ # Get all session events for a user
115
+ # Returns a list of session events associated with a user.
71
116
  # @param partner_client_id
72
117
  # @param [Hash] opts the optional parameters
73
- # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
74
- # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
118
+ # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
119
+ # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
75
120
  # @return [Array<ConnectionsSessionEvents200ResponseInner>]
76
121
  describe 'session_events test' do
77
122
  it 'should work' do