snaptrade 3.0.56 → 3.0.57
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/README.md +7 -7
- data/lib/snaptrade/api/account_information_api.rb +16 -16
- data/lib/snaptrade/api/connections_api.rb +4 -4
- data/lib/snaptrade/models/account.rb +1 -1
- data/lib/snaptrade/models/account_category.rb +2 -1
- data/lib/snaptrade/models/annuity_account.rb +1 -1
- data/lib/snaptrade/models/annuity_account_sync_status.rb +1 -1
- data/lib/snaptrade/models/connection_account.rb +5 -3
- data/lib/snaptrade/models/mortgage_account.rb +356 -0
- data/lib/snaptrade/models/mortgage_account_kind.rb +36 -0
- data/lib/snaptrade/models/mortgage_account_net_value.rb +228 -0
- data/lib/snaptrade/models/mortgage_account_sync_status.rb +228 -0
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +4 -0
- data/spec/api/account_information_api_spec.rb +4 -4
- data/spec/api/connections_api_spec.rb +1 -1
- data/spec/models/mortgage_account_kind_spec.rb +23 -0
- data/spec/models/mortgage_account_net_value_spec.rb +35 -0
- data/spec/models/mortgage_account_spec.rb +95 -0
- data/spec/models/mortgage_account_sync_status_spec.rb +35 -0
- metadata +301 -289
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6209e647c586658dbbb6545fafd560c0a611ad8156d6d27b1eb4795abb3300c6
|
|
4
|
+
data.tar.gz: 25f5c17b087184330fcee6528a21269e32b95b126216b74b1fe691f35fe369a8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 292bfc9397a82c5191583849e35206d7bfa9e4c69b86c7ecccbcf0423e2909fe71d5d5dfed0e347f32b73dab8e7c8aa7d4e3c398b5856d134f4345e2ab3000c8
|
|
7
|
+
data.tar.gz: 92040801dc21f003952a4a05b04843af7abe57bd6a369a5dade9c22b2311f12a5d0ff3cc2c9a81498554fc2aa952936a8381f64a4ca27cc7853e26d7daad78d5
|
data/README.md
CHANGED
|
@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
|
|
|
63
63
|
See https://docs.snaptrade.com/docs/ratelimiting.
|
|
64
64
|
|
|
65
65
|
|
|
66
|
-
[](https://rubygems.org/gems/snaptrade/versions/3.0.57)
|
|
67
67
|
[](https://snaptrade.com/)
|
|
68
68
|
|
|
69
69
|
</div>
|
|
@@ -149,7 +149,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
|
|
|
149
149
|
Add to Gemfile:
|
|
150
150
|
|
|
151
151
|
```ruby
|
|
152
|
-
gem 'snaptrade', '~> 3.0.
|
|
152
|
+
gem 'snaptrade', '~> 3.0.57'
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -361,7 +361,7 @@ p result
|
|
|
361
361
|
|
|
362
362
|
### `snaptrade.account_information.get_account_details`<a id="snaptradeaccount_informationget_account_details"></a>
|
|
363
363
|
|
|
364
|
-
Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
364
|
+
Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account.
|
|
365
365
|
|
|
366
366
|
On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
367
367
|
|
|
@@ -486,7 +486,7 @@ p result
|
|
|
486
486
|
### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
|
|
487
487
|

|
|
488
488
|
|
|
489
|
-
**Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
489
|
+
**Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
490
490
|
|
|
491
491
|
Returns account detail known to SnapTrade for the specified account.
|
|
492
492
|
|
|
@@ -753,7 +753,7 @@ p result
|
|
|
753
753
|
|
|
754
754
|
Returns all accounts across all connections known to SnapTrade for the authenticated user.
|
|
755
755
|
|
|
756
|
-
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
756
|
+
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
757
757
|
|
|
758
758
|
This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
759
759
|
|
|
@@ -788,7 +788,7 @@ p result
|
|
|
788
788
|
### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
|
|
789
789
|

|
|
790
790
|
|
|
791
|
-
**Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
791
|
+
**Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
792
792
|
|
|
793
793
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
794
794
|
|
|
@@ -1283,7 +1283,7 @@ p result
|
|
|
1283
1283
|
|
|
1284
1284
|
Returns all accounts that belong to the specified connection for the authenticated user.
|
|
1285
1285
|
|
|
1286
|
-
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1286
|
+
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
1287
1287
|
|
|
1288
1288
|
On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
1289
1289
|
|
|
@@ -415,7 +415,7 @@ module SnapTrade
|
|
|
415
415
|
|
|
416
416
|
# Get account details
|
|
417
417
|
#
|
|
418
|
-
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
418
|
+
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account.
|
|
419
419
|
#
|
|
420
420
|
# On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
421
421
|
#
|
|
@@ -436,7 +436,7 @@ module SnapTrade
|
|
|
436
436
|
|
|
437
437
|
# Get account details
|
|
438
438
|
#
|
|
439
|
-
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
439
|
+
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account.
|
|
440
440
|
#
|
|
441
441
|
# On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
442
442
|
#
|
|
@@ -455,7 +455,7 @@ module SnapTrade
|
|
|
455
455
|
end
|
|
456
456
|
|
|
457
457
|
# Get account details
|
|
458
|
-
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
458
|
+
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
|
|
459
459
|
# @param user_id [String]
|
|
460
460
|
# @param user_secret [String]
|
|
461
461
|
# @param account_id [String]
|
|
@@ -467,7 +467,7 @@ module SnapTrade
|
|
|
467
467
|
end
|
|
468
468
|
|
|
469
469
|
# Get account details
|
|
470
|
-
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
470
|
+
# Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
|
|
471
471
|
# @param user_id [String]
|
|
472
472
|
# @param user_secret [String]
|
|
473
473
|
# @param account_id [String]
|
|
@@ -768,7 +768,7 @@ module SnapTrade
|
|
|
768
768
|
|
|
769
769
|
# Get account detail
|
|
770
770
|
#
|
|
771
|
-
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
771
|
+
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
772
772
|
#
|
|
773
773
|
# Returns account detail known to SnapTrade for the specified account.
|
|
774
774
|
#
|
|
@@ -789,7 +789,7 @@ module SnapTrade
|
|
|
789
789
|
|
|
790
790
|
# Get account detail
|
|
791
791
|
#
|
|
792
|
-
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
792
|
+
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
793
793
|
#
|
|
794
794
|
# Returns account detail known to SnapTrade for the specified account.
|
|
795
795
|
#
|
|
@@ -808,7 +808,7 @@ module SnapTrade
|
|
|
808
808
|
end
|
|
809
809
|
|
|
810
810
|
# Get account detail
|
|
811
|
-
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
811
|
+
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts. Returns account detail known to SnapTrade for the specified account. 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.
|
|
812
812
|
# @param user_id [String]
|
|
813
813
|
# @param user_secret [String]
|
|
814
814
|
# @param account_id [String]
|
|
@@ -820,7 +820,7 @@ module SnapTrade
|
|
|
820
820
|
end
|
|
821
821
|
|
|
822
822
|
# Get account detail
|
|
823
|
-
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
823
|
+
# **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts. Returns account detail known to SnapTrade for the specified account. 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.
|
|
824
824
|
# @param user_id [String]
|
|
825
825
|
# @param user_secret [String]
|
|
826
826
|
# @param account_id [String]
|
|
@@ -1519,7 +1519,7 @@ module SnapTrade
|
|
|
1519
1519
|
#
|
|
1520
1520
|
# Returns all accounts across all connections known to SnapTrade for the authenticated user.
|
|
1521
1521
|
#
|
|
1522
|
-
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1522
|
+
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
1523
1523
|
#
|
|
1524
1524
|
# This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1525
1525
|
#
|
|
@@ -1535,7 +1535,7 @@ module SnapTrade
|
|
|
1535
1535
|
#
|
|
1536
1536
|
# Returns all accounts across all connections known to SnapTrade for the authenticated user.
|
|
1537
1537
|
#
|
|
1538
|
-
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1538
|
+
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
1539
1539
|
#
|
|
1540
1540
|
# This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1541
1541
|
#
|
|
@@ -1547,7 +1547,7 @@ module SnapTrade
|
|
|
1547
1547
|
end
|
|
1548
1548
|
|
|
1549
1549
|
# List all user accounts
|
|
1550
|
-
# Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1550
|
+
# Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1551
1551
|
# @param user_id [String]
|
|
1552
1552
|
# @param user_secret [String]
|
|
1553
1553
|
# @param [Hash] opts the optional parameters
|
|
@@ -1558,7 +1558,7 @@ module SnapTrade
|
|
|
1558
1558
|
end
|
|
1559
1559
|
|
|
1560
1560
|
# List all user accounts
|
|
1561
|
-
# Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1561
|
+
# Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1562
1562
|
# @param user_id [String]
|
|
1563
1563
|
# @param user_secret [String]
|
|
1564
1564
|
# @param [Hash] opts the optional parameters
|
|
@@ -1620,7 +1620,7 @@ module SnapTrade
|
|
|
1620
1620
|
|
|
1621
1621
|
# List user accounts
|
|
1622
1622
|
#
|
|
1623
|
-
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
1623
|
+
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
1624
1624
|
#
|
|
1625
1625
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1626
1626
|
#
|
|
@@ -1636,7 +1636,7 @@ module SnapTrade
|
|
|
1636
1636
|
|
|
1637
1637
|
# List user accounts
|
|
1638
1638
|
#
|
|
1639
|
-
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
1639
|
+
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
1640
1640
|
#
|
|
1641
1641
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1642
1642
|
#
|
|
@@ -1650,7 +1650,7 @@ module SnapTrade
|
|
|
1650
1650
|
end
|
|
1651
1651
|
|
|
1652
1652
|
# List user accounts
|
|
1653
|
-
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
1653
|
+
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1654
1654
|
# @param user_id [String]
|
|
1655
1655
|
# @param user_secret [String]
|
|
1656
1656
|
# @param [Hash] opts the optional parameters
|
|
@@ -1661,7 +1661,7 @@ module SnapTrade
|
|
|
1661
1661
|
end
|
|
1662
1662
|
|
|
1663
1663
|
# List user accounts
|
|
1664
|
-
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
1664
|
+
# **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1665
1665
|
# @param user_id [String]
|
|
1666
1666
|
# @param user_secret [String]
|
|
1667
1667
|
# @param [Hash] opts the optional parameters
|
|
@@ -554,7 +554,7 @@ module SnapTrade
|
|
|
554
554
|
#
|
|
555
555
|
# Returns all accounts that belong to the specified connection for the authenticated user.
|
|
556
556
|
#
|
|
557
|
-
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
557
|
+
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
558
558
|
#
|
|
559
559
|
# On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
560
560
|
#
|
|
@@ -575,7 +575,7 @@ module SnapTrade
|
|
|
575
575
|
#
|
|
576
576
|
# Returns all accounts that belong to the specified connection for the authenticated user.
|
|
577
577
|
#
|
|
578
|
-
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
578
|
+
# The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
579
579
|
#
|
|
580
580
|
# On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
581
581
|
#
|
|
@@ -592,7 +592,7 @@ module SnapTrade
|
|
|
592
592
|
end
|
|
593
593
|
|
|
594
594
|
# List accounts
|
|
595
|
-
# Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
595
|
+
# Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
596
596
|
# @param connection_id [String]
|
|
597
597
|
# @param user_id [String]
|
|
598
598
|
# @param user_secret [String]
|
|
@@ -604,7 +604,7 @@ module SnapTrade
|
|
|
604
604
|
end
|
|
605
605
|
|
|
606
606
|
# List accounts
|
|
607
|
-
# Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
607
|
+
# Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
608
608
|
# @param connection_id [String]
|
|
609
609
|
# @param user_id [String]
|
|
610
610
|
# @param user_secret [String]
|
|
@@ -50,7 +50,7 @@ module SnapTrade
|
|
|
50
50
|
# The account type as provided by the brokerage
|
|
51
51
|
attr_accessor :raw_type
|
|
52
52
|
|
|
53
|
-
# The category of the account, normalized across institutions. Returns `null` if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See [Filtering Accounts by Category](https://docs.snaptrade.com/docs/filtering-accounts-by-category) for more information. - `INVESTMENT`: A brokerage / investment account (equities, options, crypto, etc.). - `DEPOSIT`: A bank deposit account (checking, savings). - `LOC`: A line of credit account. - `ANNUITY`: An annuity contract account.
|
|
53
|
+
# The category of the account, normalized across institutions. Returns `null` if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See [Filtering Accounts by Category](https://docs.snaptrade.com/docs/filtering-accounts-by-category) for more information. - `INVESTMENT`: A brokerage / investment account (equities, options, crypto, etc.). - `DEPOSIT`: A bank deposit account (checking, savings). - `LOC`: A line of credit account. - `ANNUITY`: An annuity contract account. - `MORTGAGE`: A mortgage account.
|
|
54
54
|
attr_accessor :account_category
|
|
55
55
|
|
|
56
56
|
# Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
|
|
@@ -16,9 +16,10 @@ module SnapTrade
|
|
|
16
16
|
DEPOSIT = "DEPOSIT".freeze
|
|
17
17
|
LOC = "LOC".freeze
|
|
18
18
|
ANNUITY = "ANNUITY".freeze
|
|
19
|
+
MORTGAGE = "MORTGAGE".freeze
|
|
19
20
|
|
|
20
21
|
def self.all_vars
|
|
21
|
-
@all_vars ||= [INVESTMENT, DEPOSIT, LOC, ANNUITY].freeze
|
|
22
|
+
@all_vars ||= [INVESTMENT, DEPOSIT, LOC, ANNUITY, MORTGAGE].freeze
|
|
22
23
|
end
|
|
23
24
|
|
|
24
25
|
# Builds the enum from string
|
|
@@ -11,7 +11,7 @@ require 'date'
|
|
|
11
11
|
require 'time'
|
|
12
12
|
|
|
13
13
|
module SnapTrade
|
|
14
|
-
# An annuity contract account under a connection.
|
|
14
|
+
# An annuity contract account under a connection. Investment accounts holding annuity products remain `investment` accounts. `net_value` is the contract's surrender/cash value, not available cash. It is real-time or cached depending on the caller's plan, and always cached on `AccountInformation_listAllUserAccounts`.
|
|
15
15
|
class AnnuityAccount
|
|
16
16
|
# Discriminator for the account kind.
|
|
17
17
|
attr_accessor :kind
|
|
@@ -11,7 +11,7 @@ require 'date'
|
|
|
11
11
|
require 'time'
|
|
12
12
|
|
|
13
13
|
module SnapTrade
|
|
14
|
-
# Contains sync status for an annuity contract's value.
|
|
14
|
+
# Contains sync status for an annuity contract's value. Transactions, orders, and positions are omitted. `balances` is derived from the last successful holdings sync and is null if never synced. It tracks the contract value, not available cash.
|
|
15
15
|
class AnnuityAccountSyncStatus
|
|
16
16
|
# The last time the annuity contract value was successfully synced by SnapTrade.
|
|
17
17
|
attr_accessor :balances
|
|
@@ -11,7 +11,7 @@ require 'date'
|
|
|
11
11
|
require 'time'
|
|
12
12
|
|
|
13
13
|
module SnapTrade
|
|
14
|
-
# A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts` and `AccountInformation_listAllUserAccounts`. Use `kind` to determine which schema is present. `investment`, `deposit`, `line_of_credit`, and `
|
|
14
|
+
# A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts` and `AccountInformation_listAllUserAccounts`. Use `kind` to determine which schema is present. `investment`, `deposit`, `line_of_credit`, `annuity`, and `mortgage` are implemented today.
|
|
15
15
|
module ConnectionAccount
|
|
16
16
|
class << self
|
|
17
17
|
# List of class defined in oneOf (OpenAPI v3)
|
|
@@ -20,7 +20,8 @@ module SnapTrade
|
|
|
20
20
|
:'AnnuityAccount',
|
|
21
21
|
:'DepositAccount',
|
|
22
22
|
:'InvestmentAccount',
|
|
23
|
-
:'LineOfCreditAccount'
|
|
23
|
+
:'LineOfCreditAccount',
|
|
24
|
+
:'MortgageAccount'
|
|
24
25
|
]
|
|
25
26
|
end
|
|
26
27
|
|
|
@@ -35,7 +36,8 @@ module SnapTrade
|
|
|
35
36
|
:'annuity' => :'AnnuityAccount',
|
|
36
37
|
:'deposit' => :'DepositAccount',
|
|
37
38
|
:'investment' => :'InvestmentAccount',
|
|
38
|
-
:'line_of_credit' => :'LineOfCreditAccount'
|
|
39
|
+
:'line_of_credit' => :'LineOfCreditAccount',
|
|
40
|
+
:'mortgage' => :'MortgageAccount'
|
|
39
41
|
}
|
|
40
42
|
end
|
|
41
43
|
|