Class: XeroRuby::PayrollNz::Reimbursement

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

GST = 
"GST".freeze
NO_GST = 
"NoGST".freeze
GST_INCLUSIVE = 
"GSTInclusive".freeze
UNKNOWN = 
"Unknown".freeze
FIXED_AMOUNT = 
"FixedAmount".freeze
RATE_PER_UNIT = 
"RatePerUnit".freeze
HOURS = 
"Hours".freeze
KM = 
"km".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Reimbursement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 108

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Xero unique identifier for the account used for the reimbursement



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

def 
  @account_id
end

#calculation_type ⇒ Object

See Calculation Types



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

def calculation_type
  @calculation_type
end

#current_record ⇒ Object

Indicates that whether the reimbursement is active



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

def current_record
  @current_record
end

#name ⇒ Object

Name of the reimbursement



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

def name
  @name
end

#reimbursement_category ⇒ Object

See Reimbursement Categories



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

def reimbursement_category
  @reimbursement_category
end

#reimbursement_id ⇒ Object

Xero unique identifier for a reimbursement



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

def reimbursement_id
  @reimbursement_id
end

#standard_amount ⇒ Object

Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount



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

def standard_amount
  @standard_amount
end

#standard_rate_per_unit ⇒ Object

Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit



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

def standard_rate_per_unit
  @standard_rate_per_unit
end

#standard_type_of_units ⇒ Object

Optional Type Of Units. Applicable when calculation type is Rate Per Unit



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

def standard_type_of_units
  @standard_type_of_units
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
89
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 77

def self.attribute_map
  {
    :'reimbursement_id' => :'reimbursementID',
    :'name' => :'name',
    :'account_id' => :'accountID',
    :'current_record' => :'currentRecord',
    :'reimbursement_category' => :'reimbursementCategory',
    :'calculation_type' => :'calculationType',
    :'standard_amount' => :'standardAmount',
    :'standard_type_of_units' => :'standardTypeOfUnits',
    :'standard_rate_per_unit' => :'standardRatePerUnit'
  }
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



248
249
250
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 248

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 92

def self.openapi_types
  {
    :'reimbursement_id' => :'String',
    :'name' => :'String',
    :'account_id' => :'String',
    :'current_record' => :'Boolean',
    :'reimbursement_category' => :'String',
    :'calculation_type' => :'String',
    :'standard_amount' => :'String',
    :'standard_type_of_units' => :'String',
    :'standard_rate_per_unit' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reimbursement_id == o.reimbursement_id &&
      name == o.name &&
       == o. &&
      current_record == o.current_record &&
      reimbursement_category == o.reimbursement_category &&
      calculation_type == o.calculation_type &&
      standard_amount == o.standard_amount &&
      standard_type_of_units == o.standard_type_of_units &&
      standard_rate_per_unit == o.standard_rate_per_unit
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



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
313
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 276

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::PayrollNz.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



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

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



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

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


235
236
237
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 241

def hash
  [reimbursement_id, name, , current_record, reimbursement_category, calculation_type, standard_amount, standard_type_of_units, standard_rate_per_unit].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



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 160

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

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 365

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

Returns the object in the form of hash with snake_case



341
342
343
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 341

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



323
324
325
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 329

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



317
318
319
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 317

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



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/payroll_nz/reimbursement.rb', line 175

def valid?
  return false if @name.nil?
  return false if @account_id.nil?
  reimbursement_category_validator = EnumAttributeValidator.new('String', ["GST", "NoGST", "GSTInclusive"])
  return false unless reimbursement_category_validator.valid?(@reimbursement_category)
  calculation_type_validator = EnumAttributeValidator.new('String', ["Unknown", "FixedAmount", "RatePerUnit"])
  return false unless calculation_type_validator.valid?(@calculation_type)
  standard_type_of_units_validator = EnumAttributeValidator.new('String', ["Hours", "km"])
  return false unless standard_type_of_units_validator.valid?(@standard_type_of_units)
  true
end