snaptrade 2.0.30 → 2.0.32

data/lib/snaptrade/models/{portfolio_group.rb → universal_symbol_exchange.rb}

@@ -11,16 +11,43 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class PortfolioGroup
+  # The exchange on which the security is listed and traded.
+  class UniversalSymbolExchange
+    # Unique ID for the exchange in SnapTrade.
     attr_accessor :id
 
+    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
+    attr_accessor :code
+
+    # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
+    attr_accessor :mic_code
+
+    # The full name of the exchange.
     attr_accessor :name
 
+    # The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
+    attr_accessor :timezone
+
+    # The time when the exchange opens for trading.
+    attr_accessor :start_time
+
+    # The time when the exchange closes for trading.
+    attr_accessor :close_time
+
+    # The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
+    attr_accessor :suffix
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'name' => :'name'
+        :'code' => :'code',
+        :'mic_code' => :'mic_code',
+        :'name' => :'name',
+        :'timezone' => :'timezone',
+        :'start_time' => :'start_time',
+        :'close_time' => :'close_time',
+        :'suffix' => :'suffix'
       }
     end
 
@@ -33,27 +60,41 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'name' => :'String'
+        :'code' => :'String',
+        :'mic_code' => :'String',
+        :'name' => :'String',
+        :'timezone' => :'String',
+        :'start_time' => :'String',
+        :'close_time' => :'String',
+        :'suffix' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'suffix'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Exchange'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::PortfolioGroup` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::UniversalSymbolExchange` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::PortfolioGroup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::UniversalSymbolExchange`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -62,9 +103,33 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'mic_code')
+        self.mic_code = attributes[:'mic_code']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'close_time')
+        self.close_time = attributes[:'close_time']
+      end
+
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -86,7 +151,13 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          name == o.name
+          code == o.code &&
+          mic_code == o.mic_code &&
+          name == o.name &&
+          timezone == o.timezone &&
+          start_time == o.start_time &&
+          close_time == o.close_time &&
+          suffix == o.suffix
     end
 
     # @see the `==` method
@@ -98,7 +169,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name].hash
+      [id, code, mic_code, name, timezone, start_time, close_time, suffix].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.30'
+  VERSION = '2.0.32'
 end

data/lib/snaptrade.rb

@@ -34,16 +34,10 @@ require 'snaptrade/models/brokerage'
 require 'snaptrade/models/brokerage_authorization'
 require 'snaptrade/models/brokerage_authorization_disabled_confirmation'
 require 'snaptrade/models/brokerage_authorization_refresh_confirmation'
-require 'snaptrade/models/brokerage_authorization_type'
 require 'snaptrade/models/brokerage_authorization_type_read_only'
 require 'snaptrade/models/brokerage_authorization_type_read_only_brokerage'
 require 'snaptrade/models/brokerage_authorization_type_read_only_type'
-require 'snaptrade/models/brokerage_authorization_type_type'
-require 'snaptrade/models/brokerage_symbol'
-require 'snaptrade/models/brokerage_symbol_option_symbol'
-require 'snaptrade/models/brokerage_symbol_symbol'
 require 'snaptrade/models/brokerage_type'
-require 'snaptrade/models/calculated_trade'
 require 'snaptrade/models/cash_restriction'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'
@@ -55,10 +49,8 @@ require 'snaptrade/models/encrypted_response'
 require 'snaptrade/models/encrypted_response_encrypted_message_data'
 require 'snaptrade/models/exchange'
 require 'snaptrade/models/exchange_rate_pairs'
-require 'snaptrade/models/excluded_asset'
 require 'snaptrade/models/figi_instrument'
 require 'snaptrade/models/holdings_status'
-require 'snaptrade/models/jwt'
 require 'snaptrade/models/login_redirect_uri'
 require 'snaptrade/models/manual_trade'
 require 'snaptrade/models/manual_trade_and_impact'
@@ -74,14 +66,6 @@ require 'snaptrade/models/model403_failed_request_response'
 require 'snaptrade/models/model403_feature_not_enabled_response'
 require 'snaptrade/models/model404_failed_request_response'
 require 'snaptrade/models/model500_unexpected_exception_response'
-require 'snaptrade/models/model_asset_class'
-require 'snaptrade/models/model_asset_class_details'
-require 'snaptrade/models/model_asset_class_target'
-require 'snaptrade/models/model_portfolio'
-require 'snaptrade/models/model_portfolio_asset_class'
-require 'snaptrade/models/model_portfolio_details'
-require 'snaptrade/models/model_portfolio_security'
-require 'snaptrade/models/model_type'
 require 'snaptrade/models/monthly_dividends'
 require 'snaptrade/models/net_contributions'
 require 'snaptrade/models/net_dividend'
@@ -96,7 +80,6 @@ require 'snaptrade/models/option_strategy'
 require 'snaptrade/models/option_strategy_legs_inner'
 require 'snaptrade/models/option_type'
 require 'snaptrade/models/options_get_option_strategy_request'
-require 'snaptrade/models/options_holdings'
 require 'snaptrade/models/options_place_option_strategy_request'
 require 'snaptrade/models/options_position'
 require 'snaptrade/models/options_position_currency'
@@ -105,30 +88,18 @@ require 'snaptrade/models/order_type_strict'
 require 'snaptrade/models/partner_data'
 require 'snaptrade/models/past_value'
 require 'snaptrade/models/performance_custom'
-require 'snaptrade/models/portfolio_group'
-require 'snaptrade/models/portfolio_group_info'
-require 'snaptrade/models/portfolio_group_position'
-require 'snaptrade/models/portfolio_group_settings'
 require 'snaptrade/models/position'
 require 'snaptrade/models/position_symbol'
-require 'snaptrade/models/redirect_tokenand_pin'
 require 'snaptrade/models/security_type'
 require 'snaptrade/models/session_event'
 require 'snaptrade/models/session_event_type'
-require 'snaptrade/models/snap_trade_api_disclaimer_accept_status'
 require 'snaptrade/models/snap_trade_holdings_account'
 require 'snaptrade/models/snap_trade_holdings_account_account_id'
 require 'snaptrade/models/snap_trade_holdings_account_account_id_balance'
 require 'snaptrade/models/snap_trade_holdings_total_value'
 require 'snaptrade/models/snap_trade_login_user_request_body'
 require 'snaptrade/models/snap_trade_register_user_request_body'
-require 'snaptrade/models/state'
 require 'snaptrade/models/status'
-require 'snaptrade/models/strategy_impact'
-require 'snaptrade/models/strategy_impact_legs_inner'
-require 'snaptrade/models/strategy_order_place'
-require 'snaptrade/models/strategy_order_place_orders_inner'
-require 'snaptrade/models/strategy_order_place_orders_inner_legs_inner'
 require 'snaptrade/models/strategy_order_record'
 require 'snaptrade/models/strategy_order_record_status'
 require 'snaptrade/models/strategy_quotes'
@@ -139,23 +110,19 @@ require 'snaptrade/models/symbol'
 require 'snaptrade/models/symbol_figi_instrument'
 require 'snaptrade/models/symbol_query'
 require 'snaptrade/models/symbols_quotes_inner'
-require 'snaptrade/models/target_asset'
 require 'snaptrade/models/time_in_force_strict'
-require 'snaptrade/models/trade'
-require 'snaptrade/models/trade_action'
-require 'snaptrade/models/trade_execution_status'
-require 'snaptrade/models/trade_execution_status_action'
-require 'snaptrade/models/trade_impact'
 require 'snaptrade/models/trading_cancel_user_account_order_request'
 require 'snaptrade/models/transactions_status'
 require 'snaptrade/models/type'
 require 'snaptrade/models/us_exchange'
 require 'snaptrade/models/underlying_symbol'
+require 'snaptrade/models/underlying_symbol_exchange'
+require 'snaptrade/models/underlying_symbol_type'
 require 'snaptrade/models/universal_activity'
 require 'snaptrade/models/universal_symbol'
-require 'snaptrade/models/user_error_log'
+require 'snaptrade/models/universal_symbol_currency'
+require 'snaptrade/models/universal_symbol_exchange'
 require 'snaptrade/models/user_i_dand_secret'
-require 'snaptrade/models/user_settings'
 require 'snaptrade/models/validated_trade_body'
 
 # APIs

data/spec/api/account_information_api_spec.rb

@@ -100,9 +100,9 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_holdings
-  # List balances, positions and orders for the specified account
-  # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
-  # @param account_id The ID of the account to fetch holdings for.
+  # List account holdings
+  # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
+  # @param account_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/options_symbol_spec.rb

@@ -62,16 +62,4 @@ describe SnapTrade::OptionsSymbol do
     end
   end
 
-  describe 'test attribute "local_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 "exchange_id"' 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/{brokerage_symbol_option_symbol_spec.rb → underlying_symbol_exchange_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::BrokerageSymbolOptionSymbol
-describe SnapTrade::BrokerageSymbolOptionSymbol do
-  let(:instance) { SnapTrade::BrokerageSymbolOptionSymbol.new }
+# Unit tests for SnapTrade::UnderlyingSymbolExchange
+describe SnapTrade::UnderlyingSymbolExchange do
+  let(:instance) { SnapTrade::UnderlyingSymbolExchange.new }
 
-  describe 'test an instance of BrokerageSymbolOptionSymbol' do
-    it 'should create an instance of BrokerageSymbolOptionSymbol' do
-      expect(instance).to be_instance_of(SnapTrade::BrokerageSymbolOptionSymbol)
+  describe 'test an instance of UnderlyingSymbolExchange' do
+    it 'should create an instance of UnderlyingSymbolExchange' do
+      expect(instance).to be_instance_of(SnapTrade::UnderlyingSymbolExchange)
     end
   end
   describe 'test attribute "id"' do
@@ -26,49 +26,49 @@ describe SnapTrade::BrokerageSymbolOptionSymbol do
     end
   end
 
-  describe 'test attribute "ticker"' do
+  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 "option_type"' do
+  describe 'test attribute "mic_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 "strike_price"' do
+  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
 
-  describe 'test attribute "expiration_date"' do
+  describe 'test attribute "timezone"' 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
+  describe 'test attribute "start_time"' 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
+  describe 'test attribute "close_time"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "local_id"' do
+  describe 'test attribute "suffix"' 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_id"' do
+  describe 'test attribute "allows_cryptocurrency_symbols"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/underlying_symbol_spec.rb

@@ -32,6 +32,12 @@ describe SnapTrade::UnderlyingSymbol do
     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

data/spec/models/{trade_impact_spec.rb → underlying_symbol_type_spec.rb}

@@ -11,40 +11,34 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::TradeImpact
-describe SnapTrade::TradeImpact do
-  let(:instance) { SnapTrade::TradeImpact.new }
+# Unit tests for SnapTrade::UnderlyingSymbolType
+describe SnapTrade::UnderlyingSymbolType do
+  let(:instance) { SnapTrade::UnderlyingSymbolType.new }
 
-  describe 'test an instance of TradeImpact' do
-    it 'should create an instance of TradeImpact' do
-      expect(instance).to be_instance_of(SnapTrade::TradeImpact)
+  describe 'test an instance of UnderlyingSymbolType' do
+    it 'should create an instance of UnderlyingSymbolType' do
+      expect(instance).to be_instance_of(SnapTrade::UnderlyingSymbolType)
     end
   end
-  describe 'test attribute "account"' do
+  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 "currency"' do
+  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 "remaining_cash"' 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 "estimated_commissions"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "forex_fees"' do
+  describe 'test attribute "is_supported"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

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

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::ModelPortfolio
-describe SnapTrade::ModelPortfolio do
-  let(:instance) { SnapTrade::ModelPortfolio.new }
+# Unit tests for SnapTrade::UniversalSymbolCurrency
+describe SnapTrade::UniversalSymbolCurrency do
+  let(:instance) { SnapTrade::UniversalSymbolCurrency.new }
 
-  describe 'test an instance of ModelPortfolio' do
-    it 'should create an instance of ModelPortfolio' do
-      expect(instance).to be_instance_of(SnapTrade::ModelPortfolio)
+  describe 'test an instance of UniversalSymbolCurrency' do
+    it 'should create an instance of UniversalSymbolCurrency' do
+      expect(instance).to be_instance_of(SnapTrade::UniversalSymbolCurrency)
     end
   end
   describe 'test attribute "id"' do
@@ -26,13 +26,13 @@ describe SnapTrade::ModelPortfolio do
     end
   end
 
-  describe 'test attribute "name"' do
+  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 "model_type"' do
+  describe 'test attribute "name"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

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

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::Trade
-describe SnapTrade::Trade do
-  let(:instance) { SnapTrade::Trade.new }
+# Unit tests for SnapTrade::UniversalSymbolExchange
+describe SnapTrade::UniversalSymbolExchange do
+  let(:instance) { SnapTrade::UniversalSymbolExchange.new }
 
-  describe 'test an instance of Trade' do
-    it 'should create an instance of Trade' do
-      expect(instance).to be_instance_of(SnapTrade::Trade)
+  describe 'test an instance of UniversalSymbolExchange' do
+    it 'should create an instance of UniversalSymbolExchange' do
+      expect(instance).to be_instance_of(SnapTrade::UniversalSymbolExchange)
     end
   end
   describe 'test attribute "id"' do
@@ -26,43 +26,43 @@ describe SnapTrade::Trade do
     end
   end
 
-  describe 'test attribute "account"' do
+  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 "symbol"' do
+  describe 'test attribute "mic_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 "universal_symbol"' do
+  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
 
-  describe 'test attribute "action"' do
+  describe 'test attribute "timezone"' 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 "start_time"' 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 "close_time"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "sequence"' do
+  describe 'test attribute "suffix"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end