snaptrade 2.0.29 → 2.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eda55725a9b97295f947e385aaa5003b02a7d20e8e4603cefa5a17dbdf27215d
-  data.tar.gz: f03cb7a20b125bb83a122fa42ab9948891583bb8f4888d365ec225e51f1220a1
+  metadata.gz: 90d2830fdcb3a1406af0db439f7cdec6d02b895b715c4a90093dca06c4a5e787
+  data.tar.gz: 67b0d298c28363d224e26a59cd559de0a0330498da7877e81cc3d95f03660460
 SHA512:
-  metadata.gz: dec55a480470054f6c039189d796edf016ff838ab276afa435c2b8f6fd7df6c94687ca474af52311a16c2a039a819043e938fbb228be751d67ccae77ec145590
-  data.tar.gz: 7213d617ae5118e8f7b313bbafa49446e17134c7b5fefc961626cdab60f28e61844bc8345fb40b8b77a2794aabf88b8102df9c2cb3afa1d4ffbc7d854fb35800
+  metadata.gz: 6a5af9e47b615b7eee91ec656eda1acb7a8006066df7519c2e7947371fbc09e085f1ed31e8644318033664a64d09e91eab57d468987730b9f9e28a7f6393c05d
+  data.tar.gz: 3a282337bbcad359000d485fb143dbcf9598e8a3a10fcc5b6d4844893f8aeb8d2ac57e69df4504e5d2f982252554aa2ee5ddf54f402bb1511a19c6f3b0e63f94

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.28)
+    snaptrade (2.0.29)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.29-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.29)
+[![npm](https://img.shields.io/badge/gem-v2.0.30-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.30)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.29'
+gem 'snaptrade', '~> 2.0.30'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -112,8 +112,10 @@ p.result[3] # [Faraday::Response] Raw HTTP response
 ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
 ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
-Lists balances, positions and orders for the specified account. The data returned is similar to
-the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+**Deprecated, please use the account-specific holdings endpoint instead.**
+
+List all accounts for the user, plus balances, positions, and orders for each
+account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -501,7 +503,9 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### broker: `String`<a id="broker-string"></a>
-Slug of the brokerage to connect the user to
+Slug of the brokerage to connect the user to. See [this
+document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead)
+for a list of supported brokerages and their slugs.
 
 ##### immediateRedirect: `Boolean`<a id="immediateredirect-boolean"></a>
 When set to True, user will be redirected back to the partner's site instead of
@@ -519,7 +523,7 @@ Accounts’ for more information.
 Sets whether the connection should be read or trade
 
 ##### connectionPortalVersion: [`ConnectionPortalVersion`](./lib/snaptrade/models/connection_portal_version.rb)<a id="connectionportalversion-connectionportalversionlibsnaptrademodelsconnection_portal_versionrb"></a>
-Sets the version of the connection portal to render, with a default to 'v2'
+Sets the version of the connection portal to render, with a default to 'v3'
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -536,8 +540,8 @@ Sets the version of the connection portal to render, with a default to 'v2'
 
 ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
 
-Registers a new SnapTrade user under your ClientID.
-Most SnapTrade operations require a user to be passed as a parameter.
+Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -714,7 +718,7 @@ p result
 
 ### `snaptrade.connections.refresh_brokerage_authorization`<a id="snaptradeconnectionsrefresh_brokerage_authorization"></a>
 
-Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1441,7 +1445,7 @@ Canceled
 
 ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
 
-Returns live quote(s) from the brokerage for the specified symbol(s).
+Returns quote(s) from the brokerage for the specified symbol(s).
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -19,8 +19,10 @@ module SnapTrade
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
     #
-    # Lists balances, positions and orders for the specified account. The data returned is similar to
-    # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # **Deprecated, please use the account-specific holdings endpoint instead.**
+    # 
+    # List all accounts for the user, plus balances, positions, and orders for each
+    # account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -34,8 +36,10 @@ module SnapTrade
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
     #
-    # Lists balances, positions and orders for the specified account. The data returned is similar to
-    # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # **Deprecated, please use the account-specific holdings endpoint instead.**
+    # 
+    # List all accounts for the user, plus balances, positions, and orders for each
+    # account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -47,7 +51,7 @@ module SnapTrade
     end
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
-    # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+    # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -59,7 +63,7 @@ module SnapTrade
     end
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
-    # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+    # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/api/authentication_api.rb

@@ -186,12 +186,12 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
     # @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.
     # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     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: {})
@@ -213,12 +213,12 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
     # @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.
     # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     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: {})
@@ -314,8 +314,8 @@ module SnapTrade
 
     # Create SnapTrade user
     #
-    # Registers a new SnapTrade user under your ClientID.
-    # Most SnapTrade operations require a user to be passed as a parameter.
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+    # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
@@ -330,8 +330,8 @@ module SnapTrade
 
     # Create SnapTrade user
     #
-    # Registers a new SnapTrade user under your ClientID.
-    # Most SnapTrade operations require a user to be passed as a parameter.
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+    # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
@@ -344,7 +344,7 @@ module SnapTrade
     end
 
     # Create SnapTrade user
-    # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -354,7 +354,7 @@ module SnapTrade
     end
 
     # Create SnapTrade user
-    # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/api/connections_api.rb

@@ -320,7 +320,7 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
@@ -333,7 +333,7 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
@@ -344,7 +344,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -356,7 +356,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/trading_api.rb

@@ -293,7 +293,7 @@ module SnapTrade
 
     # Get symbol quotes
     #
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -309,7 +309,7 @@ module SnapTrade
 
     # Get symbol quotes
     #
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -323,7 +323,7 @@ module SnapTrade
     end
 
     # Get symbol quotes
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param symbols [String] List of universal_symbol_id or tickers to get quotes for.
@@ -337,7 +337,7 @@ module SnapTrade
     end
 
     # Get symbol quotes
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param symbols [String] List of universal_symbol_id or tickers to get quotes for.

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # Data to login a user via SnapTrade Partner
   class SnapTradeLoginUserRequestBody
-    # Slug of the brokerage to connect the user to
+    # Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     attr_accessor :broker
 
     # When set to True, user will be redirected back to the partner's site instead of the connection portal
@@ -28,7 +28,7 @@ module SnapTrade
     # Sets whether the connection should be read or trade
     attr_accessor :connection_type
 
-    # Sets the version of the connection portal to render, with a default to 'v2'
+    # Sets the version of the connection portal to render, with a default to 'v3'
     attr_accessor :connection_portal_version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.29'
+  VERSION = '2.0.30'
 end

data/spec/api/account_information_api_spec.rb

@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_all_user_holdings
   # List all accounts for the user, plus balances, positions, and orders for each account.
-  # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+  # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/authentication_api_spec.rb

@@ -66,7 +66,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for register_snap_trade_user
   # Create SnapTrade user
-  # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+  # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
   # @param snap_trade_register_user_request_body 
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/api/connections_api_spec.rb

@@ -70,7 +70,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
   # @param authorization_id The ID of a brokerage authorization object.
   # @param user_id 
   # @param user_secret 

data/spec/api/trading_api_spec.rb

@@ -58,7 +58,7 @@ describe 'TradingApi' do
 
   # unit tests for get_user_account_quotes
   # Get symbol quotes
-  # Returns live quote(s) from the brokerage for the specified symbol(s).
+  # Returns quote(s) from the brokerage for the specified symbol(s).
   # @param user_id 
   # @param user_secret 
   # @param symbols List of universal_symbol_id or tickers to get quotes for.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.29
+  version: 2.0.30
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday