gobl 0.1.2

data/lib/gobl/bill/line_discount.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # LineDiscount represents an amount deducted from the line, and will be applied before taxes.
+    class LineDiscount < GOBL::Struct
+      # The Schema ID of the GOBL LineDiscount structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/LineDiscount'
+
+      # @!attribute [r] percent
+      # Percentage if fixed amount not applied
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] amount
+      # Fixed discount amount to apply (calculated if percent present).
+      # @return [GOBL::Num::Amount]
+      attribute? :amount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] code
+      # Reason code.
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] reason
+      # Text description as to why the discount was applied
+      # @return [String]
+      attribute? :reason, GOBL::Types::String.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [LineDiscount] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          percent: data['percent'] || nil,
+          amount: data['amount'] || nil,
+          code: data['code'],
+          reason: data['reason']
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'code' => attributes[:code],
+          'reason' => attributes[:reason]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {LineDiscount} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [LineDiscount] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/ordering.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Ordering allows additional order details to be appended
+    class Ordering < GOBL::Struct
+      # The Schema ID of the GOBL Ordering structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Ordering'
+
+      # @!attribute [r] seller
+      # Party who is selling the goods and is not responsible for taxes
+      # @return [GOBL::Org::Party]
+      attribute? :seller, GOBL::Org::Party.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Ordering] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          seller: data['seller'] ? GOBL::Org::Party.from_gobl!(data['seller']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'seller' => attributes[:seller]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Ordering} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Ordering] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/outlay.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Outlay represents a reimbursable expense that was paid for by the supplier and invoiced separately by the third party directly to the customer.
+    class Outlay < GOBL::Struct
+      # The Schema ID of the GOBL Outlay structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Outlay'
+
+      # @!attribute [r] uuid
+      # Unique identity for this outlay.
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] i
+      # Outlay number index inside the invoice for ordering (calculated).
+      # @return [Integer]
+      attribute? :i, GOBL::Types::Int.optional
+
+      # @!attribute [r] date
+      # When was the outlay made.
+      # @return [GOBL::Cal::Date]
+      attribute? :date, GOBL::Cal::Date.optional
+
+      # @!attribute [r] code
+      # Invoice number or other reference detail used to identify the outlay.
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] series
+      # Series of the outlay invoice.
+      # @return [String]
+      attribute? :series, GOBL::Types::String.optional
+
+      # @!attribute [r] desc
+      # Details on what the outlay was.
+      # @return [String]
+      attribute :desc, GOBL::Types::String
+
+      # @!attribute [r] supplier
+      # Who was the supplier of the outlay
+      # @return [GOBL::Org::Party]
+      attribute? :supplier, GOBL::Org::Party.optional
+
+      # @!attribute [r] amount
+      # Amount paid by the supplier.
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Outlay] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          i: data['i'],
+          date: data['date'] ? GOBL::Cal::Date.from_gobl!(data['date']) : nil,
+          code: data['code'],
+          series: data['series'],
+          desc: data['desc'],
+          supplier: data['supplier'] ? GOBL::Org::Party.from_gobl!(data['supplier']) : nil,
+          amount: data['amount']
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'i' => attributes[:i],
+          'date' => attributes[:date]&.to_gobl,
+          'code' => attributes[:code],
+          'series' => attributes[:series],
+          'desc' => attributes[:desc],
+          'supplier' => attributes[:supplier]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Outlay} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Outlay] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/payment.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Payment contains details as to how the invoice should be paid.
+    class Payment < GOBL::Struct
+      # The Schema ID of the GOBL Payment structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Payment'
+
+      # @!attribute [r] payer
+      # The party responsible for paying for the invoice, if not the customer.
+      # @return [GOBL::Org::Party]
+      attribute? :payer, GOBL::Org::Party.optional
+
+      # @!attribute [r] terms
+      # Payment terms or conditions.
+      # @return [GOBL::Pay::Terms]
+      attribute? :terms, GOBL::Pay::Terms.optional
+
+      # @!attribute [r] advances
+      # Any amounts that have been paid in advance and should be deducted from the amount due.
+      # @return [Advances]
+      attribute? :advances, Advances.optional
+
+      # @!attribute [r] instructions
+      # Details on how payment should be made.
+      # @return [GOBL::Pay::Instructions]
+      attribute? :instructions, GOBL::Pay::Instructions.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Payment] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          payer: data['payer'] ? GOBL::Org::Party.from_gobl!(data['payer']) : nil,
+          terms: data['terms'] ? GOBL::Pay::Terms.from_gobl!(data['terms']) : nil,
+          advances: data['advances'] ? Advances.from_gobl!(data['advances']) : nil,
+          instructions: data['instructions'] ? GOBL::Pay::Instructions.from_gobl!(data['instructions']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'payer' => attributes[:payer]&.to_gobl,
+          'terms' => attributes[:terms]&.to_gobl,
+          'advances' => attributes[:advances]&.to_gobl,
+          'instructions' => attributes[:instructions]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Payment} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Payment] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/preceding.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Preceding allows for information to be provided about a previous invoice that this one will replace or subtract from.
+    class Preceding < GOBL::Struct
+      # The Schema ID of the GOBL Preceding structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Preceding'
+
+      # @!attribute [r] uuid
+      # Preceding document's UUID if available can be useful for tracing.
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] code
+      # Identity code of the previous invoice.
+      # @return [String]
+      attribute :code, GOBL::Types::String
+
+      # @!attribute [r] series
+      # Additional identification details
+      # @return [String]
+      attribute? :series, GOBL::Types::String.optional
+
+      # @!attribute [r] issue_date
+      # When the preceding invoice was issued.
+      # @return [GOBL::Cal::Date]
+      attribute :issue_date, GOBL::Cal::Date
+
+      # @!attribute [r] period
+      # Tax period in which the previous invoice has an effect.
+      # @return [GOBL::Cal::Period]
+      attribute? :period, GOBL::Cal::Period.optional
+
+      # @!attribute [r] corrections
+      # Specific codes for the corrections made.
+      # @return [Array<String>]
+      attribute? :corrections, GOBL::Types::Array.of(GOBL::Types::String).optional
+
+      # @!attribute [r] correction_method
+      # How has the previous invoice been corrected?
+      # @return [String]
+      attribute? :correction_method, GOBL::Types::String.optional
+
+      # @!attribute [r] notes
+      # Additional details regarding preceding invoice
+      # @return [String]
+      attribute? :notes, GOBL::Types::String.optional
+
+      # @!attribute [r] meta
+      # Additional semi-structured data that may be useful in specific regions
+      # @return [GOBL::Org::Meta]
+      attribute? :meta, GOBL::Org::Meta.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Preceding] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          code: data['code'],
+          series: data['series'],
+          issue_date: GOBL::Cal::Date.from_gobl!(data['issue_date']),
+          period: data['period'] ? GOBL::Cal::Period.from_gobl!(data['period']) : nil,
+          corrections: data['corrections']&.map { |item| item },
+          correction_method: data['correction_method'],
+          notes: data['notes'],
+          meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'code' => attributes[:code],
+          'series' => attributes[:series],
+          'issue_date' => attributes[:issue_date]&.to_gobl,
+          'period' => attributes[:period]&.to_gobl,
+          'corrections' => attributes[:corrections]&.map { |item| item },
+          'correction_method' => attributes[:correction_method],
+          'notes' => attributes[:notes],
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Preceding} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Preceding] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/scheme_keys.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # SchemeKeys stores a list of keys that makes it easier to perform matches.
+    class SchemeKeys < GOBL::Struct
+      extend Forwardable
+      include Enumerable
+
+      # The Schema ID of the GOBL SchemeKeys structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/SchemeKeys'
+
+      attribute :_ary, GOBL::Types::Array.of(GOBL::Org::Key)
+
+      # @!method [](*args)
+      #   Returns elements from the array
+      #   @overload [](index)
+      #     Returns the element in a specific position
+      #     @param index [Integer] the position of the object
+      #     @return [GOBL::Org::Key] the element in the `index` position
+      #   @overload [](start, length)
+      #     Returns all the elements within a range of positions
+      #     @param start [Integer] start position of the range
+      #     @param length [Integer] length of the range
+      #     @return [Array<GOBL::Org::Key>] the elements in the range
+      #   @overload [](range)
+      #     Returns all the elements within a range
+      #     @param range [Range] start and end positions of the range
+      #     @return [Array<GOBL::Org::Key>] the elements in the range
+      #
+      # @!method each
+      #   Iterates over the array elements
+      #   @overload each(&block)
+      #     Calls the given block with each element in the array
+      #     @yield [element] element of the array
+      #     @return [self] the object itself
+      #   @overload each
+      #     Returns an Enumerator that iterates over the array elements
+      #     @return [Enumerator] the enumerator of the array elements
+      #
+      # @!method empty?
+      #   Returns `true` if the number of elements in the array is zero, `false` otherwise.
+      #   @return [Boolean] whether the array is empty or not
+      #
+      # @!method length
+      #   Returns the number of elements in the array
+      #   @return [Integer] the number of elements in the array
+      def_delegators :_ary, :[], :each, :empty?, :length
+
+      # Creates a new object from an array of GOBL data
+      #
+      # @param data [Array] an array of GOBL data
+      #
+      # @return [SchemeKeys] the object created from the given data
+      def self.from_gobl!(data)
+        new(_ary: data&.map { |item| GOBL::Org::Key.from_gobl!(item) })
+      end
+
+      # Returns an array of GOBL data representing the current object
+      #
+      # @return [Array<Hash>] the array of GOBL data that represents the current object
+      def to_gobl
+        _ary.map(&:to_gobl)
+      end
+
+      # Returns a {SchemeKeys} object from a given array of structs. The array may
+      # contain {GOBL::Org::Key} objects or hashes. If hashes are provided, the constructor
+      # will call `GOBL::Org::Key#new` to generate the objects that will be part of the
+      # returned {SchemeKeys} object
+      #
+      # @param object [Array<GOBL::Org::Key, Hash>] the array containing the structs
+      #
+      # @return [SchemeKeys] the object corresponding to the given input
+      def self.new(object)
+        case object
+        when Array
+          super _ary: object
+        else # internal use, not to be used in public calls
+          super
+        end
+      end
+    end
+  end
+end

