class XeroRuby::Accounting::Employee
Constants
- ACTIVE
- ARCHIVED
- DELETED
- GDPRREQUEST
Attributes
The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
First name of an employee (max length = 255)
Last name of an employee (max length = 255)
Current status of an employee – see contact status types
A string to indicate if a invoice status
Displays array of validation error messages from the API
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/employee.rb, line 232 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/employee.rb, line 219 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] first_name
Value to be assigned
# File lib/xero-ruby/models/accounting/employee.rb, line 184 def first_name=(first_name) if !first_name.nil? && first_name.to_s.length > 255 fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 255.' end @first_name = first_name end
Calculates hash code according to all attributes. @return [Integer] Hash code
# 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
Custom attribute writer method with validation @param [Object] last_name
Value to be assigned
# File lib/xero-ruby/models/accounting/employee.rb, line 194 def last_name=(last_name) if !last_name.nil? && last_name.to_s.length > 255 fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 255.' end @last_name = last_name end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
# 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 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
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/xero-ruby/models/accounting/employee.rb, line 174 def status=(status) validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "GDPRREQUEST", "DELETED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/employee.rb, line 325 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/employee.rb, line 301 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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