snaptrade 2.0.185 → 2.0.186

data/lib/snaptrade/models/underlying_option_instrument.rb

@@ -0,0 +1,57 @@
+=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 'date'
+require 'time'
+
+module SnapTrade
+  # The underlying instrument for an option.
+  module UnderlyingOptionInstrument
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'CryptoInstrument',
+          :'EtfInstrument',
+          :'OtherInstrument',
+          :'StockInstrument'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'kind'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'crypto' => :'CryptoInstrument',
+          :'etf' => :'EtfInstrument',
+          :'other' => :'OtherInstrument',
+          :'stock' => :'StockInstrument'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        SnapTrade.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/snaptrade/models/underlying_symbol.rb

@@ -71,7 +71,7 @@ module SnapTrade
         :'exchange' => :'UnderlyingSymbolExchange',
         :'type' => :'UnderlyingSymbolType',
         :'figi_code' => :'String',
-        :'figi_instrument' => :'SymbolFigiInstrument',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end

data/lib/snaptrade/models/universal_symbol.rb

@@ -71,7 +71,7 @@ module SnapTrade
         :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
         :'figi_code' => :'String',
-        :'figi_instrument' => :'SymbolFigiInstrument',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -36,6 +36,7 @@ require 'snaptrade/models/account_order_record_trailing_stop'
 require 'snaptrade/models/account_order_record_universal_symbol'
 require 'snaptrade/models/account_order_record_v2'
 require 'snaptrade/models/account_orders_v2_response'
+require 'snaptrade/models/account_position'
 require 'snaptrade/models/account_simple'
 require 'snaptrade/models/account_status'
 require 'snaptrade/models/account_sync_status'
@@ -47,6 +48,7 @@ require 'snaptrade/models/account_value_history_item'
 require 'snaptrade/models/account_value_history_response'
 require 'snaptrade/models/action_strict'
 require 'snaptrade/models/action_strict_with_options'
+require 'snaptrade/models/all_account_positions_response'
 require 'snaptrade/models/auth_type'
 require 'snaptrade/models/authentication_login_snap_trade_user200_response'
 require 'snaptrade/models/balance'
@@ -71,6 +73,8 @@ require 'snaptrade/models/complex_order_response_type'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'
 require 'snaptrade/models/connections_session_events200_response_inner'
+require 'snaptrade/models/crypto_instrument'
+require 'snaptrade/models/crypto_instrument_kind'
 require 'snaptrade/models/crypto_order_form'
 require 'snaptrade/models/crypto_order_form_time_in_force'
 require 'snaptrade/models/crypto_order_form_type'
@@ -86,10 +90,16 @@ require 'snaptrade/models/delete_user_response'
 require 'snaptrade/models/dividend_at_date'
 require 'snaptrade/models/encrypted_response'
 require 'snaptrade/models/encrypted_response_encrypted_message_data'
+require 'snaptrade/models/etf_instrument'
+require 'snaptrade/models/etf_instrument_kind'
 require 'snaptrade/models/exchange'
 require 'snaptrade/models/exchange_rate_pairs'
 require 'snaptrade/models/figi_instrument'
+require 'snaptrade/models/future_instrument'
+require 'snaptrade/models/future_instrument_kind'
 require 'snaptrade/models/holdings_status'
+require 'snaptrade/models/instrument'
+require 'snaptrade/models/kind'
 require 'snaptrade/models/login_redirect_uri'
 require 'snaptrade/models/manual_trade'
 require 'snaptrade/models/manual_trade_and_impact'
@@ -129,6 +139,8 @@ require 'snaptrade/models/option_chain_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner'
 require 'snaptrade/models/option_impact'
+require 'snaptrade/models/option_instrument'
+require 'snaptrade/models/option_instrument_kind'
 require 'snaptrade/models/option_leg'
 require 'snaptrade/models/option_leg_action'
 require 'snaptrade/models/option_quote'
@@ -139,10 +151,13 @@ require 'snaptrade/models/option_type'
 require 'snaptrade/models/options_position'
 require 'snaptrade/models/options_position_currency'
 require 'snaptrade/models/options_symbol'
+require 'snaptrade/models/options_symbol_option_type'
 require 'snaptrade/models/order_role'
 require 'snaptrade/models/order_type_strict'
 require 'snaptrade/models/order_updated_response'
 require 'snaptrade/models/order_updated_response_order'
+require 'snaptrade/models/other_instrument'
+require 'snaptrade/models/other_instrument_kind'
 require 'snaptrade/models/paginated_universal_activity'
 require 'snaptrade/models/pagination_details'
 require 'snaptrade/models/partner_data'
@@ -165,6 +180,8 @@ 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/status'
+require 'snaptrade/models/stock_instrument'
+require 'snaptrade/models/stock_instrument_figi_instrument'
 require 'snaptrade/models/stop_loss'
 require 'snaptrade/models/strategy_order_record'
 require 'snaptrade/models/strategy_order_record_status'
@@ -175,7 +192,6 @@ require 'snaptrade/models/sub_period_return_rate'
 require 'snaptrade/models/symbol'
 require 'snaptrade/models/symbol_currency'
 require 'snaptrade/models/symbol_exchange'
-require 'snaptrade/models/symbol_figi_instrument'
 require 'snaptrade/models/symbol_query'
 require 'snaptrade/models/symbols_quotes_inner'
 require 'snaptrade/models/take_profit'
@@ -190,6 +206,7 @@ require 'snaptrade/models/trailing_stop'
 require 'snaptrade/models/transactions_status'
 require 'snaptrade/models/type'
 require 'snaptrade/models/us_exchange'
+require 'snaptrade/models/underlying_option_instrument'
 require 'snaptrade/models/underlying_symbol'
 require 'snaptrade/models/underlying_symbol_exchange'
 require 'snaptrade/models/underlying_symbol_type'

data/spec/api/experimental_endpoints_api_spec.rb

@@ -41,6 +41,22 @@ describe 'ExperimentalEndpointsApi' do
     end
   end
 
+  # unit tests for get_all_account_positions
+  # List all account positions
+  # Returns a paginated list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page The page number to return. Defaults to 1.
+  # @option opts [Integer] :page_size The number of positions to return per page. Defaults to 100 with a maximum of 1000.
+  # @return [AllAccountPositionsResponse]
+  describe 'get_all_account_positions 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 get_user_account_order_detail_v2
   # Get account order detail (V2)
   # Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 

data/spec/models/account_position_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::AccountPosition
+describe SnapTrade::AccountPosition do
+  let(:instance) { SnapTrade::AccountPosition.new }
+
+  describe 'test an instance of AccountPosition' do
+    it 'should create an instance of AccountPosition' do
+      expect(instance).to be_instance_of(SnapTrade::AccountPosition)
+    end
+  end
+  describe 'test attribute "instrument"' 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
+    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
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "cost_basis"' 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 "cash_equivalent"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "tax_lots"' 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/all_account_positions_response_spec.rb

@@ -0,0 +1,47 @@
+=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::AllAccountPositionsResponse
+describe SnapTrade::AllAccountPositionsResponse do
+  let(:instance) { SnapTrade::AllAccountPositionsResponse.new }
+
+  describe 'test an instance of AllAccountPositionsResponse' do
+    it 'should create an instance of AllAccountPositionsResponse' do
+      expect(instance).to be_instance_of(SnapTrade::AllAccountPositionsResponse)
+    end
+  end
+  describe 'test attribute "count"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "_next"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "previous"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "results"' 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/crypto_instrument_kind_spec.rb

@@ -0,0 +1,23 @@
+=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::CryptoInstrumentKind
+describe SnapTrade::CryptoInstrumentKind do
+  let(:instance) { SnapTrade::CryptoInstrumentKind.new }
+
+  describe 'test an instance of CryptoInstrumentKind' do
+    it 'should create an instance of CryptoInstrumentKind' do
+      expect(instance).to be_instance_of(SnapTrade::CryptoInstrumentKind)
+    end
+  end
+end

data/spec/models/crypto_instrument_spec.rb

@@ -0,0 +1,71 @@
+=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::CryptoInstrument
+describe SnapTrade::CryptoInstrument do
+  let(:instance) { SnapTrade::CryptoInstrument.new }
+
+  describe 'test an instance of CryptoInstrument' do
+    it 'should create an instance of CryptoInstrument' do
+      expect(instance).to be_instance_of(SnapTrade::CryptoInstrument)
+    end
+  end
+  describe 'test attribute "kind"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    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 "figi_instrument"' 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/etf_instrument_kind_spec.rb

@@ -0,0 +1,23 @@
+=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::EtfInstrumentKind
+describe SnapTrade::EtfInstrumentKind do
+  let(:instance) { SnapTrade::EtfInstrumentKind.new }
+
+  describe 'test an instance of EtfInstrumentKind' do
+    it 'should create an instance of EtfInstrumentKind' do
+      expect(instance).to be_instance_of(SnapTrade::EtfInstrumentKind)
+    end
+  end
+end

data/spec/models/etf_instrument_spec.rb

@@ -0,0 +1,71 @@
+=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::EtfInstrument
+describe SnapTrade::EtfInstrument do
+  let(:instance) { SnapTrade::EtfInstrument.new }
+
+  describe 'test an instance of EtfInstrument' do
+    it 'should create an instance of EtfInstrument' do
+      expect(instance).to be_instance_of(SnapTrade::EtfInstrument)
+    end
+  end
+  describe 'test attribute "kind"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    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 "figi_instrument"' 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/future_instrument_kind_spec.rb

@@ -0,0 +1,23 @@
+=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::FutureInstrumentKind
+describe SnapTrade::FutureInstrumentKind do
+  let(:instance) { SnapTrade::FutureInstrumentKind.new }
+
+  describe 'test an instance of FutureInstrumentKind' do
+    it 'should create an instance of FutureInstrumentKind' do
+      expect(instance).to be_instance_of(SnapTrade::FutureInstrumentKind)
+    end
+  end
+end

data/spec/models/future_instrument_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::FutureInstrument
+describe SnapTrade::FutureInstrument do
+  let(:instance) { SnapTrade::FutureInstrument.new }
+
+  describe 'test an instance of FutureInstrument' do
+    it 'should create an instance of FutureInstrument' do
+      expect(instance).to be_instance_of(SnapTrade::FutureInstrument)
+    end
+  end
+  describe 'test attribute "kind"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    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 "root_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 "expiration_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 "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 "multiplier"' 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
+
+end

data/spec/models/instrument_spec.rb

@@ -0,0 +1,38 @@
+=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::Instrument
+describe SnapTrade::Instrument do
+  describe '.openapi_one_of' do
+    it 'lists the items referenced in the oneOf array' do
+      expect(described_class.openapi_one_of).to_not be_empty
+    end
+  end
+
+  describe '.openapi_discriminator_name' do
+    it 'returns the value of the "discriminator" property' do
+      expect(described_class.openapi_discriminator_name).to_not be_empty
+    end
+  end
+
+  describe '.openapi_discriminator_mapping' do
+    it 'returns the key/values of the "mapping" property' do
+      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+    end
+  end
+
+  describe '.build' do
+    it 'returns the correct model' do
+    end
+  end
+end

data/spec/models/kind_spec.rb

@@ -0,0 +1,23 @@
+=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::Kind
+describe SnapTrade::Kind do
+  let(:instance) { SnapTrade::Kind.new }
+
+  describe 'test an instance of Kind' do
+    it 'should create an instance of Kind' do
+      expect(instance).to be_instance_of(SnapTrade::Kind)
+    end
+  end
+end