snaptrade 1.17.6 → 1.17.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +14 -22
  3. data/README.md +2 -1
  4. data/docs/AccountHoldings.md +2 -2
  5. data/docs/AccountHoldingsAccount.md +2 -2
  6. data/docs/AccountOrderRecord.md +2 -2
  7. data/docs/AuthenticationApi.md +4 -0
  8. data/docs/Balance.md +1 -1
  9. data/docs/Brokerage.md +1 -1
  10. data/docs/BrokerageAuthorization.md +1 -1
  11. data/docs/BrokerageAuthorizationTypeReadOnly.md +1 -1
  12. data/docs/BrokerageSymbol.md +1 -1
  13. data/docs/BrokerageSymbolOptionSymbol.md +1 -1
  14. data/docs/BrokerageSymbolSymbol.md +3 -3
  15. data/docs/ConnectionPortalVersion.md +15 -0
  16. data/docs/EncryptedResponse.md +1 -1
  17. data/docs/ExchangeRatePairs.md +2 -2
  18. data/docs/ExcludedAsset.md +1 -1
  19. data/docs/ManualTrade.md +1 -1
  20. data/docs/ManualTradeAndImpact.md +2 -2
  21. data/docs/ManualTradeBalance.md +2 -2
  22. data/docs/ManualTradeSymbol.md +1 -1
  23. data/docs/ModelAssetClassDetails.md +1 -1
  24. data/docs/ModelAssetClassTarget.md +1 -1
  25. data/docs/ModelPortfolioAssetClass.md +1 -1
  26. data/docs/ModelPortfolioDetails.md +1 -1
  27. data/docs/ModelPortfolioSecurity.md +1 -1
  28. data/docs/MonthlyDividends.md +1 -1
  29. data/docs/NetContributions.md +1 -1
  30. data/docs/NetDividend.md +1 -1
  31. data/docs/OptionStrategy.md +1 -1
  32. data/docs/OptionsHoldings.md +2 -2
  33. data/docs/OptionsPosition.md +1 -1
  34. data/docs/OptionsSymbol.md +1 -1
  35. data/docs/PastValue.md +1 -1
  36. data/docs/PerformanceCustom.md +1 -1
  37. data/docs/PortfolioGroupInfo.md +1 -1
  38. data/docs/PortfolioGroupPosition.md +1 -1
  39. data/docs/PortfolioGroupSettings.md +1 -1
  40. data/docs/Position.md +1 -1
  41. data/docs/PositionSymbol.md +1 -1
  42. data/docs/SnapTradeHoldingsAccount.md +1 -1
  43. data/docs/SnapTradeLoginUserRequestBody.md +4 -2
  44. data/docs/StrategyOrderRecord.md +1 -1
  45. data/docs/StrategyQuotes.md +2 -2
  46. data/docs/SubPeriodReturnRate.md +2 -2
  47. data/docs/Symbol.md +3 -3
  48. data/docs/SymbolsQuotesInner.md +1 -1
  49. data/docs/TargetAsset.md +1 -1
  50. data/docs/Trade.md +3 -3
  51. data/docs/TradeExecutionStatus.md +3 -3
  52. data/docs/TradeImpact.md +2 -2
  53. data/docs/TransactionsAndReportingApi.md +2 -2
  54. data/docs/TransactionsStatus.md +1 -1
  55. data/docs/UnderlyingSymbol.md +3 -3
  56. data/docs/UniversalActivity.md +4 -4
  57. data/docs/UniversalSymbol.md +3 -3
  58. data/docs/UniversalSymbolTicker.md +3 -3
  59. data/docs/UserSettings.md +1 -1
  60. data/lib/snaptrade/api/authentication_api.rb +8 -4
  61. data/lib/snaptrade/api/transactions_and_reporting_api.rb +8 -8
  62. data/lib/snaptrade/models/connection_portal_version.rb +38 -0
  63. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +14 -5
  64. data/lib/snaptrade/version.rb +1 -1
  65. data/lib/snaptrade.rb +1 -0
  66. data/spec/api/transactions_and_reporting_api_spec.rb +2 -2
  67. data/spec/models/connection_portal_version_spec.rb +24 -0
  68. data/spec/models/snap_trade_login_user_request_body_spec.rb +6 -0
  69. metadata +7 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2ccb4f353fc653e152f5eb6afeefe3656924848582cb959f02377cee0787e5a9
4
- data.tar.gz: ccc5319257834058e7106231218b202c300167874e05dcc7ebd4e31bd7071685
3
+ metadata.gz: 7b221cb897fe57d17b100c1fbbbdf614465b1b0d390b9287d7508d181d765cbc
4
+ data.tar.gz: 9618df627fc3d0189fcae206d2a7a4b6904505cad3cfc0ee0b0c8068a533caed
5
5
  SHA512:
6
- metadata.gz: 68ae35db6b8a6691621ea5cfe413660792d1d81094fc8d40bd5a2dca5e1417ed66c759e5de54f7dad19337926929a88e038070b0be2dbc5e707e157fd6a06747
7
- data.tar.gz: 0d598c9e1a80b10f4d88e8c1e806794c0075835a88d8f01b8fbcaf12b32e018676ee2b4a30f1223050969f68d6a2279393e68a0ffa95c1af5417b0adae4ce588
6
+ metadata.gz: 5faaa3a1204977ad12102406c5098402c96aa2f3ee6cc3010d1463907a50cb520627fed07aa9d5c552ca347db35d60fe88f35239f9f9cce8db96f7b2afa24765
7
+ data.tar.gz: a1571025bd5c63cb10f51228802633d119e5a6098febeef2ac6738942a0ef623ff013d7a0c46f23b69a8c4a1240d9f555a16837d79af5887e015cc4fc0f90eb9
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (1.17.5)
4
+ snaptrade (1.17.7)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -9,14 +9,14 @@ GEM
9
9
  remote: https://rubygems.org/
10
10
  specs:
11
11
  ast (2.4.2)
12
- base64 (0.1.1)
12
+ base64 (0.2.0)
13
13
  byebug (11.1.3)
14
14
  coderay (1.1.3)
15
15
  debug (1.8.0)
16
16
  irb (>= 1.5.0)
17
17
  reline (>= 0.3.1)
18
18
  diff-lcs (1.5.0)
19
- faraday (2.7.11)
19
+ faraday (2.7.12)
20
20
  base64
21
21
  faraday-net_http (>= 2.0, < 3.1)
22
22
  ruby2_keywords (>= 0.0.4)
@@ -24,32 +24,25 @@ GEM
24
24
  multipart-post (~> 2)
25
25
  faraday-net_http (3.0.2)
26
26
  io-console (0.6.0)
27
- irb (1.8.1)
28
- rdoc
29
- reline (>= 0.3.8)
27
+ irb (1.6.4)
28
+ reline (>= 0.3.0)
30
29
  method_source (1.0.0)
31
30
  multipart-post (2.3.0)
32
31
  parallel (1.23.0)
33
- parser (3.2.2.3)
32
+ parser (3.2.2.1)
34
33
  ast (~> 2.4.1)
35
- racc
36
34
  pry (0.14.2)
37
35
  coderay (~> 1.1)
38
36
  method_source (~> 1.0)
39
37
  pry-byebug (3.10.1)
40
38
  byebug (~> 11.0)
41
39
  pry (>= 0.13, < 0.15)
42
- psych (5.1.0)
43
- stringio
44
- racc (1.7.1)
45
40
  rainbow (3.1.1)
46
41
  rake (13.0.6)
47
- rdoc (6.5.0)
48
- psych (>= 4.0.0)
49
- regexp_parser (2.8.1)
50
- reline (0.3.8)
42
+ regexp_parser (2.8.0)
43
+ reline (0.3.4)
51
44
  io-console (~> 0.5)
52
- rexml (3.2.6)
45
+ rexml (3.2.5)
53
46
  rspec (3.12.0)
54
47
  rspec-core (~> 3.12.0)
55
48
  rspec-expectations (~> 3.12.0)
@@ -59,10 +52,10 @@ GEM
59
52
  rspec-expectations (3.12.3)
60
53
  diff-lcs (>= 1.2.0, < 2.0)
61
54
  rspec-support (~> 3.12.0)
62
- rspec-mocks (3.12.6)
55
+ rspec-mocks (3.12.5)
63
56
  diff-lcs (>= 1.2.0, < 2.0)
64
57
  rspec-support (~> 3.12.0)
65
- rspec-support (3.12.1)
58
+ rspec-support (3.12.0)
66
59
  rubocop (1.12.1)
67
60
  parallel (~> 1.10)
68
61
  parser (>= 3.0.0.0)
@@ -72,15 +65,14 @@ GEM
72
65
  rubocop-ast (>= 1.2.0, < 2.0)
73
66
  ruby-progressbar (~> 1.7)
74
67
  unicode-display_width (>= 1.4.0, < 3.0)
75
- rubocop-ast (1.29.0)
68
+ rubocop-ast (1.28.1)
76
69
  parser (>= 3.2.1.0)
77
70
  ruby-progressbar (1.13.0)
78
71
  ruby2_keywords (0.0.5)
79
- stringio (3.0.8)
80
72
  unicode-display_width (2.4.2)
81
73
 
82
74
  PLATFORMS
83
- arm64-darwin-22
75
+ arm64-darwin-21
84
76
 
85
77
  DEPENDENCIES
86
78
  debug (~> 1.8)
@@ -91,4 +83,4 @@ DEPENDENCIES
91
83
  snaptrade!
92
84
 
93
85
  BUNDLED WITH
94
- 2.4.19
86
+ 2.3.7
data/README.md CHANGED
@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
9
9
  Add to Gemfile:
10
10
 
11
11
  ```ruby
12
- gem 'snaptrade', '~> 1.17.6'
12
+ gem 'snaptrade', '~> 1.17.7'
13
13
  ```
14
14
 
15
15
  ## Getting Started
@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
117
117
  - [SnapTrade::BrokerageType](docs/BrokerageType.md)
118
118
  - [SnapTrade::CalculatedTrade](docs/CalculatedTrade.md)
119
119
  - [SnapTrade::CashRestriction](docs/CashRestriction.md)
120
+ - [SnapTrade::ConnectionPortalVersion](docs/ConnectionPortalVersion.md)
120
121
  - [SnapTrade::ConnectionType](docs/ConnectionType.md)
121
122
  - [SnapTrade::ConnectionsSessionEvents200ResponseInner](docs/ConnectionsSessionEvents200ResponseInner.md)
122
123
  - [SnapTrade::Currency](docs/Currency.md)
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **account** | **SnapTradeHoldingsAccount** | | [optional] |
7
+ | **account** | [**SnapTradeHoldingsAccount**](SnapTradeHoldingsAccount.md) | | [optional] |
8
8
  | **balances** | [**Array&lt;Balance&gt;**](Balance.md) | | [optional] |
9
9
  | **positions** | [**Array&lt;Position&gt;**](Position.md) | | [optional] |
10
- | **total_value** | **SnapTradeHoldingsTotalValue** | | [optional] |
10
+ | **total_value** | [**SnapTradeHoldingsTotalValue**](SnapTradeHoldingsTotalValue.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **account** | **SnapTradeHoldingsAccountAccountId** | | [optional] |
7
+ | **account** | [**SnapTradeHoldingsAccountAccountId**](SnapTradeHoldingsAccountAccountId.md) | | [optional] |
8
8
  | **balances** | [**Array&lt;Balance&gt;**](Balance.md) | | [optional] |
9
9
  | **positions** | [**Array&lt;Position&gt;**](Position.md) | | [optional] |
10
10
  | **orders** | [**Array&lt;AccountOrderRecord&gt;**](AccountOrderRecord.md) | | [optional] |
11
- | **total_value** | **SnapTradeHoldingsTotalValue** | | [optional] |
11
+ | **total_value** | [**SnapTradeHoldingsTotalValue**](SnapTradeHoldingsTotalValue.md) | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -7,8 +7,8 @@
7
7
  | **brokerage_order_id** | **String** | Order id returned by brokerage | [optional] |
8
8
  | **status** | [**AccountOrderRecordStatus**](AccountOrderRecordStatus.md) | | [optional] |
9
9
  | **symbol** | **String** | | [optional] |
10
- | **universal_symbol** | **UniversalSymbol** | | [optional] |
11
- | **option_symbol** | **OptionsSymbol** | | [optional] |
10
+ | **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
11
+ | **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) | | [optional] |
12
12
  | **action** | [**Action**](Action.md) | | [optional] |
