snaptrade 1.16.2 → 1.16.3

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 (309) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -10
  3. data/Gemfile.lock +16 -8
  4. data/README.md +222 -221
  5. data/docs/APIStatusApi.md +57 -57
  6. data/docs/AccountInformationApi.md +535 -535
  7. data/docs/AuthenticationApi.md +314 -314
  8. data/docs/BrokerageSymbolOptionSymbol.md +7 -5
  9. data/docs/ConnectionsApi.md +265 -265
  10. data/docs/ErrorLogsApi.md +68 -68
  11. data/docs/MonthlyDividends.md +1 -1
  12. data/docs/NetContributions.md +1 -1
  13. data/docs/OptionType.md +15 -0
  14. data/docs/OptionsApi.md +378 -378
  15. data/docs/OptionsSymbol.md +7 -5
  16. data/docs/PastValue.md +1 -1
  17. data/docs/ReferenceDataApi.md +595 -595
  18. data/docs/SubPeriodReturnRate.md +2 -2
  19. data/docs/TradingApi.md +478 -478
  20. data/docs/TransactionsAndReportingApi.md +183 -183
  21. data/docs/TransactionsStatus.md +1 -1
  22. data/lib/snaptrade/api/account_information_api.rb +801 -801
  23. data/lib/snaptrade/api/api_status_api.rb +98 -98
  24. data/lib/snaptrade/api/authentication_api.rb +481 -481
  25. data/lib/snaptrade/api/connections_api.rb +398 -398
  26. data/lib/snaptrade/api/error_logs_api.rb +112 -112
  27. data/lib/snaptrade/api/options_api.rb +591 -591
  28. data/lib/snaptrade/api/reference_data_api.rb +894 -894
  29. data/lib/snaptrade/api/trading_api.rb +741 -741
  30. data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
  31. data/lib/snaptrade/api_client.rb +427 -427
  32. data/lib/snaptrade/api_client_custom.rb +32 -32
  33. data/lib/snaptrade/api_error.rb +6 -6
  34. data/lib/snaptrade/configuration.rb +341 -341
  35. data/lib/snaptrade/models/account.rb +6 -6
  36. data/lib/snaptrade/models/account_holdings.rb +6 -6
  37. data/lib/snaptrade/models/account_holdings_account.rb +6 -6
  38. data/lib/snaptrade/models/account_order_record.rb +6 -6
  39. data/lib/snaptrade/models/account_order_record_status.rb +6 -6
  40. data/lib/snaptrade/models/account_simple.rb +6 -6
  41. data/lib/snaptrade/models/account_sync_status.rb +6 -6
  42. data/lib/snaptrade/models/action.rb +6 -6
  43. data/lib/snaptrade/models/auth_type.rb +6 -6
  44. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
  45. data/lib/snaptrade/models/balance.rb +6 -6
  46. data/lib/snaptrade/models/brokerage.rb +6 -6
  47. data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
  48. data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
  49. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
  50. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
  51. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
  52. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
  53. data/lib/snaptrade/models/brokerage_symbol.rb +6 -6
  54. data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +46 -7
  55. data/lib/snaptrade/models/brokerage_symbol_symbol.rb +6 -6
  56. data/lib/snaptrade/models/brokerage_type.rb +6 -6
  57. data/lib/snaptrade/models/calculated_trade.rb +6 -6
  58. data/lib/snaptrade/models/cash_restriction.rb +6 -6
  59. data/lib/snaptrade/models/connection_type.rb +6 -6
  60. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
  61. data/lib/snaptrade/models/currency.rb +6 -6
  62. data/lib/snaptrade/models/delete_user_response.rb +6 -6
  63. data/lib/snaptrade/models/dividend_at_date.rb +6 -6
  64. data/lib/snaptrade/models/encrypted_response.rb +6 -6
  65. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
  66. data/lib/snaptrade/models/exchange.rb +6 -6
  67. data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
  68. data/lib/snaptrade/models/excluded_asset.rb +6 -6
  69. data/lib/snaptrade/models/jwt.rb +6 -6
  70. data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
  71. data/lib/snaptrade/models/manual_trade.rb +6 -6
  72. data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
  73. data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
  74. data/lib/snaptrade/models/manual_trade_form.rb +6 -6
  75. data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
  76. data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
  77. data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
  78. data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
  79. data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
  80. data/lib/snaptrade/models/model_asset_class.rb +6 -6
  81. data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
  82. data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
  83. data/lib/snaptrade/models/model_portfolio.rb +6 -6
  84. data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
  85. data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
  86. data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
  87. data/lib/snaptrade/models/model_type.rb +6 -6
  88. data/lib/snaptrade/models/monthly_dividends.rb +6 -6
  89. data/lib/snaptrade/models/net_contributions.rb +6 -6
  90. data/lib/snaptrade/models/net_dividend.rb +6 -6
  91. data/lib/snaptrade/models/option_chain_inner.rb +6 -6
  92. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
  93. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
  94. data/lib/snaptrade/models/option_leg.rb +6 -6
  95. data/lib/snaptrade/models/option_leg_action.rb +6 -6
  96. data/lib/snaptrade/models/option_strategy.rb +6 -6
  97. data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
  98. data/lib/snaptrade/models/option_type.rb +38 -0
  99. data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
  100. data/lib/snaptrade/models/options_holdings.rb +6 -6
  101. data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
  102. data/lib/snaptrade/models/options_position.rb +6 -6
  103. data/lib/snaptrade/models/options_position_currency.rb +6 -6
  104. data/lib/snaptrade/models/options_symbol.rb +46 -7
  105. data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
  106. data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
  107. data/lib/snaptrade/models/order_type.rb +6 -6
  108. data/lib/snaptrade/models/partner_data.rb +6 -6
  109. data/lib/snaptrade/models/past_value.rb +6 -6
  110. data/lib/snaptrade/models/performance_custom.rb +6 -6
  111. data/lib/snaptrade/models/portfolio_group.rb +6 -6
  112. data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
  113. data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
  114. data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
  115. data/lib/snaptrade/models/position.rb +6 -6
  116. data/lib/snaptrade/models/position_symbol.rb +6 -6
  117. data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
  118. data/lib/snaptrade/models/security_type.rb +6 -6
  119. data/lib/snaptrade/models/session_event.rb +6 -6
  120. data/lib/snaptrade/models/session_event_type.rb +6 -6
  121. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
  122. data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
  123. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
  124. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
  125. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
  126. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
  127. data/lib/snaptrade/models/state.rb +6 -6
  128. data/lib/snaptrade/models/status.rb +6 -6
  129. data/lib/snaptrade/models/strategy_impact.rb +6 -6
  130. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
  131. data/lib/snaptrade/models/strategy_order_place.rb +6 -6
  132. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
  133. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
  134. data/lib/snaptrade/models/strategy_order_record.rb +6 -6
  135. data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
  136. data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
  137. data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
  138. data/lib/snaptrade/models/strategy_quotes.rb +6 -6
  139. data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
  140. data/lib/snaptrade/models/strategy_type.rb +6 -6
  141. data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
  142. data/lib/snaptrade/models/symbol.rb +6 -6
  143. data/lib/snaptrade/models/symbol_query.rb +6 -6
  144. data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
  145. data/lib/snaptrade/models/target_asset.rb +6 -6
  146. data/lib/snaptrade/models/time_in_force.rb +6 -6
  147. data/lib/snaptrade/models/trade.rb +6 -6
  148. data/lib/snaptrade/models/trade_action.rb +6 -6
  149. data/lib/snaptrade/models/trade_execution_status.rb +6 -6
  150. data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
  151. data/lib/snaptrade/models/trade_impact.rb +6 -6
  152. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
  153. data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
  154. data/lib/snaptrade/models/transactions_status.rb +6 -6
  155. data/lib/snaptrade/models/type.rb +6 -6
  156. data/lib/snaptrade/models/underlying_symbol.rb +6 -6
  157. data/lib/snaptrade/models/universal_activity.rb +6 -6
  158. data/lib/snaptrade/models/universal_symbol.rb +6 -6
  159. data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
  160. data/lib/snaptrade/models/us_exchange.rb +6 -6
  161. data/lib/snaptrade/models/user_error_log.rb +6 -6
  162. data/lib/snaptrade/models/user_i_dand_secret.rb +6 -6
  163. data/lib/snaptrade/models/user_settings.rb +6 -6
  164. data/lib/snaptrade/version.rb +7 -7
  165. data/lib/snaptrade.rb +215 -214
  166. data/snaptrade.gemspec +41 -41
  167. data/spec/api/account_information_api_spec.rb +135 -135
  168. data/spec/api/api_status_api_spec.rb +42 -42
  169. data/spec/api/authentication_api_spec.rb +88 -88
  170. data/spec/api/connections_api_spec.rb +82 -82
  171. data/spec/api/error_logs_api_spec.rb +43 -43
  172. data/spec/api/options_api_spec.rb +101 -101
  173. data/spec/api/reference_data_api_spec.rb +150 -150
  174. data/spec/api/trading_api_spec.rb +112 -112
  175. data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
  176. data/spec/api_client_spec.rb +193 -193
  177. data/spec/configuration_spec.rb +6 -6
  178. data/spec/getting_started_spec.rb +114 -114
  179. data/spec/models/account_holdings_account_spec.rb +54 -54
  180. data/spec/models/account_holdings_spec.rb +48 -48
  181. data/spec/models/account_order_record_spec.rb +132 -132
  182. data/spec/models/account_order_record_status_spec.rb +24 -24
  183. data/spec/models/account_simple_spec.rb +48 -48
  184. data/spec/models/account_spec.rb +84 -84
  185. data/spec/models/account_sync_status_spec.rb +30 -30
  186. data/spec/models/action_spec.rb +24 -24
  187. data/spec/models/auth_type_spec.rb +24 -24
  188. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
  189. data/spec/models/balance_spec.rb +36 -36
  190. data/spec/models/brokerage_authorization_spec.rb +78 -78
  191. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
  192. data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
  193. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
  194. data/spec/models/brokerage_authorization_type_spec.rb +30 -30
  195. data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
  196. data/spec/models/brokerage_spec.rb +132 -132
  197. data/spec/models/brokerage_symbol_option_symbol_spec.rb +78 -72
  198. data/spec/models/brokerage_symbol_spec.rb +60 -60
  199. data/spec/models/brokerage_symbol_symbol_spec.rb +72 -72
  200. data/spec/models/brokerage_type_spec.rb +36 -36
  201. data/spec/models/calculated_trade_spec.rb +36 -36
  202. data/spec/models/cash_restriction_spec.rb +54 -54
  203. data/spec/models/connection_type_spec.rb +24 -24
  204. data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
  205. data/spec/models/currency_spec.rb +42 -42
  206. data/spec/models/delete_user_response_spec.rb +36 -36
  207. data/spec/models/dividend_at_date_spec.rb +42 -42
  208. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
  209. data/spec/models/encrypted_response_spec.rb +36 -36
  210. data/spec/models/exchange_rate_pairs_spec.rb +42 -42
  211. data/spec/models/exchange_spec.rb +72 -72
  212. data/spec/models/excluded_asset_spec.rb +30 -30
  213. data/spec/models/jwt_spec.rb +30 -30
  214. data/spec/models/login_redirect_uri_spec.rb +36 -36
  215. data/spec/models/manual_trade_and_impact_spec.rb +42 -42
  216. data/spec/models/manual_trade_balance_spec.rb +42 -42
  217. data/spec/models/manual_trade_form_spec.rb +72 -72
  218. data/spec/models/manual_trade_spec.rb +72 -72
  219. data/spec/models/manual_trade_symbol_spec.rb +60 -60
  220. data/spec/models/model400_failed_request_response_spec.rb +36 -36
  221. data/spec/models/model401_failed_request_response_spec.rb +36 -36
  222. data/spec/models/model403_failed_request_response_spec.rb +36 -36
  223. data/spec/models/model404_failed_request_response_spec.rb +36 -36
  224. data/spec/models/model_asset_class_details_spec.rb +36 -36
  225. data/spec/models/model_asset_class_spec.rb +36 -36
  226. data/spec/models/model_asset_class_target_spec.rb +30 -30
  227. data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
  228. data/spec/models/model_portfolio_details_spec.rb +42 -42
  229. data/spec/models/model_portfolio_security_spec.rb +36 -36
  230. data/spec/models/model_portfolio_spec.rb +42 -42
  231. data/spec/models/model_type_spec.rb +24 -24
  232. data/spec/models/monthly_dividends_spec.rb +36 -36
  233. data/spec/models/net_contributions_spec.rb +42 -42
  234. data/spec/models/net_dividend_spec.rb +42 -42
  235. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
  236. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
  237. data/spec/models/option_chain_inner_spec.rb +54 -54
  238. data/spec/models/option_leg_action_spec.rb +24 -24
  239. data/spec/models/option_leg_spec.rb +42 -42
  240. data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
  241. data/spec/models/option_strategy_spec.rb +54 -54
  242. data/spec/models/option_type_spec.rb +24 -0
  243. data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
  244. data/spec/models/options_holdings_spec.rb +60 -60
  245. data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
  246. data/spec/models/options_position_currency_spec.rb +42 -42
  247. data/spec/models/options_position_spec.rb +66 -66
  248. data/spec/models/options_symbol_spec.rb +78 -72
  249. data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
  250. data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
  251. data/spec/models/order_type_spec.rb +24 -24
  252. data/spec/models/partner_data_spec.rb +96 -96
  253. data/spec/models/past_value_spec.rb +42 -42
  254. data/spec/models/performance_custom_spec.rb +138 -138
  255. data/spec/models/portfolio_group_info_spec.rb +90 -90
  256. data/spec/models/portfolio_group_position_spec.rb +42 -42
  257. data/spec/models/portfolio_group_settings_spec.rb +54 -54
  258. data/spec/models/portfolio_group_spec.rb +36 -36
  259. data/spec/models/position_spec.rb +60 -60
  260. data/spec/models/position_symbol_spec.rb +60 -60
  261. data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
  262. data/spec/models/security_type_spec.rb +48 -48
  263. data/spec/models/session_event_spec.rb +66 -66
  264. data/spec/models/session_event_type_spec.rb +24 -24
  265. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
  266. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
  267. data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
  268. data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
  269. data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
  270. data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
  271. data/spec/models/state_spec.rb +24 -24
  272. data/spec/models/status_spec.rb +42 -42
  273. data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
  274. data/spec/models/strategy_impact_spec.rb +90 -90
  275. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
  276. data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
  277. data/spec/models/strategy_order_place_spec.rb +36 -36
  278. data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
  279. data/spec/models/strategy_order_record_spec.rb +90 -90
  280. data/spec/models/strategy_order_record_status_spec.rb +24 -24
  281. data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
  282. data/spec/models/strategy_quotes_greek_spec.rb +54 -54
  283. data/spec/models/strategy_quotes_spec.rb +60 -60
  284. data/spec/models/strategy_type_spec.rb +24 -24
  285. data/spec/models/sub_period_return_rate_spec.rb +42 -42
  286. data/spec/models/symbol_query_spec.rb +30 -30
  287. data/spec/models/symbol_spec.rb +66 -66
  288. data/spec/models/symbols_quotes_inner_spec.rb +60 -60
  289. data/spec/models/target_asset_spec.rb +60 -60
  290. data/spec/models/time_in_force_spec.rb +24 -24
  291. data/spec/models/trade_action_spec.rb +24 -24
  292. data/spec/models/trade_execution_status_action_spec.rb +24 -24
  293. data/spec/models/trade_execution_status_spec.rb +78 -78
  294. data/spec/models/trade_impact_spec.rb +54 -54
  295. data/spec/models/trade_spec.rb +72 -72
  296. data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
  297. data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
  298. data/spec/models/transactions_status_spec.rb +36 -36
  299. data/spec/models/type_spec.rb +24 -24
  300. data/spec/models/underlying_symbol_spec.rb +66 -66
  301. data/spec/models/universal_activity_spec.rb +126 -126
  302. data/spec/models/universal_symbol_spec.rb +72 -72
  303. data/spec/models/universal_symbol_ticker_spec.rb +72 -72
  304. data/spec/models/us_exchange_spec.rb +78 -78
  305. data/spec/models/user_error_log_spec.rb +60 -60
  306. data/spec/models/user_i_dand_secret_spec.rb +36 -36
  307. data/spec/models/user_settings_spec.rb +84 -84
  308. data/spec/spec_helper.rb +6 -6
  309. metadata +119 -115
@@ -1,398 +1,398 @@
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 ConnectionsApi
15
- attr_accessor :api_client
16
-
17
- def initialize(api_client = ApiClient.default)
18
- @api_client = api_client
19
- end
20
-
21
- # Get brokerage authorization details
22
- # @param authorization_id [String] The ID of a brokerage authorization object.
23
- # @param user_id [String]
24
- # @param user_secret [String]
25
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
26
- def detail_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
27
-
28
- data, _status_code, _headers = detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
29
- data
30
- end
31
-
32
- # Get brokerage authorization details
33
- # @param authorization_id [String] The ID of a brokerage authorization object.
34
- # @param user_id [String]
35
- # @param user_secret [String]
36
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
37
- def detail_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
38
-
39
- detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
40
- end
41
-
42
- # Get brokerage authorization details
43
- # @param authorization_id [String] The ID of a brokerage authorization object.
44
- # @param user_id [String]
45
- # @param user_secret [String]
46
- # @param [Hash] opts the optional parameters
47
- # @return [BrokerageAuthorization]
48
- def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
49
- data, _status_code, _headers = detail_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
50
- data
51
- end
52
-
53
- # Get brokerage authorization details
54
- # @param authorization_id [String] The ID of a brokerage authorization object.
55
- # @param user_id [String]
56
- # @param user_secret [String]
57
- # @param [Hash] opts the optional parameters
58
- # @return [Array<(BrokerageAuthorization, Integer, Hash)>] BrokerageAuthorization data, response status code and response headers
59
- def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
60
- if @api_client.config.debugging
61
- @api_client.config.logger.debug 'Calling API: ConnectionsApi.detail_brokerage_authorization ...'
62
- end
63
- # verify the required parameter 'authorization_id' is set
64
- if @api_client.config.client_side_validation && authorization_id.nil?
65
- fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.detail_brokerage_authorization"
66
- end
67
- # verify the required parameter 'user_id' is set
68
- if @api_client.config.client_side_validation && user_id.nil?
69
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.detail_brokerage_authorization"
70
- end
71
- # verify the required parameter 'user_secret' is set
72
- if @api_client.config.client_side_validation && user_secret.nil?
73
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.detail_brokerage_authorization"
74
- end
75
- # resource path
76
- local_var_path = '/authorizations/{authorizationId}'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
77
-
78
- # query parameters
79
- query_params = opts[:query_params] || {}
80
- query_params[:'userId'] = user_id
81
- query_params[:'userSecret'] = user_secret
82
-
83
- # header parameters
84
- header_params = opts[:header_params] || {}
85
- # HTTP header 'Accept' (if needed)
86
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
87
-
88
- # form parameters
89
- form_params = opts[:form_params] || {}
90
-
91
- # http body (model)
92
- post_body = opts[:debug_body]
93
-
94
- # return_type
95
- return_type = opts[:debug_return_type] || 'BrokerageAuthorization'
96
-
97
- # auth_names
98
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
99
-
100
- new_options = opts.merge(
101
- :operation => :"ConnectionsApi.detail_brokerage_authorization",
102
- :header_params => header_params,
103
- :query_params => query_params,
104
- :form_params => form_params,
105
- :body => post_body,
106
- :auth_names => auth_names,
107
- :return_type => return_type
108
- )
109
-
110
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
111
- if @api_client.config.debugging
112
- @api_client.config.logger.debug "API called: ConnectionsApi#detail_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
113
- end
114
- return data, status_code, headers, response
115
- end
116
-
117
-
118
- # List all brokerage authorizations for the user
119
- # @param user_id [String]
120
- # @param user_secret [String]
121
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
122
- def list_brokerage_authorizations(user_id:, user_secret:, extra: {})
123
-
124
- data, _status_code, _headers = list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
125
- data
126
- end
127
-
128
- # List all brokerage authorizations for the user
129
- # @param user_id [String]
130
- # @param user_secret [String]
131
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
132
- def list_brokerage_authorizations_with_http_info(user_id:, user_secret:, extra: {})
133
-
134
- list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
135
- end
136
-
137
- # List all brokerage authorizations for the user
138
- # @param user_id [String]
139
- # @param user_secret [String]
140
- # @param [Hash] opts the optional parameters
141
- # @return [Array<BrokerageAuthorization>]
142
- def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
143
- data, _status_code, _headers = list_brokerage_authorizations_with_http_info(user_id, user_secret, opts)
144
- data
145
- end
146
-
147
- # List all brokerage authorizations for the user
148
- # @param user_id [String]
149
- # @param user_secret [String]
150
- # @param [Hash] opts the optional parameters
151
- # @return [Array<(Array<BrokerageAuthorization>, Integer, Hash)>] Array<BrokerageAuthorization> data, response status code and response headers
152
- def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
153
- if @api_client.config.debugging
154
- @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_brokerage_authorizations ...'
155
- end
156
- # verify the required parameter 'user_id' is set
157
- if @api_client.config.client_side_validation && user_id.nil?
158
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.list_brokerage_authorizations"
159
- end
160
- # verify the required parameter 'user_secret' is set
161
- if @api_client.config.client_side_validation && user_secret.nil?
162
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.list_brokerage_authorizations"
163
- end
164
- # resource path
165
- local_var_path = '/authorizations'
166
-
167
- # query parameters
168
- query_params = opts[:query_params] || {}
169
- query_params[:'userId'] = user_id
170
- query_params[:'userSecret'] = user_secret
171
-
172
- # header parameters
173
- header_params = opts[:header_params] || {}
174
- # HTTP header 'Accept' (if needed)
175
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
176
-
177
- # form parameters
178
- form_params = opts[:form_params] || {}
179
-
180
- # http body (model)
181
- post_body = opts[:debug_body]
182
-
183
- # return_type
184
- return_type = opts[:debug_return_type] || 'Array<BrokerageAuthorization>'
185
-
186
- # auth_names
187
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
188
-
189
- new_options = opts.merge(
190
- :operation => :"ConnectionsApi.list_brokerage_authorizations",
191
- :header_params => header_params,
192
- :query_params => query_params,
193
- :form_params => form_params,
194
- :body => post_body,
195
- :auth_names => auth_names,
196
- :return_type => return_type
197
- )
198
-
199
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
200
- if @api_client.config.debugging
201
- @api_client.config.logger.debug "API called: ConnectionsApi#list_brokerage_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
202
- end
203
- return data, status_code, headers, response
204
- end
205
-
206
-
207
- # Delete brokerage authorization
208
- # @param authorization_id [String] The ID of the Authorization to delete.
209
- # @param user_id [String]
210
- # @param user_secret [String]
211
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
212
- def remove_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
213
-
214
- remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
215
- nil
216
- end
217
-
218
- # Delete brokerage authorization
219
- # @param authorization_id [String] The ID of the Authorization to delete.
220
- # @param user_id [String]
221
- # @param user_secret [String]
222
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
223
- def remove_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
224
-
225
- remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
226
- end
227
-
228
- # Delete brokerage authorization
229
- # @param authorization_id [String] The ID of the Authorization to delete.
230
- # @param user_id [String]
231
- # @param user_secret [String]
232
- # @param [Hash] opts the optional parameters
233
- # @return [nil]
234
- def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
235
- remove_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
236
- nil
237
- end
238
-
239
- # Delete brokerage authorization
240
- # @param authorization_id [String] The ID of the Authorization to delete.
241
- # @param user_id [String]
242
- # @param user_secret [String]
243
- # @param [Hash] opts the optional parameters
244
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
245
- def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
246
- if @api_client.config.debugging
247
- @api_client.config.logger.debug 'Calling API: ConnectionsApi.remove_brokerage_authorization ...'
248
- end
249
- # verify the required parameter 'authorization_id' is set
250
- if @api_client.config.client_side_validation && authorization_id.nil?
251
- fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.remove_brokerage_authorization"
252
- end
253
- # verify the required parameter 'user_id' is set
254
- if @api_client.config.client_side_validation && user_id.nil?
255
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.remove_brokerage_authorization"
256
- end
257
- # verify the required parameter 'user_secret' is set
258
- if @api_client.config.client_side_validation && user_secret.nil?
259
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.remove_brokerage_authorization"
260
- end
261
- # resource path
262
- local_var_path = '/authorizations/{authorizationId}'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
263
-
264
- # query parameters
265
- query_params = opts[:query_params] || {}
266
- query_params[:'userId'] = user_id
267
- query_params[:'userSecret'] = user_secret
268
-
269
- # header parameters
270
- header_params = opts[:header_params] || {}
271
-
272
- # form parameters
273
- form_params = opts[:form_params] || {}
274
-
275
- # http body (model)
276
- post_body = opts[:debug_body]
277
-
278
- # return_type
279
- return_type = opts[:debug_return_type]
280
-
281
- # auth_names
282
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
283
-
284
- new_options = opts.merge(
285
- :operation => :"ConnectionsApi.remove_brokerage_authorization",
286
- :header_params => header_params,
287
- :query_params => query_params,
288
- :form_params => form_params,
289
- :body => post_body,
290
- :auth_names => auth_names,
291
- :return_type => return_type
292
- )
293
-
294
- data, status_code, headers, response = @api_client.call_api(:DELETE, local_var_path, new_options)
295
- if @api_client.config.debugging
296
- @api_client.config.logger.debug "API called: ConnectionsApi#remove_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
297
- end
298
- return data, status_code, headers, response
299
- end
300
-
301
-
302
- # List all session events for the partner
303
- # @param partner_client_id [String]
304
- # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
305
- # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
306
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
307
- def session_events(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
308
- extra[:user_id] = user_id if user_id != SENTINEL
309
- extra[:session_id] = session_id if session_id != SENTINEL
310
-
311
- data, _status_code, _headers = session_events_with_http_info_impl(partner_client_id, extra)
312
- data
313
- end
314
-
315
- # List all session events for the partner
316
- # @param partner_client_id [String]
317
- # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
318
- # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
319
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
320
- def session_events_with_http_info(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
321
- extra[:user_id] = user_id if user_id != SENTINEL
322
- extra[:session_id] = session_id if session_id != SENTINEL
323
-
324
- session_events_with_http_info_impl(partner_client_id, extra)
325
- end
326
-
327
- # List all session events for the partner
328
- # @param partner_client_id [String]
329
- # @param [Hash] opts the optional parameters
330
- # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
331
- # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
332
- # @return [Array<ConnectionsSessionEvents200ResponseInner>]
333
- def session_events_impl(partner_client_id, opts = {})
334
- data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
335
- data
336
- end
337
-
338
- # List all session events for the partner
339
- # @param partner_client_id [String]
340
- # @param [Hash] opts the optional parameters
341
- # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
342
- # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
343
- # @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
344
- def session_events_with_http_info_impl(partner_client_id, opts = {})
345
- if @api_client.config.debugging
346
- @api_client.config.logger.debug 'Calling API: ConnectionsApi.session_events ...'
347
- end
348
- # verify the required parameter 'partner_client_id' is set
349
- if @api_client.config.client_side_validation && partner_client_id.nil?
350
- fail ArgumentError, "Missing the required parameter 'partner_client_id' when calling ConnectionsApi.session_events"
351
- end
352
- # resource path
353
- local_var_path = '/sessionEvents'
354
-
355
- # query parameters
356
- query_params = opts[:query_params] || {}
357
- query_params[:'PartnerClientId'] = partner_client_id
358
- query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
359
- query_params[:'sessionId'] = opts[:'session_id'] if !opts[:'session_id'].nil?
360
-
361
- # header parameters
362
- header_params = opts[:header_params] || {}
363
- # HTTP header 'Accept' (if needed)
364
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
365
-
366
- # form parameters
367
- form_params = opts[:form_params] || {}
368
-
369
- # http body (model)
370
- post_body = opts[:debug_body]
371
-
372
- # return_type
373
- return_type = opts[:debug_return_type] || 'Array<ConnectionsSessionEvents200ResponseInner>'
374
-
375
- # auth_names
376
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
377
-
378
- new_options = opts.merge(
379
- :operation => :"ConnectionsApi.session_events",
380
- :header_params => header_params,
381
- :query_params => query_params,
382
- :form_params => form_params,
383
- :body => post_body,
384
- :auth_names => auth_names,
385
- :return_type => return_type
386
- )
387
-
388
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
389
- if @api_client.config.debugging
390
- @api_client.config.logger.debug "API called: ConnectionsApi#session_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
391
- end
392
- return data, status_code, headers, response
393
- end
394
- end
395
-
396
- # top-level client access to avoid having the user to insantiate their own API instances
397
- Connections = ConnectionsApi::new
398
- 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 ConnectionsApi
15
+ attr_accessor :api_client
16
+
17
+ def initialize(api_client = ApiClient.default)
18
+ @api_client = api_client
19
+ end
20
+
21
+ # Get brokerage authorization details
22
+ # @param authorization_id [String] The ID of a brokerage authorization object.
23
+ # @param user_id [String]
24
+ # @param user_secret [String]
25
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
26
+ def detail_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
27
+
28
+ data, _status_code, _headers = detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
29
+ data
30
+ end
31
+
32
+ # Get brokerage authorization details
33
+ # @param authorization_id [String] The ID of a brokerage authorization object.
34
+ # @param user_id [String]
35
+ # @param user_secret [String]
36
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
37
+ def detail_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
38
+
39
+ detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
40
+ end
41
+
42
+ # Get brokerage authorization details
43
+ # @param authorization_id [String] The ID of a brokerage authorization object.
44
+ # @param user_id [String]
45
+ # @param user_secret [String]
46
+ # @param [Hash] opts the optional parameters
47
+ # @return [BrokerageAuthorization]
48
+ def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
49
+ data, _status_code, _headers = detail_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
50
+ data
51
+ end
52
+
53
+ # Get brokerage authorization details
54
+ # @param authorization_id [String] The ID of a brokerage authorization object.
55
+ # @param user_id [String]
56
+ # @param user_secret [String]
57
+ # @param [Hash] opts the optional parameters
58
+ # @return [Array<(BrokerageAuthorization, Integer, Hash)>] BrokerageAuthorization data, response status code and response headers
59
+ def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
60
+ if @api_client.config.debugging
61
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.detail_brokerage_authorization ...'
62
+ end
63
+ # verify the required parameter 'authorization_id' is set
64
+ if @api_client.config.client_side_validation && authorization_id.nil?
65
+ fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.detail_brokerage_authorization"
66
+ end
67
+ # verify the required parameter 'user_id' is set
68
+ if @api_client.config.client_side_validation && user_id.nil?
69
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.detail_brokerage_authorization"
70
+ end
71
+ # verify the required parameter 'user_secret' is set
72
+ if @api_client.config.client_side_validation && user_secret.nil?
73
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.detail_brokerage_authorization"
74
+ end
75
+ # resource path
76
+ local_var_path = '/authorizations/{authorizationId}'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
77
+
78
+ # query parameters
79
+ query_params = opts[:query_params] || {}
80
+ query_params[:'userId'] = user_id
81
+ query_params[:'userSecret'] = user_secret
82
+
83
+ # header parameters
84
+ header_params = opts[:header_params] || {}
85
+ # HTTP header 'Accept' (if needed)
86
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
87
+
88
+ # form parameters
89
+ form_params = opts[:form_params] || {}
90
+
91
+ # http body (model)
92
+ post_body = opts[:debug_body]
93
+
94
+ # return_type
95
+ return_type = opts[:debug_return_type] || 'BrokerageAuthorization'
96
+
97
+ # auth_names
98
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
99
+
100
+ new_options = opts.merge(
101
+ :operation => :"ConnectionsApi.detail_brokerage_authorization",
102
+ :header_params => header_params,
103
+ :query_params => query_params,
104
+ :form_params => form_params,
105
+ :body => post_body,
106
+ :auth_names => auth_names,
107
+ :return_type => return_type
108
+ )
109
+
110
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
111
+ if @api_client.config.debugging
112
+ @api_client.config.logger.debug "API called: ConnectionsApi#detail_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
113
+ end
114
+ return data, status_code, headers, response
115
+ end
116
+
117
+
118
+ # List all brokerage authorizations for the user
119
+ # @param user_id [String]
120
+ # @param user_secret [String]
121
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
122
+ def list_brokerage_authorizations(user_id:, user_secret:, extra: {})
123
+
124
+ data, _status_code, _headers = list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
125
+ data
126
+ end
127
+
128
+ # List all brokerage authorizations for the user
129
+ # @param user_id [String]
130
+ # @param user_secret [String]
131
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
132
+ def list_brokerage_authorizations_with_http_info(user_id:, user_secret:, extra: {})
133
+
134
+ list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
135
+ end
136
+
137
+ # List all brokerage authorizations for the user
138
+ # @param user_id [String]
139
+ # @param user_secret [String]
140
+ # @param [Hash] opts the optional parameters
141
+ # @return [Array<BrokerageAuthorization>]
142
+ def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
143
+ data, _status_code, _headers = list_brokerage_authorizations_with_http_info(user_id, user_secret, opts)
144
+ data
145
+ end
146
+
147
+ # List all brokerage authorizations for the user
148
+ # @param user_id [String]
149
+ # @param user_secret [String]
150
+ # @param [Hash] opts the optional parameters
151
+ # @return [Array<(Array<BrokerageAuthorization>, Integer, Hash)>] Array<BrokerageAuthorization> data, response status code and response headers
152
+ def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_brokerage_authorizations ...'
155
+ end
156
+ # verify the required parameter 'user_id' is set
157
+ if @api_client.config.client_side_validation && user_id.nil?
158
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.list_brokerage_authorizations"
159
+ end
160
+ # verify the required parameter 'user_secret' is set
161
+ if @api_client.config.client_side_validation && user_secret.nil?
162
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.list_brokerage_authorizations"
163
+ end
164
+ # resource path
165
+ local_var_path = '/authorizations'
166
+
167
+ # query parameters
168
+ query_params = opts[:query_params] || {}
169
+ query_params[:'userId'] = user_id
170
+ query_params[:'userSecret'] = user_secret
171
+
172
+ # header parameters
173
+ header_params = opts[:header_params] || {}
174
+ # HTTP header 'Accept' (if needed)
175
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
176
+
177
+ # form parameters
178
+ form_params = opts[:form_params] || {}
179
+
180
+ # http body (model)
181
+ post_body = opts[:debug_body]
182
+
183
+ # return_type
184
+ return_type = opts[:debug_return_type] || 'Array<BrokerageAuthorization>'
185
+
186
+ # auth_names
187
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
188
+
189
+ new_options = opts.merge(
190
+ :operation => :"ConnectionsApi.list_brokerage_authorizations",
191
+ :header_params => header_params,
192
+ :query_params => query_params,
193
+ :form_params => form_params,
194
+ :body => post_body,
195
+ :auth_names => auth_names,
196
+ :return_type => return_type
197
+ )
198
+
199
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
200
+ if @api_client.config.debugging
201
+ @api_client.config.logger.debug "API called: ConnectionsApi#list_brokerage_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
202
+ end
203
+ return data, status_code, headers, response
204
+ end
205
+
206
+
207
+ # Delete brokerage authorization
208
+ # @param authorization_id [String] The ID of the Authorization to delete.
209
+ # @param user_id [String]
210
+ # @param user_secret [String]
211
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
212
+ def remove_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
213
+
214
+ remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
215
+ nil
216
+ end
217
+
218
+ # Delete brokerage authorization
219
+ # @param authorization_id [String] The ID of the Authorization to delete.
220
+ # @param user_id [String]
221
+ # @param user_secret [String]
222
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
223
+ def remove_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
224
+
225
+ remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
226
+ end
227
+
228
+ # Delete brokerage authorization
229
+ # @param authorization_id [String] The ID of the Authorization to delete.
230
+ # @param user_id [String]
231
+ # @param user_secret [String]
232
+ # @param [Hash] opts the optional parameters
233
+ # @return [nil]
234
+ def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
235
+ remove_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
236
+ nil
237
+ end
238
+
239
+ # Delete brokerage authorization
240
+ # @param authorization_id [String] The ID of the Authorization to delete.
241
+ # @param user_id [String]
242
+ # @param user_secret [String]
243
+ # @param [Hash] opts the optional parameters
244
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
245
+ def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
246
+ if @api_client.config.debugging
247
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.remove_brokerage_authorization ...'
248
+ end
249
+ # verify the required parameter 'authorization_id' is set
250
+ if @api_client.config.client_side_validation && authorization_id.nil?
251
+ fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.remove_brokerage_authorization"
252
+ end
253
+ # verify the required parameter 'user_id' is set
254
+ if @api_client.config.client_side_validation && user_id.nil?
255
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.remove_brokerage_authorization"
256
+ end
257
+ # verify the required parameter 'user_secret' is set
258
+ if @api_client.config.client_side_validation && user_secret.nil?
259
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.remove_brokerage_authorization"
260
+ end
261
+ # resource path
262
+ local_var_path = '/authorizations/{authorizationId}'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
263
+
264
+ # query parameters
265
+ query_params = opts[:query_params] || {}
266
+ query_params[:'userId'] = user_id
267
+ query_params[:'userSecret'] = user_secret
268
+
269
+ # header parameters
270
+ header_params = opts[:header_params] || {}
271
+
272
+ # form parameters
273
+ form_params = opts[:form_params] || {}
274
+
275
+ # http body (model)
276
+ post_body = opts[:debug_body]
277
+
278
+ # return_type
279
+ return_type = opts[:debug_return_type]
280
+
281
+ # auth_names
282
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
283
+
284
+ new_options = opts.merge(
285
+ :operation => :"ConnectionsApi.remove_brokerage_authorization",
286
+ :header_params => header_params,
287
+ :query_params => query_params,
288
+ :form_params => form_params,
289
+ :body => post_body,
290
+ :auth_names => auth_names,
291
+ :return_type => return_type
292
+ )
293
+
294
+ data, status_code, headers, response = @api_client.call_api(:DELETE, local_var_path, new_options)
295
+ if @api_client.config.debugging
296
+ @api_client.config.logger.debug "API called: ConnectionsApi#remove_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
297
+ end
298
+ return data, status_code, headers, response
299
+ end
300
+
301
+
302
+ # List all session events for the partner
303
+ # @param partner_client_id [String]
304
+ # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
305
+ # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
306
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
307
+ def session_events(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
308
+ extra[:user_id] = user_id if user_id != SENTINEL
309
+ extra[:session_id] = session_id if session_id != SENTINEL
310
+
311
+ data, _status_code, _headers = session_events_with_http_info_impl(partner_client_id, extra)
312
+ data
313
+ end
314
+
315
+ # List all session events for the partner
316
+ # @param partner_client_id [String]
317
+ # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
318
+ # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
319
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
320
+ def session_events_with_http_info(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
321
+ extra[:user_id] = user_id if user_id != SENTINEL
322
+ extra[:session_id] = session_id if session_id != SENTINEL
323
+
324
+ session_events_with_http_info_impl(partner_client_id, extra)
325
+ end
326
+
327
+ # List all session events for the partner
328
+ # @param partner_client_id [String]
329
+ # @param [Hash] opts the optional parameters
330
+ # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
331
+ # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
332
+ # @return [Array<ConnectionsSessionEvents200ResponseInner>]
333
+ def session_events_impl(partner_client_id, opts = {})
334
+ data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
335
+ data
336
+ end
337
+
338
+ # List all session events for the partner
339
+ # @param partner_client_id [String]
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
342
+ # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
343
+ # @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
344
+ def session_events_with_http_info_impl(partner_client_id, opts = {})
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug 'Calling API: ConnectionsApi.session_events ...'
347
+ end
348
+ # verify the required parameter 'partner_client_id' is set
349
+ if @api_client.config.client_side_validation && partner_client_id.nil?
350
+ fail ArgumentError, "Missing the required parameter 'partner_client_id' when calling ConnectionsApi.session_events"
351
+ end
352
+ # resource path
353
+ local_var_path = '/sessionEvents'
354
+
355
+ # query parameters
356
+ query_params = opts[:query_params] || {}
357
+ query_params[:'PartnerClientId'] = partner_client_id
358
+ query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
359
+ query_params[:'sessionId'] = opts[:'session_id'] if !opts[:'session_id'].nil?
360
+
361
+ # header parameters
362
+ header_params = opts[:header_params] || {}
363
+ # HTTP header 'Accept' (if needed)
364
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
365
+
366
+ # form parameters
367
+ form_params = opts[:form_params] || {}
368
+
369
+ # http body (model)
370
+ post_body = opts[:debug_body]
371
+
372
+ # return_type
373
+ return_type = opts[:debug_return_type] || 'Array<ConnectionsSessionEvents200ResponseInner>'
374
+
375
+ # auth_names
376
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
377
+
378
+ new_options = opts.merge(
379
+ :operation => :"ConnectionsApi.session_events",
380
+ :header_params => header_params,
381
+ :query_params => query_params,
382
+ :form_params => form_params,
383
+ :body => post_body,
384
+ :auth_names => auth_names,
385
+ :return_type => return_type
386
+ )
387
+
388
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
389
+ if @api_client.config.debugging
390
+ @api_client.config.logger.debug "API called: ConnectionsApi#session_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
391
+ end
392
+ return data, status_code, headers, response
393
+ end
394
+ end
395
+
396
+ # top-level client access to avoid having the user to insantiate their own API instances
397
+ Connections = ConnectionsApi::new
398
+ end