gobl 0.22.0 → 0.24.0

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Org
+    # An Attachment provides a structure to be used to attach documents inside a GOBL document, either as a reference via a URL, or directly as a base64 encoded string.
+    class Attachment < GOBL::Object
+      # The Schema ID of the GOBL Attachment structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/attachment'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] key
+      # Key used to identify the attachment inside the document.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] code
+      # Code used to identify the payload of the attachment.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] name
+      # Filename of the attachment.
+      # @return [String]
+      property :name, String
+      validates_presence_of :name
+
+      # @!attribute [r] description
+      # Details of why the attachment is being included and details on what it contains.
+      # @return [String]
+      property :description, String
+
+      # @!attribute [r] url
+      # URL of where to find the attachment. Prefer using this field over the Data field.
+      # @return [String]
+      property :url, String
+
+      # @!attribute [r] digest
+      # Digest is used to verify the integrity of the attachment when downloaded from the URL.
+      # @return [GOBL::DSig::Digest]
+      property :digest, GOBL::DSig::Digest
+
+      # @!attribute [r] mime
+      # MIME type of the attachment.
+      # @return [String]
+      property :mime, String
+    end
+  end
+end

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

@@ -17,8 +17,13 @@ module GOBL
       # @return [String]
       property :uuid, String
 
+      # @!attribute [r] schema
+      # Schema of the referenced document if different from that of the parent.
+      # @return [String]
+      property :schema, String
+
       # @!attribute [r] type
-      # Type of the document referenced.
+      # Type of the document referenced according to the defined schema or that of the parent document.
       # @return [GOBL::CBC::Key]
       property :type, GOBL::CBC::Key
 
@@ -38,10 +43,15 @@ module GOBL
       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] currency
+      # Currency used in the document, if different from the parent's currency.
+      # @return [GOBL::Currency::Code]
+      property :currency, GOBL::Currency::Code
+
+      # @!attribute [r] lines
+      # Line index numbers inside the document, if relevant.
+      # @return [Array<Integer>]
+      property :lines, [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.
@@ -64,7 +74,7 @@ module GOBL
       property :description, String
 
       # @!attribute [r] stamps
-      # Seals of approval from other organisations that may need to be listed.
+      # Seals of approval from other organizations that may need to be listed.
       # @return [Array<GOBL::Head::Stamp>]
       property :stamps, [GOBL::Head::Stamp]
 
@@ -73,6 +83,16 @@ module GOBL
       # @return [String]
       property :url, String
 
+      # @!attribute [r] tax
+      # Tax total breakdown from the original document in the provided currency. Should only be included if required by a specific tax regime or addon.
+      # @return [GOBL::Tax::Total]
+      property :tax, GOBL::Tax::Total
+
+      # @!attribute [r] payable
+      # Payable is the total amount that is payable in the referenced document. Only needed for specific tax regimes or addons. This may also be used in some scenarios to determine the proportion of the referenced document that has been paid, and calculate the remaining amount due and taxes.
+      # @return [GOBL::Num::Amount]
+      property :payable, GOBL::Num::Amount
+
       # @!attribute [r] ext
       # Extensions for additional codes that may be required.
       # @return [GOBL::Tax::Extensions]

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

@@ -28,7 +28,7 @@ module GOBL
       property :country, GOBL::L10n::ISOCountryCode
 
       # @!attribute [r] key
-      # Uniquely classify this identity using a key instead of a code.
+      # Uniquely classify this identity using a key instead of a type.
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
 
@@ -47,6 +47,11 @@ module GOBL
       # Description adds details about what the code could mean or imply
       # @return [String]
       property :description, String
+
+      # @!attribute [r] ext
+      # Ext provides a way to add additional information to the identity.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

@@ -7,7 +7,7 @@
 
 module GOBL
   module Org
-    # Inbox is used to store data about a connection with a service that is responsible for potentially receiving copies of GOBL envelopes or other document formats defined locally.
+    # Inbox is used to store data about a connection with a service that is responsible for automatically receiving copies of GOBL envelopes or other document formats.
     class Inbox < GOBL::Object
       # The Schema ID of the GOBL Inbox structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/inbox'
@@ -17,27 +17,35 @@ module GOBL
       # @return [String]
       property :uuid, String
 
+      # @!attribute [r] label
+      # Label for the inbox.
+      # @return [String]
+      property :label, String
+
       # @!attribute [r] key
-      # Type of inbox being defined.
+      # Type of inbox being defined if required for clarification between multiple inboxes.
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
-      validates_presence_of :key
 
-      # @!attribute [r] role
-      # Role assigned to this inbox that may be relevant for the consumer.
-      # @return [GOBL::CBC::Key]
-      property :role, GOBL::CBC::Key
+      # @!attribute [r] scheme
+      # Scheme ID of the code used to identify the inbox. This is context specific and usually an ISO 6523 code or CEF (Connecting Europe Facility) code.
+      # @return [GOBL::CBC::Code]
+      property :scheme, GOBL::CBC::Code
 
-      # @!attribute [r] name
-      # Human name for the inbox.
+      # @!attribute [r] code
+      # Code or ID that identifies the Inbox. Mutually exclusive with URL and Email.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] url
+      # URL of the inbox that includes the protocol, server, and path. May be used instead of the Code to identify the inbox. Mutually exclusive with Code and Email.
       # @return [String]
-      property :name, String
+      property :url, String
 
-      # @!attribute [r] code
-      # Actual Code or ID that identifies the Inbox.
+      # @!attribute [r] email
+      # Email address for the inbox. Mutually exclusive with Code and URL.
       # @return [String]
-      property :code, String
-      validates_presence_of :code
+      property :email, String
     end
   end
 end

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

@@ -19,8 +19,8 @@ module GOBL
 
       # @!attribute [r] ref
       # Primary reference code that identifies this item. Additional codes can be provided in the 'identities' property.
-      # @return [String]
-      property :ref, String
+      # @return [GOBL::CBC::Code]
+      property :ref, GOBL::CBC::Code
 
       # @!attribute [r] key
       # Special key used to classify the item sometimes required by some regimes.
@@ -43,6 +43,11 @@ module GOBL
       # @return [String]
       property :description, String
 
+      # @!attribute [r] images
+      # Images associated with the item.
+      # @return [Array<GOBL::Org::Image>]
+      property :images, [GOBL::Org::Image]
+
       # @!attribute [r] currency
       # Currency used for the item's price.
       # @return [GOBL::Currency::Code]
@@ -52,7 +57,6 @@ module GOBL
       # Base price of a single unit to be sold.
       # @return [GOBL::Num::Amount]
       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.

data/lib/generated/gobl/{cbc → org}/note.rb

@@ -6,11 +6,16 @@
 ##
 
 module GOBL
-  module CBC
+  module Org
     # Note represents a free text of additional information that may be added to a document.
     class Note < GOBL::Object
       # The Schema ID of the GOBL Note structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/note'
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/note'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # Enumeration of possible values for {#key} with their corresponding descriptions
       KEY_ENUM = {
@@ -38,7 +43,8 @@ module GOBL
         'transport' => 'Transportation information',
         'delivery' => 'Delivery information',
         'quarantine' => 'Quarantine information',
-        'tax' => 'Tax declaration'
+        'tax' => 'Tax declaration',
+        'other' => 'Mutually defined'
       }.freeze
 
       # @!attribute [r] key
@@ -49,8 +55,8 @@ module GOBL
 
       # @!attribute [r] code
       # Code used for additional data that may be required to identify the note.
-      # @return [String]
-      property :code, String
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] src
       # Source of this note, especially useful when auto-generated.
@@ -67,6 +73,11 @@ module GOBL
       # Additional information about the note
       # @return [GOBL::CBC::Meta]
       property :meta, GOBL::CBC::Meta
+
+      # @!attribute [r] ext
+      # Extension data
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

@@ -12,6 +12,10 @@ module GOBL
       # The Schema ID of the GOBL Party structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/party'
 
+      # @!attribute [r] $regime
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :$regime, GOBL::L10n::TaxCountryCode
+
       # @!attribute [r] uuid
       # Universally Unique Identifier.
       # @return [String]

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

@@ -22,17 +22,32 @@ module GOBL
       # @return [String]
       property :label, String
 
+      # @!attribute [r] key
+      # Key used to identify the role of the person inside the context of the object.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
       # @!attribute [r] name
-      # Complete details on the name of the person
+      # Complete details on the name of the person.
       # @return [GOBL::Org::Name]
       property :name, GOBL::Org::Name
       validates_presence_of :name
 
       # @!attribute [r] role
-      # What they do within an organization
+      # Role or job title of the responsibilities of the person within an organization.
       # @return [String]
       property :role, String
 
+      # @!attribute [r] identities
+      # Set of codes used to identify the person, such as ID numbers, social security, driving licenses, etc. that can be attributed to the individual.
+      # @return [Array<GOBL::Org::Identity>]
+      property :identities, [GOBL::Org::Identity]
+
+      # @!attribute [r] addresses
+      # Regular post addresses for where information should be sent if needed.
+      # @return [Array<GOBL::Org::Address>]
+      property :addresses, [GOBL::Org::Address]
+
       # @!attribute [r] emails
       # Electronic mail addresses that belong to the person.
       # @return [Array<GOBL::Org::Email>]

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

@@ -23,7 +23,7 @@ module GOBL
       property :label, String
 
       # @!attribute [r] num
-      # The number to be dialed in ITU E.164 international format.
+      # Free-text string that represents the telephone number.
       # @return [String]
       property :num, String
       validates_presence_of :num

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

@@ -7,7 +7,7 @@
 
 module GOBL
   module Org
-    # Unit describes how the quantity of the product should be interpreted either using a GOBL key, or UN/ECE code.
+    # Unit defines how the quantity of the product should be interpreted either using a GOBL lower-case key (e.g. 'kg'), or UN/ECE code upper-case code (e.g. 'KGM').
     class Unit < String
       # The Schema ID of the GOBL Unit structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/unit'
@@ -21,11 +21,20 @@ module GOBL
         't' => 'Metric tons',
         'mm' => 'Milimetres',
         'cm' => 'Centimetres',
+        'dm' => 'A unit of length equal to one-tenth of a metre.',
         'm' => 'Metres',
         'km' => 'Kilometers',
         'in' => 'Inches',
         'ft' => 'Feet',
+        'mm2' => 'Square millimetres',
+        'cm2' => 'Square centimetres',
+        'dm2' => 'Square decimetres',
         'm2' => 'Square metres',
+        'ac' => 'A unit of area equal to 43,560 square feet.',
+        'ha' => 'A unit of area equal to 10,000 square metres.',
+        'mm3' => 'Cubic millimetres',
+        'cm3' => 'Cubic centimetres',
+        'dm3' => 'Cubic decimetres',
         'm3' => 'Cubic metres',
         'ml' => 'Millilitres',
         'cl' => 'Centilitres',
@@ -53,6 +62,7 @@ module GOBL
         'kit' => 'A unit of count defining the number of kits (kit: tub, barrel or pail).',
         'basebox' => 'A unit of area of 112 sheets of tin mil products (tin plate, tin free steel or black plate) 14 by 20 inches, or 31,360 square inches.',
         'pk' => 'A unit of count defining the number of items per bulk pack.',
+        'one' => 'A single generic unit of a service or product.',
         'bag' => 'Bags',
         'box' => 'Boxes',
         'bin' => 'Bins',

data/lib/generated/gobl/pay/advance.rb

@@ -27,11 +27,13 @@ module GOBL
         'any' => 'Any method available, no preference.',
         'card' => 'Payment card.',
         'credit-transfer' => 'Sender initiated bank or wire transfer.',
+        'credit-transfer+sepa' => 'Sender initiated bank or wire transfer via SEPA.',
         'debit-transfer' => 'Receiver initiated bank or wire transfer.',
         'cash' => 'Cash in hand.',
         'cheque' => 'Cheque from bank.',
         'bank-draft' => 'Bankers Draft or Bank Cheque.',
         'direct-debit' => 'Direct debit from the customers bank account.',
+        'direct-debit+sepa' => 'Direct debit from the customers bank account via SEPA.',
         'online' => 'Online or web payment.',
         'promissory-note' => 'Promissory note contract.',
         'netting' => 'Intercompany clearing or clearing between partners.',
@@ -60,7 +62,7 @@ module GOBL
       validates_presence_of :description
 
       # @!attribute [r] percent
-      # How much as a percentage of the total with tax was paid
+      # Percentage of the total amount payable that was paid. Note that multiple advances with percentages may lead to rounding errors, especially when the total advances sums to 100%. We recommend only including one advance with a percent value per document.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 

data/lib/generated/gobl/pay/card.rb

@@ -12,17 +12,20 @@ module GOBL
       # The Schema ID of the GOBL Card structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/Card'
 
+      # @!attribute [r] first6
+      # First 6 digits of the card's Primary Account Number (PAN).
+      # @return [String]
+      property :first6, String
+
       # @!attribute [r] last4
       # Last 4 digits of the card's Primary Account Number (PAN).
       # @return [String]
       property :last4, String
-      validates_presence_of :last4
 
       # @!attribute [r] holder
       # Name of the person whom the card belongs to.
       # @return [String]
       property :holder, String
-      validates_presence_of :holder
     end
   end
 end

data/lib/generated/gobl/pay/instructions.rb

@@ -17,11 +17,13 @@ module GOBL
         'any' => 'Any method available, no preference.',
         'card' => 'Payment card.',
         'credit-transfer' => 'Sender initiated bank or wire transfer.',
+        'credit-transfer+sepa' => 'Sender initiated bank or wire transfer via SEPA.',
         'debit-transfer' => 'Receiver initiated bank or wire transfer.',
         'cash' => 'Cash in hand.',
         'cheque' => 'Cheque from bank.',
         'bank-draft' => 'Bankers Draft or Bank Cheque.',
         'direct-debit' => 'Direct debit from the customers bank account.',
+        'direct-debit+sepa' => 'Direct debit from the customers bank account via SEPA.',
         'online' => 'Online or web payment.',
         'promissory-note' => 'Promissory note contract.',
         'netting' => 'Intercompany clearing or clearing between partners.',
@@ -40,9 +42,9 @@ module GOBL
       property :detail, String
 
       # @!attribute [r] ref
-      # Remittance information or concept, a text value used to link the payment with the invoice.
-      # @return [String]
-      property :ref, String
+      # Remittance information or concept, a code value used to link the payment with the invoice.
+      # @return [GOBL::CBC::Code]
+      property :ref, GOBL::CBC::Code
 
       # @!attribute [r] credit_transfer
       # Instructions for sending payment via a bank transfer.

data/lib/generated/gobl/pay/terms.rb

@@ -14,7 +14,6 @@ module GOBL
 
       # Enumeration of possible values for {#key} with their corresponding descriptions
       KEY_ENUM = {
-        '' => 'Not yet defined',
         'end-of-month' => 'End of month',
         'due-date' => 'Due on a specific date',
         'deferred' => 'Deferred until after the due date',
@@ -23,7 +22,8 @@ module GOBL
         'elective' => 'Chosen by the buyer',
         'pending' => 'Seller to advise buyer in separate transaction',
         'advanced' => 'Payment made in advance',
-        'delivery' => 'Payment on Delivery'
+        'delivery' => 'Payment on Delivery',
+        'undefined' => 'Not yet defined'
       }.freeze
 
       # @!attribute [r] key
@@ -46,6 +46,11 @@ module GOBL
       # Description of the conditions for payment.
       # @return [String]
       property :notes, String
+
+      # @!attribute [r] ext
+      # Extensions to the terms for local codes.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

data/lib/generated/gobl/regimes/mx/food_vouchers_line.rb

@@ -13,6 +13,11 @@ module GOBL
         # The Schema ID of the GOBL FoodVouchersLine structure
         SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/food-vouchers#/$defs/FoodVouchersLine'
 
+        # @!attribute [r] i
+        # Line number starting from 1 (calculated).
+        # @return [Integer]
+        property :i, Integer
+
         # @!attribute [r] e_wallet_id
         # Identifier of the e-wallet that received the food voucher (maps to `Identificador`).
         # @return [GOBL::CBC::Code]

data/lib/generated/gobl/regimes/mx/fuel_account_line.rb

@@ -13,6 +13,11 @@ module GOBL
         # The Schema ID of the GOBL FuelAccountLine structure
         SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/fuel-account-balance#/$defs/FuelAccountLine'
 
+        # @!attribute [r] i
+        # Index of the line starting from 1 (calculated)
+        # @return [Integer]
+        property :i, Integer
+
         # @!attribute [r] e_wallet_id
         # Identifier of the e-wallet used to make the purchase (maps to `Identificador`).
         # @return [GOBL::CBC::Code]

data/lib/generated/gobl/tax/addon_def.rb

@@ -18,6 +18,11 @@ module GOBL
       property :key, GOBL::CBC::Key
       validates_presence_of :key
 
+      # @!attribute [r] requires
+      # Requires defines any additional addons that this one depends on to operate correctly.
+      # @return [Array<GOBL::CBC::Key>]
+      property :requires, [GOBL::CBC::Key]
+
       # @!attribute [r] name
       # Name of the add-on
       # @return [GOBL::I18n::String]
@@ -29,10 +34,15 @@ module GOBL
       # @return [GOBL::I18n::String]
       property :description, GOBL::I18n::String
 
+      # @!attribute [r] sources
+      # Sources is a list of sources that are used to provide the data for the add-on.
+      # @return [Array<GOBL::CBC::Source>]
+      property :sources, [GOBL::CBC::Source]
+
       # @!attribute [r] extensions
       # Extensions defines the list of extensions that are associated with an add-on.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :extensions, [GOBL::CBC::KeyDefinition]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :extensions, [GOBL::CBC::Definition]
       validates_presence_of :extensions
 
       # @!attribute [r] tags
@@ -46,10 +56,15 @@ module GOBL
       property :scenarios, [ScenarioSet]
       validates_presence_of :scenarios
 
+      # @!attribute [r] identities
+      # Identities that are specific for the add-on and may be validated against or used during conversion processes.
+      # @return [Array<GOBL::CBC::Definition>]
+      property :identities, [GOBL::CBC::Definition]
+
       # @!attribute [r] inboxes
       # Inboxes is a list of keys that are used to identify where copies of documents can be sent.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :inboxes, [GOBL::CBC::KeyDefinition]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :inboxes, [GOBL::CBC::Definition]
 
       # @!attribute [r] corrections
       # Corrections is used to provide a map of correction definitions that are supported by the add-on.

data/lib/generated/gobl/tax/catalogue_def.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # A CatalogueDef contains a set of re-useable extensions, scenarios, and validators that can be used by addons or tax regimes.
+    class CatalogueDef < GOBL::Object
+      # The Schema ID of the GOBL CatalogueDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/catalogue-def'
+
+      # @!attribute [r] key
+      # Key defines a unique identifier for the catalogue.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+      validates_presence_of :key
+
+      # @!attribute [r] name
+      # Name is the name of the catalogue.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+      validates_presence_of :name
+
+      # @!attribute [r] description
+      # Description is a human readable description of the catalogue.
+      # @return [GOBL::I18n::String]
+      property :description, GOBL::I18n::String
+
+      # @!attribute [r] extensions
+      # Extensions defines all the extensions offered by the catalogue.
+      # @return [Array<GOBL::CBC::Definition>]
+      property :extensions, [GOBL::CBC::Definition]
+      validates_presence_of :extensions
+    end
+  end
+end

data/lib/generated/gobl/tax/category_def.rb

@@ -39,8 +39,18 @@ module GOBL
       # @return [Boolean]
       property :retained, Boolean
 
-      # @!attribute [r] rates
+      # @!attribute [r] informative
+      # Informative when true implies that the tax amount will be calculated and reported but will not affect the invoice totals. Typically used for taxes that are embedded in the base amount or don't impact the final payable amount.
+      # @return [Boolean]
+      property :informative, Boolean
+
+      # @!attribute [r] keys
       # Specific tax definitions inside this category.
+      # @return [Array<KeyDef>]
+      property :keys, [KeyDef]
+
+      # @!attribute [r] rates
+      # Rates defines the set of rates that can be used with this category.
       # @return [Array<RateDef>]
       property :rates, [RateDef]
 
@@ -56,11 +66,11 @@ module GOBL
 
       # @!attribute [r] sources
       # List of sources for the information contained in this category.
-      # @return [Array<Source>]
-      property :sources, [Source]
+      # @return [Array<GOBL::CBC::Source>]
+      property :sources, [GOBL::CBC::Source]
 
       # @!attribute [r] ext
-      # Extensions key-value pairs that will be copied to the tax combo if this category is used.
+      # Extension key-value pairs that will be copied to the tax combo if this category is used.
       # @return [GOBL::Tax::Extensions]
       property :ext, GOBL::Tax::Extensions
 

data/lib/generated/gobl/tax/category_total.rb

@@ -21,6 +21,10 @@ module GOBL
       # @return [Boolean]
       property :retained, Boolean
 
+      # @!attribute [r] informative
+      # @return [Boolean]
+      property :informative, Boolean
+
       # @!attribute [r] rates
       # @return [Array<RateTotal>]
       property :rates, [RateTotal]