gobl 0.20.0 → 0.22.0

data/lib/generated/gobl/l10n/tax_country_code.rb

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module L10n
+    # Defines an ISO base country code used for tax purposes
+    class TaxCountryCode < String
+      # The Schema ID of the GOBL TaxCountryCode structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/l10n/tax-country-code'
+
+      include GOBL::Enum
+
+      ENUM = {
+        '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, Plurinational State of',
+        'BQ' => 'Bonaire, Sint Eustatius and Saba',
+        'BA' => 'Bosnia and Herzegovina',
+        'BW' => 'Botswana',
+        'BV' => 'Bouvet Island',
+        'BR' => 'Brazil',
+        'IO' => 'British Indian Ocean Territory',
+        'BN' => 'Brunei Darussalam',
+        '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, Democratic Republic of the',
+        'CK' => 'Cook Islands',
+        'CR' => 'Costa Rica',
+        'CI' => 'Côte dIvoireIvoire',
+        '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',
+        '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',
+        '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 (the)',
+        'HN' => 'Honduras',
+        'HK' => 'Hong Kong',
+        'HU' => 'Hungary',
+        'IS' => 'Iceland',
+        'IN' => 'India',
+        'ID' => 'Indonesia',
+        'IR' => 'Iran, Islamic Republic of',
+        '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',
+        'KP' => 'Korea, Democratic Peoples Republic ofs Republic of',
+        'KR' => 'Korea, Republic of',
+        'KW' => 'Kuwait',
+        'KG' => 'Kyrgyzstan',
+        'LA' => 'Lao Peoples Democratic Republics Democratic Republic',
+        'LV' => 'Latvia',
+        'LB' => 'Lebanon',
+        'LS' => 'Lesotho',
+        'LR' => 'Liberia',
+        'LY' => 'Libya',
+        'LI' => 'Liechtenstein',
+        'LT' => 'Lithuania',
+        'LU' => 'Luxembourg',
+        'MO' => 'Macao',
+        'MK' => 'North Macedonia',
+        '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, Republic of',
+        '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',
+        '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' => 'Russian Federation',
+        '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',
+        'SS' => 'South Sudan',
+        'ES' => 'Spain',
+        'LK' => 'Sri Lanka',
+        'SD' => 'Sudan',
+        'SR' => 'Suriname',
+        'SJ' => 'Svalbard and Jan Mayen',
+        'SE' => 'Sweden',
+        'CH' => 'Switzerland',
+        'SY' => 'Syrian Arab Republic',
+        'TW' => 'Taiwan (Province of China)',
+        'TJ' => 'Tajikistan',
+        'TZ' => 'Tanzania, the United Republic of',
+        'TH' => 'Thailand',
+        'TL' => 'Timor-Leste',
+        'TG' => 'Togo',
+        'TK' => 'Tokelau',
+        'TO' => 'Tonga',
+        'TT' => 'Trinidad and Tobago',
+        'TN' => 'Tunisia',
+        'TR' => 'Türkiye',
+        'TM' => 'Turkmenistan',
+        'TC' => 'Turks and Caicos Islands',
+        'TV' => 'Tuvalu',
+        'UG' => 'Uganda',
+        'UA' => 'Ukraine',
+        'AE' => 'United Arab Emirates',
+        'GB' => 'United Kingdom',
+        'US' => 'United States of America',
+        'UM' => 'United States Minor Outlying Islands',
+        'UY' => 'Uruguay',
+        'UZ' => 'Uzbekistan',
+        'VU' => 'Vanuatu',
+        'VE' => 'Venezuela, Bolivarian Republic of',
+        'VN' => 'Viet Nam',
+        'VG' => 'Virgin Islands (British)',
+        'VI' => 'Virgin Islands (U.S.)',
+        'WF' => 'Wallis and Futuna',
+        'EH' => 'Western Sahara',
+        'YE' => 'Yemen',
+        'ZM' => 'Zambia',
+        'ZW' => 'Zimbabwe',
+        'EL' => 'Greece',
+        'XI' => 'United Kingdom (Northern Ireland)',
+        'XU' => 'United Kingdom (excluding Northern Ireland)',
+        'EU' => 'European Union'
+      }.freeze
+
+      def strict_enum?
+        true
+      end
+    end
+  end
+end

data/lib/generated/gobl/note/message.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -13,6 +12,11 @@ module GOBL
       # The Schema ID of the GOBL Message structure
       SCHEMA_ID = 'https://gobl.org/draft-0/note/message'
 
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
       # @!attribute [r] title
       # Summary of the message content
       # @return [String]

data/lib/generated/gobl/org/address.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/address'
 
       # @!attribute [r] uuid
-      # Internal ID used to identify the party inside a document.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
       # Useful identifier, such as home, work, etc.
@@ -62,7 +61,6 @@ module GOBL
       # Village, town, district, or city, typically inside a region.
       # @return [String]
       property :locality, String
-      validates_presence_of :locality
 
       # @!attribute [r] region
       # Province, county, or state, inside a country.
@@ -76,8 +74,8 @@ module GOBL
 
       # @!attribute [r] country
       # ISO country code.
-      # @return [GOBL::L10n::CountryCode]
-      property :country, GOBL::L10n::CountryCode
+      # @return [GOBL::L10n::ISOCountryCode]
+      property :country, GOBL::L10n::ISOCountryCode
 
       # @!attribute [r] coords
       # When the postal address is not sufficient, coordinates help locate the address more precisely.

data/lib/generated/gobl/org/coordinates.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/org/document_ref.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Org
+    # DocumentRef is used to describe an existing document or a specific part of it's contents.
+    class DocumentRef < GOBL::Object
+      # The Schema ID of the GOBL DocumentRef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/document-ref'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] type
+      # Type of the document referenced.
+      # @return [GOBL::CBC::Key]
+      property :type, GOBL::CBC::Key
+
+      # @!attribute [r] issue_date
+      # IssueDate reflects the date the document was issued.
+      # @return [GOBL::Cal::Date]
+      property :issue_date, GOBL::Cal::Date
+
+      # @!attribute [r] series
+      # Series the referenced document belongs to.
+      # @return [GOBL::CBC::Code]
+      property :series, GOBL::CBC::Code
+
+      # @!attribute [r] code
+      # Source document's code or other identifier.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+      validates_presence_of :code
+
+      # @!attribute [r] line
+      # Line index number inside the document, if relevant.
+      # @return [Integer]
+      property :line, Integer
+
+      # @!attribute [r] identities
+      # List of additional codes, IDs, or SKUs which can be used to identify the document or its contents, agreed upon by the supplier and customer.
+      # @return [Array<GOBL::Org::Identity>]
+      property :identities, [GOBL::Org::Identity]
+
+      # @!attribute [r] period
+      # Tax period in which the referred document had an effect required by some tax regimes and formats.
+      # @return [GOBL::Cal::Period]
+      property :period, GOBL::Cal::Period
+
+      # @!attribute [r] reason
+      # Human readable description on why this reference is here or needs to be used.
+      # @return [String]
+      property :reason, String
+
+      # @!attribute [r] description
+      # Additional details about the document.
+      # @return [String]
+      property :description, String
+
+      # @!attribute [r] stamps
+      # Seals of approval from other organisations that may need to be listed.
+      # @return [Array<GOBL::Head::Stamp>]
+      property :stamps, [GOBL::Head::Stamp]
+
+      # @!attribute [r] url
+      # Link to the source document.
+      # @return [String]
+      property :url, String
+
+      # @!attribute [r] ext
+      # Extensions for additional codes that may be required.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
+      # @!attribute [r] meta
+      # Meta contains additional information about the document.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/generated/gobl/org/email.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/email'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
       # Identifier for the email.

data/lib/generated/gobl/org/identity.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,15 +13,20 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/identity'
 
       # @!attribute [r] uuid
-      # Unique identity for this identity object.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
       # Optional label useful for non-standard identities to give a bit more context.
       # @return [String]
       property :label, String
 
+      # @!attribute [r] country
+      # Country from which the identity was issued.
+      # @return [GOBL::L10n::ISOCountryCode]
+      property :country, GOBL::L10n::ISOCountryCode
+
       # @!attribute [r] key
       # Uniquely classify this identity using a key instead of a code.
       # @return [GOBL::CBC::Key]

data/lib/generated/gobl/org/image.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/image'
 
       # @!attribute [r] uuid
-      # Unique ID of the image
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
       # Label to help identify the image.

data/lib/generated/gobl/org/inbox.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/inbox'
 
       # @!attribute [r] uuid
-      # Unique ID. Useful if inbox is stored in a database.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] key
       # Type of inbox being defined.

data/lib/generated/gobl/org/item.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/item'
 
       # @!attribute [r] uuid
-      # Unique identity of this item
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] ref
       # Primary reference code that identifies this item. Additional codes can be provided in the 'identities' property.
@@ -55,6 +54,11 @@ module GOBL
       property :price, GOBL::Num::Amount
       validates_presence_of :price
 
+      # @!attribute [r] alt_prices
+      # AltPrices defines a list of prices with their currencies that may be used as an alternative to the item's base price.
+      # @return [Array<GOBL::Currency::Amount>]
+      property :alt_prices, [GOBL::Currency::Amount]
+
       # @!attribute [r] unit
       # Unit of measure.
       # @return [GOBL::Org::Unit]
@@ -62,8 +66,8 @@ module GOBL
 
       # @!attribute [r] origin
       # Country code of where this item was from originally.
-      # @return [GOBL::L10n::CountryCode]
-      property :origin, GOBL::L10n::CountryCode
+      # @return [GOBL::L10n::ISOCountryCode]
+      property :origin, GOBL::L10n::ISOCountryCode
 
       # @!attribute [r] ext
       # Extension code map for any additional regime specific codes that may be required.

data/lib/generated/gobl/org/name.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/name'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] alias
       # What the person would like to be called
@@ -32,7 +31,6 @@ module GOBL
       # Person's given or first name
       # @return [String]
       property :given, String
-      validates_presence_of :given
 
       # @!attribute [r] middle
       # Middle names or initials
@@ -43,7 +41,6 @@ module GOBL
       # Second or Family name.
       # @return [String]
       property :surname, String
-      validates_presence_of :surname
 
       # @!attribute [r] surname2
       # Additional second of family name.

data/lib/generated/gobl/org/party.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,15 +13,19 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/party'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] label
+      # Label can be used to provide a custom label for the party in a given context in a single language, for example "Supplier", "Host", or similar.
+      # @return [String]
+      property :label, String
 
       # @!attribute [r] name
       # Legal name or representation of the organization.
       # @return [String]
       property :name, String
-      validates_presence_of :name
 
       # @!attribute [r] alias
       # Alternate short name.

data/lib/generated/gobl/org/person.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,14 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/person'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] label
+      # Label can be used to identify the person in a given context in a single language, for example "Attn", "Contact", "Responsible", etc.
+      # @return [String]
+      property :label, String
 
       # @!attribute [r] name
       # Complete details on the name of the person