Class: XeroRuby::Assets::BookDepreciationSetting

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/assets/book_depreciation_setting.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

NO_DEPRECIATION = 
"NoDepreciation".freeze
STRAIGHT_LINE = 
"StraightLine".freeze
DIMINISHING_VALUE100 = 
"DiminishingValue100".freeze
DIMINISHING_VALUE150 = 
"DiminishingValue150".freeze
DIMINISHING_VALUE200 = 
"DiminishingValue200".freeze
FULL_DEPRECIATION = 
"FullDepreciation".freeze
FULL_MONTH = 
"FullMonth".freeze
ACTUAL_DAYS = 
"ActualDays".freeze
RATE = 
"Rate".freeze
LIFE = 
"Life".freeze
NONE = 
"None".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BookDepreciationSetting

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Assets::BookDepreciationSetting` 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 `XeroRuby::Assets::BookDepreciationSetting`. 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?(:'depreciation_method')
    self.depreciation_method = attributes[:'depreciation_method']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#averaging_method ⇒ Object

The method of averaging applied to this asset. See Averaging Methods



28
29
30
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 28

def averaging_method
  @averaging_method
end

#book_effective_date_of_change_id ⇒ Object

Unique Xero identifier for the effective date change



51
52
53
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 51

def book_effective_date_of_change_id
  @book_effective_date_of_change_id
end

#depreciable_object_id ⇒ Object

Unique Xero identifier for the depreciable object



45
46
47
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 45

def depreciable_object_id
  @depreciable_object_id
end

#depreciable_object_type ⇒ Object

The type of asset object



48
49
50
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 48

def depreciable_object_type
  @depreciable_object_type
end

#depreciation_calculation_method ⇒ Object

See Depreciation Calculation Methods



39
40
41
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 39

def depreciation_calculation_method
  @depreciation_calculation_method
end

#depreciation_method ⇒ Object

The method of depreciation applied to this asset. See Depreciation Methods



19
20
21
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 19

def depreciation_method
  @depreciation_method
end

#depreciation_rate ⇒ Object

The rate of depreciation (e.g. 0.05)



33
34
35
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 33

def depreciation_rate
  @depreciation_rate
end

#effective_life_years ⇒ Object

Effective life of the asset in years (e.g. 5)



36
37
38
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 36

def effective_life_years
  @effective_life_years
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 76

def self.attribute_map
  {
    :'depreciation_method' => :'depreciationMethod',
    :'averaging_method' => :'averagingMethod',
    :'depreciation_rate' => :'depreciationRate',
    :'effective_life_years' => :'effectiveLifeYears',
    :'depreciation_calculation_method' => :'depreciationCalculationMethod',
    :'depreciable_object_id' => :'depreciableObjectId',
    :'depreciable_object_type' => :'depreciableObjectType',
    :'book_effective_date_of_change_id' => :'bookEffectiveDateOfChangeId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



230
231
232
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 230

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 90

def self.openapi_types
  {
    :'depreciation_method' => :'String',
    :'averaging_method' => :'String',
    :'depreciation_rate' => :'Float',
    :'effective_life_years' => :'Integer',
    :'depreciation_calculation_method' => :'String',
    :'depreciable_object_id' => :'String',
    :'depreciable_object_type' => :'String',
    :'book_effective_date_of_change_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      depreciation_method == o.depreciation_method &&
      averaging_method == o.averaging_method &&
      depreciation_rate == o.depreciation_rate &&
      effective_life_years == o.effective_life_years &&
      depreciation_calculation_method == o.depreciation_calculation_method &&
      depreciable_object_id == o.depreciable_object_id &&
      depreciable_object_type == o.depreciable_object_type &&
      book_effective_date_of_change_id == o.book_effective_date_of_change_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 258

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_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
    XeroRuby::Assets.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 323

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 237

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 223

def hash
  [depreciation_method, averaging_method, depreciation_rate, effective_life_years, depreciation_calculation_method, depreciable_object_id, depreciable_object_type, book_effective_date_of_change_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



153
154
155
156
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



338
339
340
341
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 338

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 303

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 309

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



297
298
299
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 297

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



160
161
162
163
164
165
166
167
168
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 160

def valid?
  depreciation_method_validator = EnumAttributeValidator.new('String', ["NoDepreciation", "StraightLine", "DiminishingValue100", "DiminishingValue150", "DiminishingValue200", "FullDepreciation"])
  return false unless depreciation_method_validator.valid?(@depreciation_method)
  averaging_method_validator = EnumAttributeValidator.new('String', ["FullMonth", "ActualDays"])
  return false unless averaging_method_validator.valid?(@averaging_method)
  depreciation_calculation_method_validator = EnumAttributeValidator.new('String', ["Rate", "Life", "None"])
  return false unless depreciation_calculation_method_validator.valid?(@depreciation_calculation_method)
  true
end