data/lib/gobl/bill/tax.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Tax defines a summary of the taxes which may be applied to an invoice.
+    class Tax < GOBL::Struct
+      # The Schema ID of the GOBL Tax structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Tax'
+
+      # @!attribute [r] prices_include
+      # Category of the tax already included in the line item prices, especially useful for B2C retailers with customers who prefer final prices inclusive of tax.
+      # @return [GOBL::Org::Code]
+      attribute? :prices_include, GOBL::Org::Code.optional
+
+      # @!attribute [r] schemes
+      # Special tax schemes that apply to this invoice according to local requirements.
+      # @return [SchemeKeys]
+      attribute? :schemes, SchemeKeys.optional
+
+      # @!attribute [r] meta
+      # Any additional data that may be required for processing, but should never be relied upon by recipients.
+      # @return [GOBL::Org::Meta]
+      attribute? :meta, GOBL::Org::Meta.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Tax] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          prices_include: data['prices_include'] ? GOBL::Org::Code.from_gobl!(data['prices_include']) : nil,
+          schemes: data['schemes'] ? SchemeKeys.from_gobl!(data['schemes']) : nil,
+          meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'prices_include' => attributes[:prices_include]&.to_gobl,
+          'schemes' => attributes[:schemes]&.to_gobl,
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Tax} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Tax] the object corresponding to the given input
+    end
+  end
+end