class BudgeaClient::Pocket

Attributes

availability_date[RW]

Availability date of the pocket

condition[RW]

Withdrawal condition of the pocket

deleted[RW]

If set, this pocket has been removed from the website

id[RW]

ID of the pocket

id_account[RW]

ID of the related account

id_investment[RW]

ID of the related investment

label[RW]

Label of the pocket

last_update[RW]

Last update of the pocket

quantity[RW]

Quantity of stocks

value[RW]

Value of the pocket

Public Class Methods

attribute_map() click to toggle source

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

# File lib/budgea_client/models/pocket.rb, line 48
def self.attribute_map
  {
    :'id' => :'id',
    :'id_account' => :'id_account',
    :'id_investment' => :'id_investment',
    :'label' => :'label',
    :'value' => :'value',
    :'quantity' => :'quantity',
    :'availability_date' => :'availability_date',
    :'condition' => :'condition',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/budgea_client/models/pocket.rb, line 81
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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'id_account')
    self.id_account = attributes[:'id_account']
  end

  if attributes.has_key?(:'id_investment')
    self.id_investment = attributes[:'id_investment']
  end

  if attributes.has_key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.has_key?(:'value')
    self.value = attributes[:'value']
  end

  if attributes.has_key?(:'quantity')
    self.quantity = attributes[:'quantity']
  else
    self.quantity = 0.0
  end

  if attributes.has_key?(:'availability_date')
    self.availability_date = attributes[:'availability_date']
  end

  if attributes.has_key?(:'condition')
    self.condition = attributes[:'condition']
  else
    self.condition = 'inconnu'
  end

  if attributes.has_key?(:'last_update')
    self.last_update = attributes[:'last_update']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/budgea_client/models/pocket.rb, line 64
def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_account' => :'Integer',
    :'id_investment' => :'Integer',
    :'label' => :'String',
    :'value' => :'Float',
    :'quantity' => :'Float',
    :'availability_date' => :'Date',
    :'condition' => :'String',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/budgea_client/models/pocket.rb, line 172
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_account == o.id_account &&
      id_investment == o.id_investment &&
      label == o.label &&
      value == o.value &&
      quantity == o.quantity &&
      availability_date == o.availability_date &&
      condition == o.condition &&
      last_update == o.last_update &&
      deleted == o.deleted
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/budgea_client/models/pocket.rb, line 223
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = BudgeaClient.const_get(type).new
    temp_model.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/budgea_client/models/pocket.rb, line 289
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/budgea_client/models/pocket.rb, line 202
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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
eql?(o) click to toggle source

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

# File lib/budgea_client/models/pocket.rb, line 189
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/budgea_client/models/pocket.rb, line 195
def hash
  [id, id_account, id_investment, label, value, quantity, availability_date, condition, last_update, deleted].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/budgea_client/models/pocket.rb, line 134
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

  if @condition.nil?
    invalid_properties.push('invalid value for "condition", condition 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/budgea_client/models/pocket.rb, line 269
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/budgea_client/models/pocket.rb, line 275
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/budgea_client/models/pocket.rb, line 263
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/budgea_client/models/pocket.rb, line 161
def valid?
  return false if @id.nil?
  return false if @id_account.nil?
  return false if @id_investment.nil?
  return false if @value.nil?
  return false if @condition.nil?
  true
end