snaptrade 2.0.27 → 2.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6042448247c24c9ffbf7656391e3ae3c3027e5acffec97f3de615faf5d15dd57
-  data.tar.gz: bcb2d19068587ca7f97bf4f7ece5c722deb5f3a4bf29dcbb97cd9bc30dc549d2
+  metadata.gz: 2fe92620a58d056da38b520075900fca5e87dba39e7672055d1dc2c3b4397615
+  data.tar.gz: ca4859a220b98ede43621daaa2fe68d957abe9c082b13c08b69d1b208e86382b
 SHA512:
-  metadata.gz: 768abac024f9c9e18035f16aa8af729f2034e32ee3792d9770c9a695a7eda05ea1a2f2dcfefb70ab707d5992da8a2258df7e599be14e918b209f1c0ef3b2dcbf
-  data.tar.gz: 3605ff7b1215aa6b8f8ec1e1eaec5a17ee2f19d37e3db41496143b0baf6009332426de796227c5e3733d8b531fc4fdc9ab4da8d61c346a57416f04057f9db8f3
+  metadata.gz: 34e441cc2e218a54300ccbce4e4c4259f75fe4d134cc2f3b0cd7f4bdb8d5ab507ca1c6886fcb248883cbd8d6e321efb78d900099056279747c2a11a35e0e6bab
+  data.tar.gz: 5197c3ad9f01759083ae79c142a96383dfa3e20dbcd052efea58c260e9e7f5797436576c86dcf784e20d9668c02ff203c9896e03509152abdda192f46dd72987

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.26)
+    snaptrade (2.0.27)
       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.27-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.27)
+[![npm](https://img.shields.io/badge/gem-v2.0.28-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.28)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -71,7 +71,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.27'
+gem 'snaptrade', '~> 2.0.28'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -606,8 +606,8 @@ immutable.
 
 ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
 
-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.
+This API is used to rotate the secret for a SnapTrade user. You might use this if a 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.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -629,9 +629,8 @@ 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 should be considered
-priviledged information and if compromised, you should delete and re-create this
-SnapTrade user.
+SnapTrade User Secret randomly generated by SnapTrade. This is privileged
+information and if compromised, should be rotated via the SnapTrade API.
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/snaptrade/api/authentication_api.rb

@@ -511,11 +511,11 @@ 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.
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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 should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     # @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: {})
@@ -529,11 +529,11 @@ 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.
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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 should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     # @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: {})
@@ -545,7 +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. 
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -555,7 +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. 
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/models/user_i_dand_secret.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # 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 should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     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.27'
+  VERSION = '2.0.28'
 end

data/spec/api/authentication_api_spec.rb

@@ -91,7 +91,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for reset_snap_trade_user_secret
   # 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. 
+  # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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_i_dand_secret 
   # @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.27
+  version: 2.0.28
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday