snaptrade 2.0.7 → 2.0.8

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 (431) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +4 -9
  4. data/README.md +1680 -206
  5. data/lib/snaptrade/api/account_information_api.rb +40 -21
  6. data/lib/snaptrade/api/api_status_api.rb +6 -3
  7. data/lib/snaptrade/api/authentication_api.rb +40 -23
  8. data/lib/snaptrade/api/connections_api.rb +16 -9
  9. data/lib/snaptrade/api/error_logs_api.rb +4 -3
  10. data/lib/snaptrade/api/options_api.rb +24 -15
  11. data/lib/snaptrade/api/reference_data_api.rb +46 -23
  12. data/lib/snaptrade/api/trading_api.rb +38 -27
  13. data/lib/snaptrade/api/transactions_and_reporting_api.rb +12 -5
  14. data/lib/snaptrade/api_client.rb +24 -14
  15. data/lib/snaptrade/api_error.rb +0 -1
  16. data/lib/snaptrade/configuration.rb +11 -29
  17. data/lib/snaptrade/models/account.rb +0 -1
  18. data/lib/snaptrade/models/account_balance.rb +0 -1
  19. data/lib/snaptrade/models/account_balance_total.rb +0 -1
  20. data/lib/snaptrade/models/account_holdings.rb +0 -1
  21. data/lib/snaptrade/models/account_holdings_account.rb +0 -1
  22. data/lib/snaptrade/models/account_order_record.rb +3 -2
  23. data/lib/snaptrade/models/account_order_record_status.rb +0 -1
  24. data/lib/snaptrade/models/account_simple.rb +0 -1
  25. data/lib/snaptrade/models/account_sync_status.rb +0 -1
  26. data/lib/snaptrade/models/action.rb +0 -1
  27. data/lib/snaptrade/models/amount.rb +0 -1
  28. data/lib/snaptrade/models/auth_type.rb +0 -1
  29. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +0 -1
  30. data/lib/snaptrade/models/balance.rb +0 -1
  31. data/lib/snaptrade/models/brokerage.rb +0 -1
  32. data/lib/snaptrade/models/brokerage_authorization.rb +0 -1
  33. data/lib/snaptrade/models/brokerage_authorization_type.rb +0 -1
  34. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +0 -1
  35. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +0 -1
  36. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +0 -1
  37. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +0 -1
  38. data/lib/snaptrade/models/brokerage_symbol.rb +0 -1
  39. data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +0 -1
  40. data/lib/snaptrade/models/brokerage_symbol_symbol.rb +0 -1
  41. data/lib/snaptrade/models/brokerage_type.rb +0 -1
  42. data/lib/snaptrade/models/calculated_trade.rb +0 -1
  43. data/lib/snaptrade/models/cash_restriction.rb +0 -1
  44. data/lib/snaptrade/models/connection_portal_version.rb +0 -1
  45. data/lib/snaptrade/models/connection_type.rb +0 -1
  46. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +0 -1
  47. data/lib/snaptrade/models/currency.rb +0 -1
  48. data/lib/snaptrade/models/delete_user_response.rb +0 -1
  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 +0 -1
  53. data/lib/snaptrade/models/exchange_rate_pairs.rb +0 -1
  54. data/lib/snaptrade/models/excluded_asset.rb +0 -1
  55. data/lib/snaptrade/models/jwt.rb +0 -1
  56. data/lib/snaptrade/models/login_redirect_uri.rb +0 -1
  57. data/lib/snaptrade/models/manual_trade.rb +3 -2
  58. data/lib/snaptrade/models/manual_trade_and_impact.rb +0 -1
  59. data/lib/snaptrade/models/manual_trade_balance.rb +0 -1
  60. data/lib/snaptrade/models/manual_trade_form.rb +3 -1
  61. data/lib/snaptrade/models/manual_trade_symbol.rb +0 -1
  62. data/lib/snaptrade/models/model400_failed_request_response.rb +0 -1
  63. data/lib/snaptrade/models/model401_failed_request_response.rb +0 -1
  64. data/lib/snaptrade/models/model403_failed_request_response.rb +0 -1
  65. data/lib/snaptrade/models/model404_failed_request_response.rb +0 -1
  66. data/lib/snaptrade/models/model500_unexpected_exception_response.rb +0 -1
  67. data/lib/snaptrade/models/model_asset_class.rb +0 -1
  68. data/lib/snaptrade/models/model_asset_class_details.rb +0 -1
  69. data/lib/snaptrade/models/model_asset_class_target.rb +0 -1
  70. data/lib/snaptrade/models/model_portfolio.rb +0 -1
  71. data/lib/snaptrade/models/model_portfolio_asset_class.rb +0 -1
  72. data/lib/snaptrade/models/model_portfolio_details.rb +0 -1
  73. data/lib/snaptrade/models/model_portfolio_security.rb +0 -1
  74. data/lib/snaptrade/models/model_type.rb +0 -1
  75. data/lib/snaptrade/models/monthly_dividends.rb +0 -1
  76. data/lib/snaptrade/models/net_contributions.rb +0 -1
  77. data/lib/snaptrade/models/net_dividend.rb +0 -1
  78. data/lib/snaptrade/models/option_chain_inner.rb +0 -1
  79. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +0 -1
  80. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +0 -1
  81. data/lib/snaptrade/models/option_leg.rb +0 -1
  82. data/lib/snaptrade/models/option_leg_action.rb +0 -1
  83. data/lib/snaptrade/models/option_strategy.rb +0 -1
  84. data/lib/snaptrade/models/option_strategy_legs_inner.rb +0 -1
  85. data/lib/snaptrade/models/option_type.rb +0 -1
  86. data/lib/snaptrade/models/options_get_option_strategy_request.rb +0 -1
  87. data/lib/snaptrade/models/options_holdings.rb +0 -1
  88. data/lib/snaptrade/models/options_place_option_strategy_request.rb +2 -1
  89. data/lib/snaptrade/models/options_position.rb +0 -1
  90. data/lib/snaptrade/models/options_position_currency.rb +0 -1
  91. data/lib/snaptrade/models/options_symbol.rb +0 -1
  92. data/lib/snaptrade/models/order_type.rb +0 -1
  93. data/lib/snaptrade/models/partner_data.rb +0 -1
  94. data/lib/snaptrade/models/past_value.rb +0 -1
  95. data/lib/snaptrade/models/performance_custom.rb +0 -1
  96. data/lib/snaptrade/models/portfolio_group.rb +0 -1
  97. data/lib/snaptrade/models/portfolio_group_info.rb +0 -1
  98. data/lib/snaptrade/models/portfolio_group_position.rb +0 -1
  99. data/lib/snaptrade/models/portfolio_group_settings.rb +0 -1
  100. data/lib/snaptrade/models/position.rb +0 -1
  101. data/lib/snaptrade/models/position_symbol.rb +0 -1
  102. data/lib/snaptrade/models/redirect_tokenand_pin.rb +0 -1
  103. data/lib/snaptrade/models/security_type.rb +0 -1
  104. data/lib/snaptrade/models/session_event.rb +0 -1
  105. data/lib/snaptrade/models/session_event_type.rb +0 -1
  106. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +0 -1
  107. data/lib/snaptrade/models/snap_trade_holdings_account.rb +0 -1
  108. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +0 -1
  109. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +0 -1
  110. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +2 -1
  111. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +0 -1
  112. data/lib/snaptrade/models/state.rb +0 -1
  113. data/lib/snaptrade/models/status.rb +0 -1
  114. data/lib/snaptrade/models/strategy_impact.rb +0 -1
  115. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +0 -1
  116. data/lib/snaptrade/models/strategy_order_place.rb +0 -1
  117. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +0 -1
  118. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +0 -1
  119. data/lib/snaptrade/models/strategy_order_record.rb +1 -1
  120. data/lib/snaptrade/models/strategy_order_record_status.rb +0 -1
  121. data/lib/snaptrade/models/strategy_quotes.rb +0 -1
  122. data/lib/snaptrade/models/strategy_quotes_greek.rb +0 -1
  123. data/lib/snaptrade/models/strategy_type.rb +0 -1
  124. data/lib/snaptrade/models/sub_period_return_rate.rb +0 -1
  125. data/lib/snaptrade/models/symbol.rb +0 -1
  126. data/lib/snaptrade/models/symbol_query.rb +0 -1
  127. data/lib/snaptrade/models/symbols_quotes_inner.rb +0 -1
  128. data/lib/snaptrade/models/target_asset.rb +0 -1
  129. data/lib/snaptrade/models/time_in_force_strict.rb +0 -1
  130. data/lib/snaptrade/models/trade.rb +0 -1
  131. data/lib/snaptrade/models/trade_action.rb +0 -1
  132. data/lib/snaptrade/models/trade_execution_status.rb +2 -1
  133. data/lib/snaptrade/models/trade_execution_status_action.rb +0 -1
  134. data/lib/snaptrade/models/trade_impact.rb +0 -1
  135. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +0 -1
  136. data/lib/snaptrade/models/trading_place_oco_order_request.rb +0 -1
  137. data/lib/snaptrade/models/transactions_status.rb +0 -1
  138. data/lib/snaptrade/models/type.rb +0 -1
  139. data/lib/snaptrade/models/underlying_symbol.rb +0 -1
  140. data/lib/snaptrade/models/universal_activity.rb +0 -1
  141. data/lib/snaptrade/models/universal_symbol.rb +0 -1
  142. data/lib/snaptrade/models/us_exchange.rb +0 -1
  143. data/lib/snaptrade/models/user_error_log.rb +0 -1
  144. data/lib/snaptrade/models/user_i_dand_secret.rb +0 -1
  145. data/lib/snaptrade/models/user_settings.rb +0 -1
  146. data/lib/snaptrade/models/validated_trade_body.rb +0 -1
  147. data/lib/snaptrade/version.rb +1 -2
  148. data/lib/snaptrade.rb +50 -18
  149. data/snaptrade.gemspec +0 -1
  150. data/spec/api/account_information_api_spec.rb +0 -1
  151. data/spec/api/api_status_api_spec.rb +0 -1
  152. data/spec/api/authentication_api_spec.rb +0 -1
  153. data/spec/api/connections_api_spec.rb +0 -1
  154. data/spec/api/error_logs_api_spec.rb +0 -1
  155. data/spec/api/options_api_spec.rb +0 -1
  156. data/spec/api/reference_data_api_spec.rb +0 -1
  157. data/spec/api/trading_api_spec.rb +0 -1
  158. data/spec/api/transactions_and_reporting_api_spec.rb +0 -1
  159. data/spec/api_client_spec.rb +0 -1
  160. data/spec/configuration_spec.rb +0 -1
  161. data/spec/models/account_balance_spec.rb +0 -1
  162. data/spec/models/account_balance_total_spec.rb +0 -1
  163. data/spec/models/account_holdings_account_spec.rb +0 -1
  164. data/spec/models/account_holdings_spec.rb +0 -1
  165. data/spec/models/account_order_record_spec.rb +0 -1
  166. data/spec/models/account_order_record_status_spec.rb +0 -1
  167. data/spec/models/account_simple_spec.rb +0 -1
  168. data/spec/models/account_spec.rb +0 -1
  169. data/spec/models/account_sync_status_spec.rb +0 -1
  170. data/spec/models/action_spec.rb +0 -1
  171. data/spec/models/amount_spec.rb +0 -1
  172. data/spec/models/auth_type_spec.rb +0 -1
  173. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +0 -1
  174. data/spec/models/balance_spec.rb +0 -1
  175. data/spec/models/brokerage_authorization_spec.rb +0 -1
  176. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +0 -1
  177. data/spec/models/brokerage_authorization_type_read_only_spec.rb +0 -1
  178. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +0 -1
  179. data/spec/models/brokerage_authorization_type_spec.rb +0 -1
  180. data/spec/models/brokerage_authorization_type_type_spec.rb +0 -1
  181. data/spec/models/brokerage_spec.rb +0 -1
  182. data/spec/models/brokerage_symbol_option_symbol_spec.rb +0 -1
  183. data/spec/models/brokerage_symbol_spec.rb +0 -1
  184. data/spec/models/brokerage_symbol_symbol_spec.rb +0 -1
  185. data/spec/models/brokerage_type_spec.rb +0 -1
  186. data/spec/models/calculated_trade_spec.rb +0 -1
  187. data/spec/models/cash_restriction_spec.rb +0 -1
  188. data/spec/models/connection_portal_version_spec.rb +0 -1
  189. data/spec/models/connection_type_spec.rb +0 -1
  190. data/spec/models/connections_session_events200_response_inner_spec.rb +0 -1
  191. data/spec/models/currency_spec.rb +0 -1
  192. data/spec/models/delete_user_response_spec.rb +0 -1
  193. data/spec/models/dividend_at_date_spec.rb +0 -1
  194. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +0 -1
  195. data/spec/models/encrypted_response_spec.rb +0 -1
  196. data/spec/models/exchange_rate_pairs_spec.rb +0 -1
  197. data/spec/models/exchange_spec.rb +0 -1
  198. data/spec/models/excluded_asset_spec.rb +0 -1
  199. data/spec/models/jwt_spec.rb +0 -1
  200. data/spec/models/login_redirect_uri_spec.rb +0 -1
  201. data/spec/models/manual_trade_and_impact_spec.rb +0 -1
  202. data/spec/models/manual_trade_balance_spec.rb +0 -1
  203. data/spec/models/manual_trade_form_spec.rb +0 -1
  204. data/spec/models/manual_trade_spec.rb +0 -1
  205. data/spec/models/manual_trade_symbol_spec.rb +0 -1
  206. data/spec/models/model400_failed_request_response_spec.rb +0 -1
  207. data/spec/models/model401_failed_request_response_spec.rb +0 -1
  208. data/spec/models/model403_failed_request_response_spec.rb +0 -1
  209. data/spec/models/model404_failed_request_response_spec.rb +0 -1
  210. data/spec/models/model500_unexpected_exception_response_spec.rb +0 -1
  211. data/spec/models/model_asset_class_details_spec.rb +0 -1
  212. data/spec/models/model_asset_class_spec.rb +0 -1
  213. data/spec/models/model_asset_class_target_spec.rb +0 -1
  214. data/spec/models/model_portfolio_asset_class_spec.rb +0 -1
  215. data/spec/models/model_portfolio_details_spec.rb +0 -1
  216. data/spec/models/model_portfolio_security_spec.rb +0 -1
  217. data/spec/models/model_portfolio_spec.rb +0 -1
  218. data/spec/models/model_type_spec.rb +0 -1
  219. data/spec/models/monthly_dividends_spec.rb +0 -1
  220. data/spec/models/net_contributions_spec.rb +0 -1
  221. data/spec/models/net_dividend_spec.rb +0 -1
  222. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +0 -1
  223. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +0 -1
  224. data/spec/models/option_chain_inner_spec.rb +0 -1
  225. data/spec/models/option_leg_action_spec.rb +0 -1
  226. data/spec/models/option_leg_spec.rb +0 -1
  227. data/spec/models/option_strategy_legs_inner_spec.rb +0 -1
  228. data/spec/models/option_strategy_spec.rb +0 -1
  229. data/spec/models/option_type_spec.rb +0 -1
  230. data/spec/models/options_get_option_strategy_request_spec.rb +0 -1
  231. data/spec/models/options_holdings_spec.rb +0 -1
  232. data/spec/models/options_place_option_strategy_request_spec.rb +0 -1
  233. data/spec/models/options_position_currency_spec.rb +0 -1
  234. data/spec/models/options_position_spec.rb +0 -1
  235. data/spec/models/options_symbol_spec.rb +0 -1
  236. data/spec/models/order_type_spec.rb +0 -1
  237. data/spec/models/partner_data_spec.rb +0 -1
  238. data/spec/models/past_value_spec.rb +0 -1
  239. data/spec/models/performance_custom_spec.rb +0 -1
  240. data/spec/models/portfolio_group_info_spec.rb +0 -1
  241. data/spec/models/portfolio_group_position_spec.rb +0 -1
  242. data/spec/models/portfolio_group_settings_spec.rb +0 -1
  243. data/spec/models/portfolio_group_spec.rb +0 -1
  244. data/spec/models/position_spec.rb +0 -1
  245. data/spec/models/position_symbol_spec.rb +0 -1
  246. data/spec/models/redirect_tokenand_pin_spec.rb +0 -1
  247. data/spec/models/security_type_spec.rb +0 -1
  248. data/spec/models/session_event_spec.rb +0 -1
  249. data/spec/models/session_event_type_spec.rb +0 -1
  250. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +0 -1
  251. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +0 -1
  252. data/spec/models/snap_trade_holdings_account_spec.rb +0 -1
  253. data/spec/models/snap_trade_holdings_total_value_spec.rb +0 -1
  254. data/spec/models/snap_trade_login_user_request_body_spec.rb +0 -1
  255. data/spec/models/snap_trade_register_user_request_body_spec.rb +0 -1
  256. data/spec/models/state_spec.rb +0 -1
  257. data/spec/models/status_spec.rb +0 -1
  258. data/spec/models/strategy_impact_legs_inner_spec.rb +0 -1
  259. data/spec/models/strategy_impact_spec.rb +0 -1
  260. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +0 -1
  261. data/spec/models/strategy_order_place_orders_inner_spec.rb +0 -1
  262. data/spec/models/strategy_order_place_spec.rb +0 -1
  263. data/spec/models/strategy_order_record_spec.rb +0 -1
  264. data/spec/models/strategy_order_record_status_spec.rb +0 -1
  265. data/spec/models/strategy_quotes_greek_spec.rb +0 -1
  266. data/spec/models/strategy_quotes_spec.rb +0 -1
  267. data/spec/models/strategy_type_spec.rb +0 -1
  268. data/spec/models/sub_period_return_rate_spec.rb +0 -1
  269. data/spec/models/symbol_query_spec.rb +0 -1
  270. data/spec/models/symbol_spec.rb +0 -1
  271. data/spec/models/symbols_quotes_inner_spec.rb +0 -1
  272. data/spec/models/target_asset_spec.rb +0 -1
  273. data/spec/models/time_in_force_strict_spec.rb +0 -1
  274. data/spec/models/trade_action_spec.rb +0 -1
  275. data/spec/models/trade_execution_status_action_spec.rb +0 -1
  276. data/spec/models/trade_execution_status_spec.rb +0 -1
  277. data/spec/models/trade_impact_spec.rb +0 -1
  278. data/spec/models/trade_spec.rb +0 -1
  279. data/spec/models/trading_cancel_user_account_order_request_spec.rb +0 -1
  280. data/spec/models/trading_place_oco_order_request_spec.rb +0 -1
  281. data/spec/models/transactions_status_spec.rb +0 -1
  282. data/spec/models/type_spec.rb +0 -1
  283. data/spec/models/underlying_symbol_spec.rb +0 -1
  284. data/spec/models/universal_activity_spec.rb +0 -1
  285. data/spec/models/universal_symbol_spec.rb +0 -1
  286. data/spec/models/us_exchange_spec.rb +0 -1
  287. data/spec/models/user_error_log_spec.rb +0 -1
  288. data/spec/models/user_i_dand_secret_spec.rb +0 -1
  289. data/spec/models/user_settings_spec.rb +0 -1
  290. data/spec/models/validated_trade_body_spec.rb +0 -1
  291. data/spec/spec_helper.rb +0 -1
  292. metadata +2 -141
  293. data/docs/APIStatusApi.md +0 -57
  294. data/docs/Account.md +0 -38
  295. data/docs/AccountBalance.md +0 -18
  296. data/docs/AccountBalanceTotal.md +0 -20
  297. data/docs/AccountHoldings.md +0 -24
  298. data/docs/AccountHoldingsAccount.md +0 -26
  299. data/docs/AccountInformationApi.md +0 -544
  300. data/docs/AccountOrderRecord.md +0 -52
  301. data/docs/AccountOrderRecordStatus.md +0 -15
  302. data/docs/AccountSimple.md +0 -24
  303. data/docs/AccountSyncStatus.md +0 -18
  304. data/docs/Action.md +0 -15
  305. data/docs/Amount.md +0 -20
  306. data/docs/AuthType.md +0 -15
  307. data/docs/AuthenticationApi.md +0 -380
  308. data/docs/AuthenticationLoginSnapTradeUser200Response.md +0 -49
  309. data/docs/Balance.md +0 -22
  310. data/docs/Brokerage.md +0 -56
  311. data/docs/BrokerageAuthorization.md +0 -34
  312. data/docs/BrokerageAuthorizationType.md +0 -18
  313. data/docs/BrokerageAuthorizationTypeReadOnly.md +0 -24
  314. data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md +0 -22
  315. data/docs/BrokerageAuthorizationTypeReadOnlyType.md +0 -15
  316. data/docs/BrokerageAuthorizationTypeType.md +0 -15
  317. data/docs/BrokerageSymbol.md +0 -28
  318. data/docs/BrokerageSymbolOptionSymbol.md +0 -34
  319. data/docs/BrokerageSymbolSymbol.md +0 -34
  320. data/docs/BrokerageType.md +0 -20
  321. data/docs/CalculatedTrade.md +0 -20
  322. data/docs/CashRestriction.md +0 -26
  323. data/docs/ConnectionPortalVersion.md +0 -15
  324. data/docs/ConnectionType.md +0 -15
  325. data/docs/ConnectionsApi.md +0 -265
  326. data/docs/ConnectionsSessionEvents200ResponseInner.md +0 -30
  327. data/docs/Currency.md +0 -22
  328. data/docs/DeleteUserResponse.md +0 -20
  329. data/docs/DividendAtDate.md +0 -22
  330. data/docs/EncryptedResponse.md +0 -20
  331. data/docs/EncryptedResponseEncryptedMessageData.md +0 -22
  332. data/docs/ErrorLogsApi.md +0 -68
  333. data/docs/Exchange.md +0 -32
  334. data/docs/ExchangeRatePairs.md +0 -22
  335. data/docs/ExcludedAsset.md +0 -18
  336. data/docs/JWT.md +0 -18
  337. data/docs/LoginRedirectURI.md +0 -20
  338. data/docs/ManualTrade.md +0 -32
  339. data/docs/ManualTradeAndImpact.md +0 -22
  340. data/docs/ManualTradeBalance.md +0 -22
  341. data/docs/ManualTradeForm.md +0 -34
  342. data/docs/ManualTradeSymbol.md +0 -28
  343. data/docs/Model400FailedRequestResponse.md +0 -20
  344. data/docs/Model401FailedRequestResponse.md +0 -20
  345. data/docs/Model403FailedRequestResponse.md +0 -20
  346. data/docs/Model404FailedRequestResponse.md +0 -20
  347. data/docs/Model500UnexpectedExceptionResponse.md +0 -22
  348. data/docs/ModelAssetClass.md +0 -20
  349. data/docs/ModelAssetClassDetails.md +0 -20
  350. data/docs/ModelAssetClassTarget.md +0 -18
  351. data/docs/ModelPortfolio.md +0 -22
  352. data/docs/ModelPortfolioAssetClass.md +0 -20
  353. data/docs/ModelPortfolioDetails.md +0 -22
  354. data/docs/ModelPortfolioSecurity.md +0 -20
  355. data/docs/ModelType.md +0 -15
  356. data/docs/MonthlyDividends.md +0 -20
  357. data/docs/NetContributions.md +0 -22
  358. data/docs/NetDividend.md +0 -22
  359. data/docs/OptionChainInner.md +0 -26
  360. data/docs/OptionChainInnerChainPerRootInner.md +0 -22
  361. data/docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md +0 -22
  362. data/docs/OptionLeg.md +0 -22
  363. data/docs/OptionLegAction.md +0 -15
  364. data/docs/OptionStrategy.md +0 -26
  365. data/docs/OptionStrategyLegsInner.md +0 -24
  366. data/docs/OptionType.md +0 -15
  367. data/docs/OptionsApi.md +0 -390
  368. data/docs/OptionsGetOptionStrategyRequest.md +0 -22
  369. data/docs/OptionsHoldings.md +0 -28
  370. data/docs/OptionsPlaceOptionStrategyRequest.md +0 -22
  371. data/docs/OptionsPosition.md +0 -26
  372. data/docs/OptionsPositionCurrency.md +0 -22
  373. data/docs/OptionsSymbol.md +0 -34
  374. data/docs/OrderType.md +0 -15
  375. data/docs/PartnerData.md +0 -40
  376. data/docs/PastValue.md +0 -22
  377. data/docs/PerformanceCustom.md +0 -54
  378. data/docs/PortfolioGroup.md +0 -20
  379. data/docs/PortfolioGroupInfo.md +0 -38
  380. data/docs/PortfolioGroupPosition.md +0 -22
  381. data/docs/PortfolioGroupSettings.md +0 -26
  382. data/docs/Position.md +0 -28
  383. data/docs/PositionSymbol.md +0 -28
  384. data/docs/RedirectTokenandPin.md +0 -20
  385. data/docs/ReferenceDataApi.md +0 -592
  386. data/docs/SecurityType.md +0 -24
  387. data/docs/SessionEvent.md +0 -30
  388. data/docs/SessionEventType.md +0 -15
  389. data/docs/SnapTradeAPIDisclaimerAcceptStatus.md +0 -20
  390. data/docs/SnapTradeHoldingsAccount.md +0 -32
  391. data/docs/SnapTradeHoldingsAccountAccountId.md +0 -34
  392. data/docs/SnapTradeHoldingsTotalValue.md +0 -20
  393. data/docs/SnapTradeLoginUserRequestBody.md +0 -28
  394. data/docs/SnapTradeRegisterUserRequestBody.md +0 -18
  395. data/docs/State.md +0 -15
  396. data/docs/Status.md +0 -22
  397. data/docs/StrategyImpact.md +0 -38
  398. data/docs/StrategyImpactLegsInner.md +0 -30
  399. data/docs/StrategyOrderPlace.md +0 -20
  400. data/docs/StrategyOrderPlaceOrdersInner.md +0 -102
  401. data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md +0 -30
  402. data/docs/StrategyOrderRecord.md +0 -38
  403. data/docs/StrategyOrderRecordStatus.md +0 -15
  404. data/docs/StrategyQuotes.md +0 -28
  405. data/docs/StrategyQuotesGreek.md +0 -26
  406. data/docs/StrategyType.md +0 -15
  407. data/docs/SubPeriodReturnRate.md +0 -22
  408. data/docs/Symbol.md +0 -32
  409. data/docs/SymbolQuery.md +0 -18
  410. data/docs/SymbolsQuotesInner.md +0 -28
  411. data/docs/TargetAsset.md +0 -28
  412. data/docs/TimeInForceStrict.md +0 -15
  413. data/docs/Trade.md +0 -32
  414. data/docs/TradeAction.md +0 -15
  415. data/docs/TradeExecutionStatus.md +0 -34
  416. data/docs/TradeExecutionStatusAction.md +0 -15
  417. data/docs/TradeImpact.md +0 -26
  418. data/docs/TradingApi.md +0 -491
  419. data/docs/TradingCancelUserAccountOrderRequest.md +0 -18
  420. data/docs/TradingPlaceOCOOrderRequest.md +0 -20
  421. data/docs/TransactionsAndReportingApi.md +0 -183
  422. data/docs/TransactionsStatus.md +0 -20
  423. data/docs/Type.md +0 -15
  424. data/docs/USExchange.md +0 -34
  425. data/docs/UnderlyingSymbol.md +0 -32
  426. data/docs/UniversalActivity.md +0 -50
  427. data/docs/UniversalSymbol.md +0 -34
  428. data/docs/UserErrorLog.md +0 -28
  429. data/docs/UserIDandSecret.md +0 -20
  430. data/docs/UserSettings.md +0 -36
  431. data/docs/ValidatedTradeBody.md +0 -18
