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

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



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
150
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 106

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



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

def averaging_method
  @averaging_method
end

#book_effective_date_of_change_id ⇒ Object

Unique Xero identifier for the effective date change



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

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



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

def depreciable_object_id
  @depreciable_object_id
end

#depreciable_object_type ⇒ Object

The type of asset object



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

def depreciable_object_type
  @depreciable_object_type
end

#depreciation_calculation_method ⇒ Object

See Depreciation Calculation Methods



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

def depreciation_calculation_method
  @depreciation_calculation_method
end

#depreciation_method ⇒ Object

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



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

def depreciation_method
  @depreciation_method
end

#depreciation_rate ⇒ Object

The rate of depreciation (e.g. 0.05)



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

def depreciation_rate
  @depreciation_rate
end

#effective_life_years ⇒ Object

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



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

def effective_life_years
  @effective_life_years
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'depreciation_method' => :'String',
    :'averaging_method' => :'String',
    :'depreciation_rate' => :'BigDecimal',
    :'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



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

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



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
294
295
296
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 259

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 :BigDecimal
    BigDecimal(value.to_s)
  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, downcase: false) ⇒ 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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 332

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 348

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



324
325
326
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 324

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 306

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 312

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



300
301
302
 
# File 'lib/xero-ruby/models/assets/book_depreciation_setting.rb', line 300

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



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

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