snaptrade 1.12.0 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (302) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -10
  3. data/Gemfile.lock +12 -10
  4. data/README.md +220 -218
  5. data/docs/APIStatusApi.md +57 -57
  6. data/docs/AccountInformationApi.md +535 -535
  7. data/docs/AuthenticationApi.md +314 -314
  8. data/docs/BrokerageSymbol.md +28 -26
  9. data/docs/BrokerageSymbolOptionSymbol.md +38 -0
  10. data/docs/BrokerageSymbolSymbol.md +32 -0
  11. data/docs/ConnectionsApi.md +265 -265
  12. data/docs/ErrorLogsApi.md +68 -68
  13. data/docs/OptionsApi.md +378 -378
  14. data/docs/ReferenceDataApi.md +595 -595
  15. data/docs/TradingApi.md +478 -478
  16. data/docs/TransactionsAndReportingApi.md +183 -183
  17. data/docs/UniversalActivity.md +48 -48
  18. data/docs/UserIDandSecret.md +20 -20
  19. data/lib/snaptrade/api/account_information_api.rb +801 -801
  20. data/lib/snaptrade/api/api_status_api.rb +98 -98
  21. data/lib/snaptrade/api/authentication_api.rb +481 -481
  22. data/lib/snaptrade/api/connections_api.rb +398 -398
  23. data/lib/snaptrade/api/error_logs_api.rb +112 -112
  24. data/lib/snaptrade/api/options_api.rb +591 -591
  25. data/lib/snaptrade/api/reference_data_api.rb +894 -894
  26. data/lib/snaptrade/api/trading_api.rb +741 -741
  27. data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
  28. data/lib/snaptrade/api_client.rb +427 -427
  29. data/lib/snaptrade/api_client_custom.rb +32 -32
  30. data/lib/snaptrade/api_error.rb +6 -6
  31. data/lib/snaptrade/configuration.rb +334 -334
  32. data/lib/snaptrade/models/account.rb +6 -6
  33. data/lib/snaptrade/models/account_holdings.rb +6 -6
  34. data/lib/snaptrade/models/account_holdings_account.rb +6 -6
  35. data/lib/snaptrade/models/account_order_record.rb +6 -6
  36. data/lib/snaptrade/models/account_order_record_status.rb +6 -6
  37. data/lib/snaptrade/models/account_simple.rb +6 -6
  38. data/lib/snaptrade/models/account_sync_status.rb +6 -6
  39. data/lib/snaptrade/models/action.rb +6 -6
  40. data/lib/snaptrade/models/auth_type.rb +6 -6
  41. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
  42. data/lib/snaptrade/models/balance.rb +6 -6
  43. data/lib/snaptrade/models/brokerage.rb +6 -6
  44. data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
  45. data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
  46. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
  47. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
  48. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
  49. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
  50. data/lib/snaptrade/models/brokerage_symbol.rb +266 -255
  51. data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +316 -0
  52. data/lib/snaptrade/models/brokerage_symbol_symbol.rb +290 -0
  53. data/lib/snaptrade/models/brokerage_type.rb +6 -6
  54. data/lib/snaptrade/models/calculated_trade.rb +6 -6
  55. data/lib/snaptrade/models/cash_restriction.rb +6 -6
  56. data/lib/snaptrade/models/connection_type.rb +6 -6
  57. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
  58. data/lib/snaptrade/models/currency.rb +6 -6
  59. data/lib/snaptrade/models/delete_user_response.rb +6 -6
  60. data/lib/snaptrade/models/dividend_at_date.rb +6 -6
  61. data/lib/snaptrade/models/encrypted_response.rb +6 -6
  62. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
  63. data/lib/snaptrade/models/exchange.rb +6 -6
  64. data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
  65. data/lib/snaptrade/models/excluded_asset.rb +6 -6
  66. data/lib/snaptrade/models/jwt.rb +6 -6
  67. data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
  68. data/lib/snaptrade/models/manual_trade.rb +6 -6
  69. data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
  70. data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
  71. data/lib/snaptrade/models/manual_trade_form.rb +6 -6
  72. data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
  73. data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
  74. data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
  75. data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
  76. data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
  77. data/lib/snaptrade/models/model_asset_class.rb +6 -6
  78. data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
  79. data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
  80. data/lib/snaptrade/models/model_portfolio.rb +6 -6
  81. data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
  82. data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
  83. data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
  84. data/lib/snaptrade/models/model_type.rb +6 -6
  85. data/lib/snaptrade/models/monthly_dividends.rb +6 -6
  86. data/lib/snaptrade/models/net_contributions.rb +6 -6
  87. data/lib/snaptrade/models/net_dividend.rb +6 -6
  88. data/lib/snaptrade/models/option_chain_inner.rb +6 -6
  89. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
  90. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
  91. data/lib/snaptrade/models/option_leg.rb +6 -6
  92. data/lib/snaptrade/models/option_leg_action.rb +6 -6
  93. data/lib/snaptrade/models/option_strategy.rb +6 -6
  94. data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
  95. data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
  96. data/lib/snaptrade/models/options_holdings.rb +6 -6
  97. data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
  98. data/lib/snaptrade/models/options_position.rb +6 -6
  99. data/lib/snaptrade/models/options_symbol.rb +6 -6
  100. data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
  101. data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
  102. data/lib/snaptrade/models/order_type.rb +6 -6
  103. data/lib/snaptrade/models/partner_data.rb +6 -6
  104. data/lib/snaptrade/models/past_value.rb +6 -6
  105. data/lib/snaptrade/models/performance_custom.rb +6 -6
  106. data/lib/snaptrade/models/portfolio_group.rb +6 -6
  107. data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
  108. data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
  109. data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
  110. data/lib/snaptrade/models/position.rb +6 -6
  111. data/lib/snaptrade/models/position_symbol.rb +6 -6
  112. data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
  113. data/lib/snaptrade/models/security_type.rb +6 -6
  114. data/lib/snaptrade/models/session_event.rb +6 -6
  115. data/lib/snaptrade/models/session_event_type.rb +6 -6
  116. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
  117. data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
  118. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
  119. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
  120. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
  121. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
  122. data/lib/snaptrade/models/state.rb +6 -6
  123. data/lib/snaptrade/models/status.rb +6 -6
  124. data/lib/snaptrade/models/strategy_impact.rb +6 -6
  125. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
  126. data/lib/snaptrade/models/strategy_order_place.rb +6 -6
  127. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
  128. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
  129. data/lib/snaptrade/models/strategy_order_record.rb +6 -6
  130. data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
  131. data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
  132. data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
  133. data/lib/snaptrade/models/strategy_quotes.rb +6 -6
  134. data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
  135. data/lib/snaptrade/models/strategy_type.rb +6 -6
  136. data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
  137. data/lib/snaptrade/models/symbol.rb +6 -6
  138. data/lib/snaptrade/models/symbol_query.rb +6 -6
  139. data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
  140. data/lib/snaptrade/models/target_asset.rb +6 -6
  141. data/lib/snaptrade/models/time_in_force.rb +6 -6
  142. data/lib/snaptrade/models/trade.rb +6 -6
  143. data/lib/snaptrade/models/trade_action.rb +6 -6
  144. data/lib/snaptrade/models/trade_execution_status.rb +6 -6
  145. data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
  146. data/lib/snaptrade/models/trade_impact.rb +6 -6
  147. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
  148. data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
  149. data/lib/snaptrade/models/transactions_status.rb +6 -6
  150. data/lib/snaptrade/models/type.rb +6 -6
  151. data/lib/snaptrade/models/underlying_symbol.rb +6 -6
  152. data/lib/snaptrade/models/universal_activity.rb +360 -360
  153. data/lib/snaptrade/models/universal_symbol.rb +6 -6
  154. data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
  155. data/lib/snaptrade/models/us_exchange.rb +6 -6
  156. data/lib/snaptrade/models/user_error_log.rb +6 -6
  157. data/lib/snaptrade/models/user_i_dand_secret.rb +229 -229
  158. data/lib/snaptrade/models/user_settings.rb +6 -6
  159. data/lib/snaptrade/version.rb +13 -13
  160. data/lib/snaptrade.rb +213 -211
  161. data/snaptrade.gemspec +41 -41
  162. data/spec/api/account_information_api_spec.rb +135 -135
  163. data/spec/api/api_status_api_spec.rb +42 -42
  164. data/spec/api/authentication_api_spec.rb +88 -88
  165. data/spec/api/connections_api_spec.rb +82 -82
  166. data/spec/api/error_logs_api_spec.rb +43 -43
  167. data/spec/api/options_api_spec.rb +101 -101
  168. data/spec/api/reference_data_api_spec.rb +150 -150
  169. data/spec/api/trading_api_spec.rb +112 -112
  170. data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
  171. data/spec/api_client_spec.rb +193 -193
  172. data/spec/configuration_spec.rb +6 -6
  173. data/spec/getting_started_spec.rb +108 -108
  174. data/spec/models/account_holdings_account_spec.rb +54 -54
  175. data/spec/models/account_holdings_spec.rb +48 -48
  176. data/spec/models/account_order_record_spec.rb +132 -132
  177. data/spec/models/account_order_record_status_spec.rb +24 -24
  178. data/spec/models/account_simple_spec.rb +48 -48
  179. data/spec/models/account_spec.rb +84 -84
  180. data/spec/models/account_sync_status_spec.rb +30 -30
  181. data/spec/models/action_spec.rb +24 -24
  182. data/spec/models/auth_type_spec.rb +24 -24
  183. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
  184. data/spec/models/balance_spec.rb +36 -36
  185. data/spec/models/brokerage_authorization_spec.rb +78 -78
  186. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
  187. data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
  188. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
  189. data/spec/models/brokerage_authorization_type_spec.rb +30 -30
  190. data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
  191. data/spec/models/brokerage_spec.rb +132 -132
  192. data/spec/models/brokerage_symbol_option_symbol_spec.rb +90 -0
  193. data/spec/models/brokerage_symbol_spec.rb +60 -54
  194. data/spec/models/brokerage_symbol_symbol_spec.rb +72 -0
  195. data/spec/models/brokerage_type_spec.rb +36 -36
  196. data/spec/models/calculated_trade_spec.rb +36 -36
  197. data/spec/models/cash_restriction_spec.rb +54 -54
  198. data/spec/models/connection_type_spec.rb +24 -24
  199. data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
  200. data/spec/models/currency_spec.rb +42 -42
  201. data/spec/models/delete_user_response_spec.rb +36 -36
  202. data/spec/models/dividend_at_date_spec.rb +42 -42
  203. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
  204. data/spec/models/encrypted_response_spec.rb +36 -36
  205. data/spec/models/exchange_rate_pairs_spec.rb +42 -42
  206. data/spec/models/exchange_spec.rb +72 -72
  207. data/spec/models/excluded_asset_spec.rb +30 -30
  208. data/spec/models/jwt_spec.rb +30 -30
  209. data/spec/models/login_redirect_uri_spec.rb +36 -36
  210. data/spec/models/manual_trade_and_impact_spec.rb +42 -42
  211. data/spec/models/manual_trade_balance_spec.rb +42 -42
  212. data/spec/models/manual_trade_form_spec.rb +72 -72
  213. data/spec/models/manual_trade_spec.rb +72 -72
  214. data/spec/models/manual_trade_symbol_spec.rb +60 -60
  215. data/spec/models/model400_failed_request_response_spec.rb +36 -36
  216. data/spec/models/model401_failed_request_response_spec.rb +36 -36
  217. data/spec/models/model403_failed_request_response_spec.rb +36 -36
  218. data/spec/models/model404_failed_request_response_spec.rb +36 -36
  219. data/spec/models/model_asset_class_details_spec.rb +36 -36
  220. data/spec/models/model_asset_class_spec.rb +36 -36
  221. data/spec/models/model_asset_class_target_spec.rb +30 -30
  222. data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
  223. data/spec/models/model_portfolio_details_spec.rb +42 -42
  224. data/spec/models/model_portfolio_security_spec.rb +36 -36
  225. data/spec/models/model_portfolio_spec.rb +42 -42
  226. data/spec/models/model_type_spec.rb +24 -24
  227. data/spec/models/monthly_dividends_spec.rb +36 -36
  228. data/spec/models/net_contributions_spec.rb +42 -42
  229. data/spec/models/net_dividend_spec.rb +42 -42
  230. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
  231. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
  232. data/spec/models/option_chain_inner_spec.rb +54 -54
  233. data/spec/models/option_leg_action_spec.rb +24 -24
  234. data/spec/models/option_leg_spec.rb +42 -42
  235. data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
  236. data/spec/models/option_strategy_spec.rb +54 -54
  237. data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
  238. data/spec/models/options_holdings_spec.rb +60 -60
  239. data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
  240. data/spec/models/options_position_spec.rb +66 -66
  241. data/spec/models/options_symbol_spec.rb +90 -90
  242. data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
  243. data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
  244. data/spec/models/order_type_spec.rb +24 -24
  245. data/spec/models/partner_data_spec.rb +96 -96
  246. data/spec/models/past_value_spec.rb +42 -42
  247. data/spec/models/performance_custom_spec.rb +138 -138
  248. data/spec/models/portfolio_group_info_spec.rb +90 -90
  249. data/spec/models/portfolio_group_position_spec.rb +42 -42
  250. data/spec/models/portfolio_group_settings_spec.rb +54 -54
  251. data/spec/models/portfolio_group_spec.rb +36 -36
  252. data/spec/models/position_spec.rb +60 -60
  253. data/spec/models/position_symbol_spec.rb +60 -60
  254. data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
  255. data/spec/models/security_type_spec.rb +48 -48
  256. data/spec/models/session_event_spec.rb +66 -66
  257. data/spec/models/session_event_type_spec.rb +24 -24
  258. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
  259. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
  260. data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
  261. data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
  262. data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
  263. data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
  264. data/spec/models/state_spec.rb +24 -24
  265. data/spec/models/status_spec.rb +42 -42
  266. data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
  267. data/spec/models/strategy_impact_spec.rb +90 -90
  268. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
  269. data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
  270. data/spec/models/strategy_order_place_spec.rb +36 -36
  271. data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
  272. data/spec/models/strategy_order_record_spec.rb +90 -90
  273. data/spec/models/strategy_order_record_status_spec.rb +24 -24
  274. data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
  275. data/spec/models/strategy_quotes_greek_spec.rb +54 -54
  276. data/spec/models/strategy_quotes_spec.rb +60 -60
  277. data/spec/models/strategy_type_spec.rb +24 -24
  278. data/spec/models/sub_period_return_rate_spec.rb +42 -42
  279. data/spec/models/symbol_query_spec.rb +30 -30
  280. data/spec/models/symbol_spec.rb +66 -66
  281. data/spec/models/symbols_quotes_inner_spec.rb +60 -60
  282. data/spec/models/target_asset_spec.rb +60 -60
  283. data/spec/models/time_in_force_spec.rb +24 -24
  284. data/spec/models/trade_action_spec.rb +24 -24
  285. data/spec/models/trade_execution_status_action_spec.rb +24 -24
  286. data/spec/models/trade_execution_status_spec.rb +78 -78
  287. data/spec/models/trade_impact_spec.rb +54 -54
  288. data/spec/models/trade_spec.rb +72 -72
  289. data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
  290. data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
  291. data/spec/models/transactions_status_spec.rb +36 -36
  292. data/spec/models/type_spec.rb +24 -24
  293. data/spec/models/underlying_symbol_spec.rb +66 -66
  294. data/spec/models/universal_activity_spec.rb +120 -120
  295. data/spec/models/universal_symbol_spec.rb +72 -72
  296. data/spec/models/universal_symbol_ticker_spec.rb +72 -72
  297. data/spec/models/us_exchange_spec.rb +78 -78
  298. data/spec/models/user_error_log_spec.rb +60 -60
  299. data/spec/models/user_i_dand_secret_spec.rb +36 -36
  300. data/spec/models/user_settings_spec.rb +84 -84
  301. data/spec/spec_helper.rb +6 -6
  302. metadata +121 -113
@@ -1,112 +1,112 @@
1
- =begin
2
- #SnapTrade
3
-
4
- #Connect brokerage accounts to your app for live positions and trading
5
-
6
- The version of the OpenAPI document: 1.0.0
7
- Contact: api@snaptrade.com
8
-
9
- =end
10
-
11
- require '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
-
27
- data, _status_code, _headers = list_user_errors_with_http_info_impl(user_id, user_secret, extra)
28
- data
29
- end
30
-
31
- # Retrieve error logs on behalf of your SnapTrade users
32
- # @param user_id [String]
33
- # @param user_secret [String]
34
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
35
- def list_user_errors_with_http_info(user_id:, user_secret:, extra: {})
36
-
37
- list_user_errors_with_http_info_impl(user_id, user_secret, extra)
38
- end
39
-
40
- # Retrieve error logs on behalf of your SnapTrade users
41
- # @param user_id [String]
42
- # @param user_secret [String]
43
- # @param [Hash] opts the optional parameters
44
- # @return [Array<UserErrorLog>]
45
- def list_user_errors_impl(user_id, user_secret, opts = {})
46
- data, _status_code, _headers = list_user_errors_with_http_info(user_id, user_secret, opts)
47
- data
48
- end
49
-
50
- # Retrieve error logs on behalf of your SnapTrade users
51
- # @param user_id [String]
52
- # @param user_secret [String]
53
- # @param [Hash] opts the optional parameters
54
- # @return [Array<(Array<UserErrorLog>, Integer, Hash)>] Array<UserErrorLog> data, response status code and response headers
55
- def list_user_errors_with_http_info_impl(user_id, user_secret, opts = {})
56
- if @api_client.config.debugging
57
- @api_client.config.logger.debug 'Calling API: ErrorLogsApi.list_user_errors ...'
58
- end
59
- # verify the required parameter 'user_id' is set
60
- if @api_client.config.client_side_validation && user_id.nil?
61
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ErrorLogsApi.list_user_errors"
62
- end
63
- # verify the required parameter 'user_secret' is set
64
- if @api_client.config.client_side_validation && user_secret.nil?
65
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ErrorLogsApi.list_user_errors"
66
- end
67
- # resource path
68
- local_var_path = '/snapTrade/listUserErrors'
69
-
70
- # query parameters
71
- query_params = opts[:query_params] || {}
72
- query_params[:'userId'] = user_id
73
- query_params[:'userSecret'] = user_secret
74
-
75
- # header parameters
76
- header_params = opts[:header_params] || {}
77
- # HTTP header 'Accept' (if needed)
78
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
79
-
80
- # form parameters
81
- form_params = opts[:form_params] || {}
82
-
83
- # http body (model)
84
- post_body = opts[:debug_body]
85
-
86
- # return_type
87
- return_type = opts[:debug_return_type] || 'Array<UserErrorLog>'
88
-
89
- # auth_names
90
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
91
-
92
- new_options = opts.merge(
93
- :operation => :"ErrorLogsApi.list_user_errors",
94
- :header_params => header_params,
95
- :query_params => query_params,
96
- :form_params => form_params,
97
- :body => post_body,
98
- :auth_names => auth_names,
99
- :return_type => return_type
100
- )
101
-
102
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
103
- if @api_client.config.debugging
104
- @api_client.config.logger.debug "API called: ErrorLogsApi#list_user_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
105
- end
106
- return data, status_code, headers, response
107
- end
108
- end
109
-
110
- # top-level client access to avoid having the user to insantiate their own API instances
111
- ErrorLogs = ErrorLogsApi::new
112
- end
1
+ =begin
2
+ #SnapTrade
3
+
4
+ #Connect brokerage accounts to your app for live positions and trading
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@snaptrade.com
8
+
9
+ =end
10
+
11
+ require '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
+
27
+ data, _status_code, _headers = list_user_errors_with_http_info_impl(user_id, user_secret, extra)
28
+ data
29
+ end
30
+
31
+ # Retrieve error logs on behalf of your SnapTrade users
32
+ # @param user_id [String]
33
+ # @param user_secret [String]
34
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
35
+ def list_user_errors_with_http_info(user_id:, user_secret:, extra: {})
36
+
37
+ list_user_errors_with_http_info_impl(user_id, user_secret, extra)
38
+ end
39
+
40
+ # Retrieve error logs on behalf of your SnapTrade users
41
+ # @param user_id [String]
42
+ # @param user_secret [String]
43
+ # @param [Hash] opts the optional parameters
44
+ # @return [Array<UserErrorLog>]
45
+ def list_user_errors_impl(user_id, user_secret, opts = {})
46
+ data, _status_code, _headers = list_user_errors_with_http_info(user_id, user_secret, opts)
47
+ data
48
+ end
49
+
50
+ # Retrieve error logs on behalf of your SnapTrade users
51
+ # @param user_id [String]
52
+ # @param user_secret [String]
53
+ # @param [Hash] opts the optional parameters
54
+ # @return [Array<(Array<UserErrorLog>, Integer, Hash)>] Array<UserErrorLog> data, response status code and response headers
55
+ def list_user_errors_with_http_info_impl(user_id, user_secret, opts = {})
56
+ if @api_client.config.debugging
57
+ @api_client.config.logger.debug 'Calling API: ErrorLogsApi.list_user_errors ...'
58
+ end
59
+ # verify the required parameter 'user_id' is set
60
+ if @api_client.config.client_side_validation && user_id.nil?
61
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ErrorLogsApi.list_user_errors"
62
+ end
63
+ # verify the required parameter 'user_secret' is set
64
+ if @api_client.config.client_side_validation && user_secret.nil?
65
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling ErrorLogsApi.list_user_errors"
66
+ end
67
+ # resource path
68
+ local_var_path = '/snapTrade/listUserErrors'
69
+
70
+ # query parameters
71
+ query_params = opts[:query_params] || {}
72
+ query_params[:'userId'] = user_id
73
+ query_params[:'userSecret'] = user_secret
74
+
75
+ # header parameters
76
+ header_params = opts[:header_params] || {}
77
+ # HTTP header 'Accept' (if needed)
78
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
79
+
80
+ # form parameters
81
+ form_params = opts[:form_params] || {}
82
+
83
+ # http body (model)
84
+ post_body = opts[:debug_body]
85
+
86
+ # return_type
87
+ return_type = opts[:debug_return_type] || 'Array<UserErrorLog>'
88
+
89
+ # auth_names
90
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
91
+
92
+ new_options = opts.merge(
93
+ :operation => :"ErrorLogsApi.list_user_errors",
94
+ :header_params => header_params,
95
+ :query_params => query_params,
96
+ :form_params => form_params,
97
+ :body => post_body,
98
+ :auth_names => auth_names,
99
+ :return_type => return_type
100
+ )
101
+
102
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug "API called: ErrorLogsApi#list_user_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
105
+ end
106
+ return data, status_code, headers, response
107
+ end
108
+ end
109
+
110
+ # top-level client access to avoid having the user to insantiate their own API instances
111
+ ErrorLogs = ErrorLogsApi::new
112
+ end