class NucleusApi::Order
Order
Object
Attributes
accountId
amount
commission
date
isRead
metadata
modelId
orderBulkId
orderTicketId
orderType
portfolioId
price
quantity
securityId
transactionCodeId
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/nucleus_api/models/order.rb, line 74 def self.attribute_map { :'account_id' => :'account_id', :'amount' => :'amount', :'commission' => :'commission', :'create_date' => :'create_date', :'date' => :'date', :'id' => :'id', :'is_read' => :'is_read', :'metadata' => :'metadata', :'model_id' => :'model_id', :'order_bulk_id' => :'order_bulk_id', :'order_ticket_id' => :'order_ticket_id', :'order_type' => :'order_type', :'portfolio_id' => :'portfolio_id', :'price' => :'price', :'quantity' => :'quantity', :'secondary_id' => :'secondary_id', :'security_id' => :'security_id', :'tmp_tracker_id' => :'tmp_tracker_id', :'transaction_code_id' => :'transaction_code_id', :'update_date' => :'update_date' } end
Initializes the object @param [Hash] attributes Model
attributes in the form of hash
# File lib/nucleus_api/models/order.rb, line 127 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'commission') self.commission = attributes[:'commission'] end if attributes.has_key?(:'create_date') self.create_date = attributes[:'create_date'] end if attributes.has_key?(:'date') self.date = attributes[:'date'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'is_read') self.is_read = attributes[:'is_read'] end if attributes.has_key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end if attributes.has_key?(:'model_id') self.model_id = attributes[:'model_id'] end if attributes.has_key?(:'order_bulk_id') self.order_bulk_id = attributes[:'order_bulk_id'] end if attributes.has_key?(:'order_ticket_id') self.order_ticket_id = attributes[:'order_ticket_id'] end if attributes.has_key?(:'order_type') self.order_type = attributes[:'order_type'] end if attributes.has_key?(:'portfolio_id') self.portfolio_id = attributes[:'portfolio_id'] end if attributes.has_key?(:'price') self.price = attributes[:'price'] end if attributes.has_key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.has_key?(:'secondary_id') self.secondary_id = attributes[:'secondary_id'] end if attributes.has_key?(:'security_id') self.security_id = attributes[:'security_id'] end if attributes.has_key?(:'tmp_tracker_id') self.tmp_tracker_id = attributes[:'tmp_tracker_id'] end if attributes.has_key?(:'transaction_code_id') self.transaction_code_id = attributes[:'transaction_code_id'] end if attributes.has_key?(:'update_date') self.update_date = attributes[:'update_date'] end end
Attribute type mapping.
# File lib/nucleus_api/models/order.rb, line 100 def self.swagger_types { :'account_id' => :'String', :'amount' => :'Float', :'commission' => :'Float', :'create_date' => :'DateTime', :'date' => :'Date', :'id' => :'String', :'is_read' => :'BOOLEAN', :'metadata' => :'Hash<String, String>', :'model_id' => :'String', :'order_bulk_id' => :'String', :'order_ticket_id' => :'String', :'order_type' => :'String', :'portfolio_id' => :'String', :'price' => :'Float', :'quantity' => :'Float', :'secondary_id' => :'String', :'security_id' => :'String', :'tmp_tracker_id' => :'String', :'transaction_code_id' => :'String', :'update_date' => :'DateTime' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/nucleus_api/models/order.rb, line 251 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && amount == o.amount && commission == o.commission && create_date == o.create_date && date == o.date && id == o.id && is_read == o.is_read && metadata == o.metadata && model_id == o.model_id && order_bulk_id == o.order_bulk_id && order_ticket_id == o.order_ticket_id && order_type == o.order_type && portfolio_id == o.portfolio_id && price == o.price && quantity == o.quantity && secondary_id == o.secondary_id && security_id == o.security_id && tmp_tracker_id == o.tmp_tracker_id && transaction_code_id == o.transaction_code_id && update_date == o.update_date end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/nucleus_api/models/order.rb, line 310 def _deserialize(type, value) case type.to_sym when :DateTime (value) when :Date (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 temp_model = NucleusApi.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/nucleus_api/models/order.rb, line 376 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
Builds the object from hash @param [Hash] attributes Model
attributes in the form of hash @return [Object] Returns the model itself
# File lib/nucleus_api/models/order.rb, line 291 def build_from_hash(attributes) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/nucleus_api/models/order.rb, line 278 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/nucleus_api/models/order.rb, line 284 def hash [account_id, amount, commission, create_date, date, id, is_read, metadata, model_id, order_bulk_id, order_ticket_id, order_type, portfolio_id, price, quantity, secondary_id, security_id, tmp_tracker_id, transaction_code_id, update_date].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/nucleus_api/models/order.rb, line 218 def list_invalid_properties invalid_properties = Array.new if @date.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') end if @order_ticket_id.nil? invalid_properties.push('invalid value for "order_ticket_id", order_ticket_id cannot be nil.') end if @security_id.nil? invalid_properties.push('invalid value for "security_id", security_id cannot be nil.') end if @transaction_code_id.nil? invalid_properties.push('invalid value for "transaction_code_id", transaction_code_id cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/nucleus_api/models/order.rb, line 363 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/nucleus_api/models/order.rb, line 351 def to_s to_hash.to_s end
Check
to see if the all the properties in the model are valid @return true if the model is valid
# File lib/nucleus_api/models/order.rb, line 241 def valid? return false if @date.nil? return false if @order_ticket_id.nil? return false if @security_id.nil? return false if @transaction_code_id.nil? true end