snaptrade 2.0.185 → 2.0.187

data/lib/snaptrade/models/option_instrument.rb

@@ -0,0 +1,322 @@
+=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
+  # Option instrument metadata for a V2 position.
+  class OptionInstrument
+    attr_accessor :kind
+
+    # Unique identifier for the option instrument.
+    attr_accessor :id
+
+    # OCC symbol for the option contract.
+    attr_accessor :symbol
+
+    # Whether the contract is a call or put.
+    attr_accessor :option_type
+
+    # Strike price for the option contract.
+    attr_accessor :strike_price
+
+    # Expiration date of the option contract.
+    attr_accessor :expiration_date
+
+    # Human-readable description of the option contract.
+    attr_accessor :description
+
+    attr_accessor :underlying
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'id' => :'id',
+        :'symbol' => :'symbol',
+        :'option_type' => :'option_type',
+        :'strike_price' => :'strike_price',
+        :'expiration_date' => :'expiration_date',
+        :'description' => :'description',
+        :'underlying' => :'underlying'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'kind' => :'OptionInstrumentKind',
+        :'id' => :'String',
+        :'symbol' => :'String',
+        :'option_type' => :'OptionType',
+        :'strike_price' => :'Float',
+        :'expiration_date' => :'Date',
+        :'description' => :'String',
+        :'underlying' => :'UnderlyingOptionInstrument'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+      ])
+    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::OptionInstrument` 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::OptionInstrument`. 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?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'option_type')
+        self.option_type = attributes[:'option_type']
+      end
+
+      if attributes.key?(:'strike_price')
+        self.strike_price = attributes[:'strike_price']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'underlying')
+        self.underlying = attributes[:'underlying']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @symbol.nil?
+        invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
+      end
+
+      if @option_type.nil?
+        invalid_properties.push('invalid value for "option_type", option_type cannot be nil.')
+      end
+
+      if @strike_price.nil?
+        invalid_properties.push('invalid value for "strike_price", strike_price cannot be nil.')
+      end
+
+      if @expiration_date.nil?
+        invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
+      end
+
+      if @underlying.nil?
+        invalid_properties.push('invalid value for "underlying", underlying 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 @kind.nil?
+      return false if @id.nil?
+      return false if @symbol.nil?
+      return false if @option_type.nil?
+      return false if @strike_price.nil?
+      return false if @expiration_date.nil?
+      return false if @underlying.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          kind == o.kind &&
+          id == o.id &&
+          symbol == o.symbol &&
+          option_type == o.option_type &&
+          strike_price == o.strike_price &&
+          expiration_date == o.expiration_date &&
+          description == o.description &&
+          underlying == o.underlying
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [kind, id, symbol, option_type, strike_price, expiration_date, description, underlying].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/snaptrade/models/option_instrument_kind.rb

@@ -0,0 +1,36 @@
+=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 OptionInstrumentKind
+    OPTION = "option".freeze
+
+    def self.all_vars
+      @all_vars ||= [OPTION].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 OptionInstrumentKind.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OptionInstrumentKind"
+    end
+  end
+end

data/lib/snaptrade/models/options_symbol.rb

@@ -56,7 +56,7 @@ module SnapTrade
       {
         :'id' => :'String',
         :'ticker' => :'String',
-        :'option_type' => :'OptionType',
+        :'option_type' => :'OptionsSymbolOptionType',
         :'strike_price' => :'Float',
         :'expiration_date' => :'Date',
         :'is_mini_option' => :'Boolean',

data/lib/snaptrade/models/options_symbol_option_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 OptionsSymbolOptionType
+    CALL = "CALL".freeze
+    PUT = "PUT".freeze
+
+    def self.all_vars
+      @all_vars ||= [CALL, PUT].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 OptionsSymbolOptionType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OptionsSymbolOptionType"
+    end
+  end
+end

data/lib/snaptrade/models/order_updated_response_order.rb

@@ -15,6 +15,12 @@ module SnapTrade
     # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier. 
+    attr_accessor :brokerage_group_order_id
+
+    # The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders. 
+    attr_accessor :order_role
+
     # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED 
     attr_accessor :status
 
@@ -79,6 +85,8 @@ module SnapTrade
     def self.attribute_map
       {
         :'brokerage_order_id' => :'brokerage_order_id',
+        :'brokerage_group_order_id' => :'brokerage_group_order_id',
+        :'order_role' => :'order_role',
         :'status' => :'status',
         :'universal_symbol' => :'universal_symbol',
         :'option_symbol' => :'option_symbol',
@@ -113,6 +121,8 @@ module SnapTrade
     def self.openapi_types
       {
         :'brokerage_order_id' => :'String',
+        :'brokerage_group_order_id' => :'String',
+        :'order_role' => :'OrderRole',
         :'status' => :'AccountOrderRecordStatus',
         :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
         :'option_symbol' => :'AccountOrderRecordOptionSymbol',
@@ -141,6 +151,8 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'brokerage_group_order_id',
+        :'order_role',
         :'total_quantity',
         :'open_quantity',
         :'canceled_quantity',
@@ -183,6 +195,14 @@ module SnapTrade
         self.brokerage_order_id = attributes[:'brokerage_order_id']
       end
 
+      if attributes.key?(:'brokerage_group_order_id')
+        self.brokerage_group_order_id = attributes[:'brokerage_group_order_id']
+      end
+
+      if attributes.key?(:'order_role')
+        self.order_role = attributes[:'order_role']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -291,6 +311,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           brokerage_order_id == o.brokerage_order_id &&
+          brokerage_group_order_id == o.brokerage_group_order_id &&
+          order_role == o.order_role &&
           status == o.status &&
           universal_symbol == o.universal_symbol &&
           option_symbol == o.option_symbol &&
@@ -324,7 +346,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, universal_symbol, option_symbol, quote_universal_symbol, quote_currency, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, trailing_stop, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol, child_brokerage_order_ids].hash
+      [brokerage_order_id, brokerage_group_order_id, order_role, status, universal_symbol, option_symbol, quote_universal_symbol, quote_currency, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, trailing_stop, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol, child_brokerage_order_ids].hash
     end
 
     # Builds the object from hash