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



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

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_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_value ⇒ Object

The accounting value of the asset



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

def accounting_book_value
  @accounting_book_value
end

#asset_id ⇒ Object

The Xero-generated Id for the asset



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

def asset_id
  @asset_id
end

#asset_name ⇒ Object

The name of the asset



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

def asset_name
  @asset_name
end

#asset_number ⇒ Object

Must be unique.



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

def asset_number
  @asset_number
end

#asset_status ⇒ Object

Returns the value of attribute asset_status.



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

def asset_status
  @asset_status
end

#asset_type_id ⇒ Object

The Xero-generated Id for the asset type



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

def asset_type_id
  @asset_type_id
end

#book_depreciation_detail ⇒ Object

Returns the value of attribute book_depreciation_detail.



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

def book_depreciation_detail
  @book_depreciation_detail
end

#book_depreciation_setting ⇒ Object

Returns the value of attribute book_depreciation_setting.



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

def book_depreciation_setting
  @book_depreciation_setting
end

#can_rollback ⇒ Object

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.



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

def can_rollback
  @can_rollback
end

#disposal_price ⇒ Object

The price the asset was disposed at



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

def disposal_price
  @disposal_price
end

#is_delete_enabled_for_date ⇒ Object

Boolean to indicate whether delete is enabled



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

def is_delete_enabled_for_date
  @is_delete_enabled_for_date
end

#purchase_date ⇒ Object

The date the asset was purchased YYYY-MM-DD



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

def purchase_date
  @purchase_date
end

#purchase_price ⇒ Object

The purchase price of the asset



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

def purchase_price
  @purchase_price
end

#serial_number ⇒ Object

The asset’s serial number



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

def serial_number
  @serial_number
end

#warranty_expiry_date ⇒ Object

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



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

def warranty_expiry_date
  @warranty_expiry_date
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 61

def self.attribute_map
  {
    :'asset_id' => :'assetId',
    :'asset_name' => :'assetName',
    :'asset_type_id' => :'assetTypeId',
    :'asset_number' => :'assetNumber',
    :'purchase_date' => :'purchaseDate',
    :'purchase_price' => :'purchasePrice',
    :'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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 82

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 198

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



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/asset.rb', line 261

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



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

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



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

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


220
221
222
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 226

def hash
  [asset_id, asset_name, asset_type_id, asset_number, purchase_date, purchase_price, 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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



180
181
182
183
184
185
186
187
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 180

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

customized data_parser



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

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



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

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



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

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



300
301
302
 
# File 'lib/xero-ruby/models/assets/asset.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



191
192
193
194
 
# File 'lib/xero-ruby/models/assets/asset.rb', line 191

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