Class: XeroRuby::PayrollAu::SuperannuationLine

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SuperannuationLine

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
119
120
121
122
123
124
125
126
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 78

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amountObject

Superannuation amount


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

def amount
  @amount
end

#calculation_typeObject

Returns the value of attribute calculation_type


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

def calculation_type
  @calculation_type
end

#contribution_typeObject

Returns the value of attribute contribution_type


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

def contribution_type
  @contribution_type
end

#expense_account_codeObject

Superannuation expense account code.


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

def 
  @expense_account_code
end

#liability_account_codeObject

Superannuation liability account code


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

def 
  @liability_account_code
end

#minimum_monthly_earningsObject

Superannuation minimum monthly earnings.


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

def minimum_monthly_earnings
  @minimum_monthly_earnings
end

#payment_date_for_this_periodObject

Superannuation payment date for the current period (YYYY-MM-DD)


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

def payment_date_for_this_period
  @payment_date_for_this_period
end

#percentageObject

Superannuation percentage


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

def percentage
  @percentage
end

#super_membership_idObject

Xero identifier for payroll super fund membership ID.


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

def super_membership_id
  @super_membership_id
end

Class Method Details

.attribute_mapObject

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


47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 47

def self.attribute_map
  {
    :'super_membership_id' => :'SuperMembershipID',
    :'contribution_type' => :'ContributionType',
    :'calculation_type' => :'CalculationType',
    :'minimum_monthly_earnings' => :'MinimumMonthlyEarnings',
    :'expense_account_code' => :'ExpenseAccountCode',
    :'liability_account_code' => :'LiabilityAccountCode',
    :'payment_date_for_this_period' => :'PaymentDateForThisPeriod',
    :'percentage' => :'Percentage',
    :'amount' => :'Amount'
  }
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


172
173
174
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 172

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

.openapi_typesObject

Attribute type mapping.


62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 62

def self.openapi_types
  {
    :'super_membership_id' => :'String',
    :'contribution_type' => :'SuperannuationContributionType',
    :'calculation_type' => :'SuperannuationCalculationType',
    :'minimum_monthly_earnings' => :'BigDecimal',
    :'expense_account_code' => :'String',
    :'liability_account_code' => :'String',
    :'payment_date_for_this_period' => :'Date',
    :'percentage' => :'BigDecimal',
    :'amount' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      super_membership_id == o.super_membership_id &&
      contribution_type == o.contribution_type &&
      calculation_type == o.calculation_type &&
      minimum_monthly_earnings == o.minimum_monthly_earnings &&
       == o. &&
       == o. &&
      payment_date_for_this_period == o.payment_date_for_this_period &&
      percentage == o.percentage &&
      amount == o.amount
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


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
229
230
231
232
233
234
235
236
237
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 200

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


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 273

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


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 179

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

159
160
161
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 159

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


165
166
167
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 165

def hash
  [super_membership_id, contribution_type, calculation_type, minimum_monthly_earnings, , , payment_date_for_this_period, percentage, amount].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


130
131
132
133
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


289
290
291
292
293
294
295
296
297
298
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 289

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


265
266
267
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 265

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


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

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


253
254
255
256
257
258
259
260
261
262
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 253

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


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

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


137
138
139
# File 'lib/xero-ruby/models/payroll_au/superannuation_line.rb', line 137

def valid?
  true
end