Class: XeroRuby::Assets::Setting

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Setting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 74

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_number_prefix ⇒ Object

The prefix used for fixed asset numbers (“FA-” by default)



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

def asset_number_prefix
  @asset_number_prefix
end

#asset_number_sequence ⇒ Object

The next available sequence number



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

def asset_number_sequence
  @asset_number_sequence
end

#asset_start_date ⇒ Object

The date depreciation calculations started on registered fixed assets in Xero



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

def asset_start_date
  @asset_start_date
end

#default_capital_gain_on_disposal_account_id ⇒ Object

Default account that capital gains are posted to



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

def 
  @default_capital_gain_on_disposal_account_id
end

#default_gain_on_disposal_account_id ⇒ Object

Default account that gains are posted to



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

def 
  @default_gain_on_disposal_account_id
end

#default_loss_on_disposal_account_id ⇒ Object

Default account that losses are posted to



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

def 
  @default_loss_on_disposal_account_id
end

#last_depreciation_date ⇒ Object

The last depreciation date



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

def last_depreciation_date
  @last_depreciation_date
end

#opt_in_for_tax ⇒ Object

opt in for tax calculation



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

def opt_in_for_tax
  @opt_in_for_tax
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 45

def self.attribute_map
  {
    :'asset_number_prefix' => :'assetNumberPrefix',
    :'asset_number_sequence' => :'assetNumberSequence',
    :'asset_start_date' => :'assetStartDate',
    :'last_depreciation_date' => :'lastDepreciationDate',
    :'default_gain_on_disposal_account_id' => :'defaultGainOnDisposalAccountId',
    :'default_loss_on_disposal_account_id' => :'defaultLossOnDisposalAccountId',
    :'default_capital_gain_on_disposal_account_id' => :'defaultCapitalGainOnDisposalAccountId',
    :'opt_in_for_tax' => :'optInForTax'
  }
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



163
164
165
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 163

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 59

def self.openapi_types
  {
    :'asset_number_prefix' => :'String',
    :'asset_number_sequence' => :'String',
    :'asset_start_date' => :'Date',
    :'last_depreciation_date' => :'Date',
    :'default_gain_on_disposal_account_id' => :'String',
    :'default_loss_on_disposal_account_id' => :'String',
    :'default_capital_gain_on_disposal_account_id' => :'String',
    :'opt_in_for_tax' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_number_prefix == o.asset_number_prefix &&
      asset_number_sequence == o.asset_number_sequence &&
      asset_start_date == o.asset_start_date &&
      last_depreciation_date == o.last_depreciation_date &&
       == o. &&
       == o. &&
       == o. &&
      opt_in_for_tax == o.opt_in_for_tax
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 191

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 258

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 170

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


150
151
152
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 156

def hash
  [asset_number_prefix, asset_number_sequence, asset_start_date, last_depreciation_date, , , , opt_in_for_tax].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



122
123
124
125
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



273
274
275
276
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 273

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



238
239
240
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 244

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



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

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



129
130
131
 
# File 'lib/xero-ruby/models/assets/setting.rb', line 129

def valid?
  true
end