Class: XeroRuby::PayrollUk::PayRunCalendar

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

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 = {}) ⇒ PayRunCalendar

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
130
131
132
133
134
135
136
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 96

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

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

  if attributes.key?(:'calendar_type')
    self.calendar_type = attributes[:'calendar_type']
  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?(:'updated_date_utc')
    self.updated_date_utc = attributes[:'updated_date_utc']
  end
end

Instance Attribute Details

#calendar_typeObject

Type of the calendar


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

def calendar_type
  @calendar_type
end

#nameObject

Name of the calendar


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

def name
  @name
end

#payment_dateObject

Payment date of the calendar


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

def payment_date
  @payment_date
end

#payroll_calendar_idObject

Xero unique identifier for the payroll calendar


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

def payroll_calendar_id
  @payroll_calendar_id
end

#period_end_dateObject

Period end date of the calendar


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

def period_end_date
  @period_end_date
end

#period_start_dateObject

Period start date of the calendar


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

def period_start_date
  @period_start_date
end

#updated_date_utcObject

UTC timestamp of the last update to the pay run calendar


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

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_mapObject

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


69
70
71
72
73
74
75
76
77
78
79
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 69

def self.attribute_map
  {
    :'payroll_calendar_id' => :'payrollCalendarID',
    :'name' => :'name',
    :'calendar_type' => :'calendarType',
    :'period_start_date' => :'periodStartDate',
    :'period_end_date' => :'periodEndDate',
    :'payment_date' => :'paymentDate',
    :'updated_date_utc' => :'updatedDateUTC'
  }
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


212
213
214
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 212

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

.openapi_typesObject

Attribute type mapping.


82
83
84
85
86
87
88
89
90
91
92
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 82

def self.openapi_types
  {
    :'payroll_calendar_id' => :'String',
    :'name' => :'String',
    :'calendar_type' => :'String',
    :'period_start_date' => :'Date',
    :'period_end_date' => :'Date',
    :'payment_date' => :'Date',
    :'updated_date_utc' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


185
186
187
188
189
190
191
192
193
194
195
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payroll_calendar_id == o.payroll_calendar_id &&
      name == o.name &&
      calendar_type == o.calendar_type &&
      period_start_date == o.period_start_date &&
      period_end_date == o.period_end_date &&
      payment_date == o.payment_date &&
      updated_date_utc == o.updated_date_utc
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


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 240

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


313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 313

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


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 219

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

199
200
201
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 199

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


205
206
207
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 205

def hash
  [payroll_calendar_id, name, calendar_type, period_start_date, period_end_date, payment_date, updated_date_utc].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 140

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

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


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

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


305
306
307
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 305

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


287
288
289
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 287

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


293
294
295
296
297
298
299
300
301
302
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 293

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


281
282
283
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 281

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


163
164
165
166
167
168
169
170
171
# File 'lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb', line 163

def valid?
  return false if @name.nil?
  return false if @calendar_type.nil?
  calendar_type_validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
  return false unless calendar_type_validator.valid?(@calendar_type)
  return false if @period_start_date.nil?
  return false if @payment_date.nil?
  true
end