class TinkoffInvestClient::Operation

Attributes

commission[RW]
currency[RW]
date[RW]

ISO8601

figi[RW]
id[RW]
instrument_type[RW]
is_margin_call[RW]
operation_type[RW]
payment[RW]
price[RW]
quantity[RW]

Число инструментов в выставленной заявке

quantity_executed[RW]

Число инструментов, исполненных в заявке

status[RW]
trades[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/tinkoff_invest_client/models/operation.rb, line 70
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/tinkoff_invest_client/models/operation.rb, line 50
def self.attribute_map
  {
    :'id' => :'id',
    :'status' => :'status',
    :'trades' => :'trades',
    :'commission' => :'commission',
    :'currency' => :'currency',
    :'payment' => :'payment',
    :'price' => :'price',
    :'quantity' => :'quantity',
    :'quantity_executed' => :'quantityExecuted',
    :'figi' => :'figi',
    :'instrument_type' => :'instrumentType',
    :'is_margin_call' => :'isMarginCall',
    :'date' => :'date',
    :'operation_type' => :'operationType'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/tinkoff_invest_client/models/operation.rb, line 253
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/tinkoff_invest_client/models/operation.rb, line 102
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TinkoffInvestClient::Operation` 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 `TinkoffInvestClient::Operation`. 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']
  end

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

  if attributes.key?(:'trades')
    if (value = attributes[:'trades']).is_a?(Array)
      self.trades = value
    end
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'operation_type')
    self.operation_type = attributes[:'operation_type']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/tinkoff_invest_client/models/operation.rb, line 95
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/tinkoff_invest_client/models/operation.rb, line 75
def self.openapi_types
  {
    :'id' => :'String',
    :'status' => :'OperationStatus',
    :'trades' => :'Array<OperationTrade>',
    :'commission' => :'MoneyAmount',
    :'currency' => :'Currency',
    :'payment' => :'Float',
    :'price' => :'Float',
    :'quantity' => :'Integer',
    :'quantity_executed' => :'Integer',
    :'figi' => :'String',
    :'instrument_type' => :'InstrumentType',
    :'is_margin_call' => :'Boolean',
    :'date' => :'Time',
    :'operation_type' => :'OperationTypeWithCommission'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/tinkoff_invest_client/models/operation.rb, line 219
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      status == o.status &&
      trades == o.trades &&
      commission == o.commission &&
      currency == o.currency &&
      payment == o.payment &&
      price == o.price &&
      quantity == o.quantity &&
      quantity_executed == o.quantity_executed &&
      figi == o.figi &&
      instrument_type == o.instrument_type &&
      is_margin_call == o.is_margin_call &&
      date == o.date &&
      operation_type == o.operation_type
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/tinkoff_invest_client/models/operation.rb, line 283
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 = TinkoffInvestClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/tinkoff_invest_client/models/operation.rb, line 354
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/tinkoff_invest_client/models/operation.rb, line 260
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/tinkoff_invest_client/models/operation.rb, line 240
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/tinkoff_invest_client/models/operation.rb, line 246
def hash
  [id, status, trades, commission, currency, payment, price, quantity, quantity_executed, figi, instrument_type, is_margin_call, date, operation_type].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/tinkoff_invest_client/models/operation.rb, line 176
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @payment.nil?
    invalid_properties.push('invalid value for "payment", payment cannot be nil.')
  end

  if @is_margin_call.nil?
    invalid_properties.push('invalid value for "is_margin_call", is_margin_call cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/tinkoff_invest_client/models/operation.rb, line 330
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/tinkoff_invest_client/models/operation.rb, line 336
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/tinkoff_invest_client/models/operation.rb, line 324
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/tinkoff_invest_client/models/operation.rb, line 207
def valid?
  return false if @id.nil?
  return false if @status.nil?
  return false if @currency.nil?
  return false if @payment.nil?
  return false if @is_margin_call.nil?
  return false if @date.nil?
  true
end