Class: XeroRuby::PayrollUk::PayRun

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

DRAFT =
"Draft".freeze
POSTED =
"Posted".freeze
SCHEDULED =
"Scheduled".freeze
UNSCHEDULED =
"Unscheduled".freeze
EARLIER_YEAR_UPDATE =
"EarlierYearUpdate".freeze
WEEKLY =
"Weekly".freeze
FORTNIGHTLY =
"Fortnightly".freeze
FOUR_WEEKLY =
"FourWeekly".freeze
MONTHLY =
"Monthly".freeze
ANNUAL =
"Annual".freeze
QUARTERLY =
"Quarterly".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#calendar_typeObject

Calendar type of the pay run


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

def calendar_type
  @calendar_type
end

#pay_run_idObject

Xero unique identifier for the pay run


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

def pay_run_id
  @pay_run_id
end

#pay_run_statusObject

Pay run status


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

def pay_run_status
  @pay_run_status
end

#pay_run_typeObject

Pay run type


46
47
48
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 46

def pay_run_type
  @pay_run_type
end

#pay_slipsObject

Returns the value of attribute pay_slips


64
65
66
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 64

def pay_slips
  @pay_slips
end

#payment_dateObject

Payment date of the pay run


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

def payment_date
  @payment_date
end

#payroll_calendar_idObject

Xero unique identifier for the payroll calendar


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

def payroll_calendar_id
  @payroll_calendar_id
end

#period_end_dateObject

Period end date of the payroll calendar


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

def period_end_date
  @period_end_date
end

#period_start_dateObject

Period start date of the payroll calendar


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

def period_start_date
  @period_start_date
end

#posted_date_timeObject

Posted date time of the pay run


61
62
63
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 61

def posted_date_time
  @posted_date_time
end

#total_costObject

Total cost of the pay run


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

def total_cost
  @total_cost
end

#total_payObject

Total pay of the pay run


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

def total_pay
  @total_pay
end

Class Method Details

.attribute_mapObject

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


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 89

def self.attribute_map
  {
    :'pay_run_id' => :'payRunID',
    :'payroll_calendar_id' => :'payrollCalendarID',
    :'period_start_date' => :'periodStartDate',
    :'period_end_date' => :'periodEndDate',
    :'payment_date' => :'paymentDate',
    :'total_cost' => :'totalCost',
    :'total_pay' => :'totalPay',
    :'pay_run_status' => :'payRunStatus',
    :'pay_run_type' => :'payRunType',
    :'calendar_type' => :'calendarType',
    :'posted_date_time' => :'postedDateTime',
    :'pay_slips' => :'paySlips'
  }
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


273
274
275
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 273

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

.openapi_typesObject

Attribute type mapping.


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 107

def self.openapi_types
  {
    :'pay_run_id' => :'String',
    :'payroll_calendar_id' => :'String',
    :'period_start_date' => :'Date',
    :'period_end_date' => :'Date',
    :'payment_date' => :'Date',
    :'total_cost' => :'Float',
    :'total_pay' => :'Float',
    :'pay_run_status' => :'String',
    :'pay_run_type' => :'String',
    :'calendar_type' => :'String',
    :'posted_date_time' => :'Date',
    :'pay_slips' => :'Array<Payslip>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pay_run_id == o.pay_run_id &&
      payroll_calendar_id == o.payroll_calendar_id &&
      period_start_date == o.period_start_date &&
      period_end_date == o.period_end_date &&
      payment_date == o.payment_date &&
      total_cost == o.total_cost &&
      total_pay == o.total_pay &&
      pay_run_status == o.pay_run_status &&
      pay_run_type == o.pay_run_type &&
      calendar_type == o.calendar_type &&
      posted_date_time == o.posted_date_time &&
      pay_slips == o.pay_slips
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


301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 301

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


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 374

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


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 280

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

260
261
262
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 260

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


266
267
268
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 266

def hash
  [pay_run_id, payroll_calendar_id, period_start_date, period_end_date, payment_date, total_cost, total_pay, pay_run_status, pay_run_type, calendar_type, posted_date_time, pay_slips].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


192
193
194
195
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 192

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


390
391
392
393
394
395
396
397
398
399
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 390

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


366
367
368
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 366

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


348
349
350
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 348

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


354
355
356
357
358
359
360
361
362
363
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 354

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


342
343
344
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 342

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


199
200
201
202
203
204
205
206
207
# File 'lib/xero-ruby/models/payroll_uk/pay_run.rb', line 199

def valid?
  pay_run_status_validator = EnumAttributeValidator.new('String', ["Draft", "Posted"])
  return false unless pay_run_status_validator.valid?(@pay_run_status)
  pay_run_type_validator = EnumAttributeValidator.new('String', ["Scheduled", "Unscheduled", "EarlierYearUpdate"])
  return false unless pay_run_type_validator.valid?(@pay_run_type)
  calendar_type_validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
  return false unless calendar_type_validator.valid?(@calendar_type)
  true
end