Class: XeroRuby::PayrollAu::OpeningBalances

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpeningBalances

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'earnings_lines')
    if (value = attributes[:'earnings_lines']).is_a?(Array)
      self.earnings_lines = value
    end
  end

  if attributes.key?(:'deduction_lines')
    if (value = attributes[:'deduction_lines']).is_a?(Array)
      self.deduction_lines = value
    end
  end

  if attributes.key?(:'super_lines')
    if (value = attributes[:'super_lines']).is_a?(Array)
      self.super_lines = value
    end
  end

  if attributes.key?(:'reimbursement_lines')
    if (value = attributes[:'reimbursement_lines']).is_a?(Array)
      self.reimbursement_lines = value
    end
  end

  if attributes.key?(:'leave_lines')
    if (value = attributes[:'leave_lines']).is_a?(Array)
      self.leave_lines = value
    end
  end

  if attributes.key?(:'paid_leave_earnings_lines')
    if (value = attributes[:'paid_leave_earnings_lines']).is_a?(Array)
      self.paid_leave_earnings_lines = value
    end
  end
end

Instance Attribute Details

#deduction_lines ⇒ Object

Returns the value of attribute deduction_lines.



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

def deduction_lines
  @deduction_lines
end

#earnings_lines ⇒ Object

Returns the value of attribute earnings_lines.



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

def earnings_lines
  @earnings_lines
end

#leave_lines ⇒ Object

Returns the value of attribute leave_lines.



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

def leave_lines
  @leave_lines
end

#opening_balance_date ⇒ Object

Opening Balance Date. (YYYY-MM-DD)



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

def opening_balance_date
  @opening_balance_date
end

Returns the value of attribute paid_leave_earnings_lines.



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

def paid_leave_earnings_lines
  @paid_leave_earnings_lines
end

#reimbursement_lines ⇒ Object

Returns the value of attribute reimbursement_lines.



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

def reimbursement_lines
  @reimbursement_lines
end

#super_lines ⇒ Object

Returns the value of attribute super_lines.



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

def super_lines
  @super_lines
end

#tax ⇒ Object

Opening Balance tax



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

def tax
  @tax
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'opening_balance_date' => :'OpeningBalanceDate',
    :'tax' => :'Tax',
    :'earnings_lines' => :'EarningsLines',
    :'deduction_lines' => :'DeductionLines',
    :'super_lines' => :'SuperLines',
    :'reimbursement_lines' => :'ReimbursementLines',
    :'leave_lines' => :'LeaveLines',
    :'paid_leave_earnings_lines' => :'PaidLeaveEarningsLines'
  }
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



174
175
176
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 174

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'opening_balance_date' => :'Date',
    :'tax' => :'String',
    :'earnings_lines' => :'Array<EarningsLine>',
    :'deduction_lines' => :'Array<DeductionLine>',
    :'super_lines' => :'Array<SuperLine>',
    :'reimbursement_lines' => :'Array<ReimbursementLine>',
    :'leave_lines' => :'Array<LeaveLine>',
    :'paid_leave_earnings_lines' => :'Array<PaidLeaveEarningsLine>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      opening_balance_date == o.opening_balance_date &&
      tax == o.tax &&
      earnings_lines == o.earnings_lines &&
      deduction_lines == o.deduction_lines &&
      super_lines == o.super_lines &&
      reimbursement_lines == o.reimbursement_lines &&
      leave_lines == o.leave_lines &&
      paid_leave_earnings_lines == o.paid_leave_earnings_lines
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



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
238
239
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 202

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



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

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



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

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


161
162
163
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 167

def hash
  [opening_balance_date, tax, earnings_lines, deduction_lines, super_lines, reimbursement_lines, leave_lines, paid_leave_earnings_lines].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



133
134
135
136
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 291

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
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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



267
268
269
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 267

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



249
250
251
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 249

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



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 255

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



243
244
245
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 243

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



140
141
142
 
# File 'lib/xero-ruby/models/payroll_au/opening_balances.rb', line 140

def valid?
  true
end