Class: XeroRuby::Accounting::Employee

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACTIVE =
"ACTIVE".freeze
ARCHIVED =
"ARCHIVED".freeze
GDPRREQUEST =
"GDPRREQUEST".freeze
DELETED =
"DELETED".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Employee

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
137
138
139
140
141
142
143
144
145
# File 'lib/xero-ruby/models/accounting/employee.rb', line 99

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

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

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

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

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

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

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

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

Instance Attribute Details

#employee_idObject

The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9


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

def employee_id
  @employee_id
end

Returns the value of attribute external_link


36
37
38
# File 'lib/xero-ruby/models/accounting/employee.rb', line 36

def external_link
  @external_link
end

#first_nameObject

First name of an employee (max length = 255)


30
31
32
# File 'lib/xero-ruby/models/accounting/employee.rb', line 30

def first_name
  @first_name
end

#last_nameObject

Last name of an employee (max length = 255)


33
34
35
# File 'lib/xero-ruby/models/accounting/employee.rb', line 33

def last_name
  @last_name
end

#statusObject

Current status of an employee – see contact status types


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

def status
  @status
end

#status_attribute_stringObject

A string to indicate if a invoice status


42
43
44
# File 'lib/xero-ruby/models/accounting/employee.rb', line 42

def status_attribute_string
  @status_attribute_string
end

#updated_date_utcObject

Returns the value of attribute updated_date_utc


39
40
41
# File 'lib/xero-ruby/models/accounting/employee.rb', line 39

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


45
46
47
# File 'lib/xero-ruby/models/accounting/employee.rb', line 45

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

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


70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/xero-ruby/models/accounting/employee.rb', line 70

def self.attribute_map
  {
    :'employee_id' => :'EmployeeID',
    :'status' => :'Status',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'external_link' => :'ExternalLink',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'status_attribute_string' => :'StatusAttributeString',
    :'validation_errors' => :'ValidationErrors'
  }
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


232
233
234
# File 'lib/xero-ruby/models/accounting/employee.rb', line 232

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

.openapi_typesObject

Attribute type mapping.


84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/xero-ruby/models/accounting/employee.rb', line 84

def self.openapi_types
  {
    :'employee_id' => :'String',
    :'status' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'external_link' => :'ExternalLink',
    :'updated_date_utc' => :'DateTime',
    :'status_attribute_string' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/xero-ruby/models/accounting/employee.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_id == o.employee_id &&
      status == o.status &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      external_link == o.external_link &&
      updated_date_utc == o.updated_date_utc &&
      status_attribute_string == o.status_attribute_string &&
      validation_errors == o.validation_errors
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


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/xero-ruby/models/accounting/employee.rb', line 260

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


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/xero-ruby/models/accounting/employee.rb', line 333

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


239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/xero-ruby/models/accounting/employee.rb', line 239

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

219
220
221
# File 'lib/xero-ruby/models/accounting/employee.rb', line 219

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


225
226
227
# File 'lib/xero-ruby/models/accounting/employee.rb', line 225

def hash
  [employee_id, status, first_name, last_name, external_link, updated_date_utc, status_attribute_string, validation_errors].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/xero-ruby/models/accounting/employee.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  if !@first_name.nil? && @first_name.to_s.length > 255
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 255.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 255
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object


349
350
351
352
353
354
355
356
357
358
# File 'lib/xero-ruby/models/accounting/employee.rb', line 349

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


325
326
327
# File 'lib/xero-ruby/models/accounting/employee.rb', line 325

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


307
308
309
# File 'lib/xero-ruby/models/accounting/employee.rb', line 307

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


313
314
315
316
317
318
319
320
321
322
# File 'lib/xero-ruby/models/accounting/employee.rb', line 313

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


301
302
303
# File 'lib/xero-ruby/models/accounting/employee.rb', line 301

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


164
165
166
167
168
169
170
# File 'lib/xero-ruby/models/accounting/employee.rb', line 164

def valid?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "GDPRREQUEST", "DELETED"])
  return false unless status_validator.valid?(@status)
  return false if !@first_name.nil? && @first_name.to_s.length > 255
  return false if !@last_name.nil? && @last_name.to_s.length > 255
  true
end