snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/manual_trade_and_impact.rb

@@ -5,17 +5,16 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual Trade and Impact object
   class ManualTradeAndImpact
     attr_accessor :trade
 
+    # List of impacts of the trade on the account. The list always contains one value at the moment.
     attr_accessor :trade_impacts
 
     attr_accessor :combined_remaining_balance
@@ -38,7 +37,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'trade' => :'ManualTrade',
-        :'trade_impacts' => :'Array<ManualTrade>',
+        :'trade_impacts' => :'Array<ManualTradeImpact>',
         :'combined_remaining_balance' => :'ManualTradeBalance'
       }
     end

data/lib/snaptrade/models/manual_trade_balance.rb

@@ -5,20 +5,19 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Balance
+  # Estimated remaining balance of the account after the trade is executed.
   class ManualTradeBalance
     attr_accessor :account
 
     attr_accessor :currency
 
-    # Cash
+    # Estimated amount of cash remaining in the account after the trade. At the moment this is the same as `remaining_cash` under `trade_impacts`.
     attr_accessor :cash
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,7 +37,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account' => :'Account',
+        :'account' => :'AccountSimple',
         :'currency' => :'Currency',
         :'cash' => :'Float'
       }

data/lib/snaptrade/models/manual_trade_form.rb

@@ -5,35 +5,37 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual Trade Form
+  # Inputs for placing an order with the brokerage.
   class ManualTradeForm
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :account_id
 
+    # The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
     attr_accessor :action
 
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    attr_accessor :universal_symbol_id
+
+    # 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. 
     attr_accessor :order_type
 
-    # Trade Price if limit or stop limit order
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
+    attr_accessor :time_in_force
+
+    # The limit price for `Limit` and `StopLimit` orders.
     attr_accessor :price
 
-    # Stop Price. If stop loss or stop limit order, the price to trigger the stop
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
     attr_accessor :stop
 
-    attr_accessor :time_in_force
-
-    # Trade Units. Cannot work with notional value.
     attr_accessor :units
 
-    attr_accessor :universal_symbol_id
-
-    # Dollar amount to trade. Cannot work with units. Can only work for market order types and day for time in force.
     attr_accessor :notional_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,12 +43,12 @@ module SnapTrade
       {
         :'account_id' => :'account_id',
         :'action' => :'action',
+        :'universal_symbol_id' => :'universal_symbol_id',
         :'order_type' => :'order_type',
+        :'time_in_force' => :'time_in_force',
         :'price' => :'price',
         :'stop' => :'stop',
-        :'time_in_force' => :'time_in_force',
         :'units' => :'units',
-        :'universal_symbol_id' => :'universal_symbol_id',
         :'notional_value' => :'notional_value'
       }
     end
@@ -60,14 +62,14 @@ module SnapTrade
     def self.openapi_types
       {
         :'account_id' => :'String',
-        :'action' => :'Action',
-        :'order_type' => :'OrderType',
+        :'action' => :'ActionStrict',
+        :'universal_symbol_id' => :'String',
+        :'order_type' => :'OrderTypeStrict',
+        :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float',
         :'stop' => :'Float',
-        :'time_in_force' => :'TimeInForce',
         :'units' => :'Float',
-        :'universal_symbol_id' => :'String',
-        :'notional_value' => :'Float'
+        :'notional_value' => :'ManualTradeFormNotionalValue'
       }
     end
 
@@ -76,6 +78,7 @@ module SnapTrade
       Set.new([
         :'price',
         :'stop',
+        :'units',
         :'notional_value'
       ])
     end
@@ -103,10 +106,18 @@ module SnapTrade
         self.action = attributes[:'action']
       end
 
+      if attributes.key?(:'universal_symbol_id')
+        self.universal_symbol_id = attributes[:'universal_symbol_id']
+      end
+
       if attributes.key?(:'order_type')
         self.order_type = attributes[:'order_type']
       end
 
+      if attributes.key?(:'time_in_force')
+        self.time_in_force = attributes[:'time_in_force']
+      end
+
       if attributes.key?(:'price')
         self.price = attributes[:'price']
       end
@@ -115,18 +126,10 @@ module SnapTrade
         self.stop = attributes[:'stop']
       end
 
-      if attributes.key?(:'time_in_force')
-        self.time_in_force = attributes[:'time_in_force']
-      end
-
       if attributes.key?(:'units')
         self.units = attributes[:'units']
       end
 
