Class: XeroRuby::Accounting::Employee
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Employee
- 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
-
#employee_id ⇒ Object
The Xero identifier for an employee e.g.
-
#external_link ⇒ Object
Returns the value of attribute external_link.
-
#first_name ⇒ Object
First name of an employee (max length = 255).
-
#last_name ⇒ Object
Last name of an employee (max length = 255).
-
#status ⇒ Object
Current status of an employee – see contact status types.
-
#status_attribute_string ⇒ Object
A string to indicate if a invoice status.
-
#updated_date_utc ⇒ Object
Returns the value of attribute updated_date_utc.
-
#validation_errors ⇒ Object
Displays array of validation error messages from the API.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Employee
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Employee
Initializes the object
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 146 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 100 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_id ⇒ Object
The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
21 22 23 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 21 def employee_id @employee_id end |
#external_link ⇒ Object
Returns the value of attribute external_link.
37 38 39 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 37 def external_link @external_link end |
#first_name ⇒ Object
First name of an employee (max length = 255)
31 32 33 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 31 def first_name @first_name end |
#last_name ⇒ Object
Last name of an employee (max length = 255)
34 35 36 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 34 def last_name @last_name end |
#status ⇒ Object
Current status of an employee – see contact status types
24 25 26 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 24 def status @status end |
#status_attribute_string ⇒ Object
A string to indicate if a invoice status
43 44 45 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 43 def status_attribute_string @status_attribute_string end |
#updated_date_utc ⇒ Object
Returns the value of attribute updated_date_utc.
40 41 42 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 40 def updated_date_utc @updated_date_utc end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
46 47 48 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 46 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 71 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
233 234 235 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 233 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 85 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.
205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 205 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
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 298 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 261 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 328 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 240 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
220 221 222 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 220 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
226 227 228 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 226 def hash [employee_id, status, first_name, last_name, external_link, updated_date_utc, status_attribute_string, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 150 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
customized data_parser
343 344 345 346 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 343 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
308 309 310 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 308 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
314 315 316 317 318 319 320 321 322 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 314 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
302 303 304 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 302 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
165 166 167 168 169 170 171 |
# File 'lib/xero-ruby/models/accounting/employee.rb', line 165 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 |