@@ -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 'cgi'
@@ -19,6 +18,7 @@ module SnapTrade
19
18
  end
20
19
 
21
20
  # List all accounts for the user, plus balances, positions, and orders for each account.
21
+ #
22
22
  # @param user_id [String]
23
23
  # @param user_secret [String]
24
24
  # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -30,6 +30,7 @@ module SnapTrade
30
30
  end
31
31
 
32
32
  # List all accounts for the user, plus balances, positions, and orders for each account.
33
+ #
33
34
  # @param user_id [String]
34
35
  # @param user_secret [String]
35
36
  # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -45,7 +46,7 @@ module SnapTrade
45
46
  # @param [Hash] opts the optional parameters
46
47
  # @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
47
48
  # @return [Array<AccountHoldings>]
48
- def get_all_user_holdings_impl(user_id, user_secret, opts = {})
49
+ private def get_all_user_holdings_impl(user_id, user_secret, opts = {})
49
50
  data, _status_code, _headers = get_all_user_holdings_with_http_info(user_id, user_secret, opts)
50
51
  data
51
52
  end
@@ -56,7 +57,7 @@ module SnapTrade
56
57
  # @param [Hash] opts the optional parameters
57
58
  # @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
58
59
  # @return [Array<(Array<AccountHoldings>, Integer, Hash)>] Array<AccountHoldings> data, response status code and response headers
59
- def get_all_user_holdings_with_http_info_impl(user_id, user_secret, opts = {})
60
+ private def get_all_user_holdings_with_http_info_impl(user_id, user_secret, opts = {})
60
61
  if @api_client.config.debugging
61
62
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_all_user_holdings ...'
62
63
  end
@@ -113,7 +114,9 @@ module SnapTrade
113
114
 
114
115
 
115
116
  # List account balances
117
+ #
116
118
  # A list of account balances for the specified account (one per currency that the account holds).
119
+ #
117
120
  # @param user_id [String]
118
121
  # @param user_secret [String]
119
122
  # @param account_id [String] The ID of the account to get balances.
@@ -124,7 +127,9 @@ module SnapTrade
124
127
  end
125
128
 
126
129
  # List account balances
130
+ #
127
131
  # A list of account balances for the specified account (one per currency that the account holds).
132
+ #
128
133
  # @param user_id [String]
129
134
  # @param user_secret [String]
130
135
  # @param account_id [String] The ID of the account to get balances.
@@ -140,7 +145,7 @@ module SnapTrade
140
145
  # @param account_id [String] The ID of the account to get balances.
141
146
  # @param [Hash] opts the optional parameters
142
147
  # @return [Array<Balance>]
143
- def get_user_account_balance_impl(user_id, user_secret, account_id, opts = {})
148
+ private def get_user_account_balance_impl(user_id, user_secret, account_id, opts = {})
144
149
  data, _status_code, _headers = get_user_account_balance_with_http_info(user_id, user_secret, account_id, opts)
