snaptrade 2.0.27 → 2.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6042448247c24c9ffbf7656391e3ae3c3027e5acffec97f3de615faf5d15dd57
-  data.tar.gz: bcb2d19068587ca7f97bf4f7ece5c722deb5f3a4bf29dcbb97cd9bc30dc549d2
+  metadata.gz: eda55725a9b97295f947e385aaa5003b02a7d20e8e4603cefa5a17dbdf27215d
+  data.tar.gz: f03cb7a20b125bb83a122fa42ab9948891583bb8f4888d365ec225e51f1220a1
 SHA512:
-  metadata.gz: 768abac024f9c9e18035f16aa8af729f2034e32ee3792d9770c9a695a7eda05ea1a2f2dcfefb70ab707d5992da8a2258df7e599be14e918b209f1c0ef3b2dcbf
-  data.tar.gz: 3605ff7b1215aa6b8f8ec1e1eaec5a17ee2f19d37e3db41496143b0baf6009332426de796227c5e3733d8b531fc4fdc9ab4da8d61c346a57416f04057f9db8f3
+  metadata.gz: dec55a480470054f6c039189d796edf016ff838ab276afa435c2b8f6fd7df6c94687ca474af52311a16c2a039a819043e938fbb228be751d67ccae77ec145590
+  data.tar.gz: 7213d617ae5118e8f7b313bbafa49446e17134c7b5fefc961626cdab60f28e61844bc8345fb40b8b77a2794aabf88b8102df9c2cb3afa1d4ffbc7d854fb35800

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.26)
+    snaptrade (2.0.28)
       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.29-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.29)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -29,7 +29,6 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.account_information.update_user_account`](#snaptradeaccount_informationupdate_user_account)
   * [`snaptrade.api_status.check`](#snaptradeapi_statuscheck)
   * [`snaptrade.authentication.delete_snap_trade_user`](#snaptradeauthenticationdelete_snap_trade_user)
-  * [`snaptrade.authentication.get_user_jwt`](#snaptradeauthenticationget_user_jwt)
   * [`snaptrade.authentication.list_snap_trade_users`](#snaptradeauthenticationlist_snap_trade_users)
   * [`snaptrade.authentication.login_snap_trade_user`](#snaptradeauthenticationlogin_snap_trade_user)
   * [`snaptrade.authentication.register_snap_trade_user`](#snaptradeauthenticationregister_snap_trade_user)
@@ -71,7 +70,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.29'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -457,39 +456,6 @@ p result
 ---
 
 
-### `snaptrade.authentication.get_user_jwt`<a id="snaptradeauthenticationget_user_jwt"></a>
-
-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>
-
-```ruby
-result = snaptrade.authentication.get_user_jwt(
-  user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
-)
-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>
-#### 🔄 Return<a id="🔄-return"></a>
-
-[EncryptedResponse](./lib/snaptrade/models/encrypted_response.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/snapTrade/encryptedJWT` `GET`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.authentication.list_snap_trade_users`<a id="snaptradeauthenticationlist_snap_trade_users"></a>
 
 Returns a list of users you've registered over the SnapTrade API.
@@ -606,8 +572,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 +595,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

@@ -103,103 +103,6 @@ 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] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_jwt(user_id:, user_secret:, extra: {})
-      data, _status_code, _headers = get_user_jwt_with_http_info_impl(user_id, user_secret, extra)
-      data
-    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] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_jwt_with_http_info(user_id:, user_secret:, extra: {})
-      get_user_jwt_with_http_info_impl(user_id, user_secret, extra)
-    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
-    # @return [EncryptedResponse]
-    private def get_user_jwt_impl(user_id, user_secret, opts = {})
-      data, _status_code, _headers = get_user_jwt_with_http_info(user_id, user_secret, opts)
-      data
-    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
-    # @return [Array<(EncryptedResponse, Integer, Hash)>] EncryptedResponse data, response status code and response headers
-    private def get_user_jwt_with_http_info_impl(user_id, user_secret, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_user_jwt ...'
-      end
-      # verify the required parameter 'user_id' is set
-      if @api_client.config.client_side_validation && user_id.nil?
-        fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.get_user_jwt"
-      end
-      # verify the required parameter 'user_secret' is set
-      if @api_client.config.client_side_validation && user_secret.nil?
-        fail ArgumentError, "Missing the required parameter 'user_secret' when calling AuthenticationApi.get_user_jwt"
-      end
-      # resource path
-      local_var_path = '/snapTrade/encryptedJWT'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'userId'] = user_id
-      query_params[:'userSecret'] = user_secret
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'EncryptedResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
-
-      new_options = opts.merge(
-        :operation => :"AuthenticationApi.get_user_jwt",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AuthenticationApi#get_user_jwt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers, response
-    end
-
-
     # List SnapTrade users
     #
     # Returns a list of users you've registered over the SnapTrade API.
@@ -511,11 +414,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 +432,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 +448,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 +458,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&#39;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.29'
 end

data/spec/api/authentication_api_spec.rb

@@ -39,19 +39,6 @@ describe 'AuthenticationApi' do
     end
   end
 
-  # unit tests for get_user_jwt
-  # 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 
-  # @param user_secret 
-  # @param [Hash] opts the optional parameters
-  # @return [EncryptedResponse]
-  describe 'get_user_jwt test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for list_snap_trade_users
   # List SnapTrade users
   # Returns a list of users you've registered over the SnapTrade API.
@@ -91,7 +78,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.29
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday