Class: Merge::Accounting::Address
- Inherits:
-
Object
- Object
- Merge::Accounting::Address
- Defined in:
- lib/merge_ruby_client/accounting/types/address.rb
Overview
# The Address Object
### Description
The `Address` object is used to represent a contact's or company's address.
### Usage Example
Fetch from the `GET CompanyInfo` endpoint and view the company's addresses.
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#city ⇒ String
readonly
The address’s city.
-
#country ⇒ Merge::Accounting::CountryEnum
readonly
The address’s country.
-
#country_subdivision ⇒ String
readonly
The address’s state or region.
-
#created_at ⇒ DateTime
readonly
The datetime that this object was created by Merge.
-
#modified_at ⇒ DateTime
readonly
The datetime that this object was modified by Merge.
- #state ⇒ Object readonly
-
#street_1 ⇒ String
readonly
Line 1 of the address’s street.
-
#street_2 ⇒ String
readonly
Line 2 of the address’s street.
-
#type ⇒ Merge::Accounting::AddressTypeEnum
readonly
The address type.
-
#zip_code ⇒ String
readonly
The address’s zip code.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Merge::Accounting::Address
Deserialize a JSON object to an instance of Address.
-
.validate_raw(obj:) ⇒ Void
Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.
Instance Method Summary collapse
- #initialize(created_at: OMIT, modified_at: OMIT, type: OMIT, street_1: OMIT, street_2: OMIT, city: OMIT, state: OMIT, country_subdivision: OMIT, country: OMIT, zip_code: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Address constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of Address to a JSON object.
Constructor Details
#initialize(created_at: OMIT, modified_at: OMIT, type: OMIT, street_1: OMIT, street_2: OMIT, city: OMIT, state: OMIT, country_subdivision: OMIT, country: OMIT, zip_code: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Address
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 559 def initialize(created_at: OMIT, modified_at: OMIT, type: OMIT, street_1: OMIT, street_2: OMIT, city: OMIT, state: OMIT, country_subdivision: OMIT, country: OMIT, zip_code: OMIT, additional_properties: nil) @created_at = created_at if created_at != OMIT @modified_at = modified_at if modified_at != OMIT @type = type if type != OMIT @street_1 = street_1 if street_1 != OMIT @street_2 = street_2 if street_2 != OMIT @city = city if city != OMIT @state = state if state != OMIT @country_subdivision = country_subdivision if country_subdivision != OMIT @country = country if country != OMIT @zip_code = zip_code if zip_code != OMIT @additional_properties = additional_properties @_field_set = { "created_at": created_at, "modified_at": modified_at, "type": type, "street_1": street_1, "street_2": street_2, "city": city, "state": state, "country_subdivision": country_subdivision, "country": country, "zip_code": zip_code }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#additional_properties ⇒ OpenStruct (readonly)
Returns Additional properties unmapped to the current class definition.
289 290 291 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 289 def additional_properties @additional_properties end |
#city ⇒ String (readonly)
Returns The address’s city.
30 31 32 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 30 def city @city end |
#country ⇒ Merge::Accounting::CountryEnum (readonly)
Returns The address’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.
285 286 287 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 285 def country @country end |
#country_subdivision ⇒ String (readonly)
Returns The address’s state or region.
34 35 36 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 34 def country_subdivision @country_subdivision end |
#created_at ⇒ DateTime (readonly)
Returns The datetime that this object was created by Merge.
18 19 20 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 18 def created_at @created_at end |
#modified_at ⇒ DateTime (readonly)
Returns The datetime that this object was modified by Merge.
20 21 22 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 20 def modified_at @modified_at end |
#state ⇒ Object (readonly)
32 33 34 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 32 def state @state end |
#street_1 ⇒ String (readonly)
Returns Line 1 of the address’s street.
26 27 28 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 26 def street_1 @street_1 end |
#street_2 ⇒ String (readonly)
Returns Line 2 of the address’s street.
28 29 30 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 28 def street_2 @street_2 end |
#type ⇒ Merge::Accounting::AddressTypeEnum (readonly)
Returns The address type.
-
‘BILLING` - BILLING
-
‘SHIPPING` - SHIPPING.
24 25 26 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 24 def type @type end |
#zip_code ⇒ String (readonly)
Returns The address’s zip code.
287 288 289 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 287 def zip_code @zip_code end |
Class Method Details
.from_json(json_object:) ⇒ Merge::Accounting::Address
Deserialize a JSON object to an instance of Address
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 592 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?) modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?) type = parsed_json["type"] street_1 = parsed_json["street_1"] street_2 = parsed_json["street_2"] city = parsed_json["city"] state = parsed_json["state"] country_subdivision = parsed_json["country_subdivision"] country = parsed_json["country"] zip_code = parsed_json["zip_code"] new( created_at: created_at, modified_at: modified_at, type: type, street_1: street_1, street_2: street_2, city: city, state: state, country_subdivision: country_subdivision, country: country, zip_code: zip_code, additional_properties: struct ) end |
.validate_raw(obj:) ⇒ Void
Leveraged for Union-type generation, validate_raw attempts to parse the given
hash and check each fields type against the current object's property
definitions.
633 634 635 636 637 638 639 640 641 642 643 644 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 633 def self.validate_raw(obj:) obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.") obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.") obj.type&.is_a?(Merge::Accounting::AddressTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.") obj.street_1&.is_a?(String) != false || raise("Passed value for field obj.street_1 is not the expected type, validation failed.") obj.street_2&.is_a?(String) != false || raise("Passed value for field obj.street_2 is not the expected type, validation failed.") obj.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.") obj.state&.is_a?(Object) != false || raise("Passed value for field obj.state is not the expected type, validation failed.") obj.country_subdivision&.is_a?(String) != false || raise("Passed value for field obj.country_subdivision is not the expected type, validation failed.") obj.country&.is_a?(Merge::Accounting::CountryEnum) != false || raise("Passed value for field obj.country is not the expected type, validation failed.") obj.zip_code&.is_a?(String) != false || raise("Passed value for field obj.zip_code is not the expected type, validation failed.") end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of Address to a JSON object
623 624 625 |
# File 'lib/merge_ruby_client/accounting/types/address.rb', line 623 def to_json(*_args) @_field_set&.to_json end |