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
@@ -1,183 +0,0 @@
1
- # SnapTrade::TransactionsAndReportingApi
2
-
3
- All URIs are relative to *https://api.snaptrade.com/api/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_activities**](TransactionsAndReportingApi.md#get_activities) | **GET** /activities | Get transaction history for a user |
8
- | [**get_reporting_custom_range**](TransactionsAndReportingApi.md#get_reporting_custom_range) | **GET** /performance/custom | Get performance information for a specific timeframe |
9
-
10
- ## get_activities
11
-
12
- Get transaction history for a user
13
-
14
- Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
15
-
16
- ### Example
17
-
18
- ```ruby
19
- require 'snaptrade'
20
-
21
- SnapTrade.client_id = "YOUR_CLIENT_ID"
22
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
23
-
24
- user_id = "John.doe@snaptrade.com"
25
- user_secret = "USERSECRET123"
26
- start_date = "2022-01-24"
27
- end_date = "2022-01-24"
28
- accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
29
- brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
30
- type = "DIVIDEND"
31
-
32
- begin
33
- # Get transaction history for a user
34
- result = SnapTrade::TransactionsAndReporting.get_activities(
35
- user_id: user_id,
36
- user_secret: user_secret,
37
- start_date: start_date,
38
- end_date: end_date,
39
- accounts: accounts,
40
- brokerage_authorizations: brokerage_authorizations,
41
- type: type,
42
- )
43
- p result
44
- rescue SnapTrade::ApiError => e
45
- puts "Exception when calling SnapTrade::TransactionsAndReporting.get_activities: #{e}"
46
- end
47
- ```
48
-
49
- #### Using the get_activities_with_http_info variant
50
-
51
- This returns an Array which contains the response data, status code and headers.
52
-
53
- ```ruby
54
- user_id = "John.doe@snaptrade.com"
55
- user_secret = "USERSECRET123"
56
- start_date = "2022-01-24"
57
- end_date = "2022-01-24"
58
- accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
59
- brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
60
- type = "DIVIDEND"
61
-
62
- begin
63
- # Get transaction history for a user
64
- data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_activities_with_http_info(
65
- user_id: user_id,
66
- user_secret: user_secret,
67
- start_date: start_date,
68
- end_date: end_date,
69
- accounts: accounts,
70
- brokerage_authorizations: brokerage_authorizations,
71
- type: type,
72
- )
73
- p status_code # => 2xx
74
- p headers # => { ... }
75
- p data # => Array<UniversalActivity>
76
- rescue SnapTrade::ApiError => e
77
- puts "Exception when calling SnapTrade::TransactionsAndReporting.get_activities: #{e}"
78
- end
79
- ```
80
-
81
- ### Parameters
82
-
83
- | Name | Type | Description | Notes |
84
- | ---- | ---- | ----------- | ----- |
85
- | **user_id** | **String** | | |
86
- | **user_secret** | **String** | | |
87
- | **start_date** | **Date** | | [optional] |
88
- | **end_date** | **Date** | | [optional] |
89
- | **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
90
- | **brokerage_authorizations** | **String** | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | [optional] |
91
- | **type** | **String** | Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
92
-
93
- ### Return type
94
-
95
- [**Array&lt;UniversalActivity&gt;**](UniversalActivity.md)
96
-
97
- ## get_reporting_custom_range
98
-
99
- Get performance information for a specific timeframe
100
-
101
- Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
102
-
103
- ### Example
104
-
105
- ```ruby
106
- require 'snaptrade'
107
-
108
- SnapTrade.client_id = "YOUR_CLIENT_ID"
109
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
110
-
111
- start_date = "2022-01-24"
112
- end_date = "2022-01-24"
113
- user_id = "John.doe@snaptrade.com"
114
- user_secret = "USERSECRET123"
115
- accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
116
- detailed = True
117
- frequency = "monthly"
118
-
119
- begin
120
- # Get performance information for a specific timeframe
121
- result = SnapTrade::TransactionsAndReporting.get_reporting_custom_range(
122
- start_date: start_date,
123
- end_date: end_date,
124
- user_id: user_id,
125
- user_secret: user_secret,
126
- accounts: accounts,
127
- detailed: detailed,
128
- frequency: frequency,
129
- )
130
- p result
131
- rescue SnapTrade::ApiError => e
132
- puts "Exception when calling SnapTrade::TransactionsAndReporting.get_reporting_custom_range: #{e}"
133
- end
134
- ```
135
-
136
- #### Using the get_reporting_custom_range_with_http_info variant
137
-
138
- This returns an Array which contains the response data, status code and headers.
139
-
140
- ```ruby
141
- start_date = "2022-01-24"
142
- end_date = "2022-01-24"
143
- user_id = "John.doe@snaptrade.com"
144
- user_secret = "USERSECRET123"
145
- accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
146
- detailed = True
147
- frequency = "monthly"
148
-
149
- begin
150
- # Get performance information for a specific timeframe
151
- data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_reporting_custom_range_with_http_info(
152
- start_date: start_date,
153
- end_date: end_date,
154
- user_id: user_id,
155
- user_secret: user_secret,
156
- accounts: accounts,
157
- detailed: detailed,
158
- frequency: frequency,
159
- )
160
- p status_code # => 2xx
161
- p headers # => { ... }
162
- p data # => PerformanceCustom
163
- rescue SnapTrade::ApiError => e
164
- puts "Exception when calling SnapTrade::TransactionsAndReporting.get_reporting_custom_range: #{e}"
165
- end
166
- ```
167
-
168
- ### Parameters
169
-
170
- | Name | Type | Description | Notes |
171
- | ---- | ---- | ----------- | ----- |
172
- | **start_date** | **Date** | | |
173
- | **end_date** | **Date** | | |
174
- | **user_id** | **String** | | |
175
- | **user_secret** | **String** | | |
176
- | **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
177
- | **detailed** | **Boolean** | Optional, increases frequency of data points for the total value and contribution charts if set to true | [optional] |
178
- | **frequency** | **String** | Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly. | [optional] |
179
-
180
- ### Return type
181
-
182
- [**PerformanceCustom**](PerformanceCustom.md)
183
-
@@ -1,20 +0,0 @@
1
- # SnapTrade::TransactionsStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **initial_sync_completed** | **Boolean** | | [optional] |
8
- | **last_successful_sync** | **Date** | Date in YYYY-MM-DD format or null | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'snaptrade'
14
-
15
- instance = SnapTrade::TransactionsStatus.new(
16
- initial_sync_completed: null,
17
- last_successful_sync: Sun Jan 23 16:00:00 PST 2022
18
- )
19
- ```
20
-
data/docs/Type.md DELETED
@@ -1,15 +0,0 @@
1
- # SnapTrade::Type
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'snaptrade'
12
-
13
- instance = SnapTrade::Type.new()
14
- ```
15
-
data/docs/USExchange.md DELETED
@@ -1,34 +0,0 @@
1
- # SnapTrade::USExchange
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **code** | **String** | | [optional] |
9
- | **mic_code** | **String** | | [optional] |
10
- | **name** | **String** | | [optional] |
11
- | **timezone** | **String** | | [optional] |
12
- | **start_time** | **String** | | [optional] |
13
- | **close_time** | **String** | | [optional] |
14
- | **suffix** | **String** | | [optional] |
15
- | **allows_cryptocurrency_symbols** | **Boolean** | | [optional] |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'snaptrade'
21
-
22
- instance = SnapTrade::USExchange.new(
23
- id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
24
- code: ARCX,
25
- mic_code: ARCA,
26
- name: NYSE ARCA,
27
- timezone: America/New_York,
28
- start_time: 09:30:00,
29
- close_time: 57600,
30
- suffix: None,
31
- allows_cryptocurrency_symbols: false
32
- )
33
- ```
34
-
@@ -1,30 +0,0 @@
1
- # SnapTrade::UnderlyingSymbol
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **symbol** | **String** | | [optional] |
9
- | **description** | **String** | | [optional] |
10
- | **currency** | [**Currency**](Currency.md) | | [optional] |
11
- | **exchange** | [**USExchange**](USExchange.md) | | [optional] |
12
- | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
13
- | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | [optional] |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'snaptrade'
19
-
20
- instance = SnapTrade::UnderlyingSymbol.new(
21
- id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
22
- symbol: SPY,
23
- description: SPDR S&amp;P 500 ETF Trust,
24
- currency: null,
25
- exchange: null,
26
- type: null,
27
- currencies: null
28
- )
29
- ```
30
-
@@ -1,50 +0,0 @@
1
- # SnapTrade::UniversalActivity
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **account** | [**AccountSimple**](AccountSimple.md) | | [optional] |
9
- | **amount** | **Float** | | [optional] |
10
- | **currency** | [**Currency**](Currency.md) | | [optional] |
11
- | **description** | **String** | | [optional] |
12
- | **fee** | **Float** | | [optional] |
13
- | **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -&gt; currency) | [optional] |
14
- | **institution** | **String** | | [optional] |
15
- | **option_type** | **String** | If an option transaction, then it&#39;s type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string | [optional] |
16
- | **price** | **Float** | | [optional] |
17
- | **settlement_date** | **String** | | [optional] |
18
- | **external_reference_id** | **String** | Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id | [optional] |
19
- | **symbol** | [**Symbol**](Symbol.md) | | [optional] |
20
- | **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) | | [optional] |
21
- | **trade_date** | **String** | | [optional] |
22
- | **type** | **String** | Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
23
- | **units** | **Float** | Usually but not necessarily an integer | [optional] |
24
-
25
- ## Example
26
-
27
- ```ruby
28
- require 'snaptrade'
29
-
30
- instance = SnapTrade::UniversalActivity.new(
31
- id: 2f7dc9b3-5c33-4668-3440-2b31e056ebe6,
32
- account: null,
33
- amount: 263.82,
34
- currency: null,
35
- description: WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22,
36
- fee: 0,
37
- fx_rate: 1.032,
38
- institution: SnapTrade Investr,
39
- option_type: BUY_TO_OPEN,
40
- price: 0.4,
41
- settlement_date: 2022-01-06T05:00:00.000Z,
42
- external_reference_id: 2f7dc9b3-5c33-4668-3440-2b31e056ebe6,
43
- symbol: null,
44
- option_symbol: null,
45
- trade_date: 2022-01-06T05:00:00.000Z,
46
- type: null,
47
- units: 5
48
- )
49
- ```
50
-
@@ -1,32 +0,0 @@
1
- # SnapTrade::UniversalSymbol
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **symbol** | **String** | | |
9
- | **raw_symbol** | **String** | | |
10
- | **description** | **String** | | [optional] |
11
- | **currency** | [**Currency**](Currency.md) | | |
12
- | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
- | **type** | [**SecurityType**](SecurityType.md) | | |
14
- | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'snaptrade'
20
-
21
- instance = SnapTrade::UniversalSymbol.new(
22
- id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
23
- symbol: VAB.TO,
24
- raw_symbol: VAB,
25
- description: VANGUARD CDN AGGREGATE BOND INDEX ETF,
26
- currency: null,
27
- exchange: null,
28
- type: null,
29
- currencies: null
30
- )
31
- ```
32
-
@@ -1,32 +0,0 @@
1
- # SnapTrade::UniversalSymbolTicker
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **symbol** | **String** | | [optional] |
9
- | **raw_symbol** | **String** | | [optional] |
10
- | **description** | **String** | | [optional] |
11
- | **currency** | [**Currency**](Currency.md) | | [optional] |
12
- | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
- | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
14
- | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | [optional] |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'snaptrade'
20
-
21
- instance = SnapTrade::UniversalSymbolTicker.new(
22
- id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
23
- symbol: VAB.TO,
24
- raw_symbol: VAB,
25
- description: VANGUARD CDN AGGREGATE BOND INDEX ETF,
26
- currency: null,
27
- exchange: null,
28
- type: null,
29
- currencies: null
30
- )
31
- ```
32
-
data/docs/UserErrorLog.md DELETED
@@ -1,28 +0,0 @@
1
- # SnapTrade::UserErrorLog
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **requested_at** | **String** | | [optional] |
8
- | **response** | **String** | | [optional] |
9
- | **status_code** | **Float** | | [optional] |
10
- | **_query_params** | **String** | | [optional] |
11
- | **http_method** | **String** | | [optional] |
12
- | **endpoint** | **String** | | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'snaptrade'
18
-
19
- instance = SnapTrade::UserErrorLog.new(
20
- requested_at: 2022-01-21T20:11:19.217Z,
21
- response: null,
22
- status_code: 200,
23
- _query_params: null,
24
- http_method: POST,
25
- endpoint: api/v1/snapTrade
26
- )
27
- ```
28
-
@@ -1,20 +0,0 @@
1
- # SnapTrade::UserIDandSecret
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user | [optional] |
8
- | **user_secret** | **String** | SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'snaptrade'
14
-
15
- instance = SnapTrade::UserIDandSecret.new(
16
- user_id: snaptrade-user-123,
17
- user_secret: h81@cx1lkalablakwjaltkejraj11&#x3D;
18
- )
19
- ```
20
-
data/docs/UserSettings.md DELETED
@@ -1,36 +0,0 @@
1
- # SnapTrade::UserSettings
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **receive_cash_notification** | **Boolean** | | [optional] |
10
- | **receive_drift_notification** | **Boolean** | | [optional] |
11
- | **user_trial_activated** | **Boolean** | | [optional] |
12
- | **activated_trial_date** | **String** | | [optional] |
13
- | **demo** | **Boolean** | | [optional] |
14
- | **api_enabled** | **Boolean** | | [optional] |
15
- | **drift_threshold** | **Float** | | [optional] |
16
- | **preferred_currency** | [**Currency**](Currency.md) | | [optional] |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'snaptrade'
22
-
23
- instance = SnapTrade::UserSettings.new(
24
- email: ops@snaptrade.com,
25
- name: James Bond,
26
- receive_cash_notification: true,
27
- receive_drift_notification: true,
28
- user_trial_activated: true,
29
- activated_trial_date: 2017-07-17T15:13:07.177712+00:00,
30
- demo: false,
31
- api_enabled: false,
32
- drift_threshold: 95,
33
- preferred_currency: null
34
- )
35
- ```
36
-
@@ -1,110 +0,0 @@
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 'cgi'
12
-
13
- module SnapTrade
14
- class ErrorLogsApi
15
- attr_accessor :api_client
16
-
17
- def initialize(api_client = ApiClient.default)
18
- @api_client = api_client
19
- end
20
-
21
- # Retrieve error logs on behalf of your SnapTrade users
22
- # @param user_id [String]
23
- # @param user_secret [String]
24
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
25
- def list_user_errors(user_id:, user_secret:, extra: {})
26
- data, _status_code, _headers = list_user_errors_with_http_info_impl(user_id, user_secret, extra)
27
- data
28
- end
29
-
30
- # Retrieve error logs on behalf of your SnapTrade users
31
- # @param user_id [String]
32
- # @param user_secret [String]
33
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
34
- def list_user_errors_with_http_info(user_id:, user_secret:, extra: {})
35
- list_user_errors_with_http_info_impl(user_id, user_secret, extra)
36
- end
37
-
38
- # Retrieve error logs on behalf of your SnapTrade users
39
- # @param user_id [String]
40
- # @param user_secret [String]
41
- # @param [Hash] opts the optional parameters
42
- # @return [Array<UserErrorLog>]
43
- def list_user_errors_impl(user_id, user_secret, opts = {})
44
- data, _status_code, _headers = list_user_errors_with_http_info(user_id, user_secret, opts)
45
- data
46
- end
47
-
48
- # Retrieve error logs on behalf of your SnapTrade users
49
- # @param user_id [String]
50
- # @param user_secret [String]
51
- # @param [Hash] opts the optional parameters
52
- # @return [Array<(Array<UserErrorLog>, Integer, Hash)>] Array<UserErrorLog> data, response status code and response headers
53
- def list_user_errors_with_http_info_impl(user_id, user_secret, opts = {})
54
- if @api_client.config.debugging
55
- @api_client.config.logger.debug 'Calling API: ErrorLogsApi.list_user_errors ...'
56
- end
57
- # verify the required parameter 'user_id' is set
58
- if @api_client.config.client_side_validation && user_id.nil?
59
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ErrorLogsApi.list_user_errors"
60
- end
61
- # verify the required parameter 'user_secret' is set
62
- if @api_client.config.client_side_validation && user_secret.nil?
63
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ErrorLogsApi.list_user_errors"
64
- end
65
- # resource path
66
- local_var_path = '/snapTrade/listUserErrors'
67
-
68
- # query parameters
69
- query_params = opts[:query_params] || {}
70
- query_params[:'userId'] = user_id
71
- query_params[:'userSecret'] = user_secret
72
-
73
- # header parameters
74
- header_params = opts[:header_params] || {}
75
- # HTTP header 'Accept' (if needed)
76
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
77
-
78
- # form parameters
79
- form_params = opts[:form_params] || {}
80
-
81
- # http body (model)
82
- post_body = opts[:debug_body]
83
-
84
- # return_type
85
- return_type = opts[:debug_return_type] || 'Array<UserErrorLog>'
86
-
87
- # auth_names
88
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
89
-
90
- new_options = opts.merge(
91
- :operation => :"ErrorLogsApi.list_user_errors",
92
- :header_params => header_params,
93
- :query_params => query_params,
94
- :form_params => form_params,
95
- :body => post_body,
96
- :auth_names => auth_names,
97
- :return_type => return_type
98
- )
99
-
100
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
101
- if @api_client.config.debugging
102
- @api_client.config.logger.debug "API called: ErrorLogsApi#list_user_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
103
- end
104
- return data, status_code, headers, response
105
- end
106
- end
107
-
108
- # top-level client access to avoid having the user to insantiate their own API instances
109
- ErrorLogs = ErrorLogsApi::new
110
- end
@@ -1,38 +0,0 @@
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 'date'
12
- require 'time'
13
-
14
- module SnapTrade
15
- class Action
16
- BUY = "BUY".freeze
17
- SELL = "SELL".freeze
18
-
19
- def self.all_vars
20
- @all_vars ||= [BUY, SELL].freeze
21
- end
22
-
23
- # Builds the enum from string
24
- # @param [String] The enum value in the form of the string
25
- # @return [String] The enum value
26
- def self.build_from_hash(value)
27
- new.build_from_hash(value)
28
- end
29
-
30
- # Builds the enum from string
31
- # @param [String] The enum value in the form of the string
32
- # @return [String] The enum value
33
- def build_from_hash(value)
34
- return value if Action.all_vars.include?(value)
35
- raise "Invalid ENUM value #{value} for class #Action"
36
- end
37
- end
38
- end
@@ -1,38 +0,0 @@
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 'date'
12
- require 'time'
13
-
14
- module SnapTrade
15
- class BrokerageAuthorizationTypeReadOnlyType
16
- READ = "read".freeze
17
- TRADE = "trade".freeze
18
-
19
- def self.all_vars
20
- @all_vars ||= [READ, TRADE].freeze
21
- end
22
-
23
- # Builds the enum from string
24
- # @param [String] The enum value in the form of the string
25
- # @return [String] The enum value
26
- def self.build_from_hash(value)
27
- new.build_from_hash(value)
28
- end
29
-
30
- # Builds the enum from string
31
- # @param [String] The enum value in the form of the string
32
- # @return [String] The enum value
33
- def build_from_hash(value)
34
- return value if BrokerageAuthorizationTypeReadOnlyType.all_vars.include?(value)
35
- raise "Invalid ENUM value #{value} for class #BrokerageAuthorizationTypeReadOnlyType"
36
- end
37
- end
38
- end