snaptrade 2.1.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +2 -576
- data/lib/snaptrade/api/account_information_api.rb +0 -231
- data/lib/snaptrade/api/connections_api.rb +0 -201
- data/lib/snaptrade/api/reference_data_api.rb +0 -316
- data/lib/snaptrade/api/trading_api.rb +0 -290
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +0 -7
- data/spec/api/account_information_api_spec.rb +0 -28
- data/spec/api/connections_api_spec.rb +0 -28
- data/spec/api/reference_data_api_spec.rb +0 -45
- data/spec/api/trading_api_spec.rb +0 -30
- metadata +202 -211
- data/lib/snaptrade/api/options_api.rb +0 -137
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +0 -302
- data/lib/snaptrade/models/connections_session_events200_response_inner.rb +0 -292
- data/spec/api/options_api_spec.rb +0 -44
- data/spec/api/transactions_and_reporting_api_spec.rb +0 -66
- data/spec/models/connections_session_events200_response_inner_spec.rb +0 -65
|
@@ -401,118 +401,6 @@ module SnapTrade
|
|
|
401
401
|
end
|
|
402
402
|
|
|
403
403
|
|
|
404
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
405
|
-
#
|
|
406
|
-
# **Deprecated.** Use the account-specific holdings endpoint instead.
|
|
407
|
-
#
|
|
408
|
-
# This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
409
|
-
#
|
|
410
|
-
# List all accounts for the user, plus balances, positions, and orders for each
|
|
411
|
-
# account.
|
|
412
|
-
#
|
|
413
|
-
# @param user_id [String]
|
|
414
|
-
# @param user_secret [String]
|
|
415
|
-
# @param brokerage_authorizations [String] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
416
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
417
|
-
def get_all_user_holdings(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
|
|
418
|
-
extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
|
|
419
|
-
data, _status_code, _headers = get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
|
|
420
|
-
data
|
|
421
|
-
end
|
|
422
|
-
|
|
423
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
424
|
-
#
|
|
425
|
-
# **Deprecated.** Use the account-specific holdings endpoint instead.
|
|
426
|
-
#
|
|
427
|
-
# This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
428
|
-
#
|
|
429
|
-
# List all accounts for the user, plus balances, positions, and orders for each
|
|
430
|
-
# account.
|
|
431
|
-
#
|
|
432
|
-
# @param user_id [String]
|
|
433
|
-
# @param user_secret [String]
|
|
434
|
-
# @param brokerage_authorizations [String] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
435
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
436
|
-
def get_all_user_holdings_with_http_info(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
|
|
437
|
-
extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
|
|
438
|
-
get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
|
|
439
|
-
end
|
|
440
|
-
|
|
441
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
442
|
-
# **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
443
|
-
# @param user_id [String]
|
|
444
|
-
# @param user_secret [String]
|
|
445
|
-
# @param [Hash] opts the optional parameters
|
|
446
|
-
# @option opts [String] :brokerage_authorizations Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
447
|
-
# @return [Array<AccountHoldings>]
|
|
448
|
-
private def get_all_user_holdings_impl(user_id, user_secret, opts = {})
|
|
449
|
-
data, _status_code, _headers = get_all_user_holdings_with_http_info(user_id, user_secret, opts)
|
|
450
|
-
data
|
|
451
|
-
end
|
|
452
|
-
|
|
453
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
454
|
-
# **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
455
|
-
# @param user_id [String]
|
|
456
|
-
# @param user_secret [String]
|
|
457
|
-
# @param [Hash] opts the optional parameters
|
|
458
|
-
# @option opts [String] :brokerage_authorizations Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
459
|
-
# @return [Array<(Array<AccountHoldings>, Integer, Hash)>] Array<AccountHoldings> data, response status code and response headers
|
|
460
|
-
private def get_all_user_holdings_with_http_info_impl(user_id, user_secret, opts = {})
|
|
461
|
-
if @api_client.config.debugging
|
|
462
|
-
@api_client.config.logger.debug 'Calling API: AccountInformationApi.get_all_user_holdings ...'
|
|
463
|
-
end
|
|
464
|
-
# verify the required parameter 'user_id' is set
|
|
465
|
-
if @api_client.config.client_side_validation && user_id.nil?
|
|
466
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.get_all_user_holdings"
|
|
467
|
-
end
|
|
468
|
-
# verify the required parameter 'user_secret' is set
|
|
469
|
-
if @api_client.config.client_side_validation && user_secret.nil?
|
|
470
|
-
fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.get_all_user_holdings"
|
|
471
|
-
end
|
|
472
|
-
# resource path
|
|
473
|
-
local_var_path = '/holdings'
|
|
474
|
-
|
|
475
|
-
# query parameters
|
|
476
|
-
query_params = opts[:query_params] || {}
|
|
477
|
-
query_params[:'userId'] = user_id
|
|
478
|
-
query_params[:'userSecret'] = user_secret
|
|
479
|
-
query_params[:'brokerage_authorizations'] = opts[:'brokerage_authorizations'] if !opts[:'brokerage_authorizations'].nil?
|
|
480
|
-
|
|
481
|
-
# header parameters
|
|
482
|
-
header_params = opts[:header_params] || {}
|
|
483
|
-
# HTTP header 'Accept' (if needed)
|
|
484
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
485
|
-
|
|
486
|
-
# form parameters
|
|
487
|
-
form_params = opts[:form_params] || {}
|
|
488
|
-
|
|
489
|
-
# http body (model)
|
|
490
|
-
post_body = opts[:debug_body]
|
|
491
|
-
|
|
492
|
-
# return_type
|
|
493
|
-
return_type = opts[:debug_return_type] || 'Array<AccountHoldings>'
|
|
494
|
-
|
|
495
|
-
# auth_names
|
|
496
|
-
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
|
497
|
-
|
|
498
|
-
new_options = opts.merge(
|
|
499
|
-
:operation => :"AccountInformationApi.get_all_user_holdings",
|
|
500
|
-
:header_params => header_params,
|
|
501
|
-
:query_params => query_params,
|
|
502
|
-
:form_params => form_params,
|
|
503
|
-
:body => post_body,
|
|
504
|
-
:auth_names => auth_names,
|
|
505
|
-
:return_type => return_type
|
|
506
|
-
)
|
|
507
|
-
|
|
508
|
-
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
|
509
|
-
if @api_client.config.debugging
|
|
510
|
-
@api_client.config.logger.debug "API called: AccountInformationApi#get_all_user_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
511
|
-
end
|
|
512
|
-
return data, status_code, headers, response
|
|
513
|
-
end
|
|
514
|
-
|
|
515
|
-
|
|
516
404
|
# List account balances
|
|
517
405
|
#
|
|
518
406
|
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
|
|
@@ -1020,125 +908,6 @@ module SnapTrade
|
|
|
1020
908
|
end
|
|
1021
909
|
|
|
1022
910
|
|
|
1023
|
-
# List account positions
|
|
1024
|
-
#
|
|
1025
|
-
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1026
|
-
#
|
|
1027
|
-
# Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
|
|
1028
|
-
#
|
|
1029
|
-
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
1030
|
-
# - If you do, this endpoint returns real-time data.
|
|
1031
|
-
# - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1032
|
-
#
|
|
1033
|
-
# If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1034
|
-
#
|
|
1035
|
-
# @param user_id [String]
|
|
1036
|
-
# @param user_secret [String]
|
|
1037
|
-
# @param account_id [String]
|
|
1038
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1039
|
-
def get_user_account_positions(user_id:, user_secret:, account_id:, extra: {})
|
|
1040
|
-
data, _status_code, _headers = get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
|
1041
|
-
data
|
|
1042
|
-
end
|
|
1043
|
-
|
|
1044
|
-
# List account positions
|
|
1045
|
-
#
|
|
1046
|
-
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1047
|
-
#
|
|
1048
|
-
# Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
|
|
1049
|
-
#
|
|
1050
|
-
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
1051
|
-
# - If you do, this endpoint returns real-time data.
|
|
1052
|
-
# - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1053
|
-
#
|
|
1054
|
-
# If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1055
|
-
#
|
|
1056
|
-
# @param user_id [String]
|
|
1057
|
-
# @param user_secret [String]
|
|
1058
|
-
# @param account_id [String]
|
|
1059
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1060
|
-
def get_user_account_positions_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
|
1061
|
-
get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
|
1062
|
-
end
|
|
1063
|
-
|
|
1064
|
-
# List account positions
|
|
1065
|
-
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1066
|
-
# @param user_id [String]
|
|
1067
|
-
# @param user_secret [String]
|
|
1068
|
-
# @param account_id [String]
|
|
1069
|
-
# @param [Hash] opts the optional parameters
|
|
1070
|
-
# @return [Array<Position>]
|
|
1071
|
-
private def get_user_account_positions_impl(user_id, user_secret, account_id, opts = {})
|
|
1072
|
-
data, _status_code, _headers = get_user_account_positions_with_http_info(user_id, user_secret, account_id, opts)
|
|
1073
|
-
data
|
|
1074
|
-
end
|
|
1075
|
-
|
|
1076
|
-
# List account positions
|
|
1077
|
-
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1078
|
-
# @param user_id [String]
|
|
1079
|
-
# @param user_secret [String]
|
|
1080
|
-
# @param account_id [String]
|
|
1081
|
-
# @param [Hash] opts the optional parameters
|
|
1082
|
-
# @return [Array<(Array<Position>, Integer, Hash)>] Array<Position> data, response status code and response headers
|
|
1083
|
-
private def get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
|
1084
|
-
if @api_client.config.debugging
|
|
1085
|
-
@api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_positions ...'
|
|
1086
|
-
end
|
|
1087
|
-
# verify the required parameter 'user_id' is set
|
|
1088
|
-
if @api_client.config.client_side_validation && user_id.nil?
|
|
1089
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.get_user_account_positions"
|
|
1090
|
-
end
|
|
1091
|
-
# verify the required parameter 'user_secret' is set
|
|
1092
|
-
if @api_client.config.client_side_validation && user_secret.nil?
|
|
1093
|
-
fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.get_user_account_positions"
|
|
1094
|
-
end
|
|
1095
|
-
# verify the required parameter 'account_id' is set
|
|
1096
|
-
if @api_client.config.client_side_validation && account_id.nil?
|
|
1097
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_user_account_positions"
|
|
1098
|
-
end
|
|
1099
|
-
# resource path
|
|
1100
|
-
local_var_path = '/accounts/{accountId}/positions'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
|
|
1101
|
-
|
|
1102
|
-
# query parameters
|
|
1103
|
-
query_params = opts[:query_params] || {}
|
|
1104
|
-
query_params[:'userId'] = user_id
|
|
1105
|
-
query_params[:'userSecret'] = user_secret
|
|
1106
|
-
|
|
1107
|
-
# header parameters
|
|
1108
|
-
header_params = opts[:header_params] || {}
|
|
1109
|
-
# HTTP header 'Accept' (if needed)
|
|
1110
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1111
|
-
|
|
1112
|
-
# form parameters
|
|
1113
|
-
form_params = opts[:form_params] || {}
|
|
1114
|
-
|
|
1115
|
-
# http body (model)
|
|
1116
|
-
post_body = opts[:debug_body]
|
|
1117
|
-
|
|
1118
|
-
# return_type
|
|
1119
|
-
return_type = opts[:debug_return_type] || 'Array<Position>'
|
|
1120
|
-
|
|
1121
|
-
# auth_names
|
|
1122
|
-
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
|
1123
|
-
|
|
1124
|
-
new_options = opts.merge(
|
|
1125
|
-
:operation => :"AccountInformationApi.get_user_account_positions",
|
|
1126
|
-
:header_params => header_params,
|
|
1127
|
-
:query_params => query_params,
|
|
1128
|
-
:form_params => form_params,
|
|
1129
|
-
:body => post_body,
|
|
1130
|
-
:auth_names => auth_names,
|
|
1131
|
-
:return_type => return_type
|
|
1132
|
-
)
|
|
1133
|
-
|
|
1134
|
-
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1135
|
-
if @api_client.config.debugging
|
|
1136
|
-
@api_client.config.logger.debug "API called: AccountInformationApi#get_user_account_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1137
|
-
end
|
|
1138
|
-
return data, status_code, headers, response
|
|
1139
|
-
end
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
911
|
# List account recent orders (last 24 hours only)
|
|
1143
912
|
#
|
|
1144
913
|
# A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
|
|
@@ -661,107 +661,6 @@ module SnapTrade
|
|
|
661
661
|
end
|
|
662
662
|
|
|
663
663
|
|
|
664
|
-
# Delete connection
|
|
665
|
-
#
|
|
666
|
-
# Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
667
|
-
#
|
|
668
|
-
# @param authorization_id [String]
|
|
669
|
-
# @param user_id [String]
|
|
670
|
-
# @param user_secret [String]
|
|
671
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
672
|
-
def remove_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
|
|
673
|
-
remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
|
|
674
|
-
nil
|
|
675
|
-
end
|
|
676
|
-
|
|
677
|
-
# Delete connection
|
|
678
|
-
#
|
|
679
|
-
# Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
680
|
-
#
|
|
681
|
-
# @param authorization_id [String]
|
|
682
|
-
# @param user_id [String]
|
|
683
|
-
# @param user_secret [String]
|
|
684
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
685
|
-
def remove_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
|
|
686
|
-
remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
|
|
687
|
-
end
|
|
688
|
-
|
|
689
|
-
# Delete connection
|
|
690
|
-
# Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
691
|
-
# @param authorization_id [String]
|
|
692
|
-
# @param user_id [String]
|
|
693
|
-
# @param user_secret [String]
|
|
694
|
-
# @param [Hash] opts the optional parameters
|
|
695
|
-
# @return [nil]
|
|
696
|
-
private def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
|
|
697
|
-
remove_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
|
|
698
|
-
nil
|
|
699
|
-
end
|
|
700
|
-
|
|
701
|
-
# Delete connection
|
|
702
|
-
# Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
703
|
-
# @param authorization_id [String]
|
|
704
|
-
# @param user_id [String]
|
|
705
|
-
# @param user_secret [String]
|
|
706
|
-
# @param [Hash] opts the optional parameters
|
|
707
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
708
|
-
private def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
|
|
709
|
-
if @api_client.config.debugging
|
|
710
|
-
@api_client.config.logger.debug 'Calling API: ConnectionsApi.remove_brokerage_authorization ...'
|
|
711
|
-
end
|
|
712
|
-
# verify the required parameter 'authorization_id' is set
|
|
713
|
-
if @api_client.config.client_side_validation && authorization_id.nil?
|
|
714
|
-
fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.remove_brokerage_authorization"
|
|
715
|
-
end
|
|
716
|
-
# verify the required parameter 'user_id' is set
|
|
717
|
-
if @api_client.config.client_side_validation && user_id.nil?
|
|
718
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.remove_brokerage_authorization"
|
|
719
|
-
end
|
|
720
|
-
# verify the required parameter 'user_secret' is set
|
|
721
|
-
if @api_client.config.client_side_validation && user_secret.nil?
|
|
722
|
-
fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.remove_brokerage_authorization"
|
|
723
|
-
end
|
|
724
|
-
# resource path
|
|
725
|
-
local_var_path = '/authorizations/{authorizationId}'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
|
|
726
|
-
|
|
727
|
-
# query parameters
|
|
728
|
-
query_params = opts[:query_params] || {}
|
|
729
|
-
query_params[:'userId'] = user_id
|
|
730
|
-
query_params[:'userSecret'] = user_secret
|
|
731
|
-
|
|
732
|
-
# header parameters
|
|
733
|
-
header_params = opts[:header_params] || {}
|
|
734
|
-
|
|
735
|
-
# form parameters
|
|
736
|
-
form_params = opts[:form_params] || {}
|
|
737
|
-
|
|
738
|
-
# http body (model)
|
|
739
|
-
post_body = opts[:debug_body]
|
|
740
|
-
|
|
741
|
-
# return_type
|
|
742
|
-
return_type = opts[:debug_return_type]
|
|
743
|
-
|
|
744
|
-
# auth_names
|
|
745
|
-
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
|
746
|
-
|
|
747
|
-
new_options = opts.merge(
|
|
748
|
-
:operation => :"ConnectionsApi.remove_brokerage_authorization",
|
|
749
|
-
:header_params => header_params,
|
|
750
|
-
:query_params => query_params,
|
|
751
|
-
:form_params => form_params,
|
|
752
|
-
:body => post_body,
|
|
753
|
-
:auth_names => auth_names,
|
|
754
|
-
:return_type => return_type
|
|
755
|
-
)
|
|
756
|
-
|
|
757
|
-
data, status_code, headers, response = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
758
|
-
if @api_client.config.debugging
|
|
759
|
-
@api_client.config.logger.debug "API called: ConnectionsApi#remove_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
760
|
-
end
|
|
761
|
-
return data, status_code, headers, response
|
|
762
|
-
end
|
|
763
|
-
|
|
764
|
-
|
|
765
664
|
# List connection rate of returns
|
|
766
665
|
#
|
|
767
666
|
# Returns a list of rate of return percents for a given connection.
|
|
@@ -872,106 +771,6 @@ module SnapTrade
|
|
|
872
771
|
end
|
|
873
772
|
|
|
874
773
|
|
|
875
|
-
# Get all session events for a user
|
|
876
|
-
#
|
|
877
|
-
# Returns a list of session events associated with a user.
|
|
878
|
-
#
|
|
879
|
-
# @param partner_client_id [String]
|
|
880
|
-
# @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
|
|
881
|
-
# @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
|
|
882
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
883
|
-
def session_events(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
|
|
884
|
-
extra[:user_id] = user_id if user_id != SENTINEL
|
|
885
|
-
extra[:session_id] = session_id if session_id != SENTINEL
|
|
886
|
-
data, _status_code, _headers = session_events_with_http_info_impl(partner_client_id, extra)
|
|
887
|
-
data
|
|
888
|
-
end
|
|
889
|
-
|
|
890
|
-
# Get all session events for a user
|
|
891
|
-
#
|
|
892
|
-
# Returns a list of session events associated with a user.
|
|
893
|
-
#
|
|
894
|
-
# @param partner_client_id [String]
|
|
895
|
-
# @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
|
|
896
|
-
# @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
|
|
897
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
898
|
-
def session_events_with_http_info(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
|
|
899
|
-
extra[:user_id] = user_id if user_id != SENTINEL
|
|
900
|
-
extra[:session_id] = session_id if session_id != SENTINEL
|
|
901
|
-
session_events_with_http_info_impl(partner_client_id, extra)
|
|
902
|
-
end
|
|
903
|
-
|
|
904
|
-
# Get all session events for a user
|
|
905
|
-
# Returns a list of session events associated with a user.
|
|
906
|
-
# @param partner_client_id [String]
|
|
907
|
-
# @param [Hash] opts the optional parameters
|
|
908
|
-
# @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
|
|
909
|
-
# @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
|
|
910
|
-
# @return [Array<ConnectionsSessionEvents200ResponseInner>]
|
|
911
|
-
private def session_events_impl(partner_client_id, opts = {})
|
|
912
|
-
data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
|
|
913
|
-
data
|
|
914
|
-
end
|
|
915
|
-
|
|
916
|
-
# Get all session events for a user
|
|
917
|
-
# Returns a list of session events associated with a user.
|
|
918
|
-
# @param partner_client_id [String]
|
|
919
|
-
# @param [Hash] opts the optional parameters
|
|
920
|
-
# @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
|
|
921
|
-
# @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
|
|
922
|
-
# @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
|
|
923
|
-
private def session_events_with_http_info_impl(partner_client_id, opts = {})
|
|
924
|
-
if @api_client.config.debugging
|
|
925
|
-
@api_client.config.logger.debug 'Calling API: ConnectionsApi.session_events ...'
|
|
926
|
-
end
|
|
927
|
-
# verify the required parameter 'partner_client_id' is set
|
|
928
|
-
if @api_client.config.client_side_validation && partner_client_id.nil?
|
|
929
|
-
fail ArgumentError, "Missing the required parameter 'partner_client_id' when calling ConnectionsApi.session_events"
|
|
930
|
-
end
|
|
931
|
-
# resource path
|
|
932
|
-
local_var_path = '/sessionEvents'
|
|
933
|
-
|
|
934
|
-
# query parameters
|
|
935
|
-
query_params = opts[:query_params] || {}
|
|
936
|
-
query_params[:'PartnerClientId'] = partner_client_id
|
|
937
|
-
query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
|
|
938
|
-
query_params[:'sessionId'] = opts[:'session_id'] if !opts[:'session_id'].nil?
|
|
939
|
-
|
|
940
|
-
# header parameters
|
|
941
|
-
header_params = opts[:header_params] || {}
|
|
942
|
-
# HTTP header 'Accept' (if needed)
|
|
943
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
944
|
-
|
|
945
|
-
# form parameters
|
|
946
|
-
form_params = opts[:form_params] || {}
|
|
947
|
-
|
|
948
|
-
# http body (model)
|
|
949
|
-
post_body = opts[:debug_body]
|
|
950
|
-
|
|
951
|
-
# return_type
|
|
952
|
-
return_type = opts[:debug_return_type] || 'Array<ConnectionsSessionEvents200ResponseInner>'
|
|
953
|
-
|
|
954
|
-
# auth_names
|
|
955
|
-
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
|
956
|
-
|
|
957
|
-
new_options = opts.merge(
|
|
958
|
-
:operation => :"ConnectionsApi.session_events",
|
|
959
|
-
:header_params => header_params,
|
|
960
|
-
:query_params => query_params,
|
|
961
|
-
:form_params => form_params,
|
|
962
|
-
:body => post_body,
|
|
963
|
-
:auth_names => auth_names,
|
|
964
|
-
:return_type => return_type
|
|
965
|
-
)
|
|
966
|
-
|
|
967
|
-
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
|
968
|
-
if @api_client.config.debugging
|
|
969
|
-
@api_client.config.logger.debug "API called: ConnectionsApi#session_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
970
|
-
end
|
|
971
|
-
return data, status_code, headers, response
|
|
972
|
-
end
|
|
973
|
-
|
|
974
|
-
|
|
975
774
|
# Sync transactions for a connection
|
|
976
775
|
#
|
|
977
776
|
# Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|