class DearInventoryRuby::Account

Attributes

_class[RW]

Should be one of the following values: `ASSET`, `LIABILITY`, `EXPENSE`, `EQUITY`, `REVENUE`

bank[RW]

Name of the Bank. Only for PUT and POST. Required if Account Type is BANK.

bank_account_id[RW]

Bank Account ID to which the Account is linked. Read-only.

bank_account_number[RW]

Bank Account Number. Only for PUT and POST. Required if Account Type is BANK.

code[RW]

Unique code of Account

currency[RW]

Currency. Read-only.

description[RW]

Account description

display_name[RW]

Account display name. Read-only.

for_payments[RW]

Account status

name[RW]

Account Name

old_code[RW]

Read-only.

status[RW]

Account status

system_account[RW]

SystemAccount

system_account_code[RW]

SystemAccountCode

type[RW]

Type

Public Class Methods

attribute_map() click to toggle source

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

# File lib/dear-inventory-ruby/models/account.rb, line 63
def self.attribute_map
  {
    :'code' => :'Code',
    :'name' => :'Name',
    :'type' => :'Type',
    :'status' => :'Status',
    :'description' => :'Description',
    :'_class' => :'Class',
    :'system_account' => :'SystemAccount',
    :'system_account_code' => :'SystemAccountCode',
    :'for_payments' => :'ForPayments',
    :'display_name' => :'DisplayName',
    :'old_code' => :'OldCode',
    :'bank' => :'Bank',
    :'bank_account_number' => :'BankAccountNumber',
    :'bank_account_id' => :'BankAccountId',
    :'currency' => :'Currency'
  }
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/dear-inventory-ruby/models/account.rb, line 332
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/dear-inventory-ruby/models/account.rb, line 112
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::Account` 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 `DearInventoryRuby::Account`. 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?(:'code')
    self.code = attributes[:'code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/dear-inventory-ruby/models/account.rb, line 105
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/dear-inventory-ruby/models/account.rb, line 84
def self.openapi_types
  {
    :'code' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'status' => :'String',
    :'description' => :'String',
    :'_class' => :'String',
    :'system_account' => :'String',
    :'system_account_code' => :'String',
    :'for_payments' => :'String',
    :'display_name' => :'String',
    :'old_code' => :'String',
    :'bank' => :'String',
    :'bank_account_number' => :'String',
    :'bank_account_id' => :'String',
    :'currency' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/dear-inventory-ruby/models/account.rb, line 297
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      name == o.name &&
      type == o.type &&
      status == o.status &&
      description == o.description &&
      _class == o._class &&
      system_account == o.system_account &&
      system_account_code == o.system_account_code &&
      for_payments == o.for_payments &&
      display_name == o.display_name &&
      old_code == o.old_code &&
      bank == o.bank &&
      bank_account_number == o.bank_account_number &&
      bank_account_id == o.bank_account_id &&
      currency == o.currency
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/dear-inventory-ruby/models/account.rb, line 360
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
    DearInventoryRuby.const_get(type).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/dear-inventory-ruby/models/account.rb, line 429
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/dear-inventory-ruby/models/account.rb, line 339
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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
code=(code) click to toggle source

Custom attribute writer method with validation @param [Object] code Value to be assigned

# File lib/dear-inventory-ruby/models/account.rb, line 241
def code=(code)
  if code.nil?
    fail ArgumentError, 'code cannot be nil'
  end

  if code.to_s.length > 50
    fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 50.'
  end

  @code = code
end
eql?(o) click to toggle source

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

# File lib/dear-inventory-ruby/models/account.rb, line 319
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/dear-inventory-ruby/models/account.rb, line 325
def hash
  [code, name, type, status, description, _class, system_account, system_account_code, for_payments, display_name, old_code, bank, bank_account_number, bank_account_id, currency].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/dear-inventory-ruby/models/account.rb, line 188
def list_invalid_properties
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

  if @code.to_s.length > 50
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 50.')
  end

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

  if @name.to_s.length > 256
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 256.')
  end

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

  if @type.to_s.length > 50
    invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 50.')
  end

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

  if @status.to_s.length > 50
    invalid_properties.push('invalid value for "status", the character length must be smaller than or equal to 50.')
  end

  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/dear-inventory-ruby/models/account.rb, line 255
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length > 256
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 256.'
  end

  @name = name
end
status=(status) click to toggle source

Custom attribute writer method with validation @param [Object] status Value to be assigned

# File lib/dear-inventory-ruby/models/account.rb, line 283
def status=(status)
  if status.nil?
    fail ArgumentError, 'status cannot be nil'
  end

  if status.to_s.length > 50
    fail ArgumentError, 'invalid value for "status", the character length must be smaller than or equal to 50.'
  end

  @status = status
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/dear-inventory-ruby/models/account.rb, line 405
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/dear-inventory-ruby/models/account.rb, line 411
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/dear-inventory-ruby/models/account.rb, line 399
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method with validation @param [Object] type Value to be assigned

# File lib/dear-inventory-ruby/models/account.rb, line 269
def type=(type)
  if type.nil?
    fail ArgumentError, 'type cannot be nil'
  end

  if type.to_s.length > 50
    fail ArgumentError, 'invalid value for "type", the character length must be smaller than or equal to 50.'
  end

  @type = type
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/dear-inventory-ruby/models/account.rb, line 227
def valid?
  return false if @code.nil?
  return false if @code.to_s.length > 50
  return false if @name.nil?
  return false if @name.to_s.length > 256
  return false if @type.nil?
  return false if @type.to_s.length > 50
  return false if @status.nil?
  return false if @status.to_s.length > 50
  true
end