snaptrade 2.0.36 → 2.0.38

data/spec/api/connections_api_spec.rb

@@ -28,9 +28,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for detail_brokerage_authorization
-  # Get brokerage authorization details
-  # Returns a single brokerage authorization object for the specified ID.
-  # @param authorization_id The ID of a brokerage authorization object.
+  # Get connection detail
+  # Returns a single connection for the specified ID.
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -42,9 +42,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for disable_brokerage_authorization
-  # Manually disable a connection for testing
-  # Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
-  # @param authorization_id The ID of a brokerage authorization object.
+  # Force disable connection
+  # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -56,8 +56,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for list_brokerage_authorizations
-  # List all brokerage authorizations for the User
-  # Returns a list of Brokerage Authorization objects for the user
+  # List all connections
+  # Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -70,8 +70,8 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
-  # @param authorization_id The ID of a brokerage authorization object.
+  # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.  *Please contact support for access as this endpoint is not enabled by default.* 
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -83,9 +83,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for remove_brokerage_authorization
-  # Delete brokerage authorization
-  # Deletes a specified brokerage authorization given by the ID.
-  # @param authorization_id The ID of the Authorization to delete.
+  # Delete connection
+  # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/brokerage_spec.rb

@@ -26,6 +26,12 @@ describe SnapTrade::Brokerage do
     end
   end
 
+  describe 'test attribute "slug"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "name"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -62,12 +68,6 @@ describe SnapTrade::Brokerage do
     end
   end
 
-  describe 'test attribute "slug"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   describe 'test attribute "url"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -110,24 +110,6 @@ describe SnapTrade::Brokerage do
     end
   end
 
-  describe 'test attribute "allows_trading_through_snaptrade_api"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "is_scraping_integration"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "default_currency"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   describe 'test attribute "brokerage_type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

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