snaptrade 2.0.14 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d69100af3ddccd0b4ebc3e450fb12537b5e65804065a23bf3bea6b56a510e5e4
-  data.tar.gz: '098cc493628b24843ba17c4afb17377b28442e7a6f3b912e1af2d2ac91e14736'
+  metadata.gz: d202c0c9f1f0e2d382cfb023056110f08727158e34c12f5d61ccf70061d2a991
+  data.tar.gz: d6535b39985caa7570ff9a002f0284c9b2a7553ce5a8821f29db6c0e0e810836
 SHA512:
-  metadata.gz: 06b6ff75ff7ab965faecf2913bf75cc4416cdf3699ee1320da20308869d15fb219df378da81a0fb5a1dcc227f05c603acc6d2f158162ecf2d93d01e8ed77bfd4
-  data.tar.gz: faa04bfceb6951514d3d3fd3b84ce07265c7c8dbc1f39b792239a92e92a871f48b5d727b5aff483a4e0232be673419197b2201d7d06288f3ebee5b03c19c814b
+  metadata.gz: 6a01fca1b933ba9aecf52ad6b779cb57bd5d04360138ae87c740b3e1bf3fdd2b301e036f7159fd979f831aedbad98cdb2b8342beb24bfd87913684bbc8894809
+  data.tar.gz: fa8f2dff41a36d48337f2223245a70dc40c478da18dfede9a5fe1e0b96971cabef62664b446af834a7fdf1245fb1a803ea0815397af6ef47389795e259e5432f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.14)
+    snaptrade (2.0.15)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -9,40 +9,42 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     byebug (11.1.3)
     coderay (1.1.3)
     debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
-    faraday (2.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.1.0)
-      net-http
+    faraday-net_http (3.0.2)
     io-console (0.6.0)
     irb (1.6.4)
       reline (>= 0.3.0)
     method_source (1.0.0)
-    multipart-post (2.4.0)
-    net-http (0.4.1)
-      uri
+    multipart-post (2.3.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    reline (0.3.4)
+    regexp_parser (2.8.1)
+    reline (0.3.8)
       io-console (~> 0.5)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -52,10 +54,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -65,14 +67,14 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
-    uri (0.13.0)
 
 PLATFORMS
-  arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
   debug (~> 1.8)
@@ -84,4 +86,4 @@ DEPENDENCIES
   snaptrade!
 
 BUNDLED WITH
-   2.3.7
+   2.4.19

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.14-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.14)
+[![npm](https://img.shields.io/badge/gem-v2.0.16-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.16)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -58,7 +58,6 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
   * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
   * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
-  * [`snaptrade.trading.place_oco_order`](#snaptradetradingplace_oco_order)
   * [`snaptrade.trading.place_order`](#snaptradetradingplace_order)
   * [`snaptrade.transactions_and_reporting.get_activities`](#snaptradetransactions_and_reportingget_activities)
   * [`snaptrade.transactions_and_reporting.get_reporting_custom_range`](#snaptradetransactions_and_reportingget_reporting_custom_range)
@@ -70,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.14'
+gem 'snaptrade', '~> 2.0.16'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -111,7 +110,9 @@ p.result[3] # [Faraday::Response] Raw HTTP response
 
 ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
 
-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.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -182,7 +183,9 @@ The ID of the account to get balances.
 
 ### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
 
-Return details of a specific investment account
+Returns an account object with details for the specified account,
+including the total account market value.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -261,7 +264,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
 
 ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
 
-List account positions
+Returns a list of positions in the the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -296,7 +299,10 @@ The ID of the account to get positions.
 
 ### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
 
-List balances, positions and orders for the specified account
+Lists balances, positions and orders for the specified account as well as
+option_positions and account metadata. The data returned is similar to the
+data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -331,7 +337,7 @@ The ID of the account to fetch holdings for.
 
 ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
 
-List accounts
+Get a list of all Account objects for the authenticated SnapTrade user.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -362,7 +368,7 @@ p result
 
 ### `snaptrade.account_information.update_user_account`<a id="snaptradeaccount_informationupdate_user_account"></a>
 
-Update details of an investment account
+Updates various properties of a specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -450,7 +456,9 @@ p result
 
 ### `snaptrade.authentication.get_user_jwt`<a id="snaptradeauthenticationget_user_jwt"></a>
 
-Generate encrypted JWT token
+This API is available to ClientIDs which have opted to use encrypted
+JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -559,7 +567,9 @@ 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>
 
-Create SnapTrade user
+Registers a new SnapTrade user under your ClientID.
+Most SnapTrade operations require a user to be passed as a parameter.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -591,7 +601,9 @@ it's unique to a user
 
 ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
 
-Obtain a new user secret for a user
+This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
+is comprimised or lost among other reasons.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1007,7 +1019,7 @@ A currency pair based on currency code for example, {CAD-USD}
 
 ### `snaptrade.reference_data.get_partner_info`<a id="snaptradereference_dataget_partner_info"></a>
 
-Get metadata related to Snaptrade partner
+Returns useful data related to the specified ClientID, including allowed brokerages and data access.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1242,7 +1254,10 @@ p result
 
 ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
 
-Search for symbols available in an account
+Returns a list of universal symbols that are supported by
+the specificied account. Returned symbols are based on the
+provided search string, matching on ticker and name.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1279,7 +1294,9 @@ The ID of the account to search for symbols within.
 
 ### `snaptrade.trading.cancel_user_account_order`<a id="snaptradetradingcancel_user_account_order"></a>
 
-Cancel open order in account
+Sends a signal to the brokerage to cancel the specified order.
+This will only work if the order has not yet been executed.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1376,7 +1393,7 @@ Canceled
 
 ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
 
-Get symbol quotes
+Returns live quote(s) from the brokerage for the specified symbol(s).
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1477,45 +1494,6 @@ Canceled
 ---
 
 
-### `snaptrade.trading.place_oco_order`<a id="snaptradetradingplace_oco_order"></a>
-
-Place a OCO (One Cancels Other) order
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.trading.place_oco_order(
-  user_id: "John.doe@snaptrade.com",
-  user_secret: "USERSECRET123",
-  first_trade_id: None,
-  second_trade_id: None,
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### user_id: `String`<a id="user_id-string"></a>
-##### user_secret: `String`<a id="user_secret-string"></a>
-##### first_trade_id: `Object`<a id="first_trade_id-object"></a>
-The ID of first trade object obtained from trade/impact endpoint
-
-##### second_trade_id: `Object`<a id="second_trade_id-object"></a>
-The ID of second trade object obtained from trade/impact endpoint
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/trade/oco` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.trading.place_order`<a id="snaptradetradingplace_order"></a>
 
 Place order

data/lib/snaptrade/api/account_information_api.rb

@@ -19,6 +19,9 @@ 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.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -31,6 +34,9 @@ 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.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -41,6 +47,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. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -52,6 +59,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. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -218,6 +226,9 @@ module SnapTrade
 
     # Return details of a specific investment account
     #
+    # Returns an account object with details for the specified account,
+    # including the total account market value.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get detail of.
@@ -229,6 +240,9 @@ module SnapTrade
 
     # Return details of a specific investment account
     #
+    # Returns an account object with details for the specified account,
+    # including the total account market value.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get detail of.
@@ -238,6 +252,7 @@ module SnapTrade
     end
 
     # Return details of a specific investment account
+    # Returns an account object with details for the specified account, including the total account market value. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get detail of.
@@ -249,6 +264,7 @@ module SnapTrade
     end
 
     # Return details of a specific investment account
+    # Returns an account object with details for the specified account, including the total account market value. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get detail of.
@@ -440,6 +456,8 @@ module SnapTrade
 
     # List account positions
     #
+    # Returns a list of positions in the the specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -451,6 +469,8 @@ module SnapTrade
 
     # List account positions
     #
+    # Returns a list of positions in the the specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -460,6 +480,7 @@ module SnapTrade
     end
 
     # List account positions
+    # Returns a list of positions in the the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -471,6 +492,7 @@ module SnapTrade
     end
 
     # List account positions
+    # Returns a list of positions in the the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -537,6 +559,10 @@ module SnapTrade
 
     # List balances, positions and orders for the specified account
     #
+    # Lists balances, positions and orders for the specified account as well as
+    # option_positions and account metadata. The data returned is similar to the
+    # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    #
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -548,6 +574,10 @@ module SnapTrade
 
     # List balances, positions and orders for the specified account
     #
+    # Lists balances, positions and orders for the specified account as well as
+    # option_positions and account metadata. The data returned is similar to the
+    # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    #
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -557,6 +587,7 @@ module SnapTrade
     end
 
     # List balances, positions and orders for the specified account
+    # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -568,6 +599,7 @@ module SnapTrade
     end
 
     # List balances, positions and orders for the specified account
+    # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -634,6 +666,8 @@ module SnapTrade
 
     # List accounts
     #
+    # Get a list of all Account objects for the authenticated SnapTrade user.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -644,6 +678,8 @@ module SnapTrade
 
     # List accounts
     #
+    # Get a list of all Account objects for the authenticated SnapTrade user.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -652,6 +688,7 @@ module SnapTrade
     end
 
     # List accounts
+    # Get a list of all Account objects for the authenticated SnapTrade user.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -662,6 +699,7 @@ module SnapTrade
     end
 
     # List accounts
+    # Get a list of all Account objects for the authenticated SnapTrade user.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -723,6 +761,8 @@ module SnapTrade
 
     # Update details of an investment account
     #
+    # Updates various properties of a specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to update.
@@ -734,6 +774,8 @@ module SnapTrade
 
     # Update details of an investment account
     #
+    # Updates various properties of a specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to update.
@@ -743,6 +785,7 @@ module SnapTrade
     end
 
     # Update details of an investment account
+    # Updates various properties of a specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to update.
@@ -754,6 +797,7 @@ module SnapTrade
     end
 
     # Update details of an investment account
+    # Updates various properties of a specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to update.

data/lib/snaptrade/api/authentication_api.rb

@@ -105,6 +105,9 @@ module SnapTrade
 
     # Generate encrypted JWT token
     #
+    # This API is available to ClientIDs which have opted to use encrypted
+    # JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -115,6 +118,9 @@ module SnapTrade
 
     # Generate encrypted JWT token
     #
+    # This API is available to ClientIDs which have opted to use encrypted
+    # JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -123,6 +129,7 @@ module SnapTrade
     end
 
     # Generate encrypted JWT token
+    # This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -133,6 +140,7 @@ module SnapTrade
     end
 
     # Generate encrypted JWT token
+    # This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -403,6 +411,9 @@ 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.
+    #
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -416,6 +427,9 @@ 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.
+    #
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -427,6 +441,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. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -436,6 +451,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. 
     # @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
@@ -495,6 +511,9 @@ module SnapTrade
 
     # Obtain a new user secret for a user
     #
+    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
+    # is comprimised or lost among other reasons.
+    #
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
     # @param body [UserIDandSecret] 
@@ -510,6 +529,9 @@ module SnapTrade
 
     # Obtain a new user secret for a user
     #
+    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
+    # is comprimised or lost among other reasons.
+    #
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
     # @param body [UserIDandSecret] 
@@ -523,6 +545,7 @@ module SnapTrade
     end
 
     # Obtain a new user secret for a user
+    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons. 
     # @param user_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -532,6 +555,7 @@ module SnapTrade
     end
 
     # Obtain a new user secret for a user
+    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons. 
     # @param user_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers