snaptrade 2.0.34 → 2.0.35

data/spec/api/authentication_api_spec.rb

@@ -28,8 +28,8 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for delete_snap_trade_user
-  # Delete SnapTrade user
-  # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+  # Delete user
+  # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
   # @param user_id 
   # @param [Hash] opts the optional parameters
   # @return [DeleteUserResponse]
@@ -40,8 +40,8 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for list_snap_trade_users
-  # List SnapTrade users
-  # Returns a list of users you've registered over the SnapTrade API.
+  # List all users
+  # Returns a list of all registered user IDs.
   # @param [Hash] opts the optional parameters
   # @return [Array<String>]
   describe 'list_snap_trade_users test' do
@@ -65,7 +65,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for register_snap_trade_user
-  # Create SnapTrade user
+  # Register user
   # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
   # @param snap_trade_register_user_request_body 
   # @param [Hash] opts the optional parameters
@@ -77,8 +77,8 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for reset_snap_trade_user_secret
-  # Obtain a new user secret for a user
-  # 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. 
+  # Rotate user secret
+  # Rotates the secret for a SnapTrade user. You might use this if &#x60;userSecret&#x60; 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 
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/api/connections_api_spec.rb

@@ -101,8 +101,8 @@ describe 'ConnectionsApi' do
   # Returns a list of session events associated with a user.
   # @param partner_client_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
-  # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+  # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
+  # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
   # @return [Array<ConnectionsSessionEvents200ResponseInner>]
   describe 'session_events test' do
     it 'should work' do

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -29,15 +29,15 @@ describe 'TransactionsAndReportingApi' do
 
   # unit tests for get_activities
   # Get transaction history for a user
-  # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+  # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
-  # @option opts [Date] :start_date 
-  # @option opts [Date] :end_date 
-  # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
-  # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-  # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+  # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+  # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+  # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
+  # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
+  # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - BUY   - SELL   - DIVIDEND   - CONTRIBUTION   - WITHDRAWAL   - REI   - INTEREST   - FEE 
   # @return [Array<UniversalActivity>]
   describe 'get_activities test' do
     it 'should work' do
@@ -53,7 +53,7 @@ describe 'TransactionsAndReportingApi' do
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
+  # @option opts [String] :accounts Optional comma separated list of account IDs used to filter the request on specific accounts
   # @option opts [Boolean] :detailed Optional, increases frequency of data points for the total value and contribution charts if set to true
   # @option opts [String] :frequency Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
   # @return [PerformanceCustom]

data/spec/models/delete_user_response_spec.rb

@@ -26,6 +26,12 @@ describe SnapTrade::DeleteUserResponse do
     end
   end
 
+  describe 'test attribute "detail"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "user_id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/{universal_symbol_currency_spec.rb → symbol_currency_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::UniversalSymbolCurrency
-describe SnapTrade::UniversalSymbolCurrency do
-  let(:instance) { SnapTrade::UniversalSymbolCurrency.new }
+# Unit tests for SnapTrade::SymbolCurrency
+describe SnapTrade::SymbolCurrency do
+  let(:instance) { SnapTrade::SymbolCurrency.new }
 
-  describe 'test an instance of UniversalSymbolCurrency' do
-    it 'should create an instance of UniversalSymbolCurrency' do
-      expect(instance).to be_instance_of(SnapTrade::UniversalSymbolCurrency)
+  describe 'test an instance of SymbolCurrency' do
+    it 'should create an instance of SymbolCurrency' do
+      expect(instance).to be_instance_of(SnapTrade::SymbolCurrency)
     end
   end
   describe 'test attribute "id"' do

data/spec/models/{universal_symbol_exchange_spec.rb → symbol_exchange_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::UniversalSymbolExchange
-describe SnapTrade::UniversalSymbolExchange do
-  let(:instance) { SnapTrade::UniversalSymbolExchange.new }
+# Unit tests for SnapTrade::SymbolExchange
+describe SnapTrade::SymbolExchange do
+  let(:instance) { SnapTrade::SymbolExchange.new }
 
-  describe 'test an instance of UniversalSymbolExchange' do
-    it 'should create an instance of UniversalSymbolExchange' do
-      expect(instance).to be_instance_of(SnapTrade::UniversalSymbolExchange)
+  describe 'test an instance of SymbolExchange' do
+    it 'should create an instance of SymbolExchange' do
+      expect(instance).to be_instance_of(SnapTrade::SymbolExchange)
     end
   end
   describe 'test attribute "id"' do

data/spec/models/symbol_spec.rb

@@ -38,7 +38,7 @@ describe SnapTrade::Symbol do
     end
   end
 
-  describe 'test attribute "name"' do
+  describe 'test attribute "description"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/universal_activity_currency_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::UniversalActivityCurrency
+describe SnapTrade::UniversalActivityCurrency do
+  let(:instance) { SnapTrade::UniversalActivityCurrency.new }
+
+  describe 'test an instance of UniversalActivityCurrency' do
+    it 'should create an instance of UniversalActivityCurrency' do
+      expect(instance).to be_instance_of(SnapTrade::UniversalActivityCurrency)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "code"' 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
+    end
+  end
+
+end

data/spec/models/universal_activity_option_symbol_spec.rb

@@ -0,0 +1,65 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::UniversalActivityOptionSymbol
+describe SnapTrade::UniversalActivityOptionSymbol do
+  let(:instance) { SnapTrade::UniversalActivityOptionSymbol.new }
+
+  describe 'test an instance of UniversalActivityOptionSymbol' do
+    it 'should create an instance of UniversalActivityOptionSymbol' do
+      expect(instance).to be_instance_of(SnapTrade::UniversalActivityOptionSymbol)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "ticker"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "option_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "strike_price"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "expiration_date"' 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_mini_option"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "underlying_symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/universal_activity_spec.rb

@@ -32,91 +32,91 @@ describe SnapTrade::UniversalActivity do
     end
   end
 
-  describe 'test attribute "amount"' do
+  describe 'test attribute "symbol"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "currency"' do
+  describe 'test attribute "option_symbol"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "description"' do
+  describe 'test attribute "price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "fee"' do
+  describe 'test attribute "units"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "fx_rate"' do
+  describe 'test attribute "amount"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "institution"' do
+  describe 'test attribute "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 "option_type"' do
+  describe 'test attribute "type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "price"' do
+  describe 'test attribute "option_type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "settlement_date"' do
+  describe 'test attribute "description"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "external_reference_id"' do
+  describe 'test attribute "trade_date"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "symbol"' do
+  describe 'test attribute "settlement_date"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "option_symbol"' do
+  describe 'test attribute "fee"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "trade_date"' do
+  describe 'test attribute "fx_rate"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "type"' do
+  describe 'test attribute "institution"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "units"' do
+  describe 'test attribute "external_reference_id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/universal_activity_symbol_spec.rb

@@ -0,0 +1,77 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::UniversalActivitySymbol
+describe SnapTrade::UniversalActivitySymbol do
+  let(:instance) { SnapTrade::UniversalActivitySymbol.new }
+
+  describe 'test an instance of UniversalActivitySymbol' do
+    it 'should create an instance of UniversalActivitySymbol' do
+      expect(instance).to be_instance_of(SnapTrade::UniversalActivitySymbol)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "raw_symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "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 "exchange"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "figi_instrument"' 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.34
+  version: 2.0.35
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,6 +184,8 @@ files:
 - lib/snaptrade/models/strategy_type.rb
 - lib/snaptrade/models/sub_period_return_rate.rb
 - lib/snaptrade/models/symbol.rb
+- lib/snaptrade/models/symbol_currency.rb
+- lib/snaptrade/models/symbol_exchange.rb
 - lib/snaptrade/models/symbol_figi_instrument.rb
 - lib/snaptrade/models/symbol_query.rb
 - lib/snaptrade/models/symbols_quotes_inner.rb
@@ -195,9 +197,10 @@ files:
 - lib/snaptrade/models/underlying_symbol_exchange.rb
 - lib/snaptrade/models/underlying_symbol_type.rb
 - lib/snaptrade/models/universal_activity.rb
+- lib/snaptrade/models/universal_activity_currency.rb
+- lib/snaptrade/models/universal_activity_option_symbol.rb
+- lib/snaptrade/models/universal_activity_symbol.rb
 - lib/snaptrade/models/universal_symbol.rb
-- lib/snaptrade/models/universal_symbol_currency.rb
-- lib/snaptrade/models/universal_symbol_exchange.rb
 - lib/snaptrade/models/us_exchange.rb
 - lib/snaptrade/models/user_i_dand_secret.rb
 - lib/snaptrade/models/validated_trade_body.rb
@@ -302,6 +305,8 @@ files:
 - spec/models/strategy_quotes_spec.rb
 - spec/models/strategy_type_spec.rb
 - spec/models/sub_period_return_rate_spec.rb
+- spec/models/symbol_currency_spec.rb
+- spec/models/symbol_exchange_spec.rb
 - spec/models/symbol_figi_instrument_spec.rb
 - spec/models/symbol_query_spec.rb
 - spec/models/symbol_spec.rb
@@ -313,9 +318,10 @@ files:
 - spec/models/underlying_symbol_exchange_spec.rb
 - spec/models/underlying_symbol_spec.rb
 - spec/models/underlying_symbol_type_spec.rb
+- spec/models/universal_activity_currency_spec.rb
+- spec/models/universal_activity_option_symbol_spec.rb
 - spec/models/universal_activity_spec.rb
-- spec/models/universal_symbol_currency_spec.rb
-- spec/models/universal_symbol_exchange_spec.rb
+- spec/models/universal_activity_symbol_spec.rb
 - spec/models/universal_symbol_spec.rb
 - spec/models/us_exchange_spec.rb
 - spec/models/user_i_dand_secret_spec.rb
@@ -369,6 +375,7 @@ test_files:
 - spec/models/underlying_symbol_spec.rb
 - spec/models/model404_failed_request_response_spec.rb
 - spec/models/snap_trade_login_user_request_body_spec.rb
+- spec/models/universal_activity_currency_spec.rb
 - spec/models/manual_trade_form_spec.rb
 - spec/models/option_strategy_legs_inner_spec.rb
 - spec/models/session_event_type_spec.rb
@@ -421,23 +428,25 @@ test_files:
 - spec/models/manual_trade_and_impact_spec.rb
 - spec/models/auth_type_spec.rb
 - spec/models/model500_unexpected_exception_response_spec.rb
+- spec/models/symbol_exchange_spec.rb
 - spec/models/brokerage_authorization_type_read_only_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
 - spec/models/user_i_dand_secret_spec.rb
 - spec/models/model403_feature_not_enabled_response_spec.rb
 - spec/models/manual_trade_spec.rb
-- spec/models/universal_symbol_currency_spec.rb
 - spec/models/account_order_record_spec.rb
-- spec/models/universal_symbol_exchange_spec.rb
 - spec/models/trading_cancel_user_account_order_request_spec.rb
 - spec/models/manual_trade_form_notional_value_spec.rb
 - spec/models/order_type_strict_spec.rb
 - spec/models/notional_value_spec.rb
 - spec/models/brokerage_authorization_disabled_confirmation_spec.rb
+- spec/models/universal_activity_symbol_spec.rb
+- spec/models/universal_activity_option_symbol_spec.rb
 - spec/models/option_type_spec.rb
 - spec/models/snap_trade_holdings_total_value_spec.rb
 - spec/models/model402_brokerage_auth_disabled_response_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
+- spec/models/symbol_currency_spec.rb
 - spec/models/options_place_option_strategy_request_spec.rb
 - spec/models/strategy_quotes_greek_spec.rb
 - spec/models/position_spec.rb