gobl 0.8.0 → 0.10.0

data/lib/gobl/bill/charge.rb

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

data/lib/gobl/bill/delivery.rb

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

data/lib/gobl/bill/discount.rb

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

data/lib/gobl/bill/document_reference.rb

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

data/lib/gobl/bill/invoice.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -27,18 +27,29 @@ module GOBL
       # Sequential code used to identify this invoice in tax declarations.
       # @return [String]
       property :code, String
-      validates :code, presence: true
+      validates_presence_of :code
+
+      # Enumeration of possible values for {#type} with their corresponding descriptions
+      TYPE_ENUM = {
+        'standard' => 'A regular commercial invoice document between a supplier and customer.',
+        'proforma' => 'For a clients validation before sending a final invoice.',
+        'corrective' => 'Corrected invoice that completely replaces the preceding document.',
+        'credit-note' => 'Reflects a refund either partial or complete of the preceding document.',
+        'debit-note' => 'An additional set of charges to be added to the preceding document.'
+      }.freeze
 
       # @!attribute [r] type
-      # Optional invoice type, leave empty unless needed for a specific situation.
-      # @return [InvoiceType]
-      property :type, InvoiceType
+      # Type of invoice document subject to the requirements of the local tax regime.
+      # @return [GOBL::CBC::Key]
+      property :type, GOBL::CBC::Key
+      validates_presence_of :type
+      validates_inclusion_of :type, in: TYPE_ENUM.keys
 
       # @!attribute [r] currency
       # Currency for all invoice totals.
       # @return [GOBL::Currency::Code]
       property :currency, GOBL::Currency::Code
-      validates :currency, presence: true
+      validates_presence_of :currency
 
       # @!attribute [r] exchange_rates
       # Exchange rates to be used when converting the invoices monetary values into other currencies.
@@ -59,7 +70,7 @@ module GOBL
       # When the invoice was created.
       # @return [GOBL::Cal::Date]
       property :issue_date, GOBL::Cal::Date
-      validates :issue_date, presence: true
+      validates_presence_of :issue_date
 
       # @!attribute [r] op_date
       # Date when the operation defined by the invoice became effective.
@@ -75,7 +86,7 @@ module GOBL
       # The taxable entity supplying the goods or services.
       # @return [GOBL::Org::Party]
       property :supplier, GOBL::Org::Party
-      validates :supplier, presence: true
+      validates_presence_of :supplier
 
       # @!attribute [r] customer
       # Legal entity receiving the goods or services, may be empty in certain circumstances such as simplified invoices.

data/lib/gobl/bill/line.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -27,13 +27,13 @@ module GOBL
       # Number of items
       # @return [GOBL::Num::Amount]
       property :quantity, GOBL::Num::Amount
-      validates :quantity, presence: true
+      validates_presence_of :quantity
 
       # @!attribute [r] item
       # Details about what is being sold
       # @return [GOBL::Org::Item]
       property :item, GOBL::Org::Item
-      validates :item, presence: true
+      validates_presence_of :item
 
       # @!attribute [r] sum
       # Result of quantity multiplied by the item's price (calculated)

data/lib/gobl/bill/line_charge.rb

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

data/lib/gobl/bill/line_discount.rb

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

data/lib/gobl/bill/ordering.rb

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

data/lib/gobl/bill/outlay.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -42,7 +42,7 @@ module GOBL
       # Details on what the outlay was.
       # @return [String]
       property :desc, String
-      validates :desc, presence: true
+      validates_presence_of :desc
 
       # @!attribute [r] supplier
       # Who was the supplier of the outlay
@@ -53,7 +53,7 @@ module GOBL
       # Amount paid by the supplier.
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
     end
   end
 end

data/lib/gobl/bill/payment.rb

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

data/lib/gobl/bill/preceding.rb

@@ -3,12 +3,12 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module Bill
-    # Preceding allows for information to be provided about a previous invoice that this one will replace or subtract from.
+    # Preceding allows for information to be provided about a previous invoice that this one will replace, subtract from, or add to.
     class Preceding < GOBL::Object
       # The Schema ID of the GOBL Preceding structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Preceding'
@@ -27,38 +27,38 @@ module GOBL
       # Code of the previous document.
       # @return [String]
       property :code, String
-      validates :code, presence: true
+      validates_presence_of :code
 
       # @!attribute [r] issue_date
-      # The issue date if the previous document.
+      # The issue date of the previous document.
       # @return [GOBL::Cal::Date]
       property :issue_date, GOBL::Cal::Date
-      validates :issue_date, presence: true
+      validates_presence_of :issue_date
 
-      # @!attribute [r] period
-      # Tax period in which the previous invoice had an effect.
-      # @return [GOBL::Cal::Period]
-      property :period, GOBL::Cal::Period
-
-      # @!attribute [r] corrections
-      # Specific codes for the corrections made.
-      # @return [Array<String>]
-      property :corrections, [String]
-
-      # @!attribute [r] correction_method
-      # How has the previous invoice been corrected?
+      # @!attribute [r] reason
+      # Human readable description on why the preceding invoice is being replaced.
       # @return [String]
-      property :correction_method, String
+      property :reason, String
 
       # @!attribute [r] stamps
-      # Seals of approval from other organisations.
+      # Seals of approval from other organisations that may need to be listed.
       # @return [Array<GOBL::CBC::Stamp>]
       property :stamps, [GOBL::CBC::Stamp]
 
-      # @!attribute [r] notes
-      # Additional details regarding preceding invoice
-      # @return [String]
-      property :notes, String
+      # @!attribute [r] corrections
+      # Tax regime specific keys reflecting why the preceding invoice is being replaced.
+      # @return [Array<GOBL::CBC::Key>]
+      property :corrections, [GOBL::CBC::Key]
+
+      # @!attribute [r] correction_method
+      # Tax regime specific keys reflecting the method used to correct the preceding invoice.
+      # @return [GOBL::CBC::Key]
+      property :correction_method, GOBL::CBC::Key
+
+      # @!attribute [r] period
+      # Tax period in which the previous invoice had an effect required by some tax regimes and formats.
+      # @return [GOBL::Cal::Period]
+      property :period, GOBL::Cal::Period
 
       # @!attribute [r] meta
       # Additional semi-structured data that may be useful in specific regions

data/lib/gobl/bill/tax.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -18,10 +18,10 @@ module GOBL
       # @return [GOBL::CBC::Code]
       property :prices_include, GOBL::CBC::Code
 
-      # @!attribute [r] schemes
-      # Special tax schemes that apply to this invoice according to local requirements.
+      # @!attribute [r] tags
+      # Special tax tags that apply to this invoice according to local requirements.
       # @return [Array<GOBL::CBC::Key>]
-      property :schemes, [GOBL::CBC::Key]
+      property :tags, [GOBL::CBC::Key]
 
       # @!attribute [r] meta
       # Any additional data that may be required for processing, but should never be relied upon by recipients.

data/lib/gobl/bill/totals.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -17,7 +17,7 @@ module GOBL
       # Sum of all line item sums
       # @return [GOBL::Num::Amount]
       property :sum, GOBL::Num::Amount
-      validates :sum, presence: true
+      validates_presence_of :sum
 
       # @!attribute [r] discount
       # Sum of all document level discounts
@@ -38,7 +38,7 @@ module GOBL
       # Sum of all line sums minus the discounts, plus the charges, without tax.
       # @return [GOBL::Num::Amount]
       property :total, GOBL::Num::Amount
-      validates :total, presence: true
+      validates_presence_of :total
 
       # @!attribute [r] taxes
       # Summary of all the taxes included in the invoice.
@@ -54,7 +54,7 @@ module GOBL
       # Grand total after all taxes have been applied.
       # @return [GOBL::Num::Amount]
       property :total_with_tax, GOBL::Num::Amount
-      validates :total_with_tax, presence: true
+      validates_presence_of :total_with_tax
 
       # @!attribute [r] outlays
       # Total paid in outlays that need to be reimbursed
@@ -65,7 +65,7 @@ module GOBL
       # Total amount to be paid after applying taxes and outlays.
       # @return [GOBL::Num::Amount]
       property :payable, GOBL::Num::Amount
-      validates :payable, presence: true
+      validates_presence_of :payable
 
       # @!attribute [r] advance
       # Total amount already paid in advance.

data/lib/gobl/cal/date.rb

@@ -3,13 +3,13 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module Cal
     # Civil date in simplified ISO format, like 2021-05-26
-    class Date < GOBL::Value
+    class Date < String
       # The Schema ID of the GOBL Date structure
       SCHEMA_ID = 'https://gobl.org/draft-0/cal/date'
     end

data/lib/gobl/cal/period.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -16,12 +16,12 @@ module GOBL
       # @!attribute [r] start
       # @return [GOBL::Cal::Date]
       property :start, GOBL::Cal::Date
-      validates :start, presence: true
+      validates_presence_of :start
 
       # @!attribute [r] end
       # @return [GOBL::Cal::Date]
       property :end, GOBL::Cal::Date
-      validates :end, presence: true
+      validates_presence_of :end
     end
   end
 end

data/lib/gobl/cbc/code.rb

@@ -3,13 +3,13 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module CBC
-    # Short upper-case identifier.
-    class Code < GOBL::Value
+    # Alphanumerical text identifier with upper-case letters, no whitespace, nor symbols.
+    class Code < String
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/cbc/code'
     end

data/lib/gobl/cbc/key.rb

@@ -3,13 +3,13 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module CBC
     # Text identifier to be used instead of a code for a more verbose but readable identifier.
-    class Key < GOBL::Value
+    class Key < String
       # The Schema ID of the GOBL Key structure
       SCHEMA_ID = 'https://gobl.org/draft-0/cbc/key'
     end

data/lib/gobl/cbc/meta.rb

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

data/lib/gobl/cbc/note.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -15,8 +15,8 @@ module GOBL
 
       # @!attribute [r] key
       # Key specifying subject of the text
-      # @return [NoteKey]
-      property :key, NoteKey
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
 
       # @!attribute [r] code
       # Code used for additional data that may be required to identify the note.
@@ -25,14 +25,14 @@ module GOBL
 
       # @!attribute [r] src
       # Source of this note, especially useful when auto-generated.
-      # @return [String]
-      property :src, String
+      # @return [GOBL::CBC::Key]
+      property :src, GOBL::CBC::Key
 
       # @!attribute [r] text
       # The contents of the note
       # @return [String]
       property :text, String
-      validates :text, presence: true
+      validates_presence_of :text
     end
   end
 end

data/lib/gobl/cbc/stamp.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -17,13 +17,13 @@ module GOBL
       # Identity of the agency used to create the stamp usually defined by each region.
       # @return [GOBL::CBC::Key]
       property :prv, GOBL::CBC::Key
-      validates :prv, presence: true
+      validates_presence_of :prv
 
       # @!attribute [r] val
       # The serialized stamp value generated for or by the external agency
       # @return [String]
       property :val, String
-      validates :val, presence: true
+      validates_presence_of :val
     end
   end
 end

data/lib/gobl/currency/code.rb

@@ -3,17 +3,18 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module Currency
     # ISO Currency Code
-    class Code < GOBL::Enum
+    class Code < String
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/currency/code'
 
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
+      include GOBL::Enum
+
       ENUM = {
         'AED' => 'UAE Dirham',
         'AFN' => 'Afghani',

data/lib/gobl/currency/exchange_rate.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -17,13 +17,13 @@ module GOBL
       # ISO currency code this rate represents.
       # @return [GOBL::Currency::Code]
       property :currency, GOBL::Currency::Code
-      validates :currency, presence: true
+      validates_presence_of :currency
 
       # @!attribute [r] amount
       # How much is 1.00 of this currency worth in the documents currency.
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
     end
   end
 end

data/lib/gobl/document.rb

@@ -3,11 +3,14 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
-  # Contents of the envelope that must contain a $schema.
+  # Contains the document payload to be included inside an Envelope.
+  # 
+  # The document must contain a `$schema` property that identifies
+  # the data's structure otherwise it will be rejected.
   class Document < GOBL::Map
   end
 end

data/lib/gobl/dsig/digest.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -17,13 +17,13 @@ module GOBL
       # Algorithm stores the algorithm key that was used to generate the value.
       # @return [String]
       property :alg, String
-      validates :alg, presence: true
+      validates_presence_of :alg
 
       # @!attribute [r] val
       # Value contains the Hexadecimal representation of the resulting hash generated by the algorithm.
       # @return [String]
       property :val, String
-      validates :val, presence: true
+      validates_presence_of :val
     end
   end
 end

data/lib/gobl/dsig/signature.rb

@@ -3,13 +3,13 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module DSig
     # JSON Web Signature in compact form.
-    class Signature < GOBL::Value
+    class Signature < String
       # The Schema ID of the GOBL Signature structure
       SCHEMA_ID = 'https://gobl.org/draft-0/dsig/signature'
     end