class MergeHRISClient::Location
The Location
Object ### Description The `Location` object is used to represent a Location
for a Company
or Employee
address. This is shared across many models and is referenced whenever a location is stored. ### Usage Example Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.
Attributes
The location's city.
The location's country.
The location's phone number.
The third-party API ID of the matching object.
The location's state. Represents a region if outside of the US.
Line 1 of the location's street address.
Line 2 of the location's street address.
The location's zip code.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/merge_hris_client/models/location.rb, line 64 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/merge_hris_client/models/location.rb, line 48 def self.attribute_map { :'id' => :'id', :'remote_id' => :'remote_id', :'phone_number' => :'phone_number', :'street_1' => :'street_1', :'street_2' => :'street_2', :'city' => :'city', :'state' => :'state', :'zip_code' => :'zip_code', :'country' => :'country', :'remote_data' => :'remote_data' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/merge_hris_client/models/location.rb, line 202 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/merge_hris_client/models/location.rb, line 101 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MergeHRISClient::Location` 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 `MergeHRISClient::Location`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'remote_id') self.remote_id = attributes[:'remote_id'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.key?(:'street_1') self.street_1 = attributes[:'street_1'] end if attributes.key?(:'street_2') self.street_2 = attributes[:'street_2'] end if attributes.key?(:'city') self.city = attributes[:'city'] end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'zip_code') self.zip_code = attributes[:'zip_code'] end if attributes.key?(:'country') self.country = attributes[:'country'] end if attributes.key?(:'remote_data') if (value = attributes[:'remote_data']).is_a?(Array) self.remote_data = value end end end
List of attributes with nullable: true
# File lib/merge_hris_client/models/location.rb, line 85 def self.openapi_nullable Set.new([ :'remote_id', :'phone_number', :'street_1', :'street_2', :'city', :'state', :'zip_code', :'country', :'remote_data' ]) end
Attribute type mapping.
# File lib/merge_hris_client/models/location.rb, line 69 def self.openapi_types { :'id' => :'String', :'remote_id' => :'String', :'phone_number' => :'String', :'street_1' => :'String', :'street_2' => :'String', :'city' => :'String', :'state' => :'String', :'zip_code' => :'String', :'country' => :'CountryEnum', :'remote_data' => :'Array<RemoteData>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/merge_hris_client/models/location.rb, line 172 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && remote_id == o.remote_id && phone_number == o.phone_number && street_1 == o.street_1 && street_2 == o.street_2 && city == o.city && state == o.state && zip_code == o.zip_code && country == o.country && remote_data == o.remote_data 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/merge_hris_client/models/location.rb, line 232 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f 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 # models (e.g. Pet) or oneOf klass = MergeHRISClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/merge_hris_client/models/location.rb, line 303 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/merge_hris_client/models/location.rb, line 209 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif 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 end self end
@see the `==` method @param [Object] Object to be compared
# File lib/merge_hris_client/models/location.rb, line 189 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/merge_hris_client/models/location.rb, line 195 def hash [id, remote_id, phone_number, street_1, street_2, city, state, zip_code, country, remote_data].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/merge_hris_client/models/location.rb, line 159 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/merge_hris_client/models/location.rb, line 285 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/merge_hris_client/models/location.rb, line 273 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/merge_hris_client/models/location.rb, line 166 def valid? true end