13
13
  | **total_quantity** | **Float** | Trade Units | [optional] |
14
14
  | **open_quantity** | **Float** | Trade Units | [optional] |
@@ -197,6 +197,7 @@ immediate_redirect = True
197
197
  custom_redirect = "https://snaptrade.com"
198
198
  reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
199
199
  connection_type = "read"
200
+ connection_portal_version = "v2"
200
201
 
201
202
  begin
202
203
  # Login user & generate connection link
@@ -208,6 +209,7 @@ begin
208
209
  custom_redirect: custom_redirect,
209
210
  reconnect: reconnect,
210
211
  connection_type: connection_type,
212
+ connection_portal_version: connection_portal_version,
211
213
  )
212
214
  p result
213
215
  rescue SnapTrade::ApiError => e
@@ -227,6 +229,7 @@ immediate_redirect = True
227
229
  custom_redirect = "https://snaptrade.com"
228
230
  reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
229
231
  connection_type = "read"
232
+ connection_portal_version = "v2"
230
233
 
231
234
  begin
232
235
  # Login user & generate connection link
@@ -238,6 +241,7 @@ begin
238
241
  custom_redirect: custom_redirect,
239
242
  reconnect: reconnect,
240
243
  connection_type: connection_type,
244
+ connection_portal_version: connection_portal_version,
241
245
  )
242
246
  p status_code # => 2xx
243
247
  p headers # => { ... }
data/docs/Balance.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **currency** | **Currency** | | [optional] |
7
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
8
8
  | **cash** | **Float** | | [optional] |
9
9
 
10
10
  ## Example
data/docs/Brokerage.md CHANGED
@@ -20,7 +20,7 @@
20
20
  | **allows_trading_through_snaptrade_api** | **Boolean** | | [optional] |
21
21
  | **is_scraping_integration** | **Boolean** | | [optional] |
22
22
  | **default_currency** | **String** | | [optional] |
23
- | **brokerage_type** | **BrokerageType** | | [optional] |
23
+ | **brokerage_type** | [**BrokerageType**](BrokerageType.md) | | [optional] |
24
24
  | **exchanges** | **Array&lt;Object&gt;** | List of exchange ID supported by brokerage | [optional] |
25
25
 
26
26
  ## Example
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | | [optional] |
8
8
  | **created_date** | **String** | Time | [optional] |
9
9
  | **updated_date** | **String** | Time | [optional] |
10
- | **brokerage** | **Brokerage** | | [optional] |
10
+ | **brokerage** | [**Brokerage**](Brokerage.md) | | [optional] |
11
11
  | **name** | **String** | Connection Name | [optional] |
12
12
  | **type** | **String** | | [optional] |
13
13
  | **disabled** | **Boolean** | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | | [optional] |
8
8
  | **type** | [**BrokerageAuthorizationTypeReadOnlyType**](BrokerageAuthorizationTypeReadOnlyType.md) | | [optional] |
9
9
  | **auth_type** | [**AuthType**](AuthType.md) | | [optional] |
