snaptrade 2.0.35 → 2.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412464fcddf65f80c586296c40db02443337c3b5c9b73ce2a2e8e4f81c891aeb
-  data.tar.gz: e7e919ba8ad6b10761c8a3e1b91533476505f4f07182d3a7537ebdcaef635103
+  metadata.gz: 88f22af63ef634b29b544f5bbc26cf9b13e9308b6f4ef33dfb560661fd5634f8
+  data.tar.gz: 86ff19da7e1921510e08601478baf357a1185d3c2637dcc1652844ec538d5a95
 SHA512:
-  metadata.gz: 538898f098a7968e48652fd208d7a1991957786d042babc3a90642ddf8a909b23329eb66bd10bdda24511314648a90ff9d3edb48a48e107d9f8afcf8ff7dba62
-  data.tar.gz: 1dd27dcf92043d041ef2f9e5bf915dcff7b9ecb504c29c8d458ce32017bc19e91febb42572a80ed4f0c9e1d1a6d0ba15486caf5aeaa16dcaf4406df4e07a3cad
+  metadata.gz: 58e865b388be36ed872dffde28d4e52ecf65b9ac0432438c3ac3882856d6cda10414360a7a1f86b58a8473097ce978525f254a4461fb8f89e15d820def612fd6
+  data.tar.gz: 40803cf194c7788f5e695f4cb72bb9db2af3afa69a6f98bcec8268ff2af8ce1c008d4414f142f63452658b83b53f6954a831a715572849b69f2697e287ff28a8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.35)
+    snaptrade (2.0.37)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -52,7 +52,7 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)

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.35-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.35)
+[![npm](https://img.shields.io/badge/gem-v2.0.37-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.37)
 [![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.35'
+gem 'snaptrade', '~> 2.0.37'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -84,7 +84,7 @@ configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
 snaptrade = SnapTrade::Client.new(configuration)
 result = snaptrade.account_information.get_all_user_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -97,7 +97,7 @@ To access the raw HTTP response, suffix any method with `_with_http_info`.
 ```ruby
 result = snaptrade.account_information.get_all_user_holdings_with_http_info(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result[0] # [Array<AccountHoldings>] Deserialized data
@@ -123,7 +123,7 @@ account.
 ```ruby
 result = snaptrade.account_information.get_all_user_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -162,7 +162,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_balance(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -198,7 +198,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.account_information.get_user_account_details(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -234,7 +234,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_orders(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   state: "all",
   days: 30,
@@ -279,7 +279,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_positions(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -316,7 +316,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 result = snaptrade.account_information.get_user_holdings(
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -351,7 +351,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.account_information.list_user_accounts(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -382,7 +382,7 @@ Updates various properties of a specified account.
 ```ruby
 result = snaptrade.account_information.update_user_account(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
 )
 p result
@@ -490,7 +490,7 @@ Logs in a SnapTrade user and returns an authenticated connection portal URL for
 ```ruby
 result = snaptrade.authentication.login_snap_trade_user(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   broker: "ALPACA",
   immediate_redirect: true,
   custom_redirect: "https://snaptrade.com",
@@ -552,8 +552,8 @@ Sets the version of the connection portal to render.
 
 ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
 
-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.
+Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -596,7 +596,7 @@ Rotates the secret for a SnapTrade user. You might use this if `userSecret` is c
 ```ruby
 result = snaptrade.authentication.reset_snap_trade_user_secret(
   user_id: "snaptrade-user-123",
-  user_secret: "h81@cx1lkalablakwjaltkejraj11=",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -610,9 +610,9 @@ NOT use email addresses for this property because they are usually not
 immutable.
 
 ##### userSecret: `String`<a id="usersecret-string"></a>
-SnapTrade User Secret randomly generated by SnapTrade. This is privileged
-information and if compromised, should be rotated via the [rotate user secret
-endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+SnapTrade User Secret. This is a randomly generated string and should be stored
+securely. If compromised, please rotate it via the [rotate user secret
+endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -637,7 +637,7 @@ Returns a single brokerage authorization object for the specified ID.
 result = snaptrade.connections.detail_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -672,7 +672,7 @@ Manually disable a connection. This should only be used for testing a reconnect
 result = snaptrade.connections.disable_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -706,7 +706,7 @@ Returns a list of Brokerage Authorization objects for the user
 ```ruby
 result = snaptrade.connections.list_brokerage_authorizations(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -738,7 +738,7 @@ Trigger a holdings update for all accounts under this authorization. Updates wil
 result = snaptrade.connections.refresh_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -773,7 +773,7 @@ Deletes a specified brokerage authorization given by the ID.
 snaptrade.connections.remove_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 ```
 
@@ -851,7 +851,7 @@ result = snaptrade.options.get_option_strategy(
     ],
   strategy_type: "CUSTOM",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
 )
 p result
@@ -889,7 +889,7 @@ Returns the option chain for the specified symbol in the specified account.
 ```ruby
 result = snaptrade.options.get_options_chain(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
   symbol: "symbol_example",
 )
@@ -929,7 +929,7 @@ Returns a Strategy Quotes object which has latest market data of the specified o
 ```ruby
 result = snaptrade.options.get_options_strategy_quote(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
 )
@@ -971,7 +971,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.options.list_option_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -1006,7 +1006,7 @@ result = snaptrade.options.place_option_strategy(
   order_type: "Limit",
   time_in_force: "FOK",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   price: 31.33,
@@ -1328,7 +1328,7 @@ provided search string, matching on ticker and name.
 ```ruby
 result = snaptrade.reference_data.symbol_search_user_account(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   substring: "apple",
 )
@@ -1367,7 +1367,7 @@ This will only work if the order has not yet been executed.
 ```ruby
 result = snaptrade.trading.cancel_user_account_order(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
 )
@@ -1404,7 +1404,7 @@ Return the trade object and it's impact on the account for the specified order.
 ```ruby
 result = snaptrade.trading.get_order_impact(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1464,7 +1464,7 @@ Returns quote(s) from the brokerage for the specified symbol(s).
 ```ruby
 result = snaptrade.trading.get_user_account_quotes(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   symbols: "symbols_example",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   use_ticker: true,
@@ -1507,7 +1507,7 @@ Places a specified trade in the specified account.
 ```ruby
 result = snaptrade.trading.place_force_order(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1570,7 +1570,7 @@ returns the status of the order from the brokerage.
 result = snaptrade.trading.place_order(
   trade_id: "tradeId_example",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   wait_to_confirm: true,
 )
 p result
@@ -1616,7 +1616,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.transactions_and_reporting.get_activities(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   start_date: "2022-01-24",
   end_date: "2022-01-24",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
@@ -1683,7 +1683,7 @@ result = snaptrade.transactions_and_reporting.get_reporting_custom_range(
   start_date: "2022-01-24",
   end_date: "2022-01-24",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
   detailed: true,
   frequency: "monthly",

data/lib/snaptrade/api/authentication_api.rb

@@ -314,8 +314,8 @@ module SnapTrade
 
     # Register user
     #
-    # 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.
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+    # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
     #
     # @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
 
     # Register user
     #
-    # 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.
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+    # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
     #
     # @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
 
     # Register user
-    # 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. 
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -354,7 +354,7 @@ module SnapTrade
     end
 
     # Register user
-    # 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. 
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. 
     # @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
@@ -417,7 +417,7 @@ module SnapTrade
     # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @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 user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+    # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -434,7 +434,7 @@ module SnapTrade
     # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @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 user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+    # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret_with_http_info(user_id: SENTINEL, user_secret: SENTINEL, extra: {})

data/lib/snaptrade/models/account.rb

@@ -11,9 +11,9 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # A single brokerage account at a financial institution.
+  # A single account at a brokerage.
   class Account
-    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. If you want a stable identifier for the account, use the `number` field.
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
     attr_accessor :id
 
     # Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
@@ -22,19 +22,19 @@ module SnapTrade
     # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
     attr_accessor :portfolio_group
 
-    # A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
+    # A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
     attr_accessor :name
 
-    # The account number assigned by the financial institution.
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
     attr_accessor :number
 
-    # The name of the financial institution that holds the account.
+    # The name of the brokerage that holds the account.
     attr_accessor :institution_name
 
-    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the financial institution.
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
     attr_accessor :created_date
 
-    # Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there's no standard format for this data. Please use at your own risk.
+    # 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. Please use at your own risk.
     attr_accessor :meta
 
     # This field is deprecated.

data/lib/snaptrade/models/account_simple.rb

@@ -11,15 +11,15 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # A single brokerage account at a financial institution.
+  # A single account at a brokerage.
   class AccountSimple
     # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :id
 
-    # A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
+    # A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
     attr_accessor :name
 
-    # The account number assigned by the financial institution.
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
     attr_accessor :number
 
     attr_accessor :sync_status

data/lib/snaptrade/models/user_i_dand_secret.rb

@@ -11,12 +11,11 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Response when register user is successful
   class UserIDandSecret
     # 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.
     attr_accessor :user_id
 
-    # SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+    # SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
     attr_accessor :user_secret
 
     # 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.35'
+  VERSION = '2.0.37'
 end

data/spec/api/authentication_api_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.35
+  version: 2.0.37
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday