Class: GOBL::Org::Address

Inherits:
GOBL::Object show all
Defined in:
lib/gobl/org/address.rb

Overview

Address defines a globally acceptable set of attributes that describes a postal or fiscal address.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Address structure

'https://gobl.org/draft-0/org/address'

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#block ⇒ String (readonly)

Block number within the building.

Returns:

  • (String) 


44
 
# File 'lib/gobl/org/address.rb', line 44

property :block, String

#code ⇒ String (readonly)

Post or ZIP code.

Returns:

  • (String) 


75
 
# File 'lib/gobl/org/address.rb', line 75

property :code, String

#coords ⇒ GOBL::Org::Coordinates (readonly)

When the postal address is not sufficient, coordinates help locate the address more precisely.

Returns:



85
 
# File 'lib/gobl/org/address.rb', line 85

property :coords, GOBL::Org::Coordinates

#country ⇒ GOBL::L10n::CountryCode (readonly)

ISO country code.

Returns:



80
 
# File 'lib/gobl/org/address.rb', line 80

property :country, GOBL::L10n::CountryCode

#door ⇒ String (readonly)

Door number within the building.

Returns:

  • (String) 


49
 
# File 'lib/gobl/org/address.rb', line 49

property :door, String

#floor ⇒ String (readonly)

Floor number within the building.

Returns:

  • (String) 


39
 
# File 'lib/gobl/org/address.rb', line 39

property :floor, String

#label ⇒ String (readonly)

Useful identifier, such as home, work, etc.

Returns:

  • (String) 


24
 
# File 'lib/gobl/org/address.rb', line 24

property :label, String

#locality ⇒ String (readonly)

Village, town, district, or city, typically inside a region.

Returns:

  • (String) 


64
 
# File 'lib/gobl/org/address.rb', line 64

property :locality, String

#meta ⇒ GOBL::CBC::Meta (readonly)

Any additional semi-structure details about the address.

Returns:



90
 
# File 'lib/gobl/org/address.rb', line 90

property :meta, GOBL::CBC::Meta

#num ⇒ String (readonly)

House or building number in the street.

Returns:

  • (String) 


34
 
# File 'lib/gobl/org/address.rb', line 34

property :num, String

#po_box ⇒ String (readonly)

Box number or code for the post office box located at the address.

Returns:

  • (String) 


29
 
# File 'lib/gobl/org/address.rb', line 29

property :po_box, String

#region ⇒ String (readonly)

Province, county, or state, inside a country.

Returns:

  • (String) 


70
 
# File 'lib/gobl/org/address.rb', line 70

property :region, String

#street ⇒ String (readonly)

First line of street.

Returns:

  • (String) 


54
 
# File 'lib/gobl/org/address.rb', line 54

property :street, String

#street_extra ⇒ String (readonly)

Additional street address details.

Returns:

  • (String) 


59
 
# File 'lib/gobl/org/address.rb', line 59

property :street_extra, String

#uuid ⇒ GOBL::UUID::UUID (readonly)

Internal ID used to identify the party inside a document.

Returns:



19
 
# File 'lib/gobl/org/address.rb', line 19

property :uuid, GOBL::UUID::UUID