10
- | **brokerage** | **BrokerageAuthorizationTypeReadOnlyBrokerage** | | [optional] |
10
+ | **brokerage** | [**BrokerageAuthorizationTypeReadOnlyBrokerage**](BrokerageAuthorizationTypeReadOnlyBrokerage.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
8
  | **symbol** | [**BrokerageSymbolSymbol**](BrokerageSymbolSymbol.md) | | [optional] |
9
- | **brokerage_authorization** | **BrokerageAuthorization** | | [optional] |
9
+ | **brokerage_authorization** | [**BrokerageAuthorization**](BrokerageAuthorization.md) | | [optional] |
10
10
  | **description** | **String** | | [optional] |
11
11
  | **allows_fractional_units** | **Boolean** | | [optional] |
12
12
  | **option_symbol** | [**BrokerageSymbolOptionSymbol**](BrokerageSymbolOptionSymbol.md) | | [optional] |
@@ -10,7 +10,7 @@
10
10
  | **strike_price** | **Float** | | |
11
11
  | **expiration_date** | **String** | | |
12
12
  | **is_mini_option** | **Boolean** | | [optional] |
13
- | **underlying_symbol** | **UnderlyingSymbol** | | |
13
+ | **underlying_symbol** | [**UnderlyingSymbol**](UnderlyingSymbol.md) | | |
14
14
  | **local_id** | **String** | | [optional] |
15
15
  | **exchange_id** | **String** | | [optional] |
16
16
 
@@ -8,9 +8,9 @@
8
8
  | **symbol** | **String** | | |
9
9
  | **raw_symbol** | **String** | | |
10
10
  | **description** | **String** | | [optional] |
11
- | **currency** | **Currency** | | |
12
- | **exchange** | **Exchange** | | [optional] |
13
- | **type** | **SecurityType** | | |
11
+ | **currency** | [**Currency**](Currency.md) | | |
12
+ | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
+ | **type** | [**SecurityType**](SecurityType.md) | | |
14
14
  | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | |
15
15
 
16
16
  ## Example
@@ -0,0 +1,15 @@
1
+ # SnapTrade::ConnectionPortalVersion
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::ConnectionPortalVersion.new()
14
+ ```
15
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **encrypted_shared_key** | **String** | | [optional] |
8
- | **encrypted_message_data** | **EncryptedResponseEncryptedMessageData** | | [optional] |
8
+ | **encrypted_message_data** | [**EncryptedResponseEncryptedMessageData**](EncryptedResponseEncryptedMessageData.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **src** | **Currency** | | [optional] |
8
- | **dst** | **Currency** | | [optional] |
7
+ | **src** | [**Currency**](Currency.md) | | [optional] |
8
+ | **dst** | [**Currency**](Currency.md) | | [optional] |
9
9
  | **exchange_rate** | **Float** | | [optional] |
10
10
 
11
11
  ## Example
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
data/docs/ManualTrade.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **account** | **String** | | [optional] |
9
9
  | **order_type** | [**OrderType**](OrderType.md) | | [optional] |
10
10
  | **time_in_force** | [**TimeInForce**](TimeInForce.md) | | [optional] |
11
- | **symbol** | **ManualTradeSymbol** | | [optional] |
11
+ | **symbol** | [**ManualTradeSymbol**](ManualTradeSymbol.md) | | [optional] |
12
12
  | **action** | [**Action**](Action.md) | | [optional] |
13
13
  | **units** | **Float** | Trade Units | [optional] |
14
14
  | **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **trade** | **ManualTrade** | | [optional] |
7
+ | **trade** | [**ManualTrade**](ManualTrade.md) | | [optional] |
8
8
  | **trade_impacts** | [**Array&lt;ManualTrade&gt;**](ManualTrade.md) | | [optional] |
9
- | **combined_remaining_balance** | **ManualTradeBalance** | | [optional] |
9
+ | **combined_remaining_balance** | [**ManualTradeBalance**](ManualTradeBalance.md) | | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **account** | **Account** | | [optional] |
8
- | **currency** | **Currency** | | [optional] |
7
+ | **account** | [**Account**](Account.md) | | [optional] |
8
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
9
9
  | **cash** | **Float** | Cash | [optional] |
10
10
 
11
11
  ## Example
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **brokerage_symbol_id** | **String** | | [optional] |
8
8
  | **universal_symbol_id** | **String** | | [optional] |
9
- | **currency** | **Currency** | | [optional] |
9
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
10
10
  | **local_id** | **String** | | [optional] |
11
11
  | **description** | **String** | | [optional] |
12
12
  | **symbol** | **String** | | [optional] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **model_asset_class** | **ModelAssetClass** | | [optional] |
7
+ | **model_asset_class** | [**ModelAssetClass**](ModelAssetClass.md) | | [optional] |
8
8
  | **model_asset_class_target** | [**Array&lt;ModelAssetClassTarget&gt;**](ModelAssetClassTarget.md) | | [optional] |
9
9
 
10
10
  ## Example
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **model_asset_class** | **ModelAssetClass** | | [optional] |
7
+ | **model_asset_class** | [**ModelAssetClass**](ModelAssetClass.md) | | [optional] |
8
8
  | **percent** | **Integer** | | [optional] |
9
9
 
10
10
  ## Example
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **model_portfolio** | **ModelPortfolio** | | [optional] |
7
+ | **model_portfolio** | [**ModelPortfolio**](ModelPortfolio.md) | | [optional] |
8
8
  | **model_portfolio_security** | [**Array&lt;ModelPortfolioSecurity&gt;**](ModelPortfolioSecurity.md) | | [optional] |
9
9
  | **model_portfolio_asset_class** | [**Array&lt;ModelPortfolioAssetClass&gt;**](ModelPortfolioAssetClass.md) | | [optional] |
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
  | **percent** | **Integer** | | [optional] |
9
9
 
10
10
  ## Example
@@ -13,7 +13,7 @@
13
13
  require 'snaptrade'
14
14
 
15
15
  instance = SnapTrade::MonthlyDividends.new(
16
- date: Mon Jan 24 00:00:00 UTC 2022,
16
+ date: Sun Jan 23 16:00:00 PST 2022,
17
17
  dividends: null
18
18
  )
19
19
  ```
@@ -14,7 +14,7 @@
14
14
  require 'snaptrade'
15
15
 
16
16
  instance = SnapTrade::NetContributions.new(
17
- date: Mon Jan 24 00:00:00 UTC 2022,
17
+ date: Sun Jan 23 16:00:00 PST 2022,
18
18
  contributions: 524.74,
19
19
  currency: CAD
20
20
  )
data/docs/NetDividend.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
  | **amount** | **Float** | | [optional] |
9
9
  | **currency** | **String** | | [optional] |
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **underlying_symbol_id** | **UniversalSymbol** | | [optional] |
8
+ | **underlying_symbol_id** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
9
9
  | **strategy_type** | **String** | | [optional] |
10
10
  | **number_of_legs** | **Float** | | [optional] |
11
11
  | **legs** | [**Array&lt;OptionStrategyLegsInner&gt;**](OptionStrategyLegsInner.md) | | [optional] |
@@ -6,9 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | Options information | [optional] |
8
8
  | **symbol** | **String** | | [optional] |
9
- | **option_symbol** | **OptionsSymbol** | | [optional] |
9
+ | **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) | | [optional] |
10
10
  | **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
11
- | **currency** | **Currency** | | [optional] |
11
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
12
12
  | **average_purchase_price** | **Float** | Average purchase price for this position | [optional] |
13
13
 
14
14
  ## Example
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **BrokerageSymbol** | | [optional] |
7
+ | **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) | | [optional] |
8
8
  | **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
9
9
  | **units** | **Float** | | [optional] |
10
10
  | **currency** | [**OptionsPositionCurrency**](OptionsPositionCurrency.md) | | [optional] |
@@ -10,7 +10,7 @@
10
10
  | **strike_price** | **Float** | | |
11
11
  | **expiration_date** | **String** | | |
12
12
  | **is_mini_option** | **Boolean** | | [optional] |
13
- | **underlying_symbol** | **UnderlyingSymbol** | | |
13
+ | **underlying_symbol** | [**UnderlyingSymbol**](UnderlyingSymbol.md) | | |
14
14
  | **local_id** | **String** | | [optional] |
15
15
  | **exchange_id** | **String** | | [optional] |
16
16
 
data/docs/PastValue.md CHANGED
@@ -14,7 +14,7 @@
14
14
  require 'snaptrade'
15
15
 
16
16
  instance = SnapTrade::PastValue.new(
17
- date: Mon Jan 24 00:00:00 UTC 2022,
17
+ date: Sun Jan 23 16:00:00 PST 2022,
18
18
  value: 52.74,
19
19
  currency: CAD
20
20
  )
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **total_equity_timeframe** | [**Array&lt;PastValue&gt;**](PastValue.md) | | [optional] |
8
- | **contributions** | **NetContributions** | | [optional] |
8
+ | **contributions** | [**NetContributions**](NetContributions.md) | | [optional] |
9
9
  | **contribution_timeframe** | [**Array&lt;PastValue&gt;**](PastValue.md) | | [optional] |
10
10
  | **contribution_timeframe_cumulative** | [**Array&lt;PastValue&gt;**](PastValue.md) | | [optional] |
11
11
  | **withdrawal_timeframe** | [**Array&lt;PastValue&gt;**](PastValue.md) | | [optional] |
@@ -14,7 +14,7 @@
14
14
  | **calculated_trades** | [**Array&lt;CalculatedTrade&gt;**](CalculatedTrade.md) | | [optional] |
15
15
  | **brokerage_authorizations** | [**Array&lt;BrokerageAuthorization&gt;**](BrokerageAuthorization.md) | | [optional] |
16
16
  | **accuracy** | **Float** | | [optional] |
17
- | **settings** | **PortfolioGroupSettings** | | [optional] |
17
+ | **settings** | [**PortfolioGroupSettings**](PortfolioGroupSettings.md) | | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
  | **price** | **Float** | Last known market price for the symbol | [optional] |
9
9
  | **units** | **Integer** | | [optional] |
10
10
 
@@ -8,7 +8,7 @@
8
8
  | **cash_optimizer** | **Boolean** | | [optional] |
9
9
  | **notify_frequency** | **String** | | [optional] |
10
10
  | **drift_threshold** | **Float** | | [optional] |
11
- | **preferred_currency** | **Currency** | | [optional] |
11
+ | **preferred_currency** | [**Currency**](Currency.md) | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
data/docs/Position.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **PositionSymbol** | | [optional] |
7
+ | **symbol** | [**PositionSymbol**](PositionSymbol.md) | | [optional] |
8
8
  | **units** | **Float** | | [optional] |
9
9
  | **price** | **Float** | Last known market price for the symbol | [optional] |
10
10
  | **open_pnl** | **Float** | | [optional] |
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
8
  | **description** | **String** | | [optional] |
9
- | **symbol** | **UniversalSymbol** | | [optional] |
9
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
10
10
  | **local_id** | **String** | | [optional] |
11
11
  | **is_quotable** | **Boolean** | | [optional] |
12
12
  | **is_tradable** | **Boolean** | | [optional] |
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **brokerage_authorization** | **BrokerageAuthorization** | | [optional] |
8
+ | **brokerage_authorization** | [**BrokerageAuthorization**](BrokerageAuthorization.md) | | [optional] |
9
9
  | **portfolio_group** | **String** | | [optional] |
10
10
  | **name** | **String** | | [optional] |
11
11
  | **number** | **String** | | [optional] |
@@ -7,8 +7,9 @@
7
7
  | **broker** | **String** | Slug of the brokerage to connect the user to | [optional] |
8
8
  | **immediate_redirect** | **Boolean** | When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal | [optional] |
9
9
  | **custom_redirect** | **String** | URL to redirect the user to after the user connects their brokerage account | [optional] |
10
- | **reconnect** | **String** | The UUID of the brokerage connection to be reconnected | [optional] |
10
+ | **reconnect** | **String** | The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information. | [optional] |
11
11
  | **connection_type** | [**ConnectionType**](ConnectionType.md) | | [optional] |
12
+ | **connection_portal_version** | [**ConnectionPortalVersion**](ConnectionPortalVersion.md) | | [optional] |
12
13
 
13
14
  ## Example
14
15
 
@@ -20,7 +21,8 @@ instance = SnapTrade::SnapTradeLoginUserRequestBody.new(
20
21
  immediate_redirect: true,
21
22
  custom_redirect: https://snaptrade.com,
22
23
  reconnect: 8b5f262d-4bb9-365d-888a-202bd3b15fa1,
23
- connection_type: null
24
+ connection_type: null,
25
+ connection_portal_version: null
24
26
  )
25
27
  ```
26
28
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **strategy** | **OptionStrategy** | | [optional] |
7
+ | **strategy** | [**OptionStrategy**](OptionStrategy.md) | | [optional] |
8
8
  | **status** | [**StrategyOrderRecordStatus**](StrategyOrderRecordStatus.md) | | [optional] |
9
9
  | **filled_quantity** | **Float** | | [optional] |
10
10
  | **open_quantity** | **Float** | | [optional] |
@@ -4,12 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **strategy** | **OptionStrategy** | | [optional] |
7
+ | **strategy** | [**OptionStrategy**](OptionStrategy.md) | | [optional] |
8
8
  | **open_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
9
9
  | **bid_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
10
10
  | **ask_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
11
11
  | **volatility** | **Float** | | [optional] |
12
- | **greek** | **StrategyQuotesGreek** | | [optional] |
12
+ | **greek** | [**StrategyQuotesGreek**](StrategyQuotesGreek.md) | | [optional] |
13
13
 
14
14
  ## Example
15
15
 
@@ -14,8 +14,8 @@
14
14
  require 'snaptrade'
15
15
 
16
16
  instance = SnapTrade::SubPeriodReturnRate.new(
17
- period_start: Mon Jan 24 00:00:00 UTC 2022,
18
- period_end: Mon Jan 24 00:00:00 UTC 2022,
17
+ period_start: Sun Jan 23 16:00:00 PST 2022,
18
+ period_end: Sun Jan 23 16:00:00 PST 2022,
19
19
  rate_of_return: 0.012312367452
20
20
  )
21
21
  ```
data/docs/Symbol.md CHANGED
@@ -8,9 +8,9 @@
8
8
  | **symbol** | **String** | | [optional] |
9
9
  | **raw_symbol** | **String** | | [optional] |
10
10
  | **name** | **String** | | [optional] |
11
- | **currency** | **Currency** | | [optional] |
12
- | **exchange** | **Exchange** | | [optional] |
13
- | **type** | **SecurityType** | | [optional] |
11
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
12
+ | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
+ | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
14
14
 
15
15
  ## Example
16
16
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **UniversalSymbol** | | [optional] |
7
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
8
8
  | **bid_price** | **Float** | | [optional] |
9
9
  | **ask_price** | **Float** | | [optional] |
10
10
  | **last_trade_price** | **Float** | | [optional] |
data/docs/TargetAsset.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **symbol** | **UniversalSymbol** | | [optional] |
8
+ | **symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
9
9
  | **percent** | **Float** | | [optional] |
10
10
  | **is_supported** | **Boolean** | | [optional] |
11
11
  | **is_excluded** | **Boolean** | | [optional] |
data/docs/Trade.md CHANGED
@@ -5,9 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **account** | **Account** | | [optional] |
9
- | **symbol** | **BrokerageSymbol** | | [optional] |
10
- | **universal_symbol** | **UniversalSymbol** | | [optional] |
8
+ | **account** | [**Account**](Account.md) | | [optional] |
9
+ | **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) | | [optional] |
10
+ | **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
11
11
  | **action** | [**TradeAction**](TradeAction.md) | | [optional] |
12
12
  | **units** | **Integer** | | [optional] |
13
13
  | **price** | **Float** | | [optional] |
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **symbol** | **BrokerageSymbol** | | [optional] |
8
- | **universal_symbol** | **UniversalSymbol** | | [optional] |
9
- | **trade** | **Trade** | | [optional] |
7
+ | **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) | | [optional] |
8
+ | **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) | | [optional] |
9
+ | **trade** | [**Trade**](Trade.md) | | [optional] |
10
10
  | **state** | [**State**](State.md) | | [optional] |
11
11
  | **filled_units** | **Integer** | Number of filled units | [optional] |
12
12
  | **action** | [**TradeExecutionStatusAction**](TradeExecutionStatusAction.md) | | [optional] |
data/docs/TradeImpact.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **account** | **Account** | | [optional] |
8
- | **currency** | **Currency** | | [optional] |
7
+ | **account** | [**Account**](Account.md) | | [optional] |
8
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
9
9
  | **remaining_cash** | **Float** | Remaining balance after executing all trades | [optional] |
10
10
  | **estimated_commissions** | **Float** | Total estimated commissions across all trades to make | [optional] |
11
11
  | **forex_fees** | **Float** | Estimated forex fees to pay to excute trades | [optional] |
@@ -11,7 +11,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
11
11
 
12
12
  Get transaction history for a user
13
13
 
14
- Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
14
+ Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
15
15
 
16
16
  ### Example
17
17
 
@@ -98,7 +98,7 @@ end
98
98
 
99
99
  Get performance information for a specific timeframe
100
100
 
101
- Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
101
+ Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
102
102
 
103
103
  ### Example
104
104
 
@@ -14,7 +14,7 @@ require 'snaptrade'
14
14
 
15
15
  instance = SnapTrade::TransactionsStatus.new(
16
16
  initial_sync_completed: null,
17
- last_successful_sync: Mon Jan 24 00:00:00 UTC 2022
17
+ last_successful_sync: Sun Jan 23 16:00:00 PST 2022
18
18
  )