145
150
  data
146
151
  end
@@ -152,7 +157,7 @@ module SnapTrade
152
157
  # @param account_id [String] The ID of the account to get balances.
153
158
  # @param [Hash] opts the optional parameters
154
159
  # @return [Array<(Array<Balance>, Integer, Hash)>] Array<Balance> data, response status code and response headers
155
- def get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, opts = {})
160
+ private def get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, opts = {})
156
161
  if @api_client.config.debugging
157
162
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_balance ...'
158
163
  end
@@ -212,6 +217,7 @@ module SnapTrade
212
217
 
213
218
 
214
219
  # Return details of a specific investment account
220
+ #
215
221
  # @param user_id [String]
216
222
  # @param user_secret [String]
217
223
  # @param account_id [String] The ID of the account to get detail of.
@@ -222,6 +228,7 @@ module SnapTrade
222
228
  end
223
229
 
224
230
  # Return details of a specific investment account
231
+ #
225
232
  # @param user_id [String]
226
233
  # @param user_secret [String]
227
234
  # @param account_id [String] The ID of the account to get detail of.
@@ -236,7 +243,7 @@ module SnapTrade
236
243
  # @param account_id [String] The ID of the account to get detail of.
237
244
  # @param [Hash] opts the optional parameters
238
245
  # @return [Account]
