Class: MergeHRISClient::Location
- Inherits:
-
Object
- Object
- MergeHRISClient::Location
- Defined in:
- lib/merge_hris_client/models/location.rb
Overview
# The Location Object ### Description The ‘Location` object is used to represent an address that can be associated with an employee. ### Usage Example Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.
Instance Attribute Summary collapse
-
#city ⇒ Object
The location’s city.
-
#country ⇒ Object
The location’s country.
-
#field_mappings ⇒ Object
Returns the value of attribute field_mappings.
-
#id ⇒ Object
Returns the value of attribute id.
-
#location_type ⇒ Object
The location’s type.
-
#modified_at ⇒ Object
This is the datetime that this object was last updated by Merge.
-
#name ⇒ Object
The location’s name.
-
#phone_number ⇒ Object
The location’s phone number.
-
#remote_data ⇒ Object
Returns the value of attribute remote_data.
-
#remote_id ⇒ Object
The third-party API ID of the matching object.
-
#remote_was_deleted ⇒ Object
Indicates whether or not this object has been deleted by third party webhooks.
-
#state ⇒ Object
The location’s state.
-
#street_1 ⇒ Object
Line 1 of the location’s street address.
-
#street_2 ⇒ Object
Line 2 of the location’s street address.
-
#zip_code ⇒ Object
The location’s zip code or postal code.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.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 = {}) ⇒ Location
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#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 = {}) ⇒ Location
Initializes the object
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/merge_hris_client/models/location.rb', line 128 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?(:'name') self.name = attributes[:'name'] 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?(:'location_type') self.location_type = attributes[:'location_type'] end if attributes.key?(:'remote_was_deleted') self.remote_was_deleted = attributes[:'remote_was_deleted'] end if attributes.key?(:'modified_at') self.modified_at = attributes[:'modified_at'] end if attributes.key?(:'field_mappings') if (value = attributes[:'field_mappings']).is_a?(Hash) self.field_mappings = value end end if attributes.key?(:'remote_data') if (value = attributes[:'remote_data']).is_a?(Array) self.remote_data = value end end end |
Instance Attribute Details
#city ⇒ Object
The location’s city.
37 38 39 |
# File 'lib/merge_hris_client/models/location.rb', line 37 def city @city end |
#country ⇒ Object
The location’s country. * ‘AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d’Ivoire * ‘HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
46 47 48 |
# File 'lib/merge_hris_client/models/location.rb', line 46 def country @country end |
#field_mappings ⇒ Object
Returns the value of attribute field_mappings.
57 58 59 |
# File 'lib/merge_hris_client/models/location.rb', line 57 def field_mappings @field_mappings end |
#id ⇒ Object
Returns the value of attribute id.
19 20 21 |
# File 'lib/merge_hris_client/models/location.rb', line 19 def id @id end |
#location_type ⇒ Object
The location’s type. Can be either WORK or HOME * ‘HOME` - HOME * `WORK` - WORK
49 50 51 |
# File 'lib/merge_hris_client/models/location.rb', line 49 def location_type @location_type end |
#modified_at ⇒ Object
This is the datetime that this object was last updated by Merge
55 56 57 |
# File 'lib/merge_hris_client/models/location.rb', line 55 def modified_at @modified_at end |
#name ⇒ Object
The location’s name.
25 26 27 |
# File 'lib/merge_hris_client/models/location.rb', line 25 def name @name end |
#phone_number ⇒ Object
The location’s phone number.
28 29 30 |
# File 'lib/merge_hris_client/models/location.rb', line 28 def phone_number @phone_number end |
#remote_data ⇒ Object
Returns the value of attribute remote_data.
59 60 61 |
# File 'lib/merge_hris_client/models/location.rb', line 59 def remote_data @remote_data end |
#remote_id ⇒ Object
The third-party API ID of the matching object.
22 23 24 |
# File 'lib/merge_hris_client/models/location.rb', line 22 def remote_id @remote_id end |
#remote_was_deleted ⇒ Object
Indicates whether or not this object has been deleted by third party webhooks.
52 53 54 |
# File 'lib/merge_hris_client/models/location.rb', line 52 def remote_was_deleted @remote_was_deleted end |
#state ⇒ Object
The location’s state. Represents a region if outside of the US.
40 41 42 |
# File 'lib/merge_hris_client/models/location.rb', line 40 def state @state end |
#street_1 ⇒ Object
Line 1 of the location’s street address.
31 32 33 |
# File 'lib/merge_hris_client/models/location.rb', line 31 def street_1 @street_1 end |
#street_2 ⇒ Object
Line 2 of the location’s street address.
34 35 36 |
# File 'lib/merge_hris_client/models/location.rb', line 34 def street_2 @street_2 end |
#zip_code ⇒ Object
The location’s zip code or postal code.
43 44 45 |
# File 'lib/merge_hris_client/models/location.rb', line 43 def zip_code @zip_code end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
83 84 85 |
# File 'lib/merge_hris_client/models/location.rb', line 83 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/merge_hris_client/models/location.rb', line 62 def self.attribute_map { :'id' => :'id', :'remote_id' => :'remote_id', :'name' => :'name', :'phone_number' => :'phone_number', :'street_1' => :'street_1', :'street_2' => :'street_2', :'city' => :'city', :'state' => :'state', :'zip_code' => :'zip_code', :'country' => :'country', :'location_type' => :'location_type', :'remote_was_deleted' => :'remote_was_deleted', :'modified_at' => :'modified_at', :'field_mappings' => :'field_mappings', :'remote_data' => :'remote_data' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
256 257 258 |
# File 'lib/merge_hris_client/models/location.rb', line 256 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/merge_hris_client/models/location.rb', line 109 def self.openapi_nullable Set.new([ :'remote_id', :'name', :'phone_number', :'street_1', :'street_2', :'city', :'state', :'zip_code', :'country', :'location_type', :'field_mappings', :'remote_data' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/merge_hris_client/models/location.rb', line 88 def self.openapi_types { :'id' => :'String', :'remote_id' => :'String', :'name' => :'String', :'phone_number' => :'String', :'street_1' => :'String', :'street_2' => :'String', :'city' => :'String', :'state' => :'String', :'zip_code' => :'String', :'country' => :'CountryEnum', :'location_type' => :'LocationTypeEnum', :'remote_was_deleted' => :'Boolean', :'modified_at' => :'Time', :'field_mappings' => :'Hash<String, Object>', :'remote_data' => :'Array<RemoteData>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/merge_hris_client/models/location.rb', line 221 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && remote_id == o.remote_id && name == o.name && 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 && location_type == o.location_type && remote_was_deleted == o.remote_was_deleted && modified_at == o.modified_at && field_mappings == o.field_mappings && remote_data == o.remote_data end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/merge_hris_client/models/location.rb', line 286 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/merge_hris_client/models/location.rb', line 357 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
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/merge_hris_client/models/location.rb', line 263 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 |
#eql?(o) ⇒ Boolean
243 244 245 |
# File 'lib/merge_hris_client/models/location.rb', line 243 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
249 250 251 |
# File 'lib/merge_hris_client/models/location.rb', line 249 def hash [id, remote_id, name, phone_number, street_1, street_2, city, state, zip_code, country, location_type, remote_was_deleted, modified_at, field_mappings, remote_data].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
208 209 210 211 |
# File 'lib/merge_hris_client/models/location.rb', line 208 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
333 334 335 |
# File 'lib/merge_hris_client/models/location.rb', line 333 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/merge_hris_client/models/location.rb', line 339 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 |
#to_s ⇒ String
Returns the string representation of the object
327 328 329 |
# File 'lib/merge_hris_client/models/location.rb', line 327 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
215 216 217 |
# File 'lib/merge_hris_client/models/location.rb', line 215 def valid? true end |