19
19
  ```
20
20
 
@@ -7,9 +7,9 @@
7
7
  | **id** | **String** | | [optional] |
8
8
  | **symbol** | **String** | | [optional] |
9
9
  | **description** | **String** | | [optional] |
10
- | **currency** | **Currency** | | [optional] |
11
- | **exchange** | **USExchange** | | [optional] |
12
- | **type** | **SecurityType** | | [optional] |
10
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
11
+ | **exchange** | [**USExchange**](USExchange.md) | | [optional] |
12
+ | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
13
13
  | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | [optional] |
14
14
 
15
15
  ## Example
@@ -5,9 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **account** | **AccountSimple** | | [optional] |
8
+ | **account** | [**AccountSimple**](AccountSimple.md) | | [optional] |
9
9
  | **amount** | **Float** | | [optional] |
10
- | **currency** | **Currency** | | [optional] |
10
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
11
11
  | **description** | **String** | | [optional] |
12
12
  | **fee** | **Float** | | [optional] |
13
13
  | **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -&gt; currency) | [optional] |
@@ -16,8 +16,8 @@
16
16
  | **price** | **Float** | | [optional] |
17
17
  | **settlement_date** | **String** | | [optional] |
18
18
  | **external_reference_id** | **String** | Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id | [optional] |
19
- | **symbol** | **Symbol** | | [optional] |
20
- | **option_symbol** | **OptionsSymbol** | | [optional] |
19
+ | **symbol** | [**Symbol**](Symbol.md) | | [optional] |
20
+ | **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) | | [optional] |
21
21
  | **trade_date** | **String** | | [optional] |
22
22
  | **type** | **String** | Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
23
23
  | **units** | **Float** | Usually but not necessarily an integer | [optional] |
@@ -8,9 +8,9 @@
8
8
  | **symbol** | **String** | | |
9
9
  | **raw_symbol** | **String** | | |
10
10
  | **description** | **String** | | [optional] |
11
- | **currency** | **Currency** | | |
12
- | **exchange** | **Exchange** | | [optional] |
13
- | **type** | **SecurityType** | | |
11
+ | **currency** | [**Currency**](Currency.md) | | |
12
+ | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
+ | **type** | [**SecurityType**](SecurityType.md) | | |
14
14
  | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | |
15
15
 
16
16
  ## Example
@@ -8,9 +8,9 @@
8
8
  | **symbol** | **String** | | [optional] |
9
9
  | **raw_symbol** | **String** | | [optional] |
10
10
  | **description** | **String** | | [optional] |
11
- | **currency** | **Currency** | | [optional] |
12
- | **exchange** | **Exchange** | | [optional] |
13
- | **type** | **SecurityType** | | [optional] |
11
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
12
+ | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
+ | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
14
14
  | **currencies** | [**Array&lt;Currency&gt;**](Currency.md) | | [optional] |
15
15
 
16
16
  ## Example
data/docs/UserSettings.md CHANGED
@@ -13,7 +13,7 @@
13
13
  | **demo** | **Boolean** | | [optional] |
14
14
  | **api_enabled** | **Boolean** | | [optional] |
15
15
  | **drift_threshold** | **Float** | | [optional] |
16
- | **preferred_currency** | **Currency** | | [optional] |
16
+ | **preferred_currency** | [**Currency**](Currency.md) | | [optional] |
17
17
 
18
18
  ## Example
19
19
 
@@ -267,17 +267,19 @@ module SnapTrade
267
267
  # @param broker [String] Slug of the brokerage to connect the user to
268
268
  # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
269
269
  # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
270
- # @param reconnect [String] The UUID of the brokerage connection to be reconnected
270
+ # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
271
271
  # @param connection_type [ConnectionType]
272
+ # @param connection_portal_version [ConnectionPortalVersion]
272
273
  # @param body [SnapTradeLoginUserRequestBody]
273
274
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
274
- def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, extra: {})
275
+ def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
275
276
  _body = {}
276
277
  _body[:broker] = broker if broker != SENTINEL
277
278
  _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
278
279
  _body[:customRedirect] = custom_redirect if custom_redirect != SENTINEL
279
280
  _body[:reconnect] = reconnect if reconnect != SENTINEL
280
281
  _body[:connectionType] = connection_type if connection_type != SENTINEL
282
+ _body[:connectionPortalVersion] = connection_portal_version if connection_portal_version != SENTINEL
281
283
  extra[:snap_trade_login_user_request_body] = _body if !_body.empty?
282
284
  data, _status_code, _headers = login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
283
285
  data
@@ -290,17 +292,19 @@ module SnapTrade
290
292
  # @param broker [String] Slug of the brokerage to connect the user to
291
293
  # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
292
294
  # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
293
- # @param reconnect [String] The UUID of the brokerage connection to be reconnected
295
+ # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
294
296
  # @param connection_type [ConnectionType]
297
+ # @param connection_portal_version [ConnectionPortalVersion]
295
298
  # @param body [SnapTradeLoginUserRequestBody]
296
299
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
297
- def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, extra: {})
300
+ def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
298
301
  _body = {}
299
302
  _body[:broker] = broker if broker != SENTINEL
300
303
  _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
301
304
  _body[:customRedirect] = custom_redirect if custom_redirect != SENTINEL
302
305
  _body[:reconnect] = reconnect if reconnect != SENTINEL
303
306
  _body[:connectionType] = connection_type if connection_type != SENTINEL
307
+ _body[:connectionPortalVersion] = connection_portal_version if connection_portal_version != SENTINEL
304
308
  extra[:snap_trade_login_user_request_body] = _body if !_body.empty?
305
309
  login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
306
310
  end
@@ -19,7 +19,7 @@ module SnapTrade
19
19
  end
20
20
 
21
21
  # Get transaction history for a user
22
- # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
22
+ # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
23
23
  # @param user_id [String]
24
24
  # @param user_secret [String]
25
25
  # @param start_date [Date]
@@ -39,7 +39,7 @@ module SnapTrade
39
39
  end
40
40
 
41
41
  # Get transaction history for a user
42
- # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
42
+ # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
43
43
  # @param user_id [String]
44
44
  # @param user_secret [String]
45
45
  # @param start_date [Date]
@@ -58,7 +58,7 @@ module SnapTrade
58
58
  end
59
59
 
60
60
  # Get transaction history for a user
61
- # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
61
+ # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
62
62
  # @param user_id [String]
63
63
  # @param user_secret [String]
64
64
  # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ module SnapTrade
74
74
  end
75
75
 
76
76
  # Get transaction history for a user
77
- # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
77
+ # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
78
78
  # @param user_id [String]
79
79
  # @param user_secret [String]
80
80
  # @param [Hash] opts the optional parameters
@@ -145,7 +145,7 @@ module SnapTrade
145
145
 
146
146
 
147
147
  # Get performance information for a specific timeframe
148
- # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
148
+ # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
149
149
  # @param start_date [Date]
150
150
  # @param end_date [Date]
151
151
  # @param user_id [String]
@@ -163,7 +163,7 @@ module SnapTrade
163
163
  end
164
164
 
165
165
  # Get performance information for a specific timeframe
166
- # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
166
+ # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
167
167
  # @param start_date [Date]
168
168
  # @param end_date [Date]
169
169
  # @param user_id [String]
@@ -180,7 +180,7 @@ module SnapTrade
180
180
  end
181
181
 
182
182
  # Get performance information for a specific timeframe
183
- # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
183
+ # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
184
184
  # @param start_date [Date]
185
185
  # @param end_date [Date]
186
186
  # @param user_id [String]
@@ -196,7 +196,7 @@ module SnapTrade
196
196
  end
197
197
 
198
198
  # Get performance information for a specific timeframe
199
- # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
199
+ # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
200
200
  # @param start_date [Date]
201
201
  # @param end_date [Date]
202
202
  # @param user_id [String]
@@ -0,0 +1,38 @@
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 'date'
12
+ require 'time'
13
+
14
+ module SnapTrade
15
+ class ConnectionPortalVersion
16
+ V2 = "v2".freeze
17
+ V3 = "v3".freeze
18
+
19
+ def self.all_vars
20
+ @all_vars ||= [V2, V3].freeze
21
+ end
22
+
23
+ # Builds the enum from string
24
+ # @param [String] The enum value in the form of the string
25
+ # @return [String] The enum value
26
+ def self.build_from_hash(value)
27
+ new.build_from_hash(value)
28
+ end
29
+
30
+ # Builds the enum from string
31
+ # @param [String] The enum value in the form of the string
32
+ # @return [String] The enum value
33
+ def build_from_hash(value)
34
+ return value if ConnectionPortalVersion.all_vars.include?(value)
35
+ raise "Invalid ENUM value #{value} for class #ConnectionPortalVersion"
36
+ end
37
+ end
38
+ end
@@ -23,11 +23,13 @@ module SnapTrade
23
23
  # URL to redirect the user to after the user connects their brokerage account
24
24
  attr_accessor :custom_redirect
25
25
 
26
- # The UUID of the brokerage connection to be reconnected
26
+ # The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
27
27
  attr_accessor :reconnect
28
28
 
29
29
  attr_accessor :connection_type
30
30
 
31
+ attr_accessor :connection_portal_version
32
+
31
33
  # Attribute mapping from ruby-style variable name to JSON key.
32
34
  def self.attribute_map
33
35
  {
@@ -35,7 +37,8 @@ module SnapTrade
35
37
  :'immediate_redirect' => :'immediateRedirect',
36
38
  :'custom_redirect' => :'customRedirect',
37
39
  :'reconnect' => :'reconnect',
38
- :'connection_type' => :'connectionType'
40
+ :'connection_type' => :'connectionType',
41
+ :'connection_portal_version' => :'connectionPortalVersion'
39
42
  }
40
43
  end
41
44
 
@@ -51,7 +54,8 @@ module SnapTrade
51
54
  :'immediate_redirect' => :'Boolean',
52
55
  :'custom_redirect' => :'String',
53
56
  :'reconnect' => :'String',
54
- :'connection_type' => :'ConnectionType'
57
+ :'connection_type' => :'ConnectionType',
58
+ :'connection_portal_version' => :'ConnectionPortalVersion'
55
59
  }
56
60
  end
57
61
 
@@ -95,6 +99,10 @@ module SnapTrade
95
99
  if attributes.key?(:'connection_type')
96
100
  self.connection_type = attributes[:'connection_type']
97
101
  end
102
+
103
+ if attributes.key?(:'connection_portal_version')
104
+ self.connection_portal_version = attributes[:'connection_portal_version']
105
+ end
98
106
  end
99
107
 
100
108
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -119,7 +127,8 @@ module SnapTrade
119
127
  immediate_redirect == o.immediate_redirect &&
120
128
  custom_redirect == o.custom_redirect &&
121
129
  reconnect == o.reconnect &&
122
- connection_type == o.connection_type
130
+ connection_type == o.connection_type &&
131
+ connection_portal_version == o.connection_portal_version
123
132
  end
124
133
 
125
134
  # @see the `==` method
@@ -131,7 +140,7 @@ module SnapTrade
131
140
  # Calculates hash code according to all attributes.
132
141
  # @return [Integer] Hash code
133
142
  def hash
134
- [broker, immediate_redirect, custom_redirect, reconnect, connection_type].hash
143
+ [broker, immediate_redirect, custom_redirect, reconnect, connection_type, connection_portal_version].hash
135
144
  end
136
145
 
137
146
  # Builds the object from hash
@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
9
9
  =end
10
10
 
11
11
  module SnapTrade
12
- VERSION = '1.17.6'
12
+ VERSION = '1.17.7'
13
13
  end
data/lib/snaptrade.rb CHANGED
@@ -44,6 +44,7 @@ require 'snaptrade/models/brokerage_symbol_symbol'
44
44
  require 'snaptrade/models/brokerage_type'
45
45
  require 'snaptrade/models/calculated_trade'
46
46
  require 'snaptrade/models/cash_restriction'
47
+ require 'snaptrade/models/connection_portal_version'
47
48
  require 'snaptrade/models/connection_type'
48
49
  require 'snaptrade/models/connections_session_events200_response_inner'
49
50
  require 'snaptrade/models/currency'
@@ -30,7 +30,7 @@ describe 'TransactionsAndReportingApi' do
30
30
 
31
31
  # unit tests for get_activities
32
32
  # Get transaction history for a user
33
- # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
33
+ # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
34
34
  # @param user_id
35
35
  # @param user_secret
36
36
  # @param [Hash] opts the optional parameters
@@ -48,7 +48,7 @@ describe 'TransactionsAndReportingApi' do
48
48
 
49
49
  # unit tests for get_reporting_custom_range
50
50
  # Get performance information for a specific timeframe
51
- # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
51
+ # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
52
52
  # @param start_date
53
53
  # @param end_date
54
54
  # @param user_id
@@ -0,0 +1,24 @@
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 'spec_helper'
12
+ require 'json'
13
+ require 'date'
14
+
15
+ # Unit tests for SnapTrade::ConnectionPortalVersion
16
+ describe SnapTrade::ConnectionPortalVersion do
17
+ let(:instance) { SnapTrade::ConnectionPortalVersion.new }
18
+
19
+ describe 'test an instance of ConnectionPortalVersion' do
20
+ it 'should create an instance of ConnectionPortalVersion' do
21
+ expect(instance).to be_instance_of(SnapTrade::ConnectionPortalVersion)
22
+ end
23
+ end
24
+ end
@@ -51,4 +51,10 @@ describe SnapTrade::SnapTradeLoginUserRequestBody do
51
51
  end
52
52
  end
53
53
 
54
+ describe 'test attribute "connection_portal_version"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
57
+ end
58
+ end
59
+
54
60
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: snaptrade
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.6
4
+ version: 1.17.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-15 00:00:00.000000000 Z
11
+ date: 2023-11-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -111,6 +111,7 @@ files:
111
111
  - docs/BrokerageType.md
112
112
  - docs/CalculatedTrade.md
113
113
  - docs/CashRestriction.md
114
+ - docs/ConnectionPortalVersion.md
114
115
  - docs/ConnectionType.md
115
116
  - docs/ConnectionsApi.md
116
117
  - docs/ConnectionsSessionEvents200ResponseInner.md
@@ -261,6 +262,7 @@ files:
261
262
  - lib/snaptrade/models/brokerage_type.rb
262
263
  - lib/snaptrade/models/calculated_trade.rb
263
264
  - lib/snaptrade/models/cash_restriction.rb
265
+ - lib/snaptrade/models/connection_portal_version.rb
264
266
  - lib/snaptrade/models/connection_type.rb
265
267
  - lib/snaptrade/models/connections_session_events200_response_inner.rb
266
268
  - lib/snaptrade/models/currency.rb
@@ -404,6 +406,7 @@ files:
404
406
  - spec/models/brokerage_type_spec.rb
405
407
  - spec/models/calculated_trade_spec.rb
406
408
  - spec/models/cash_restriction_spec.rb
409
+ - spec/models/connection_portal_version_spec.rb
407
410
  - spec/models/connection_type_spec.rb
408
411
  - spec/models/connections_session_events200_response_inner_spec.rb
409
412
  - spec/models/currency_spec.rb
@@ -528,7 +531,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
528
531
  - !ruby/object:Gem::Version
529
532
  version: '0'
530
533
  requirements: []
531
- rubygems_version: 3.4.10
534
+ rubygems_version: 3.3.7
532
535
  signing_key:
533
536
  specification_version: 4
534
537
  summary: SnapTrade Ruby Gem
@@ -589,6 +592,7 @@ test_files:
589
592
  - spec/models/options_position_spec.rb
590
593
  - spec/models/jwt_spec.rb
591
594
  - spec/models/brokerage_spec.rb
595
+ - spec/models/connection_portal_version_spec.rb
592
596
  - spec/models/account_order_record_status_spec.rb
593
597
  - spec/models/snap_trade_api_disclaimer_accept_status_spec.rb
594
598
  - spec/models/snap_trade_login_user_request_body_spec.rb