Class: XeroRuby::PayrollUk::Employment

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

A =
"A".freeze
B =
"B".freeze
C =
"C".freeze
H =
"H".freeze
J =
"J".freeze
M =
"M".freeze
Z =
"Z".freeze
X =
"X".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Employment

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 83

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

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

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

Instance Attribute Details

#employee_numberObject

The employment number of the employee


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

def employee_number
  @employee_number
end

#ni_categoryObject

The NI Category of the employee


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

def ni_category
  @ni_category
end

#payroll_calendar_idObject

Xero unique identifier for the payroll calendar of the employee


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

def payroll_calendar_id
  @payroll_calendar_id
end

#start_dateObject

Start date of the employment (YYYY-MM-DD)


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

def start_date
  @start_date
end

Class Method Details

.attribute_mapObject

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


62
63
64
65
66
67
68
69
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 62

def self.attribute_map
  {
    :'payroll_calendar_id' => :'payrollCalendarID',
    :'start_date' => :'startDate',
    :'employee_number' => :'employeeNumber',
    :'ni_category' => :'niCategory'
  }
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


164
165
166
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 164

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

.openapi_typesObject

Attribute type mapping.


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

def self.openapi_types
  {
    :'payroll_calendar_id' => :'String',
    :'start_date' => :'Date',
    :'employee_number' => :'String',
    :'ni_category' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


140
141
142
143
144
145
146
147
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payroll_calendar_id == o.payroll_calendar_id &&
      start_date == o.start_date &&
      employee_number == o.employee_number &&
      ni_category == o.ni_category
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


192
193
194
195
196
197
198
199
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
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 192

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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 265

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


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 171

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

151
152
153
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 151

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


157
158
159
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 157

def hash
  [payroll_calendar_id, start_date, employee_number, ni_category].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


115
116
117
118
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


281
282
283
284
285
286
287
288
289
290
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 281

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


257
258
259
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 257

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


239
240
241
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 239

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


245
246
247
248
249
250
251
252
253
254
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 245

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


233
234
235
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 233

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


122
123
124
125
126
# File 'lib/xero-ruby/models/payroll_uk/employment.rb', line 122

def valid?
  ni_category_validator = EnumAttributeValidator.new('String', ["A", "B", "C", "H", "J", "M", "Z", "X"])
  return false unless ni_category_validator.valid?(@ni_category)
  true
end