snaptrade 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf91b5cd3dc44efcb6a27fc4985242103d3833229db0e4e70b937f2bb7087e8
-  data.tar.gz: 53699d0fa45916f7d23b14ef383e51b3a1d79841156b530b521c447d029d4e70
+  metadata.gz: ec9e0dbe7d3e7c69d00269f23444db2c9208b10a53688128a5f1e68ce19b1783
+  data.tar.gz: 7780d0e966a7189727812916c9b79c945d608cd0671a1554a6e9ef0e42c4ec20
 SHA512:
-  metadata.gz: 3ed890b996e52f436757c72e92a1f777174944df99eb3ecc7b0e42bf0c3b0e9ae06f6792c02bfeb2d4e5affb8909431e1394fcb1f8506907578ad7da9d08160b
-  data.tar.gz: d5cf7663c262fd84cf9b49f74efa8215962d05841f869cbe23dbf05f8d730aaa5a712025e033e5129e08bcba42d79d5c8e56bd340536d42f0286acddfffe876e
+  metadata.gz: b9cad2244d5f0107d326608e94fe7908a101be05a0e63ec3af539e941dc9c5ab76be1beb09ccd3409c836acc30be2056ef1d6095fc4be40fe43f579c21bf905b
+  data.tar.gz: 3cfafe1b77b9553ef62ca93f326d0b221b00b594ccc372c4abe8474f24b012612e52c4ebde558c2fb2a667460683c6547ca740695f6289e3a0aba294683cd30d

data/Gemfile.lock

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

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.1'
+gem 'snaptrade', '~> 2.0.2'
 ```
 
 ## Getting Started
@@ -57,6 +57,7 @@ Class | Method | HTTP request | Description
 *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
 *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
 *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
+*SnapTrade::AuthenticationApi* | [**reset_snap_trade_user_secret**](docs/AuthenticationApi.md#reset_snap_trade_user_secret) | **POST** /snapTrade/resetUserSecret | Obtain a new user secret for a user
 *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details
 *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
 *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization

data/docs/AuthenticationApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | [**list_snap_trade_users**](AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users |
 | [**login_snap_trade_user**](AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link |
 | [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user |
+| [**reset_snap_trade_user_secret**](AuthenticationApi.md#reset_snap_trade_user_secret) | **POST** /snapTrade/resetUserSecret | Obtain a new user secret for a user |
 
 ## delete_snap_trade_user
 
@@ -318,3 +319,62 @@ end
 
 [**UserIDandSecret**](UserIDandSecret.md)
 
+## reset_snap_trade_user_secret
+
+Obtain a new user secret for a user
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+user_id = "snaptrade-user-123"
+user_secret = "h81@cx1lkalablakwjaltkejraj11="
+
+begin
+  # Obtain a new user secret for a user
+  result = SnapTrade::Authentication.reset_snap_trade_user_secret(
+                                                                     user_id: user_id,
+                                                                     user_secret: user_secret,
+                                                                   )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Authentication.reset_snap_trade_user_secret: #{e}"
+end
+```
+
+#### Using the reset_snap_trade_user_secret_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+```ruby
+user_id = "snaptrade-user-123"
+user_secret = "h81@cx1lkalablakwjaltkejraj11="
+
+begin
+  # Obtain a new user secret for a user
+  data, status_code, headers, response = SnapTrade::Authentication.reset_snap_trade_user_secret_with_http_info(
+                                                                                                                  user_id: user_id,
+                                                                                                                  user_secret: user_secret,
+                                                                                                                )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => UserIDandSecret
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Authentication.reset_snap_trade_user_secret: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_i_dand_secret** | [**UserIDandSecret**](UserIDandSecret.md) |  |  |
+
+### Return type
+
+[**UserIDandSecret**](UserIDandSecret.md)
+

data/lib/snaptrade/api/authentication_api.rb

@@ -476,6 +476,100 @@ module SnapTrade
       end
       return data, status_code, headers, response
     end
+
+
+    # Obtain a new user secret for a user
+    # @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] 
+    # @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: {})
+      _body = {}
+      _body[:userId] = user_id if user_id != SENTINEL
+      _body[:userSecret] = user_secret if user_secret != SENTINEL
+      user_i_dand_secret = _body
+      data, _status_code, _headers = reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, extra)
+      data
+    end
+
+    # Obtain a new user secret for a user
+    # @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] 
+    # @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: {})
+      _body = {}
+      _body[:userId] = user_id if user_id != SENTINEL
+      _body[:userSecret] = user_secret if user_secret != SENTINEL
+      user_i_dand_secret = _body
+      reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, extra)
+    end
+
+    # Obtain a new user secret for a user
+    # @param user_i_dand_secret [UserIDandSecret] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserIDandSecret]
+    def reset_snap_trade_user_secret_impl(user_i_dand_secret, opts = {})
+      data, _status_code, _headers = reset_snap_trade_user_secret_with_http_info(user_i_dand_secret, opts)
+      data
+    end
+
+    # Obtain a new user secret for a user
+    # @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
+    def reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.reset_snap_trade_user_secret ...'
+      end
+      # verify the required parameter 'user_i_dand_secret' is set
+      if @api_client.config.client_side_validation && user_i_dand_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_i_dand_secret' when calling AuthenticationApi.reset_snap_trade_user_secret"
+      end
+      # resource path
+      local_var_path = '/snapTrade/resetUserSecret'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_i_dand_secret)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserIDandSecret'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"AuthenticationApi.reset_snap_trade_user_secret",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthenticationApi#reset_snap_trade_user_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
   end
 
   # top-level client access to avoid having the user to insantiate their own API instances

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/spec/api/authentication_api_spec.rb

@@ -88,4 +88,15 @@ describe 'AuthenticationApi' do
     end
   end
 
+  # unit tests for reset_snap_trade_user_secret
+  # Obtain a new user secret for a user
+  # @param user_i_dand_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDandSecret]
+  describe 'reset_snap_trade_user_secret test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday