Class: XeroRuby::Assets::Asset

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Asset

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/xero-ruby/models/assets/asset.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounting_book_valueObject

The accounting value of the asset


62
63
64
# File 'lib/xero-ruby/models/assets/asset.rb', line 62

def accounting_book_value
  @accounting_book_value
end

#asset_idObject

The Xero-generated Id for the asset


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

def asset_id
  @asset_id
end

#asset_nameObject

The name of the asset


23
24
25
# File 'lib/xero-ruby/models/assets/asset.rb', line 23

def asset_name
  @asset_name
end

#asset_numberObject

Must be unique.


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

def asset_number
  @asset_number
end

#asset_statusObject

Returns the value of attribute asset_status


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

def asset_status
  @asset_status
end

#asset_type_idObject

The Xero-generated Id for the asset type


26
27
28
# File 'lib/xero-ruby/models/assets/asset.rb', line 26

def asset_type_id
  @asset_type_id
end

#book_depreciation_detailObject

Returns the value of attribute book_depreciation_detail


56
57
58
# File 'lib/xero-ruby/models/assets/asset.rb', line 56

def book_depreciation_detail
  @book_depreciation_detail
end

#book_depreciation_settingObject

Returns the value of attribute book_depreciation_setting


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

def book_depreciation_setting
  @book_depreciation_setting
end

#can_rollbackObject

Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back.


59
60
61
# File 'lib/xero-ruby/models/assets/asset.rb', line 59

def can_rollback
  @can_rollback
end

#disposal_dateObject

The date the asset was disposed


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

def disposal_date
  @disposal_date
end

#disposal_priceObject

The price the asset was disposed at


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

def disposal_price
  @disposal_price
end

#is_delete_enabled_for_dateObject

Boolean to indicate whether delete is enabled


65
66
67
# File 'lib/xero-ruby/models/assets/asset.rb', line 65

def is_delete_enabled_for_date
  @is_delete_enabled_for_date
end

#purchase_dateObject

The date the asset was purchased YYYY-MM-DD


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

def purchase_date
  @purchase_date
end

#purchase_priceObject

The purchase price of the asset


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

def purchase_price
  @purchase_price
end

#serial_numberObject

The asset's serial number


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

def serial_number
  @serial_number
end

#warranty_expiry_dateObject

The date the asset’s warranty expires (if needed) YYYY-MM-DD


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

def warranty_expiry_date
  @warranty_expiry_date
end

Class Method Details

.attribute_mapObject

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


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/xero-ruby/models/assets/asset.rb', line 68

def self.attribute_map
  {
    :'asset_id' => :'assetId',
    :'asset_name' => :'assetName',
    :'asset_type_id' => :'assetTypeId',
    :'asset_number' => :'assetNumber',
    :'purchase_date' => :'purchaseDate',
    :'purchase_price' => :'purchasePrice',
    :'disposal_date' => :'disposalDate',
    :'disposal_price' => :'disposalPrice',
    :'asset_status' => :'assetStatus',
    :'warranty_expiry_date' => :'warrantyExpiryDate',
    :'serial_number' => :'serialNumber',
    :'book_depreciation_setting' => :'bookDepreciationSetting',
    :'book_depreciation_detail' => :'bookDepreciationDetail',
    :'can_rollback' => :'canRollback',
    :'accounting_book_value' => :'accountingBookValue',
    :'is_delete_enabled_for_date' => :'isDeleteEnabledForDate'
  }
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


247
248
249
# File 'lib/xero-ruby/models/assets/asset.rb', line 247

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

.openapi_typesObject

Attribute type mapping.


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/xero-ruby/models/assets/asset.rb', line 90

def self.openapi_types
  {
    :'asset_id' => :'String',
    :'asset_name' => :'String',
    :'asset_type_id' => :'String',
    :'asset_number' => :'String',
    :'purchase_date' => :'Date',
    :'purchase_price' => :'BigDecimal',
    :'disposal_date' => :'Date',
    :'disposal_price' => :'BigDecimal',
    :'asset_status' => :'AssetStatus',
    :'warranty_expiry_date' => :'String',
    :'serial_number' => :'String',
    :'book_depreciation_setting' => :'BookDepreciationSetting',
    :'book_depreciation_detail' => :'BookDepreciationDetail',
    :'can_rollback' => :'Boolean',
    :'accounting_book_value' => :'BigDecimal',
    :'is_delete_enabled_for_date' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/xero-ruby/models/assets/asset.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_id == o.asset_id &&
      asset_name == o.asset_name &&
      asset_type_id == o.asset_type_id &&
      asset_number == o.asset_number &&
      purchase_date == o.purchase_date &&
      purchase_price == o.purchase_price &&
      disposal_date == o.disposal_date &&
      disposal_price == o.disposal_price &&
      asset_status == o.asset_status &&
      warranty_expiry_date == o.warranty_expiry_date &&
      serial_number == o.serial_number &&
      book_depreciation_setting == o.book_depreciation_setting &&
      book_depreciation_detail == o.book_depreciation_detail &&
      can_rollback == o.can_rollback &&
      accounting_book_value == o.accounting_book_value &&
      is_delete_enabled_for_date == o.is_delete_enabled_for_date
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


275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/xero-ruby/models/assets/asset.rb', line 275

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


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

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


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/xero-ruby/models/assets/asset.rb', line 254

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

234
235
236
# File 'lib/xero-ruby/models/assets/asset.rb', line 234

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


240
241
242
# File 'lib/xero-ruby/models/assets/asset.rb', line 240

def hash
  [asset_id, asset_name, asset_type_id, asset_number, purchase_date, purchase_price, disposal_date, disposal_price, asset_status, warranty_expiry_date, serial_number, book_depreciation_setting, book_depreciation_detail, can_rollback, accounting_book_value, is_delete_enabled_for_date].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


193
194
195
196
197
198
199
200
# File 'lib/xero-ruby/models/assets/asset.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  if @asset_name.nil?
    invalid_properties.push('invalid value for "asset_name", asset_name cannot be nil.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object


364
365
366
367
368
369
370
371
372
373
# File 'lib/xero-ruby/models/assets/asset.rb', line 364

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
  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_attributesObject

Returns the object in the form of hash with snake_case


340
341
342
# File 'lib/xero-ruby/models/assets/asset.rb', line 340

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


322
323
324
# File 'lib/xero-ruby/models/assets/asset.rb', line 322

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


328
329
330
331
332
333
334
335
336
337
# File 'lib/xero-ruby/models/assets/asset.rb', line 328

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


316
317
318
# File 'lib/xero-ruby/models/assets/asset.rb', line 316

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


204
205
206
207
# File 'lib/xero-ruby/models/assets/asset.rb', line 204

def valid?
  return false if @asset_name.nil?
  true
end