-      if attributes.key?(:'universal_symbol_id')
-        self.universal_symbol_id = attributes[:'universal_symbol_id']
-      end
-
       if attributes.key?(:'notional_value')
         self.notional_value = attributes[:'notional_value']
       end
@@ -136,12 +139,37 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @universal_symbol_id.nil?
+        invalid_properties.push('invalid value for "universal_symbol_id", universal_symbol_id cannot be nil.')
+      end
+
+      if @order_type.nil?
+        invalid_properties.push('invalid value for "order_type", order_type cannot be nil.')
+      end
+
+      if @time_in_force.nil?
+        invalid_properties.push('invalid value for "time_in_force", time_in_force cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # 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 @account_id.nil?
+      return false if @action.nil?
+      return false if @universal_symbol_id.nil?
+      return false if @order_type.nil?
+      return false if @time_in_force.nil?
       true
     end
 
@@ -152,12 +180,12 @@ module SnapTrade
       self.class == o.class &&
           account_id == o.account_id &&
           action == o.action &&
+          universal_symbol_id == o.universal_symbol_id &&
           order_type == o.order_type &&
+          time_in_force == o.time_in_force &&
           price == o.price &&
           stop == o.stop &&
-          time_in_force == o.time_in_force &&
           units == o.units &&
-          universal_symbol_id == o.universal_symbol_id &&
           notional_value == o.notional_value
     end
 
@@ -170,7 +198,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, action, order_type, price, stop, time_in_force, units, universal_symbol_id, notional_value].hash
+      [account_id, action, universal_symbol_id, order_type, time_in_force, price, stop, units, notional_value].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{model_asset_class_target.rb → manual_trade_form_notional_value.rb}

@@ -5,20 +5,16 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelAssetClassTarget
-    attr_accessor :symbol
-
+  class ManualTradeFormNotionalValue
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'symbol' => :'symbol'
       }
     end
 
@@ -30,7 +26,6 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'UniversalSymbol'
       }
     end
 
@@ -40,24 +35,27 @@ module SnapTrade
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'NotionalValue'
+      ]
+    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::ModelAssetClassTarget` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::ManualTradeFormNotionalValue` 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::ModelAssetClassTarget`. 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::ManualTradeFormNotionalValue`. 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
       }
-
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,8 +75,7 @@ module SnapTrade
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
-      self.class == o.class &&
-          symbol == o.symbol
+      self.class == o.class
     end
 
     # @see the `==` method
@@ -90,7 +87,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol].hash
+      [].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{trade.rb → manual_trade_form_with_options.rb}

@@ -5,42 +5,66 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # A trade object
-  class Trade
-    attr_accessor :id
+  # Inputs for placing an order with the brokerage.
+  class ManualTradeFormWithOptions
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    attr_accessor :account_id
+
+    # The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
+    attr_accessor :action
 
-    attr_accessor :account
+    # 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 only support 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'.
     attr_accessor :symbol
 
-    attr_accessor :universal_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. 
+    attr_accessor :order_type
 
-    attr_accessor :action
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
+    attr_accessor :time_in_force
+
+    # The limit price for `Limit` and `StopLimit` orders.
+    attr_accessor :price
 
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+    attr_accessor :stop
+
+    # For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
     attr_accessor :units
 
-    attr_accessor :price
+    attr_accessor :notional_value
+
+    # The class of order intended to be placed. Defaults to SIMPLE for regular, one legged trades. Set to BRACKET if looking to place a bracket (One-triggers-a-one-cancels-the-other) order, then specify take profit and stop loss conditions. Bracket orders currently only supported on Alpaca, Tradier, and Tradestation, contact us for more details
+    attr_accessor :order_class
 
-    attr_accessor :sequence
+    attr_accessor :stop_loss
+
+    attr_accessor :take_profit
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'account' => :'account',
-        :'symbol' => :'symbol',
-        :'universal_symbol' => :'universal_symbol',
+        :'account_id' => :'account_id',
         :'action' => :'action',
-        :'units' => :'units',
+        :'universal_symbol_id' => :'universal_symbol_id',
+        :'symbol' => :'symbol',
+        :'order_type' => :'order_type',
+        :'time_in_force' => :'time_in_force',
         :'price' => :'price',
-        :'sequence' => :'sequence'
+        :'stop' => :'stop',
+        :'units' => :'units',
+        :'notional_value' => :'notional_value',
+        :'order_class' => :'order_class',
+        :'stop_loss' => :'stop_loss',
+        :'take_profit' => :'take_profit'
       }
     end
 
@@ -52,20 +76,34 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'account' => :'Account',
-        :'symbol' => :'BrokerageSymbol',
-        :'universal_symbol' => :'UniversalSymbol',
-        :'action' => :'TradeAction',
-        :'units' => :'Integer',
+        :'account_id' => :'String',
+        :'action' => :'ActionStrictWithOptions',
+        :'universal_symbol_id' => :'String',
+        :'symbol' => :'String',
+        :'order_type' => :'OrderTypeStrict',
+        :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float',
-        :'sequence' => :'Integer'
+        :'stop' => :'Float',
+        :'units' => :'Float',
+        :'notional_value' => :'ManualTradeFormNotionalValue',
+        :'order_class' => :'OrderClass',
+        :'stop_loss' => :'ManualTradeFormWithOptionsStopLoss',
+        :'take_profit' => :'ManualTradeFormWithOptionsTakeProfit'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'universal_symbol_id',
+        :'symbol',
+        :'price',
+        :'stop',
+        :'units',
+        :'notional_value',
+        :'order_class',
+        :'stop_loss',
+        :'take_profit'
       ])
     end
 
@@ -73,47 +111,67 @@ module SnapTrade
     # @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::Trade` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::ManualTradeFormWithOptions` 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::Trade`. 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::ManualTradeFormWithOptions`. 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
       }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'account')
-        self.account = attributes[:'account']
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'universal_symbol_id')
+        self.universal_symbol_id = attributes[:'universal_symbol_id']
       end
 
       if attributes.key?(:'symbol')
         self.symbol = attributes[:'symbol']
       end
 
-      if attributes.key?(:'universal_symbol')
-        self.universal_symbol = attributes[:'universal_symbol']
+      if attributes.key?(:'order_type')
+        self.order_type = attributes[:'order_type']
       end
 
-      if attributes.key?(:'action')
-        self.action = attributes[:'action']
+      if attributes.key?(:'time_in_force')
+        self.time_in_force = attributes[:'time_in_force']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'stop')
+        self.stop = attributes[:'stop']
       end
 
       if attributes.key?(:'units')
         self.units = attributes[:'units']
       end
 
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
+      if attributes.key?(:'notional_value')
+        self.notional_value = attributes[:'notional_value']
       end
 
-      if attributes.key?(:'sequence')
-        self.sequence = attributes[:'sequence']
+      if attributes.key?(:'order_class')
+        self.order_class = attributes[:'order_class']
+      end
+
+      if attributes.key?(:'stop_loss')
+        self.stop_loss = attributes[:'stop_loss']
+      end
+
+      if attributes.key?(:'take_profit')
+        self.take_profit = attributes[:'take_profit']
       end
     end
 
@@ -121,12 +179,32 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @order_type.nil?
+        invalid_properties.push('invalid value for "order_type", order_type cannot be nil.')
+      end
+
+      if @time_in_force.nil?
+        invalid_properties.push('invalid value for "time_in_force", time_in_force cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # 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 @account_id.nil?
+      return false if @action.nil?
+      return false if @order_type.nil?
+      return false if @time_in_force.nil?
       true
     end
 
@@ -135,14 +213,19 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          account == o.account &&
-          symbol == o.symbol &&
-          universal_symbol == o.universal_symbol &&
+          account_id == o.account_id &&
           action == o.action &&
-          units == o.units &&
+          universal_symbol_id == o.universal_symbol_id &&
+          symbol == o.symbol &&
+          order_type == o.order_type &&
+          time_in_force == o.time_in_force &&
           price == o.price &&
-          sequence == o.sequence
+          stop == o.stop &&
+          units == o.units &&
+          notional_value == o.notional_value &&
+          order_class == o.order_class &&
+          stop_loss == o.stop_loss &&
+          take_profit == o.take_profit
     end
 
     # @see the `==` method
@@ -154,7 +237,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, account, symbol, universal_symbol, action, units, price, sequence].hash
+      [account_id, action, universal_symbol_id, symbol, order_type, time_in_force, price, stop, units, notional_value, order_class, stop_loss, take_profit].hash
     end
 
     # Builds the object from hash