239
- def get_user_account_details_impl(user_id, user_secret, account_id, opts = {})
246
+ private def get_user_account_details_impl(user_id, user_secret, account_id, opts = {})
240
247
  data, _status_code, _headers = get_user_account_details_with_http_info(user_id, user_secret, account_id, opts)
241
248
  data
242
249
  end
@@ -247,7 +254,7 @@ module SnapTrade
247
254
  # @param account_id [String] The ID of the account to get detail of.
248
255
  # @param [Hash] opts the optional parameters
249
256
  # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
250
- def get_user_account_details_with_http_info_impl(user_id, user_secret, account_id, opts = {})
257
+ private def get_user_account_details_with_http_info_impl(user_id, user_secret, account_id, opts = {})
251
258
  if @api_client.config.debugging
252
259
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_details ...'
253
260
  end
@@ -307,11 +314,13 @@ module SnapTrade
307
314
 
308
315
 
309
316
  # List account orders
317
+ #
310
318
  # Fetch all recent orders from a user's account.
319
+ #
311
320
  # @param user_id [String]
312
321
  # @param user_secret [String]
313
322
  # @param account_id [String] The ID of the account to get orders.
314
- # @param state [String] defaults value is set to \&quot;all\&quot;
323
+ # @param state [String] defaults value is set to \"all\"
315
324
  # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
316
325
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
317
326
  def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
@@ -322,11 +331,13 @@ module SnapTrade
322
331
  end
323
332
 
324
333
  # List account orders
334
+ #
325
335
  # Fetch all recent orders from a user's account.
336
+ #
326
337
  # @param user_id [String]
327
338
  # @param user_secret [String]
328
339
  # @param account_id [String] The ID of the account to get orders.
329
- # @param state [String] defaults value is set to \&quot;all\&quot;
340
+ # @param state [String] defaults value is set to \"all\"
330
341
  # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
331
342
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
332
343
  def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
@@ -341,10 +352,10 @@ module SnapTrade
341
352
  # @param user_secret [String]
342
353
  # @param account_id [String] The ID of the account to get orders.
343
354
  # @param [Hash] opts the optional parameters
344
- # @option opts [String] :state defaults value is set to \&quot;all\&quot;
355
+ # @option opts [String] :state defaults value is set to \"all\"
345
356
  # @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.
346
357
  # @return [Array<AccountOrderRecord>]
347
- def get_user_account_orders_impl(user_id, user_secret, account_id, opts = {})
358
+ private def get_user_account_orders_impl(user_id, user_secret, account_id, opts = {})
348
359
  data, _status_code, _headers = get_user_account_orders_with_http_info(user_id, user_secret, account_id, opts)
349
360
  data
350
361
  end
@@ -355,10 +366,10 @@ module SnapTrade
355
366
  # @param user_secret [String]
356
367
  # @param account_id [String] The ID of the account to get orders.
357
368
  # @param [Hash] opts the optional parameters
358
- # @option opts [String] :state defaults value is set to \&quot;all\&quot;
369
+ # @option opts [String] :state defaults value is set to \"all\"
359
370
  # @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.
360
371
  # @return [Array<(Array<AccountOrderRecord>, Integer, Hash)>] Array<AccountOrderRecord> data, response status code and response headers
361
- def get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, opts = {})
372
+ private def get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, opts = {})
362
373
  if @api_client.config.debugging
363
374
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_orders ...'
364
375
  end
@@ -428,6 +439,7 @@ module SnapTrade
428
439
 
429
440
 
430
441
  # List account positions
442
+ #
431
443
  # @param user_id [String]
432
444
  # @param user_secret [String]
433
445
  # @param account_id [String] The ID of the account to get positions.
@@ -438,6 +450,7 @@ module SnapTrade
438
450
  end
439
451
 
440
452
  # List account positions
453
+ #
441
454
  # @param user_id [String]
442
455
  # @param user_secret [String]
443
456
  # @param account_id [String] The ID of the account to get positions.
@@ -452,7 +465,7 @@ module SnapTrade
452
465
  # @param account_id [String] The ID of the account to get positions.
453
466
  # @param [Hash] opts the optional parameters
454
467
  # @return [Array<Position>]
455
- def get_user_account_positions_impl(user_id, user_secret, account_id, opts = {})
468
+ private def get_user_account_positions_impl(user_id, user_secret, account_id, opts = {})
456
469
  data, _status_code, _headers = get_user_account_positions_with_http_info(user_id, user_secret, account_id, opts)
457
470
  data
458
471
  end
@@ -463,7 +476,7 @@ module SnapTrade
463
476
  # @param account_id [String] The ID of the account to get positions.
464
477
  # @param [Hash] opts the optional parameters
465
478
  # @return [Array<(Array<Position>, Integer, Hash)>] Array<Position> data, response status code and response headers
466
- def get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})
479
+ private def get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})
467
480
  if @api_client.config.debugging
468
481
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_positions ...'
469
482
  end
@@ -523,6 +536,7 @@ module SnapTrade
523
536
 
524
537
 
525
538
  # List balances, positions and orders for the specified account
539
+ #
526
540
  # @param account_id [String] The ID of the account to fetch holdings for.
527
541
  # @param user_id [String]
528
542
  # @param user_secret [String]
@@ -533,6 +547,7 @@ module SnapTrade
533
547
  end
534
548
 
535
549
  # List balances, positions and orders for the specified account
550
+ #
536
551
  # @param account_id [String] The ID of the account to fetch holdings for.
537
552
  # @param user_id [String]
538
553
  # @param user_secret [String]
@@ -547,7 +562,7 @@ module SnapTrade
547
562
  # @param user_secret [String]
548
563
  # @param [Hash] opts the optional parameters
549
564
  # @return [AccountHoldingsAccount]
550
- def get_user_holdings_impl(account_id, user_id, user_secret, opts = {})
565
+ private def get_user_holdings_impl(account_id, user_id, user_secret, opts = {})
551
566
  data, _status_code, _headers = get_user_holdings_with_http_info(account_id, user_id, user_secret, opts)
552
567
  data
553
568
  end
@@ -558,7 +573,7 @@ module SnapTrade
558
573
  # @param user_secret [String]
559
574
  # @param [Hash] opts the optional parameters
560
575
  # @return [Array<(AccountHoldingsAccount, Integer, Hash)>] AccountHoldingsAccount data, response status code and response headers
561
- def get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, opts = {})
576
+ private def get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, opts = {})
562
577
  if @api_client.config.debugging
563
578
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_holdings ...'
564
579
  end
@@ -618,6 +633,7 @@ module SnapTrade
618
633
 
619
634
 
620
635
  # List accounts
636
+ #
621
637
  # @param user_id [String]
622
638
  # @param user_secret [String]
623
639
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -627,6 +643,7 @@ module SnapTrade
627
643
  end
628
644
 
629
645
  # List accounts
646
+ #
630
647
  # @param user_id [String]
631
648
  # @param user_secret [String]
632
649
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -639,7 +656,7 @@ module SnapTrade
639
656
  # @param user_secret [String]
640
657
  # @param [Hash] opts the optional parameters
641
658
  # @return [Array<Account>]
642
- def list_user_accounts_impl(user_id, user_secret, opts = {})
659
+ private def list_user_accounts_impl(user_id, user_secret, opts = {})
643
660
  data, _status_code, _headers = list_user_accounts_with_http_info(user_id, user_secret, opts)
644
661
  data
645
662
  end
@@ -649,7 +666,7 @@ module SnapTrade
649
666
  # @param user_secret [String]
650
667
  # @param [Hash] opts the optional parameters
651
668
  # @return [Array<(Array<Account>, Integer, Hash)>] Array<Account> data, response status code and response headers
652
- def list_user_accounts_with_http_info_impl(user_id, user_secret, opts = {})
669
+ private def list_user_accounts_with_http_info_impl(user_id, user_secret, opts = {})
653
670
  if @api_client.config.debugging
654
671
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.list_user_accounts ...'
655
672
  end
@@ -705,6 +722,7 @@ module SnapTrade
705
722
 
706
723
 
707
724
  # Update details of an investment account
725
+ #
708
726
  # @param user_id [String]
709
727
  # @param user_secret [String]
710
728
  # @param account_id [String] The ID of the account to update.
@@ -715,6 +733,7 @@ module SnapTrade
715
733
  end
716
734
 
717
735
  # Update details of an investment account
736
+ #
718
737
  # @param user_id [String]
719
738
  # @param user_secret [String]
720
739
  # @param account_id [String] The ID of the account to update.
@@ -729,7 +748,7 @@ module SnapTrade
729
748
  # @param account_id [String] The ID of the account to update.
730
749
  # @param [Hash] opts the optional parameters
731
750
  # @return [Array<Account>]
732
- def update_user_account_impl(user_id, user_secret, account_id, opts = {})
751
+ private def update_user_account_impl(user_id, user_secret, account_id, opts = {})
733
752
  data, _status_code, _headers = update_user_account_with_http_info(user_id, user_secret, account_id, opts)
734
753
  data
735
754
  end
@@ -740,7 +759,7 @@ module SnapTrade
740
759
  # @param account_id [String] The ID of the account to update.
741
760
  # @param [Hash] opts the optional parameters
742
761
  # @return [Array<(Array<Account>, Integer, Hash)>] Array<Account> data, response status code and response headers
743
- def update_user_account_with_http_info_impl(user_id, user_secret, account_id, opts = {})
762
+ private def update_user_account_with_http_info_impl(user_id, user_secret, account_id, opts = {})
744
763
  if @api_client.config.debugging
745
764
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.update_user_account ...'
746
765
  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 'cgi'
@@ -19,7 +18,9 @@ module SnapTrade
19
18
  end
20
19
 
21
20
  # Get API Status
21
+ #
22
22
  # Check whether the API is operational and verify timestamps.
23
+ #
23
24
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
24
25
  def check(extra: {})
25
26
  data, _status_code, _headers = check_with_http_info_impl(extra)
@@ -27,7 +28,9 @@ module SnapTrade
27
28
  end
28
29
 
29
30
  # Get API Status
31
+ #
30
32
  # Check whether the API is operational and verify timestamps.
33
+ #
31
34
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
32
35
  def check_with_http_info(extra: {})
33
36
  check_with_http_info_impl(extra)
@@ -37,7 +40,7 @@ module SnapTrade
37
40
  # Check whether the API is operational and verify timestamps.
38
41
  # @param [Hash] opts the optional parameters
39
42
  # @return [Status]
40
- def check_impl(opts = {})
43
+ private def check_impl(opts = {})
41
44
  data, _status_code, _headers = check_with_http_info(opts)
42
45
  data
43
46
  end
@@ -46,7 +49,7 @@ module SnapTrade
46
49
  # Check whether the API is operational and verify timestamps.
47
50
  # @param [Hash] opts the optional parameters
48
51
  # @return [Array<(Status, Integer, Hash)>] Status data, response status code and response headers
49
- def check_with_http_info_impl(opts = {})
52
+ private def check_with_http_info_impl(opts = {})
50
53
  if @api_client.config.debugging
51
54
  @api_client.config.logger.debug 'Calling API: APIStatusApi.check ...'
52
55
  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 'cgi'
@@ -19,7 +18,9 @@ module SnapTrade
19
18
  end
20
19
 
21
20
  # Delete SnapTrade user
21
+ #
22
22
  # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
23
+ #
23
24
  # @param user_id [String]
24
25
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
25
26
  def delete_snap_trade_user(user_id:, extra: {})
@@ -28,7 +29,9 @@ module SnapTrade
28
29
  end
29
30
 
30
31
  # Delete SnapTrade user
32
+ #
31
33
  # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
34
+ #
32
35
  # @param user_id [String]
33
36
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
34
37
  def delete_snap_trade_user_with_http_info(user_id:, extra: {})
@@ -40,7 +43,7 @@ module SnapTrade
40
43
  # @param user_id [String]
41
44
  # @param [Hash] opts the optional parameters
42
45
  # @return [DeleteUserResponse]
43
- def delete_snap_trade_user_impl(user_id, opts = {})
46
+ private def delete_snap_trade_user_impl(user_id, opts = {})
44
47
  data, _status_code, _headers = delete_snap_trade_user_with_http_info(user_id, opts)
45
48
  data
46
49
  end
@@ -50,7 +53,7 @@ module SnapTrade
50
53
  # @param user_id [String]
51
54
  # @param [Hash] opts the optional parameters
52
55
  # @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
53
- def delete_snap_trade_user_with_http_info_impl(user_id, opts = {})
56
+ private def delete_snap_trade_user_with_http_info_impl(user_id, opts = {})
54
57
  if @api_client.config.debugging
55
58
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.delete_snap_trade_user ...'
56
59
  end
@@ -101,6 +104,7 @@ module SnapTrade
101
104
 
102
105
 
103
106
  # Generate encrypted JWT token
107
+ #
104
108
  # @param user_id [String]
105
109
  # @param user_secret [String]
106
110
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -110,6 +114,7 @@ module SnapTrade
110
114
  end
111
115
 
112
116
  # Generate encrypted JWT token
117
+ #
113
118
  # @param user_id [String]
114
119
  # @param user_secret [String]
115
120
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -122,7 +127,7 @@ module SnapTrade
122
127
  # @param user_secret [String]
123
128
  # @param [Hash] opts the optional parameters
124
129
  # @return [EncryptedResponse]
125
- def get_user_jwt_impl(user_id, user_secret, opts = {})
130
+ private def get_user_jwt_impl(user_id, user_secret, opts = {})
126
131
  data, _status_code, _headers = get_user_jwt_with_http_info(user_id, user_secret, opts)
127
132
  data
128
133
  end
@@ -132,7 +137,7 @@ module SnapTrade
132
137
  # @param user_secret [String]
133
138
  # @param [Hash] opts the optional parameters
134
139
  # @return [Array<(EncryptedResponse, Integer, Hash)>] EncryptedResponse data, response status code and response headers
135
- def get_user_jwt_with_http_info_impl(user_id, user_secret, opts = {})
140
+ private def get_user_jwt_with_http_info_impl(user_id, user_secret, opts = {})
136
141
  if @api_client.config.debugging
137
142
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_user_jwt ...'
138
143
  end
@@ -188,7 +193,9 @@ module SnapTrade
188
193
 
189
194
 
190
195
  # List SnapTrade users
196
+ #
191
197
  # Returns a list of users you've registered over the SnapTrade API.
198
+ #
192
199
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
193
200
  def list_snap_trade_users(extra: {})
194
201
  data, _status_code, _headers = list_snap_trade_users_with_http_info_impl(extra)
@@ -196,7 +203,9 @@ module SnapTrade
196
203
  end
197
204
 
198
205
  # List SnapTrade users
206
+ #
199
207
  # Returns a list of users you've registered over the SnapTrade API.
208
+ #
200
209
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
201
210
  def list_snap_trade_users_with_http_info(extra: {})
