snaptrade 2.0.119 → 2.0.121

data/lib/snaptrade/models/crypto_trading_instrument_type.rb

@@ -0,0 +1,37 @@
+=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
+  class CryptoTradingInstrumentType
+    CRYPTOCURRENCY = "CRYPTOCURRENCY".freeze
+    CRYPTOCURRENCY_PAIR = "CRYPTOCURRENCY_PAIR".freeze
+
+    def self.all_vars
+      @all_vars ||= [CRYPTOCURRENCY, CRYPTOCURRENCY_PAIR].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CryptoTradingInstrumentType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CryptoTradingInstrumentType"
+    end
+  end
+end

data/lib/snaptrade/models/manual_trade_form_with_options.rb

@@ -22,7 +22,7 @@ module SnapTrade
     # The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided.
     attr_accessor :universal_symbol_id
 
-    # The security's trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL  131124C00240000` represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
+    # The security's trading ticker symbol. If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
     attr_accessor :symbol
 
     # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 

data/lib/snaptrade/models/manual_trade_replace_form.rb

@@ -11,8 +11,11 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Inputs for placing an order with the brokerage.
+  # Inputs for replacing an order with the brokerage.
   class ManualTradeReplaceForm
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    attr_accessor :brokerage_order_id
+
     # The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
     attr_accessor :action
 
@@ -36,6 +39,7 @@ module SnapTrade
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'brokerage_order_id' => :'brokerage_order_id',
         :'action' => :'action',
         :'order_type' => :'order_type',
         :'time_in_force' => :'time_in_force',
@@ -54,6 +58,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'brokerage_order_id' => :'String',
         :'action' => :'ActionStrict',
         :'order_type' => :'OrderTypeStrict',
         :'time_in_force' => :'TimeInForceStrict',
@@ -88,6 +93,10 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'brokerage_order_id')
+        self.brokerage_order_id = attributes[:'brokerage_order_id']
+      end
+
       if attributes.key?(:'action')
         self.action = attributes[:'action']
       end
@@ -121,6 +130,10 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @brokerage_order_id.nil?
+        invalid_properties.push('invalid value for "brokerage_order_id", brokerage_order_id cannot be nil.')
+      end
+
       if @action.nil?
         invalid_properties.push('invalid value for "action", action cannot be nil.')
       end
@@ -139,6 +152,7 @@ module SnapTrade
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @brokerage_order_id.nil?
       return false if @action.nil?
       return false if @order_type.nil?
       return false if @time_in_force.nil?
@@ -150,6 +164,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          brokerage_order_id == o.brokerage_order_id &&
           action == o.action &&
           order_type == o.order_type &&
           time_in_force == o.time_in_force &&
@@ -168,7 +183,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, order_type, time_in_force, price, symbol, stop, units].hash
+      [brokerage_order_id, action, order_type, time_in_force, price, symbol, stop, units].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.119'
+  VERSION = '2.0.121'
 end

data/lib/snaptrade.rb

@@ -55,6 +55,13 @@ require 'snaptrade/models/child_brokerage_order_ids'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'
 require 'snaptrade/models/connections_session_events200_response_inner'
+require 'snaptrade/models/crypto_order_form'
+require 'snaptrade/models/crypto_order_form_time_in_force'
+require 'snaptrade/models/crypto_order_form_type'
+require 'snaptrade/models/crypto_order_preview'
+require 'snaptrade/models/crypto_order_preview_estimated_fee'
+require 'snaptrade/models/crypto_trading_instrument'
+require 'snaptrade/models/crypto_trading_instrument_type'
 require 'snaptrade/models/cryptocurrency_pair'
 require 'snaptrade/models/cryptocurrency_pair_quote'
 require 'snaptrade/models/currency'
@@ -130,8 +137,6 @@ require 'snaptrade/models/session_event_type'
 require 'snaptrade/models/simple_order_form'
 require 'snaptrade/models/simple_order_form_time_in_force'
 require 'snaptrade/models/simple_order_form_type'
-require 'snaptrade/models/simple_order_preview'
-require 'snaptrade/models/simple_order_preview_estimated_fee'
 require 'snaptrade/models/snap_trade_holdings_account'
 require 'snaptrade/models/snap_trade_holdings_total_value'
 require 'snaptrade/models/snap_trade_login_user_request_body'

data/spec/api/trading_api_spec.rb

@@ -29,7 +29,7 @@ describe 'TradingApi' do
 
   # unit tests for cancel_order
   # Cancel order
-  # Cancels an order in the specified account. 
+  # Cancels an order in the specified account. Accepts order IDs for all asset types. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 
@@ -44,7 +44,7 @@ describe 'TradingApi' do
 
   # unit tests for cancel_user_account_order
   # Cancel equity order
-  # Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected. 
+  # **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 
@@ -117,6 +117,21 @@ describe 'TradingApi' do
     end
   end
 
+  # unit tests for place_crypto_order
+  # Place crypto order
+  # Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order. 
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id 
+  # @param crypto_order_form 
+  # @param [Hash] opts the optional parameters
+  # @return [OrderUpdatedResponse]
+  describe 'place_crypto_order 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 place_force_order
   # Place equity order
   # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
@@ -161,31 +176,16 @@ describe 'TradingApi' do
     end
   end
 
-  # unit tests for place_simple_order
-  # Place crypto order
-  # Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order. 
-  # @param user_id 
-  # @param user_secret 
-  # @param account_id 
-  # @param simple_order_form 
-  # @param [Hash] opts the optional parameters
-  # @return [OrderUpdatedResponse]
-  describe 'place_simple_order 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 preview_simple_order
+  # unit tests for preview_crypto_order
   # Preview crypto order
   # Previews an order using the specified account. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 
-  # @param simple_order_form 
+  # @param crypto_order_form 
   # @param [Hash] opts the optional parameters
-  # @return [SimpleOrderPreview]
-  describe 'preview_simple_order test' do
+  # @return [CryptoOrderPreview]
+  describe 'preview_crypto_order test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -195,7 +195,6 @@ describe 'TradingApi' do
   # Replace equity order
   # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages 
   # @param account_id The ID of the account to execute the trade on.
-  # @param brokerage_order_id The Brokerage Order ID of the order to replace.
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_replace_form 

data/spec/models/crypto_order_form_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::CryptoOrderForm
+describe SnapTrade::CryptoOrderForm do
+  let(:instance) { SnapTrade::CryptoOrderForm.new }
+
+  describe 'test an instance of CryptoOrderForm' do
+    it 'should create an instance of CryptoOrderForm' do
+      expect(instance).to be_instance_of(SnapTrade::CryptoOrderForm)
+    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 "side"' 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 "time_in_force"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  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 "limit_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 "stop_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 "post_only"' 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
+
+end

data/spec/models/crypto_order_form_time_in_force_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::CryptoOrderFormTimeInForce
+describe SnapTrade::CryptoOrderFormTimeInForce do
+  let(:instance) { SnapTrade::CryptoOrderFormTimeInForce.new }
+
+  describe 'test an instance of CryptoOrderFormTimeInForce' do
+    it 'should create an instance of CryptoOrderFormTimeInForce' do
+      expect(instance).to be_instance_of(SnapTrade::CryptoOrderFormTimeInForce)
+    end
+  end
+end

data/spec/models/crypto_order_form_type_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::CryptoOrderFormType
+describe SnapTrade::CryptoOrderFormType do
+  let(:instance) { SnapTrade::CryptoOrderFormType.new }
+
+  describe 'test an instance of CryptoOrderFormType' do
+    it 'should create an instance of CryptoOrderFormType' do
+      expect(instance).to be_instance_of(SnapTrade::CryptoOrderFormType)
+    end
+  end
+end

data/spec/models/{simple_order_preview_estimated_fee_spec.rb → crypto_order_preview_estimated_fee_spec.rb}

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

data/spec/models/{simple_order_preview_spec.rb → crypto_order_preview_spec.rb}

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

data/spec/models/crypto_trading_instrument_spec.rb

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

data/spec/models/manual_trade_replace_form_spec.rb

@@ -20,6 +20,12 @@ describe SnapTrade::ManualTradeReplaceForm do
       expect(instance).to be_instance_of(SnapTrade::ManualTradeReplaceForm)
     end
   end
+  describe 'test attribute "brokerage_order_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 "action"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers