gobl 0.20.0 → 0.21.0

data/lib/generated/gobl/cbc/code_map.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/cbc/key.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/cbc/key_definition.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/cbc/meta.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/cbc/note.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/currency/amount.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Currency
+    # An Amount represents a monetary value in a specific currency.
+    class Amount < GOBL::Object
+      # The Schema ID of the GOBL Amount structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/currency/amount'
+
+      # @!attribute [r] label
+      # Label allows for additional information to be added to the currency Amount that may be useful.
+      # @return [String]
+      property :label, String
+
+      # @!attribute [r] currency
+      # Code defines the currency for this amount.
+      # @return [GOBL::Currency::Code]
+      property :currency, GOBL::Currency::Code
+      validates_presence_of :currency
+
+      # @!attribute [r] value
+      # Value is the amount in the currency.
+      # @return [GOBL::Num::Amount]
+      property :value, GOBL::Num::Amount
+      validates_presence_of :value
+    end
+  end
+end

data/lib/generated/gobl/currency/code.rb

@@ -3,12 +3,11 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
   module Currency
-    # ISO Currency Code
+    # Currency Code as defined in the GOBL source which is expected to be ISO or commonly used alternative.
     class Code < String
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/currency/code'
@@ -16,172 +15,186 @@ module GOBL
       include GOBL::Enum
 
       ENUM = {
-        'AED' => 'UAE Dirham',
-        'AFN' => 'Afghani',
-        'ALL' => 'Lek',
-        'AMD' => 'Armenian Dram',
-        'ANG' => 'Netherlands Antillean Guilder',
-        'AOA' => 'Kwanza',
-        'ARS' => 'Argentine Peso',
+        'USD' => 'United States Dollar',
+        'EUR' => 'Euro',
+        'GBP' => 'British Pound',
         'AUD' => 'Australian Dollar',
-        'AWG' => 'Aruban Florin',
-        'AZN' => 'Azerbaijan Manat',
-        'BAM' => 'Convertible Mark',
-        'BBD' => 'Barbados Dollar',
-        'BDT' => 'Taka',
+        'CAD' => 'Canadian Dollar',
+        'JPY' => 'Japanese Yen',
+        'BYR' => 'Belarusian Ruble',
+        'MOP' => 'Macanese Pataca',
+        'HTG' => 'Haitian Gourde',
+        'AZN' => 'Azerbaijani Manat',
+        'BAM' => 'Bosnia and Herzegovina Convertible Mark',
+        'BBD' => 'Barbadian Dollar',
+        'BDT' => 'Bangladeshi Taka',
         'BGN' => 'Bulgarian Lev',
         'BHD' => 'Bahraini Dinar',
-        'BIF' => 'Burundi Franc',
+        'BIF' => 'Burundian Franc',
         'BMD' => 'Bermudian Dollar',
         'BND' => 'Brunei Dollar',
-        'BOB' => 'Boliviano',
-        'BOV' => 'Mvdol',
+        'BOB' => 'Bolivian Boliviano',
         'BRL' => 'Brazilian Real',
         'BSD' => 'Bahamian Dollar',
-        'BTN' => 'Ngultrum',
-        'BWP' => 'Pula',
+        'BTN' => 'Bhutanese Ngultrum',
+        'BWP' => 'Botswana Pula',
         'BYN' => 'Belarusian Ruble',
+        'ARS' => 'Argentine Peso',
         'BZD' => 'Belize Dollar',
-        'CAD' => 'Canadian Dollar',
+        'AOA' => 'Angolan Kwanza',
         'CDF' => 'Congolese Franc',
-        'CHE' => 'WIR Euro',
         'CHF' => 'Swiss Franc',
-        'CHW' => 'WIR Franc',
         'CLF' => 'Unidad de Fomento',
         'CLP' => 'Chilean Peso',
-        'CNY' => 'Yuan Renminbi',
+        'CNY' => 'Chinese Renminbi Yuan',
         'COP' => 'Colombian Peso',
-        'COU' => 'Unidad de Valor Real',
-        'CRC' => 'Costa Rican Colon',
-        'CUC' => 'Peso Convertible',
+        'CRC' => 'Costa Rican Colón',
+        'CUC' => 'Cuban Convertible Peso',
         'CUP' => 'Cuban Peso',
-        'CVE' => 'Cabo Verde Escudo',
+        'CVE' => 'Cape Verdean Escudo',
         'CZK' => 'Czech Koruna',
-        'DJF' => 'Djibouti Franc',
+        'DJF' => 'Djiboutian Franc',
         'DKK' => 'Danish Krone',
-        'DOP' => 'Dominican Peso',
+        'MXN' => 'Mexican Peso',
         'DZD' => 'Algerian Dinar',
         'EGP' => 'Egyptian Pound',
-        'ERN' => 'Nakfa',
+        'ERN' => 'Eritrean Nakfa',
         'ETB' => 'Ethiopian Birr',
-        'EUR' => 'Euro',
-        'FJD' => 'Fiji Dollar',
-        'FKP' => 'Falkland Islands Pound',
-        'GBP' => 'Pound Sterling',
-        'GEL' => 'Lari',
-        'GHS' => 'Ghana Cedi',
+        'ANG' => 'Netherlands Antillean Gulden',
+        'FJD' => 'Fijian Dollar',
+        'FKP' => 'Falkland Pound',
+        'AMD' => 'Armenian Dram',
+        'GEL' => 'Georgian Lari',
+        'GHS' => 'Ghanaian Cedi',
         'GIP' => 'Gibraltar Pound',
-        'GMD' => 'Dalasi',
+        'GMD' => 'Gambian Dalasi',
         'GNF' => 'Guinean Franc',
-        'GTQ' => 'Quetzal',
-        'GYD' => 'Guyana Dollar',
+        'GTQ' => 'Guatemalan Quetzal',
+        'GYD' => 'Guyanese Dollar',
         'HKD' => 'Hong Kong Dollar',
-        'HNL' => 'Lempira',
-        'HRK' => 'Kuna',
-        'HTG' => 'Gourde',
-        'HUF' => 'Forint',
-        'IDR' => 'Rupiah',
-        'ILS' => 'New Israeli Sheqel',
+        'HNL' => 'Honduran Lempira',
+        'MWK' => 'Malawian Kwacha',
+        'HUF' => 'Hungarian Forint',
+        'IDR' => 'Indonesian Rupiah',
+        'ILS' => 'Israeli New Sheqel',
         'INR' => 'Indian Rupee',
         'IQD' => 'Iraqi Dinar',
         'IRR' => 'Iranian Rial',
-        'ISK' => 'Iceland Krona',
+        'ISK' => 'Icelandic Króna',
         'JMD' => 'Jamaican Dollar',
         'JOD' => 'Jordanian Dinar',
-        'JPY' => 'Yen',
+        'ALL' => 'Albanian Lek',
         'KES' => 'Kenyan Shilling',
-        'KGS' => 'Som',
-        'KHR' => 'Riel',
-        'KMF' => 'Comorian Franc ',
+        'KGS' => 'Kyrgyzstani Som',
+        'KHR' => 'Cambodian Riel',
+        'KMF' => 'Comorian Franc',
         'KPW' => 'North Korean Won',
-        'KRW' => 'Won',
+        'KRW' => 'South Korean Won',
         'KWD' => 'Kuwaiti Dinar',
         'KYD' => 'Cayman Islands Dollar',
-        'KZT' => 'Tenge',
+        'KZT' => 'Kazakhstani Tenge',
         'LAK' => 'Lao Kip',
         'LBP' => 'Lebanese Pound',
-        'LKR' => 'Sri Lanka Rupee',
+        'LKR' => 'Sri Lankan Rupee',
         'LRD' => 'Liberian Dollar',
-        'LSL' => 'Loti',
+        'LSL' => 'Lesotho Loti',
         'LYD' => 'Libyan Dinar',
         'MAD' => 'Moroccan Dirham',
         'MDL' => 'Moldovan Leu',
         'MGA' => 'Malagasy Ariary',
-        'MKD' => 'Denar',
-        'MMK' => 'Kyat',
-        'MNT' => 'Tugrik',
-        'MOP' => 'Pataca',
-        'MRU' => 'Ouguiya',
-        'MUR' => 'Mauritius Rupee',
-        'MVR' => 'Rufiyaa',
-        'MWK' => 'Malawi Kwacha',
-        'MXN' => 'Mexican Peso',
-        'MXV' => 'Mexican Unidad de Inversion (UDI)',
+        'MKD' => 'Macedonian Denar',
+        'MMK' => 'Myanmar Kyat',
+        'MNT' => 'Mongolian Tögrög',
+        'AED' => 'United Arab Emirates Dirham',
+        'MRU' => 'Mauritanian Ouguiya',
+        'MUR' => 'Mauritian Rupee',
+        'PLN' => 'Polish Złoty',
+        'AWG' => 'Aruban Florin',
+        'DOP' => 'Dominican Peso',
         'MYR' => 'Malaysian Ringgit',
-        'MZN' => 'Mozambique Metical',
-        'NAD' => 'Namibia Dollar',
-        'NGN' => 'Naira',
-        'NIO' => 'Cordoba Oro',
+        'MZN' => 'Mozambican Metical',
+        'NAD' => 'Namibian Dollar',
+        'NGN' => 'Nigerian Naira',
+        'NIO' => 'Nicaraguan Córdoba',
         'NOK' => 'Norwegian Krone',
         'NPR' => 'Nepalese Rupee',
         'NZD' => 'New Zealand Dollar',
-        'OMR' => 'Rial Omani',
-        'PAB' => 'Balboa',
-        'PEN' => 'Sol',
-        'PGK' => 'Kina',
+        'OMR' => 'Omani Rial',
+        'PAB' => 'Panamanian Balboa',
+        'PEN' => 'Peruvian Sol',
+        'PGK' => 'Papua New Guinean Kina',
         'PHP' => 'Philippine Peso',
-        'PKR' => 'Pakistan Rupee',
-        'PLN' => 'Zloty',
-        'PYG' => 'Guarani',
-        'QAR' => 'Qatari Rial',
+        'PKR' => 'Pakistani Rupee',
+        'MVR' => 'Maldivian Rufiyaa',
+        'PYG' => 'Paraguayan Guaraní',
+        'QAR' => 'Qatari Riyal',
         'RON' => 'Romanian Leu',
         'RSD' => 'Serbian Dinar',
         'RUB' => 'Russian Ruble',
-        'RWF' => 'Rwanda Franc',
+        'RWF' => 'Rwandan Franc',
         'SAR' => 'Saudi Riyal',
         'SBD' => 'Solomon Islands Dollar',
-        'SCR' => 'Seychelles Rupee',
+        'SCR' => 'Seychellois Rupee',
         'SDG' => 'Sudanese Pound',
         'SEK' => 'Swedish Krona',
         'SGD' => 'Singapore Dollar',
-        'SHP' => 'Saint Helena Pound',
-        'SLL' => 'Leone',
+        'SHP' => 'Saint Helenian Pound',
+        'SKK' => 'Slovak Koruna',
+        'SLE' => 'New Leone',
+        'SLL' => 'Sierra Leonean Leone',
         'SOS' => 'Somali Shilling',
-        'SRD' => 'Surinam Dollar',
+        'SRD' => 'Surinamese Dollar',
         'SSP' => 'South Sudanese Pound',
-        'STN' => 'Dobra',
-        'SVC' => 'El Salvador Colon',
+        'STD' => 'São Tomé and Príncipe Dobra',
+        'STN' => 'São Tomé and Príncipe Second Dobra',
+        'SVC' => 'Salvadoran Colón',
         'SYP' => 'Syrian Pound',
-        'SZL' => 'Lilangeni',
-        'THB' => 'Baht',
-        'TJS' => 'Somoni',
-        'TMT' => 'Turkmenistan New Manat',
+        'SZL' => 'Swazi Lilangeni',
+        'THB' => 'Thai Baht',
+        'TJS' => 'Tajikistani Somoni',
+        'TMT' => 'Turkmenistani Manat',
         'TND' => 'Tunisian Dinar',
-        'TOP' => 'Pa’anga',
+        'TOP' => 'Tongan Paʻanga',
         'TRY' => 'Turkish Lira',
         'TTD' => 'Trinidad and Tobago Dollar',
         'TWD' => 'New Taiwan Dollar',
         'TZS' => 'Tanzanian Shilling',
-        'UAH' => 'Hryvnia',
-        'UGX' => 'Uganda Shilling',
-        'USD' => 'US Dollar',
-        'USN' => 'US Dollar (Next day)',
-        'UYI' => 'Uruguay Peso en Unidades Indexadas (UI)',
-        'UYU' => 'Peso Uruguayo',
-        'UYW' => 'Unidad Previsional',
-        'UZS' => 'Uzbekistan Sum',
-        'VES' => 'Bolívar Soberano',
-        'VND' => 'Dong',
-        'VUV' => 'Vatu',
-        'WST' => 'Tala',
-        'XAF' => 'CFA Franc BEAC',
+        'UAH' => 'Ukrainian Hryvnia',
+        'UGX' => 'Ugandan Shilling',
+        'AFN' => 'Afghan Afghani',
+        'UYU' => 'Uruguayan Peso',
+        'UZS' => 'Uzbekistan Som',
+        'VES' => 'Venezuelan Bolívar Soberano',
+        'VND' => 'Vietnamese Đồng',
+        'VUV' => 'Vanuatu Vatu',
+        'WST' => 'Samoan Tala',
+        'XAF' => 'Central African Cfa Franc',
+        'XAG' => 'Silver (Troy Ounce)',
+        'XAU' => 'Gold (Troy Ounce)',
+        'XBA' => 'European Composite Unit',
+        'XBB' => 'European Monetary Unit',
+        'XBC' => 'European Unit of Account 9',
+        'XBD' => 'European Unit of Account 17',
         'XCD' => 'East Caribbean Dollar',
-        'XOF' => 'CFA Franc BCEAO',
-        'XPF' => 'CFP Franc',
+        'XDR' => 'Special Drawing Rights',
+        'XOF' => 'West African Cfa Franc',
+        'XPD' => 'Palladium',
+        'XPF' => 'Cfp Franc',
+        'XPT' => 'Platinum',
+        'XTS' => 'Codes specifically reserved for testing purposes',
         'YER' => 'Yemeni Rial',
-        'ZAR' => 'Rand',
+        'ZAR' => 'South African Rand',
+        'ZMK' => 'Zambian Kwacha',
         'ZMW' => 'Zambian Kwacha',
-        'ZWL' => 'Zimbabwe Dollar'
+        'BCH' => 'Bitcoin Cash',
+        'BTC' => 'Bitcoin',
+        'JEP' => 'Jersey Pound',
+        'GGP' => 'Guernsey Pound',
+        'IMP' => 'Isle of Man Pound',
+        'XFU' => 'UIC Franc',
+        'GBX' => 'British Penny',
+        'CNH' => 'Chinese Renminbi Yuan Offshore',
+        'USDC' => 'USD Coin'
       }.freeze
 
       def strict_enum?

data/lib/generated/gobl/currency/exchange_rate.rb

@@ -3,27 +3,37 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
   module Currency
-    # ExchangeRate contains data on the rate to be used when converting amounts from the document's base currency to whatever is defined.
+    # ExchangeRate contains data on the rate to be used when converting amounts from one currency into another.
     class ExchangeRate < GOBL::Object
       # The Schema ID of the GOBL ExchangeRate structure
       SCHEMA_ID = 'https://gobl.org/draft-0/currency/exchange-rate'
 
-      # @!attribute [r] currency
-      # ISO currency code this rate represents.
+      # @!attribute [r] from
+      # Currency code this will be converted from.
       # @return [GOBL::Currency::Code]
-      property :currency, GOBL::Currency::Code
-      validates_presence_of :currency
+      property :from, GOBL::Currency::Code
+      validates_presence_of :from
+
+      # @!attribute [r] to
+      # Currency code this exchange rate will convert into.
+      # @return [GOBL::Currency::Code]
+      property :to, GOBL::Currency::Code
+      validates_presence_of :to
 
       # @!attribute [r] amount
-      # How much is 1.00 of this currency worth in the documents currency.
+      # How much is 1 of the "from" currency worth in the "to" currency.
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
       validates_presence_of :amount
+
+      # @!attribute [r] at
+      # At represents the date and time (which may be 00:00:00) when the currency rate amount was determined.
+      # @return [GOBL::Cal::DateTime]
+      property :at, GOBL::Cal::DateTime
     end
   end
 end

data/lib/generated/gobl/dsig/digest.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/dsig/signature.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/envelope.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/head/header.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -15,8 +14,8 @@ module GOBL
 
       # @!attribute [r] uuid
       # Unique UUIDv1 identifier for the envelope.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # @return [String]
+      property :uuid, String
       validates_presence_of :uuid
 
       # @!attribute [r] dig

data/lib/generated/gobl/head/stamp.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/i18n/string.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/l10n/code.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/l10n/country_code.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/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.

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/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,9 +13,9 @@ 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.

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.