=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
  # Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.
  class AccountOrderRecord
    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
    attr_accessor :brokerage_order_id

    # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
    attr_accessor :status

    # A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
    attr_accessor :symbol

    attr_accessor :universal_symbol

    attr_accessor :option_symbol

    # The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE 
    attr_accessor :action

    # The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
    attr_accessor :total_quantity

    # The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
    attr_accessor :open_quantity

    # The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
    attr_accessor :canceled_quantity

    # The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
    attr_accessor :filled_quantity

    # The price at which the order was executed.
    attr_accessor :execution_price

    # The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
    attr_accessor :limit_price

    # The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
    attr_accessor :stop_price

    # The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
    attr_accessor :order_type

    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `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.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. 
    attr_accessor :time_in_force

    # The time the order was placed. This is the time the order was submitted to the brokerage.
    attr_accessor :time_placed

    # The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
    attr_accessor :time_updated

    # The time the order was executed in the brokerage system. This value is not always available from the brokerage.
    attr_accessor :time_executed

    # The time the order expires. This value is not always available from the brokerage.
    attr_accessor :expiry_date

    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'brokerage_order_id' => :'brokerage_order_id',
        :'status' => :'status',
        :'symbol' => :'symbol',
        :'universal_symbol' => :'universal_symbol',
        :'option_symbol' => :'option_symbol',
        :'action' => :'action',
        :'total_quantity' => :'total_quantity',
        :'open_quantity' => :'open_quantity',
        :'canceled_quantity' => :'canceled_quantity',
        :'filled_quantity' => :'filled_quantity',
        :'execution_price' => :'execution_price',
        :'limit_price' => :'limit_price',
        :'stop_price' => :'stop_price',
        :'order_type' => :'order_type',
        :'time_in_force' => :'time_in_force',
        :'time_placed' => :'time_placed',
        :'time_updated' => :'time_updated',
        :'time_executed' => :'time_executed',
        :'expiry_date' => :'expiry_date'
      }
    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
      {
        :'brokerage_order_id' => :'String',
        :'status' => :'AccountOrderRecordStatus',
        :'symbol' => :'String',
        :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
        :'option_symbol' => :'AccountOrderRecordOptionSymbol',
        :'action' => :'String',
        :'total_quantity' => :'Float',
        :'open_quantity' => :'Float',
        :'canceled_quantity' => :'Float',
        :'filled_quantity' => :'Float',
        :'execution_price' => :'Float',
        :'limit_price' => :'Float',
        :'stop_price' => :'Float',
        :'order_type' => :'String',
        :'time_in_force' => :'String',
        :'time_placed' => :'Time',
        :'time_updated' => :'Time',
        :'time_executed' => :'Time',
        :'expiry_date' => :'Time'
      }
    end

    # List of attributes with nullable: true
    def self.openapi_nullable
      Set.new([
        :'total_quantity',
        :'open_quantity',
        :'canceled_quantity',
        :'filled_quantity',
        :'execution_price',
        :'limit_price',
        :'stop_price',
        :'order_type',
        :'time_updated',
        :'time_executed',
        :'expiry_date'
      ])
    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::AccountOrderRecord` 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::AccountOrderRecord`. 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?(:'brokerage_order_id')
        self.brokerage_order_id = attributes[:'brokerage_order_id']
      end

      if attributes.key?(:'status')
        self.status = attributes[:'status']
      end

      if attributes.key?(:'symbol')
        self.symbol = attributes[:'symbol']
      end

      if attributes.key?(:'universal_symbol')
        self.universal_symbol = attributes[:'universal_symbol']
      end

      if attributes.key?(:'option_symbol')
        self.option_symbol = attributes[:'option_symbol']
      end

      if attributes.key?(:'action')
        self.action = attributes[:'action']
      end

      if attributes.key?(:'total_quantity')
        self.total_quantity = attributes[:'total_quantity']
      end

      if attributes.key?(:'open_quantity')
        self.open_quantity = attributes[:'open_quantity']
      end

      if attributes.key?(:'canceled_quantity')
        self.canceled_quantity = attributes[:'canceled_quantity']
      end

      if attributes.key?(:'filled_quantity')
        self.filled_quantity = attributes[:'filled_quantity']
      end

      if attributes.key?(:'execution_price')
        self.execution_price = attributes[:'execution_price']
      end

      if attributes.key?(:'limit_price')
        self.limit_price = attributes[:'limit_price']
      end

      if attributes.key?(:'stop_price')
        self.stop_price = attributes[:'stop_price']
      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?(:'time_placed')
        self.time_placed = attributes[:'time_placed']
      end

      if attributes.key?(:'time_updated')
        self.time_updated = attributes[:'time_updated']
      end

      if attributes.key?(:'time_executed')
        self.time_executed = attributes[:'time_executed']
      end

      if attributes.key?(:'expiry_date')
        self.expiry_date = attributes[:'expiry_date']
      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
      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?
      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 &&
          brokerage_order_id == o.brokerage_order_id &&
          status == o.status &&
          symbol == o.symbol &&
          universal_symbol == o.universal_symbol &&
          option_symbol == o.option_symbol &&
          action == o.action &&
          total_quantity == o.total_quantity &&
          open_quantity == o.open_quantity &&
          canceled_quantity == o.canceled_quantity &&
          filled_quantity == o.filled_quantity &&
          execution_price == o.execution_price &&
          limit_price == o.limit_price &&
          stop_price == o.stop_price &&
          order_type == o.order_type &&
          time_in_force == o.time_in_force &&
          time_placed == o.time_placed &&
          time_updated == o.time_updated &&
          time_executed == o.time_executed &&
          expiry_date == o.expiry_date
    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
      [brokerage_order_id, status, symbol, universal_symbol, option_symbol, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date].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