Class: XeroRuby::PayrollNz::EarningsOrder

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EarningsOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 58

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

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

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

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

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

Instance Attribute Details

#current_recordObject

Identifier of a record is active or not.


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

def current_record
  @current_record
end

#idObject

Xero unique identifier for an earning rate


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

def id
  @id
end

#liability_account_idObject

Xero identifier for Liability Account


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

def 
  @liability_account_id
end

#nameObject

Name of the earning order


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

def name
  @name
end

#statutory_deduction_categoryObject

Returns the value of attribute statutory_deduction_category


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

def statutory_deduction_category
  @statutory_deduction_category
end

Class Method Details

.attribute_mapObject

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


35
36
37
38
39
40
41
42
43
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 35

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'statutory_deduction_category' => :'statutoryDeductionCategory',
    :'liability_account_id' => :'liabilityAccountId',
    :'current_record' => :'currentRecord'
  }
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


139
140
141
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 139

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

.openapi_typesObject

Attribute type mapping.


46
47
48
49
50
51
52
53
54
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 46

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'statutory_deduction_category' => :'StatutoryDeductionCategory',
    :'liability_account_id' => :'String',
    :'current_record' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


114
115
116
117
118
119
120
121
122
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      statutory_deduction_category == o.statutory_deduction_category &&
       == o. &&
      current_record == o.current_record
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


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 167

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


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

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


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 146

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

126
127
128
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 126

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


132
133
134
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 132

def hash
  [id, name, statutory_deduction_category, , current_record].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


96
97
98
99
100
101
102
103
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 96

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


256
257
258
259
260
261
262
263
264
265
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 256

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


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

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


214
215
216
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 214

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


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

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


208
209
210
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 208

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


107
108
109
110
# File 'lib/xero-ruby/models/payroll_nz/earnings_order.rb', line 107

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