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.
- checksums.yaml +4 -4
- data/Gemfile +10 -10
- data/Gemfile.lock +16 -8
- data/README.md +222 -221
- data/docs/APIStatusApi.md +57 -57
- data/docs/AccountInformationApi.md +535 -535
- data/docs/AuthenticationApi.md +314 -314
- data/docs/BrokerageSymbolOptionSymbol.md +7 -5
- data/docs/ConnectionsApi.md +265 -265
- data/docs/ErrorLogsApi.md +68 -68
- data/docs/MonthlyDividends.md +1 -1
- data/docs/NetContributions.md +1 -1
- data/docs/OptionType.md +15 -0
- data/docs/OptionsApi.md +378 -378
- data/docs/OptionsSymbol.md +7 -5
- data/docs/PastValue.md +1 -1
- data/docs/ReferenceDataApi.md +595 -595
- data/docs/SubPeriodReturnRate.md +2 -2
- data/docs/TradingApi.md +478 -478
- data/docs/TransactionsAndReportingApi.md +183 -183
- data/docs/TransactionsStatus.md +1 -1
- data/lib/snaptrade/api/account_information_api.rb +801 -801
- data/lib/snaptrade/api/api_status_api.rb +98 -98
- data/lib/snaptrade/api/authentication_api.rb +481 -481
- data/lib/snaptrade/api/connections_api.rb +398 -398
- data/lib/snaptrade/api/error_logs_api.rb +112 -112
- data/lib/snaptrade/api/options_api.rb +591 -591
- data/lib/snaptrade/api/reference_data_api.rb +894 -894
- data/lib/snaptrade/api/trading_api.rb +741 -741
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
- data/lib/snaptrade/api_client.rb +427 -427
- data/lib/snaptrade/api_client_custom.rb +32 -32
- data/lib/snaptrade/api_error.rb +6 -6
- data/lib/snaptrade/configuration.rb +341 -341
- data/lib/snaptrade/models/account.rb +6 -6
- data/lib/snaptrade/models/account_holdings.rb +6 -6
- data/lib/snaptrade/models/account_holdings_account.rb +6 -6
- data/lib/snaptrade/models/account_order_record.rb +6 -6
- data/lib/snaptrade/models/account_order_record_status.rb +6 -6
- data/lib/snaptrade/models/account_simple.rb +6 -6
- data/lib/snaptrade/models/account_sync_status.rb +6 -6
- data/lib/snaptrade/models/action.rb +6 -6
- data/lib/snaptrade/models/auth_type.rb +6 -6
- data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
- data/lib/snaptrade/models/balance.rb +6 -6
- data/lib/snaptrade/models/brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_symbol.rb +6 -6
- data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +46 -7
- data/lib/snaptrade/models/brokerage_symbol_symbol.rb +6 -6
- data/lib/snaptrade/models/brokerage_type.rb +6 -6
- data/lib/snaptrade/models/calculated_trade.rb +6 -6
- data/lib/snaptrade/models/cash_restriction.rb +6 -6
- data/lib/snaptrade/models/connection_type.rb +6 -6
- data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
- data/lib/snaptrade/models/currency.rb +6 -6
- data/lib/snaptrade/models/delete_user_response.rb +6 -6
- data/lib/snaptrade/models/dividend_at_date.rb +6 -6
- data/lib/snaptrade/models/encrypted_response.rb +6 -6
- data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
- data/lib/snaptrade/models/exchange.rb +6 -6
- data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
- data/lib/snaptrade/models/excluded_asset.rb +6 -6
- data/lib/snaptrade/models/jwt.rb +6 -6
- data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
- data/lib/snaptrade/models/manual_trade.rb +6 -6
- data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
- data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
- data/lib/snaptrade/models/manual_trade_form.rb +6 -6
- data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
- data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
- data/lib/snaptrade/models/model_portfolio.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
- data/lib/snaptrade/models/model_type.rb +6 -6
- data/lib/snaptrade/models/monthly_dividends.rb +6 -6
- data/lib/snaptrade/models/net_contributions.rb +6 -6
- data/lib/snaptrade/models/net_dividend.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
- data/lib/snaptrade/models/option_leg.rb +6 -6
- data/lib/snaptrade/models/option_leg_action.rb +6 -6
- data/lib/snaptrade/models/option_strategy.rb +6 -6
- data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
- data/lib/snaptrade/models/option_type.rb +38 -0
- data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_holdings.rb +6 -6
- data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_position.rb +6 -6
- data/lib/snaptrade/models/options_position_currency.rb +6 -6
- data/lib/snaptrade/models/options_symbol.rb +46 -7
- data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
- data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
- data/lib/snaptrade/models/order_type.rb +6 -6
- data/lib/snaptrade/models/partner_data.rb +6 -6
- data/lib/snaptrade/models/past_value.rb +6 -6
- data/lib/snaptrade/models/performance_custom.rb +6 -6
- data/lib/snaptrade/models/portfolio_group.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
- data/lib/snaptrade/models/position.rb +6 -6
- data/lib/snaptrade/models/position_symbol.rb +6 -6
- data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
- data/lib/snaptrade/models/security_type.rb +6 -6
- data/lib/snaptrade/models/session_event.rb +6 -6
- data/lib/snaptrade/models/session_event_type.rb +6 -6
- data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
- data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
- data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
- data/lib/snaptrade/models/state.rb +6 -6
- data/lib/snaptrade/models/status.rb +6 -6
- data/lib/snaptrade/models/strategy_impact.rb +6 -6
- data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
- data/lib/snaptrade/models/strategy_type.rb +6 -6
- data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
- data/lib/snaptrade/models/symbol.rb +6 -6
- data/lib/snaptrade/models/symbol_query.rb +6 -6
- data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
- data/lib/snaptrade/models/target_asset.rb +6 -6
- data/lib/snaptrade/models/time_in_force.rb +6 -6
- data/lib/snaptrade/models/trade.rb +6 -6
- data/lib/snaptrade/models/trade_action.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
- data/lib/snaptrade/models/trade_impact.rb +6 -6
- data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
- data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
- data/lib/snaptrade/models/transactions_status.rb +6 -6
- data/lib/snaptrade/models/type.rb +6 -6
- data/lib/snaptrade/models/underlying_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_activity.rb +6 -6
- data/lib/snaptrade/models/universal_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
- data/lib/snaptrade/models/us_exchange.rb +6 -6
- data/lib/snaptrade/models/user_error_log.rb +6 -6
- data/lib/snaptrade/models/user_i_dand_secret.rb +6 -6
- data/lib/snaptrade/models/user_settings.rb +6 -6
- data/lib/snaptrade/version.rb +7 -7
- data/lib/snaptrade.rb +215 -214
- data/snaptrade.gemspec +41 -41
- data/spec/api/account_information_api_spec.rb +135 -135
- data/spec/api/api_status_api_spec.rb +42 -42
- data/spec/api/authentication_api_spec.rb +88 -88
- data/spec/api/connections_api_spec.rb +82 -82
- data/spec/api/error_logs_api_spec.rb +43 -43
- data/spec/api/options_api_spec.rb +101 -101
- data/spec/api/reference_data_api_spec.rb +150 -150
- data/spec/api/trading_api_spec.rb +112 -112
- data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
- data/spec/api_client_spec.rb +193 -193
- data/spec/configuration_spec.rb +6 -6
- data/spec/getting_started_spec.rb +114 -114
- data/spec/models/account_holdings_account_spec.rb +54 -54
- data/spec/models/account_holdings_spec.rb +48 -48
- data/spec/models/account_order_record_spec.rb +132 -132
- data/spec/models/account_order_record_status_spec.rb +24 -24
- data/spec/models/account_simple_spec.rb +48 -48
- data/spec/models/account_spec.rb +84 -84
- data/spec/models/account_sync_status_spec.rb +30 -30
- data/spec/models/action_spec.rb +24 -24
- data/spec/models/auth_type_spec.rb +24 -24
- data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
- data/spec/models/balance_spec.rb +36 -36
- data/spec/models/brokerage_authorization_spec.rb +78 -78
- data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
- data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
- data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
- data/spec/models/brokerage_authorization_type_spec.rb +30 -30
- data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
- data/spec/models/brokerage_spec.rb +132 -132
- data/spec/models/brokerage_symbol_option_symbol_spec.rb +78 -72
- data/spec/models/brokerage_symbol_spec.rb +60 -60
- data/spec/models/brokerage_symbol_symbol_spec.rb +72 -72
- data/spec/models/brokerage_type_spec.rb +36 -36
- data/spec/models/calculated_trade_spec.rb +36 -36
- data/spec/models/cash_restriction_spec.rb +54 -54
- data/spec/models/connection_type_spec.rb +24 -24
- data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
- data/spec/models/currency_spec.rb +42 -42
- data/spec/models/delete_user_response_spec.rb +36 -36
- data/spec/models/dividend_at_date_spec.rb +42 -42
- data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
- data/spec/models/encrypted_response_spec.rb +36 -36
- data/spec/models/exchange_rate_pairs_spec.rb +42 -42
- data/spec/models/exchange_spec.rb +72 -72
- data/spec/models/excluded_asset_spec.rb +30 -30
- data/spec/models/jwt_spec.rb +30 -30
- data/spec/models/login_redirect_uri_spec.rb +36 -36
- data/spec/models/manual_trade_and_impact_spec.rb +42 -42
- data/spec/models/manual_trade_balance_spec.rb +42 -42
- data/spec/models/manual_trade_form_spec.rb +72 -72
- data/spec/models/manual_trade_spec.rb +72 -72
- data/spec/models/manual_trade_symbol_spec.rb +60 -60
- data/spec/models/model400_failed_request_response_spec.rb +36 -36
- data/spec/models/model401_failed_request_response_spec.rb +36 -36
- data/spec/models/model403_failed_request_response_spec.rb +36 -36
- data/spec/models/model404_failed_request_response_spec.rb +36 -36
- data/spec/models/model_asset_class_details_spec.rb +36 -36
- data/spec/models/model_asset_class_spec.rb +36 -36
- data/spec/models/model_asset_class_target_spec.rb +30 -30
- data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
- data/spec/models/model_portfolio_details_spec.rb +42 -42
- data/spec/models/model_portfolio_security_spec.rb +36 -36
- data/spec/models/model_portfolio_spec.rb +42 -42
- data/spec/models/model_type_spec.rb +24 -24
- data/spec/models/monthly_dividends_spec.rb +36 -36
- data/spec/models/net_contributions_spec.rb +42 -42
- data/spec/models/net_dividend_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_spec.rb +54 -54
- data/spec/models/option_leg_action_spec.rb +24 -24
- data/spec/models/option_leg_spec.rb +42 -42
- data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
- data/spec/models/option_strategy_spec.rb +54 -54
- data/spec/models/option_type_spec.rb +24 -0
- data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_holdings_spec.rb +60 -60
- data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_position_currency_spec.rb +42 -42
- data/spec/models/options_position_spec.rb +66 -66
- data/spec/models/options_symbol_spec.rb +78 -72
- data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
- data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
- data/spec/models/order_type_spec.rb +24 -24
- data/spec/models/partner_data_spec.rb +96 -96
- data/spec/models/past_value_spec.rb +42 -42
- data/spec/models/performance_custom_spec.rb +138 -138
- data/spec/models/portfolio_group_info_spec.rb +90 -90
- data/spec/models/portfolio_group_position_spec.rb +42 -42
- data/spec/models/portfolio_group_settings_spec.rb +54 -54
- data/spec/models/portfolio_group_spec.rb +36 -36
- data/spec/models/position_spec.rb +60 -60
- data/spec/models/position_symbol_spec.rb +60 -60
- data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
- data/spec/models/security_type_spec.rb +48 -48
- data/spec/models/session_event_spec.rb +66 -66
- data/spec/models/session_event_type_spec.rb +24 -24
- data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
- data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
- data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
- data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
- data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
- data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
- data/spec/models/state_spec.rb +24 -24
- data/spec/models/status_spec.rb +42 -42
- data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_impact_spec.rb +90 -90
- data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
- data/spec/models/strategy_order_place_spec.rb +36 -36
- data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
- data/spec/models/strategy_order_record_spec.rb +90 -90
- data/spec/models/strategy_order_record_status_spec.rb +24 -24
- data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
- data/spec/models/strategy_quotes_greek_spec.rb +54 -54
- data/spec/models/strategy_quotes_spec.rb +60 -60
- data/spec/models/strategy_type_spec.rb +24 -24
- data/spec/models/sub_period_return_rate_spec.rb +42 -42
- data/spec/models/symbol_query_spec.rb +30 -30
- data/spec/models/symbol_spec.rb +66 -66
- data/spec/models/symbols_quotes_inner_spec.rb +60 -60
- data/spec/models/target_asset_spec.rb +60 -60
- data/spec/models/time_in_force_spec.rb +24 -24
- data/spec/models/trade_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_spec.rb +78 -78
- data/spec/models/trade_impact_spec.rb +54 -54
- data/spec/models/trade_spec.rb +72 -72
- data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
- data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
- data/spec/models/transactions_status_spec.rb +36 -36
- data/spec/models/type_spec.rb +24 -24
- data/spec/models/underlying_symbol_spec.rb +66 -66
- data/spec/models/universal_activity_spec.rb +126 -126
- data/spec/models/universal_symbol_spec.rb +72 -72
- data/spec/models/universal_symbol_ticker_spec.rb +72 -72
- data/spec/models/us_exchange_spec.rb +78 -78
- data/spec/models/user_error_log_spec.rb +60 -60
- data/spec/models/user_i_dand_secret_spec.rb +36 -36
- data/spec/models/user_settings_spec.rb +84 -84
- data/spec/spec_helper.rb +6 -6
- metadata +119 -115
data/docs/ConnectionsApi.md
CHANGED
|
@@ -1,265 +1,265 @@
|
|
|
1
|
-
# SnapTrade::ConnectionsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**detail_brokerage_authorization**](ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details |
|
|
8
|
-
| [**list_brokerage_authorizations**](ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user |
|
|
9
|
-
| [**remove_brokerage_authorization**](ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization |
|
|
10
|
-
| [**session_events**](ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner |
|
|
11
|
-
|
|
12
|
-
## detail_brokerage_authorization
|
|
13
|
-
|
|
14
|
-
Get brokerage authorization details
|
|
15
|
-
|
|
16
|
-
### Example
|
|
17
|
-
|
|
18
|
-
```ruby
|
|
19
|
-
require 'snaptrade'
|
|
20
|
-
|
|
21
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
22
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
23
|
-
|
|
24
|
-
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
25
|
-
user_id = "John.doe@snaptrade.com"
|
|
26
|
-
user_secret = "USERSECRET123"
|
|
27
|
-
|
|
28
|
-
begin
|
|
29
|
-
# Get brokerage authorization details
|
|
30
|
-
result = SnapTrade::Connections.detail_brokerage_authorization(
|
|
31
|
-
authorization_id: authorization_id,
|
|
32
|
-
user_id: user_id,
|
|
33
|
-
user_secret: user_secret,
|
|
34
|
-
)
|
|
35
|
-
p result
|
|
36
|
-
rescue SnapTrade::ApiError => e
|
|
37
|
-
puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
|
|
38
|
-
end
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
#### Using the detail_brokerage_authorization_with_http_info variant
|
|
42
|
-
|
|
43
|
-
This returns an Array which contains the response data, status code and headers.
|
|
44
|
-
|
|
45
|
-
```ruby
|
|
46
|
-
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
47
|
-
user_id = "John.doe@snaptrade.com"
|
|
48
|
-
user_secret = "USERSECRET123"
|
|
49
|
-
|
|
50
|
-
begin
|
|
51
|
-
# Get brokerage authorization details
|
|
52
|
-
data, status_code, headers, response = SnapTrade::Connections.detail_brokerage_authorization_with_http_info(
|
|
53
|
-
authorization_id: authorization_id,
|
|
54
|
-
user_id: user_id,
|
|
55
|
-
user_secret: user_secret,
|
|
56
|
-
)
|
|
57
|
-
p status_code # => 2xx
|
|
58
|
-
p headers # => { ... }
|
|
59
|
-
p data # => BrokerageAuthorization
|
|
60
|
-
rescue SnapTrade::ApiError => e
|
|
61
|
-
puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
|
|
62
|
-
end
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
| Name | Type | Description | Notes |
|
|
68
|
-
| ---- | ---- | ----------- | ----- |
|
|
69
|
-
| **authorization_id** | **String** | The ID of a brokerage authorization object. | |
|
|
70
|
-
| **user_id** | **String** | | |
|
|
71
|
-
| **user_secret** | **String** | | |
|
|
72
|
-
|
|
73
|
-
### Return type
|
|
74
|
-
|
|
75
|
-
[**BrokerageAuthorization**](BrokerageAuthorization.md)
|
|
76
|
-
|
|
77
|
-
## list_brokerage_authorizations
|
|
78
|
-
|
|
79
|
-
List all brokerage authorizations for the user
|
|
80
|
-
|
|
81
|
-
### Example
|
|
82
|
-
|
|
83
|
-
```ruby
|
|
84
|
-
require 'snaptrade'
|
|
85
|
-
|
|
86
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
87
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
88
|
-
|
|
89
|
-
user_id = "John.doe@snaptrade.com"
|
|
90
|
-
user_secret = "USERSECRET123"
|
|
91
|
-
|
|
92
|
-
begin
|
|
93
|
-
# List all brokerage authorizations for the user
|
|
94
|
-
result = SnapTrade::Connections.list_brokerage_authorizations(
|
|
95
|
-
user_id: user_id,
|
|
96
|
-
user_secret: user_secret,
|
|
97
|
-
)
|
|
98
|
-
p result
|
|
99
|
-
rescue SnapTrade::ApiError => e
|
|
100
|
-
puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
|
|
101
|
-
end
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
#### Using the list_brokerage_authorizations_with_http_info variant
|
|
105
|
-
|
|
106
|
-
This returns an Array which contains the response data, status code and headers.
|
|
107
|
-
|
|
108
|
-
```ruby
|
|
109
|
-
user_id = "John.doe@snaptrade.com"
|
|
110
|
-
user_secret = "USERSECRET123"
|
|
111
|
-
|
|
112
|
-
begin
|
|
113
|
-
# List all brokerage authorizations for the user
|
|
114
|
-
data, status_code, headers, response = SnapTrade::Connections.list_brokerage_authorizations_with_http_info(
|
|
115
|
-
user_id: user_id,
|
|
116
|
-
user_secret: user_secret,
|
|
117
|
-
)
|
|
118
|
-
p status_code # => 2xx
|
|
119
|
-
p headers # => { ... }
|
|
120
|
-
p data # => Array<BrokerageAuthorization>
|
|
121
|
-
rescue SnapTrade::ApiError => e
|
|
122
|
-
puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
|
|
123
|
-
end
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Parameters
|
|
127
|
-
|
|
128
|
-
| Name | Type | Description | Notes |
|
|
129
|
-
| ---- | ---- | ----------- | ----- |
|
|
130
|
-
| **user_id** | **String** | | |
|
|
131
|
-
| **user_secret** | **String** | | |
|
|
132
|
-
|
|
133
|
-
### Return type
|
|
134
|
-
|
|
135
|
-
[**Array<BrokerageAuthorization>**](BrokerageAuthorization.md)
|
|
136
|
-
|
|
137
|
-
## remove_brokerage_authorization
|
|
138
|
-
|
|
139
|
-
Delete brokerage authorization
|
|
140
|
-
|
|
141
|
-
### Example
|
|
142
|
-
|
|
143
|
-
```ruby
|
|
144
|
-
require 'snaptrade'
|
|
145
|
-
|
|
146
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
147
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
148
|
-
|
|
149
|
-
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
150
|
-
user_id = "John.doe@snaptrade.com"
|
|
151
|
-
user_secret = "USERSECRET123"
|
|
152
|
-
|
|
153
|
-
begin
|
|
154
|
-
# Delete brokerage authorization
|
|
155
|
-
SnapTrade::Connections.remove_brokerage_authorization(
|
|
156
|
-
authorization_id: authorization_id,
|
|
157
|
-
user_id: user_id,
|
|
158
|
-
user_secret: user_secret,
|
|
159
|
-
)
|
|
160
|
-
rescue SnapTrade::ApiError => e
|
|
161
|
-
puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
|
|
162
|
-
end
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
#### Using the remove_brokerage_authorization_with_http_info variant
|
|
166
|
-
|
|
167
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
168
|
-
|
|
169
|
-
```ruby
|
|
170
|
-
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
171
|
-
user_id = "John.doe@snaptrade.com"
|
|
172
|
-
user_secret = "USERSECRET123"
|
|
173
|
-
|
|
174
|
-
begin
|
|
175
|
-
# Delete brokerage authorization
|
|
176
|
-
data, status_code, headers, response = SnapTrade::Connections.remove_brokerage_authorization_with_http_info(
|
|
177
|
-
authorization_id: authorization_id,
|
|
178
|
-
user_id: user_id,
|
|
179
|
-
user_secret: user_secret,
|
|
180
|
-
)
|
|
181
|
-
p status_code # => 2xx
|
|
182
|
-
p headers # => { ... }
|
|
183
|
-
p data # => nil
|
|
184
|
-
rescue SnapTrade::ApiError => e
|
|
185
|
-
puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
|
|
186
|
-
end
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
### Parameters
|
|
190
|
-
|
|
191
|
-
| Name | Type | Description | Notes |
|
|
192
|
-
| ---- | ---- | ----------- | ----- |
|
|
193
|
-
| **authorization_id** | **String** | The ID of the Authorization to delete. | |
|
|
194
|
-
| **user_id** | **String** | | |
|
|
195
|
-
| **user_secret** | **String** | | |
|
|
196
|
-
|
|
197
|
-
### Return type
|
|
198
|
-
|
|
199
|
-
nil (empty response body)
|
|
200
|
-
|
|
201
|
-
## session_events
|
|
202
|
-
|
|
203
|
-
List all session events for the partner
|
|
204
|
-
|
|
205
|
-
### Example
|
|
206
|
-
|
|
207
|
-
```ruby
|
|
208
|
-
require 'snaptrade'
|
|
209
|
-
|
|
210
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
211
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
212
|
-
|
|
213
|
-
partner_client_id = "SNAPTRADETEST"
|
|
214
|
-
user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
215
|
-
session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
216
|
-
|
|
217
|
-
begin
|
|
218
|
-
# List all session events for the partner
|
|
219
|
-
result = SnapTrade::Connections.session_events(
|
|
220
|
-
partner_client_id: partner_client_id,
|
|
221
|
-
user_id: user_id,
|
|
222
|
-
session_id: session_id,
|
|
223
|
-
)
|
|
224
|
-
p result
|
|
225
|
-
rescue SnapTrade::ApiError => e
|
|
226
|
-
puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
|
|
227
|
-
end
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
#### Using the session_events_with_http_info variant
|
|
231
|
-
|
|
232
|
-
This returns an Array which contains the response data, status code and headers.
|
|
233
|
-
|
|
234
|
-
```ruby
|
|
235
|
-
partner_client_id = "SNAPTRADETEST"
|
|
236
|
-
user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
237
|
-
session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
238
|
-
|
|
239
|
-
begin
|
|
240
|
-
# List all session events for the partner
|
|
241
|
-
data, status_code, headers, response = SnapTrade::Connections.session_events_with_http_info(
|
|
242
|
-
partner_client_id: partner_client_id,
|
|
243
|
-
user_id: user_id,
|
|
244
|
-
session_id: session_id,
|
|
245
|
-
)
|
|
246
|
-
p status_code # => 2xx
|
|
247
|
-
p headers # => { ... }
|
|
248
|
-
p data # => Array<ConnectionsSessionEvents200ResponseInner>
|
|
249
|
-
rescue SnapTrade::ApiError => e
|
|
250
|
-
puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
|
|
251
|
-
end
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### Parameters
|
|
255
|
-
|
|
256
|
-
| Name | Type | Description | Notes |
|
|
257
|
-
| ---- | ---- | ----------- | ----- |
|
|
258
|
-
| **partner_client_id** | **String** | | |
|
|
259
|
-
| **user_id** | **String** | Optional comma seperated list of user IDs used to filter the request on specific users | [optional] |
|
|
260
|
-
| **session_id** | **String** | Optional comma seperated list of session IDs used to filter the request on specific users | [optional] |
|
|
261
|
-
|
|
262
|
-
### Return type
|
|
263
|
-
|
|
264
|
-
[**Array<ConnectionsSessionEvents200ResponseInner>**](ConnectionsSessionEvents200ResponseInner.md)
|
|
265
|
-
|
|
1
|
+
# SnapTrade::ConnectionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**detail_brokerage_authorization**](ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details |
|
|
8
|
+
| [**list_brokerage_authorizations**](ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user |
|
|
9
|
+
| [**remove_brokerage_authorization**](ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization |
|
|
10
|
+
| [**session_events**](ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner |
|
|
11
|
+
|
|
12
|
+
## detail_brokerage_authorization
|
|
13
|
+
|
|
14
|
+
Get brokerage authorization details
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'snaptrade'
|
|
20
|
+
|
|
21
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
22
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
23
|
+
|
|
24
|
+
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
25
|
+
user_id = "John.doe@snaptrade.com"
|
|
26
|
+
user_secret = "USERSECRET123"
|
|
27
|
+
|
|
28
|
+
begin
|
|
29
|
+
# Get brokerage authorization details
|
|
30
|
+
result = SnapTrade::Connections.detail_brokerage_authorization(
|
|
31
|
+
authorization_id: authorization_id,
|
|
32
|
+
user_id: user_id,
|
|
33
|
+
user_secret: user_secret,
|
|
34
|
+
)
|
|
35
|
+
p result
|
|
36
|
+
rescue SnapTrade::ApiError => e
|
|
37
|
+
puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
|
|
38
|
+
end
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Using the detail_brokerage_authorization_with_http_info variant
|
|
42
|
+
|
|
43
|
+
This returns an Array which contains the response data, status code and headers.
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
47
|
+
user_id = "John.doe@snaptrade.com"
|
|
48
|
+
user_secret = "USERSECRET123"
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
# Get brokerage authorization details
|
|
52
|
+
data, status_code, headers, response = SnapTrade::Connections.detail_brokerage_authorization_with_http_info(
|
|
53
|
+
authorization_id: authorization_id,
|
|
54
|
+
user_id: user_id,
|
|
55
|
+
user_secret: user_secret,
|
|
56
|
+
)
|
|
57
|
+
p status_code # => 2xx
|
|
58
|
+
p headers # => { ... }
|
|
59
|
+
p data # => BrokerageAuthorization
|
|
60
|
+
rescue SnapTrade::ApiError => e
|
|
61
|
+
puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
|
69
|
+
| **authorization_id** | **String** | The ID of a brokerage authorization object. | |
|
|
70
|
+
| **user_id** | **String** | | |
|
|
71
|
+
| **user_secret** | **String** | | |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
[**BrokerageAuthorization**](BrokerageAuthorization.md)
|
|
76
|
+
|
|
77
|
+
## list_brokerage_authorizations
|
|
78
|
+
|
|
79
|
+
List all brokerage authorizations for the user
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```ruby
|
|
84
|
+
require 'snaptrade'
|
|
85
|
+
|
|
86
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
87
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
88
|
+
|
|
89
|
+
user_id = "John.doe@snaptrade.com"
|
|
90
|
+
user_secret = "USERSECRET123"
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
# List all brokerage authorizations for the user
|
|
94
|
+
result = SnapTrade::Connections.list_brokerage_authorizations(
|
|
95
|
+
user_id: user_id,
|
|
96
|
+
user_secret: user_secret,
|
|
97
|
+
)
|
|
98
|
+
p result
|
|
99
|
+
rescue SnapTrade::ApiError => e
|
|
100
|
+
puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
|
|
101
|
+
end
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### Using the list_brokerage_authorizations_with_http_info variant
|
|
105
|
+
|
|
106
|
+
This returns an Array which contains the response data, status code and headers.
|
|
107
|
+
|
|
108
|
+
```ruby
|
|
109
|
+
user_id = "John.doe@snaptrade.com"
|
|
110
|
+
user_secret = "USERSECRET123"
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
# List all brokerage authorizations for the user
|
|
114
|
+
data, status_code, headers, response = SnapTrade::Connections.list_brokerage_authorizations_with_http_info(
|
|
115
|
+
user_id: user_id,
|
|
116
|
+
user_secret: user_secret,
|
|
117
|
+
)
|
|
118
|
+
p status_code # => 2xx
|
|
119
|
+
p headers # => { ... }
|
|
120
|
+
p data # => Array<BrokerageAuthorization>
|
|
121
|
+
rescue SnapTrade::ApiError => e
|
|
122
|
+
puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
|
|
123
|
+
end
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
| Name | Type | Description | Notes |
|
|
129
|
+
| ---- | ---- | ----------- | ----- |
|
|
130
|
+
| **user_id** | **String** | | |
|
|
131
|
+
| **user_secret** | **String** | | |
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
[**Array<BrokerageAuthorization>**](BrokerageAuthorization.md)
|
|
136
|
+
|
|
137
|
+
## remove_brokerage_authorization
|
|
138
|
+
|
|
139
|
+
Delete brokerage authorization
|
|
140
|
+
|
|
141
|
+
### Example
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
require 'snaptrade'
|
|
145
|
+
|
|
146
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
147
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
148
|
+
|
|
149
|
+
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
150
|
+
user_id = "John.doe@snaptrade.com"
|
|
151
|
+
user_secret = "USERSECRET123"
|
|
152
|
+
|
|
153
|
+
begin
|
|
154
|
+
# Delete brokerage authorization
|
|
155
|
+
SnapTrade::Connections.remove_brokerage_authorization(
|
|
156
|
+
authorization_id: authorization_id,
|
|
157
|
+
user_id: user_id,
|
|
158
|
+
user_secret: user_secret,
|
|
159
|
+
)
|
|
160
|
+
rescue SnapTrade::ApiError => e
|
|
161
|
+
puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
|
|
162
|
+
end
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
#### Using the remove_brokerage_authorization_with_http_info variant
|
|
166
|
+
|
|
167
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
168
|
+
|
|
169
|
+
```ruby
|
|
170
|
+
authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
171
|
+
user_id = "John.doe@snaptrade.com"
|
|
172
|
+
user_secret = "USERSECRET123"
|
|
173
|
+
|
|
174
|
+
begin
|
|
175
|
+
# Delete brokerage authorization
|
|
176
|
+
data, status_code, headers, response = SnapTrade::Connections.remove_brokerage_authorization_with_http_info(
|
|
177
|
+
authorization_id: authorization_id,
|
|
178
|
+
user_id: user_id,
|
|
179
|
+
user_secret: user_secret,
|
|
180
|
+
)
|
|
181
|
+
p status_code # => 2xx
|
|
182
|
+
p headers # => { ... }
|
|
183
|
+
p data # => nil
|
|
184
|
+
rescue SnapTrade::ApiError => e
|
|
185
|
+
puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
|
|
186
|
+
end
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Parameters
|
|
190
|
+
|
|
191
|
+
| Name | Type | Description | Notes |
|
|
192
|
+
| ---- | ---- | ----------- | ----- |
|
|
193
|
+
| **authorization_id** | **String** | The ID of the Authorization to delete. | |
|
|
194
|
+
| **user_id** | **String** | | |
|
|
195
|
+
| **user_secret** | **String** | | |
|
|
196
|
+
|
|
197
|
+
### Return type
|
|
198
|
+
|
|
199
|
+
nil (empty response body)
|
|
200
|
+
|
|
201
|
+
## session_events
|
|
202
|
+
|
|
203
|
+
List all session events for the partner
|
|
204
|
+
|
|
205
|
+
### Example
|
|
206
|
+
|
|
207
|
+
```ruby
|
|
208
|
+
require 'snaptrade'
|
|
209
|
+
|
|
210
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
211
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
212
|
+
|
|
213
|
+
partner_client_id = "SNAPTRADETEST"
|
|
214
|
+
user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
215
|
+
session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
216
|
+
|
|
217
|
+
begin
|
|
218
|
+
# List all session events for the partner
|
|
219
|
+
result = SnapTrade::Connections.session_events(
|
|
220
|
+
partner_client_id: partner_client_id,
|
|
221
|
+
user_id: user_id,
|
|
222
|
+
session_id: session_id,
|
|
223
|
+
)
|
|
224
|
+
p result
|
|
225
|
+
rescue SnapTrade::ApiError => e
|
|
226
|
+
puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
|
|
227
|
+
end
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
#### Using the session_events_with_http_info variant
|
|
231
|
+
|
|
232
|
+
This returns an Array which contains the response data, status code and headers.
|
|
233
|
+
|
|
234
|
+
```ruby
|
|
235
|
+
partner_client_id = "SNAPTRADETEST"
|
|
236
|
+
user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
237
|
+
session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
|
|
238
|
+
|
|
239
|
+
begin
|
|
240
|
+
# List all session events for the partner
|
|
241
|
+
data, status_code, headers, response = SnapTrade::Connections.session_events_with_http_info(
|
|
242
|
+
partner_client_id: partner_client_id,
|
|
243
|
+
user_id: user_id,
|
|
244
|
+
session_id: session_id,
|
|
245
|
+
)
|
|
246
|
+
p status_code # => 2xx
|
|
247
|
+
p headers # => { ... }
|
|
248
|
+
p data # => Array<ConnectionsSessionEvents200ResponseInner>
|
|
249
|
+
rescue SnapTrade::ApiError => e
|
|
250
|
+
puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
|
|
251
|
+
end
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Parameters
|
|
255
|
+
|
|
256
|
+
| Name | Type | Description | Notes |
|
|
257
|
+
| ---- | ---- | ----------- | ----- |
|
|
258
|
+
| **partner_client_id** | **String** | | |
|
|
259
|
+
| **user_id** | **String** | Optional comma seperated list of user IDs used to filter the request on specific users | [optional] |
|
|
260
|
+
| **session_id** | **String** | Optional comma seperated list of session IDs used to filter the request on specific users | [optional] |
|
|
261
|
+
|
|
262
|
+
### Return type
|
|
263
|
+
|
|
264
|
+
[**Array<ConnectionsSessionEvents200ResponseInner>**](ConnectionsSessionEvents200ResponseInner.md)
|
|
265
|
+
|
data/docs/ErrorLogsApi.md
CHANGED
|
@@ -1,68 +1,68 @@
|
|
|
1
|
-
# SnapTrade::ErrorLogsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**list_user_errors**](ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users |
|
|
8
|
-
|
|
9
|
-
## list_user_errors
|
|
10
|
-
|
|
11
|
-
Retrieve error logs on behalf of your SnapTrade users
|
|
12
|
-
|
|
13
|
-
### Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'snaptrade'
|
|
17
|
-
|
|
18
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
19
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
20
|
-
|
|
21
|
-
user_id = "John.doe@snaptrade.com"
|
|
22
|
-
user_secret = "USERSECRET123"
|
|
23
|
-
|
|
24
|
-
begin
|
|
25
|
-
# Retrieve error logs on behalf of your SnapTrade users
|
|
26
|
-
result = SnapTrade::ErrorLogs.list_user_errors(
|
|
27
|
-
user_id: user_id,
|
|
28
|
-
user_secret: user_secret,
|
|
29
|
-
)
|
|
30
|
-
p result
|
|
31
|
-
rescue SnapTrade::ApiError => e
|
|
32
|
-
puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
|
|
33
|
-
end
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
#### Using the list_user_errors_with_http_info variant
|
|
37
|
-
|
|
38
|
-
This returns an Array which contains the response data, status code and headers.
|
|
39
|
-
|
|
40
|
-
```ruby
|
|
41
|
-
user_id = "John.doe@snaptrade.com"
|
|
42
|
-
user_secret = "USERSECRET123"
|
|
43
|
-
|
|
44
|
-
begin
|
|
45
|
-
# Retrieve error logs on behalf of your SnapTrade users
|
|
46
|
-
data, status_code, headers, response = SnapTrade::ErrorLogs.list_user_errors_with_http_info(
|
|
47
|
-
user_id: user_id,
|
|
48
|
-
user_secret: user_secret,
|
|
49
|
-
)
|
|
50
|
-
p status_code # => 2xx
|
|
51
|
-
p headers # => { ... }
|
|
52
|
-
p data # => Array<UserErrorLog>
|
|
53
|
-
rescue SnapTrade::ApiError => e
|
|
54
|
-
puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
|
|
55
|
-
end
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Parameters
|
|
59
|
-
|
|
60
|
-
| Name | Type | Description | Notes |
|
|
61
|
-
| ---- | ---- | ----------- | ----- |
|
|
62
|
-
| **user_id** | **String** | | |
|
|
63
|
-
| **user_secret** | **String** | | |
|
|
64
|
-
|
|
65
|
-
### Return type
|
|
66
|
-
|
|
67
|
-
[**Array<UserErrorLog>**](UserErrorLog.md)
|
|
68
|
-
|
|
1
|
+
# SnapTrade::ErrorLogsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**list_user_errors**](ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users |
|
|
8
|
+
|
|
9
|
+
## list_user_errors
|
|
10
|
+
|
|
11
|
+
Retrieve error logs on behalf of your SnapTrade users
|
|
12
|
+
|
|
13
|
+
### Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'snaptrade'
|
|
17
|
+
|
|
18
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
19
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
20
|
+
|
|
21
|
+
user_id = "John.doe@snaptrade.com"
|
|
22
|
+
user_secret = "USERSECRET123"
|
|
23
|
+
|
|
24
|
+
begin
|
|
25
|
+
# Retrieve error logs on behalf of your SnapTrade users
|
|
26
|
+
result = SnapTrade::ErrorLogs.list_user_errors(
|
|
27
|
+
user_id: user_id,
|
|
28
|
+
user_secret: user_secret,
|
|
29
|
+
)
|
|
30
|
+
p result
|
|
31
|
+
rescue SnapTrade::ApiError => e
|
|
32
|
+
puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
|
|
33
|
+
end
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
#### Using the list_user_errors_with_http_info variant
|
|
37
|
+
|
|
38
|
+
This returns an Array which contains the response data, status code and headers.
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
user_id = "John.doe@snaptrade.com"
|
|
42
|
+
user_secret = "USERSECRET123"
|
|
43
|
+
|
|
44
|
+
begin
|
|
45
|
+
# Retrieve error logs on behalf of your SnapTrade users
|
|
46
|
+
data, status_code, headers, response = SnapTrade::ErrorLogs.list_user_errors_with_http_info(
|
|
47
|
+
user_id: user_id,
|
|
48
|
+
user_secret: user_secret,
|
|
49
|
+
)
|
|
50
|
+
p status_code # => 2xx
|
|
51
|
+
p headers # => { ... }
|
|
52
|
+
p data # => Array<UserErrorLog>
|
|
53
|
+
rescue SnapTrade::ApiError => e
|
|
54
|
+
puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
|
|
55
|
+
end
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
| Name | Type | Description | Notes |
|
|
61
|
+
| ---- | ---- | ----------- | ----- |
|
|
62
|
+
| **user_id** | **String** | | |
|
|
63
|
+
| **user_secret** | **String** | | |
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
[**Array<UserErrorLog>**](UserErrorLog.md)
|
|
68
|
+
|