202
211
  list_snap_trade_users_with_http_info_impl(extra)
@@ -206,7 +215,7 @@ module SnapTrade
206
215
  # Returns a list of users you've registered over the SnapTrade API.
207
216
  # @param [Hash] opts the optional parameters
208
217
  # @return [Array<String>]
209
- def list_snap_trade_users_impl(opts = {})
218
+ private def list_snap_trade_users_impl(opts = {})
210
219
  data, _status_code, _headers = list_snap_trade_users_with_http_info(opts)
211
220
  data
212
221
  end
@@ -215,7 +224,7 @@ module SnapTrade
215
224
  # Returns a list of users you&#39;ve registered over the SnapTrade API.
216
225
  # @param [Hash] opts the optional parameters
217
226
  # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
218
- def list_snap_trade_users_with_http_info_impl(opts = {})
227
+ private def list_snap_trade_users_with_http_info_impl(opts = {})
219
228
  if @api_client.config.debugging
220
229
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.list_snap_trade_users ...'
221
230
  end
@@ -261,15 +270,17 @@ module SnapTrade
261
270
 
262
271
 
263
272
  # Login user & generate connection link
273
+ #
264
274
  # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
275
+ #
265
276
  # @param user_id [String]
266
277
  # @param user_secret [String]
267
278
  # @param broker [String] Slug of the brokerage to connect the user to
268
- # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
279
+ # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
269
280
  # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
270
281
  # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
271
- # @param connection_type [ConnectionType]
272
- # @param connection_portal_version [ConnectionPortalVersion]
282
+ # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
283
+ # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
273
284
  # @param body [SnapTradeLoginUserRequestBody]
274
285
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
275
286
  def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
@@ -286,15 +297,17 @@ module SnapTrade
286
297
  end
287
298
 
288
299
  # Login user & generate connection link
300
+ #
289
301
  # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
302
+ #
290
303
  # @param user_id [String]
291
304
  # @param user_secret [String]
292
305
  # @param broker [String] Slug of the brokerage to connect the user to
293
- # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
306
+ # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
294
307
  # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
295
308
  # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
296
- # @param connection_type [ConnectionType]
297
- # @param connection_portal_version [ConnectionPortalVersion]
309
+ # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
310
+ # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
298
311
  # @param body [SnapTradeLoginUserRequestBody]
299
312
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
300
313
  def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
@@ -316,7 +329,7 @@ module SnapTrade
316
329
  # @param [Hash] opts the optional parameters
317
330
  # @option opts [SnapTradeLoginUserRequestBody] :snap_trade_login_user_request_body
318
331
  # @return [AuthenticationLoginSnapTradeUser200Response]
319
- def login_snap_trade_user_impl(user_id, user_secret, opts = {})
332
+ private def login_snap_trade_user_impl(user_id, user_secret, opts = {})
320
333
  data, _status_code, _headers = login_snap_trade_user_with_http_info(user_id, user_secret, opts)
321
334
  data
322
335
  end
@@ -328,7 +341,7 @@ module SnapTrade
328
341
  # @param [Hash] opts the optional parameters
329
342
  # @option opts [SnapTradeLoginUserRequestBody] :snap_trade_login_user_request_body
330
343
  # @return [Array<(AuthenticationLoginSnapTradeUser200Response, Integer, Hash)>] AuthenticationLoginSnapTradeUser200Response data, response status code and response headers
331
- def login_snap_trade_user_with_http_info_impl(user_id, user_secret, opts = {})
344
+ private def login_snap_trade_user_with_http_info_impl(user_id, user_secret, opts = {})
332
345
  if @api_client.config.debugging
333
346
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.login_snap_trade_user ...'
334
347
  end
@@ -389,7 +402,8 @@ module SnapTrade
389
402
 
390
403
 
391
404
  # Create SnapTrade user
392
- # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
405
+ #
406
+ # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
393
407
  # @param body [SnapTradeRegisterUserRequestBody]
394
408
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
395
409
  def register_snap_trade_user(user_id: SENTINEL, extra: {})
@@ -401,7 +415,8 @@ module SnapTrade
401
415
  end
402
416
 
403
417
  # Create SnapTrade user
404
- # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
418
+ #
419
+ # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
405
420
  # @param body [SnapTradeRegisterUserRequestBody]
406
421
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
407
422
  def register_snap_trade_user_with_http_info(user_id: SENTINEL, extra: {})
@@ -415,7 +430,7 @@ module SnapTrade
415
430
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
416
431
  # @param [Hash] opts the optional parameters
417
432
  # @return [UserIDandSecret]
418
- def register_snap_trade_user_impl(snap_trade_register_user_request_body, opts = {})
433
+ private def register_snap_trade_user_impl(snap_trade_register_user_request_body, opts = {})
419
434
  data, _status_code, _headers = register_snap_trade_user_with_http_info(snap_trade_register_user_request_body, opts)
420
435
  data
421
436
  end
@@ -424,7 +439,7 @@ module SnapTrade
424
439
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
425
440
  # @param [Hash] opts the optional parameters
426
441
  # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
427
- def register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, opts = {})
442
+ private def register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, opts = {})
428
443
  if @api_client.config.debugging
429
444
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.register_snap_trade_user ...'
430
445
  end
@@ -479,7 +494,8 @@ module SnapTrade
479
494
 
480
495
 
481
496
  # Obtain a new user secret for a user
482
- # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
497
+ #
498
+ # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
483
499
  # @param 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.
484
500
  # @param body [UserIDandSecret]
485
501
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -493,7 +509,8 @@ module SnapTrade
493
509
  end
494
510
 
495
511
  # Obtain a new user secret for a user
496
- # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
512
+ #
513
+ # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
497
514
  # @param 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.
498
515
  # @param body [UserIDandSecret]
499
516
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -509,7 +526,7 @@ module SnapTrade
509
526
  # @param user_i_dand_secret [UserIDandSecret]
510
527
  # @param [Hash] opts the optional parameters
511
528
  # @return [UserIDandSecret]
512
- def reset_snap_trade_user_secret_impl(user_i_dand_secret, opts = {})
529
+ private def reset_snap_trade_user_secret_impl(user_i_dand_secret, opts = {})
513
530
  data, _status_code, _headers = reset_snap_trade_user_secret_with_http_info(user_i_dand_secret, opts)
514
531
  data
515
532
  end
@@ -518,7 +535,7 @@ module SnapTrade
518
535
  # @param user_i_dand_secret [UserIDandSecret]
519
536
  # @param [Hash] opts the optional parameters
520
537
  # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
521
- def reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, opts = {})
538
+ private def reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, opts = {})
522
539
  if @api_client.config.debugging
523
540
  @api_client.config.logger.debug 'Calling API: AuthenticationApi.reset_snap_trade_user_secret ...'
524
541
  end