gobl 0.1.2

data/lib/gobl/org/address.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Address defines a globally acceptable set of attributes that describes a postal or fiscal address.
+    class Address < GOBL::Struct
+      # The Schema ID of the GOBL Address structure
+      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]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] label
+      # Useful identifier, such as home, work, etc.
+      # @return [String]
+      attribute? :label, GOBL::Types::String.optional
+
+      # @!attribute [r] po_box
+      # Box number or code for the post office box located at the address.
+      # @return [String]
+      attribute? :po_box, GOBL::Types::String.optional
+
+      # @!attribute [r] num
+      # House or building number in the street.
+      # @return [String]
+      attribute? :num, GOBL::Types::String.optional
+
+      # @!attribute [r] floor
+      # Floor number within the building.
+      # @return [String]
+      attribute? :floor, GOBL::Types::String.optional
+
+      # @!attribute [r] block
+      # Block number within the building.
+      # @return [String]
+      attribute? :block, GOBL::Types::String.optional
+
+      # @!attribute [r] door
+      # Door number within the building.
+      # @return [String]
+      attribute? :door, GOBL::Types::String.optional
+
+      # @!attribute [r] street
+      # First line of street.
+      # @return [String]
+      attribute? :street, GOBL::Types::String.optional
+
+      # @!attribute [r] street_extra
+      # Additional street address details.
+      # @return [String]
+      attribute? :street_extra, GOBL::Types::String.optional
+
+      # @!attribute [r] locality
+      # The village, town, district, or city.
+      # @return [String]
+      attribute :locality, GOBL::Types::String
+
+      # @!attribute [r] region
+      # Province, County, or State.
+      # @return [String]
+      attribute :region, GOBL::Types::String
+
+      # @!attribute [r] code
+      # Post or ZIP code.
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] country
+      # ISO country code.
+      # @return [GOBL::L10n::CountryCode]
+      attribute? :country, GOBL::L10n::CountryCode.optional
+
+      # @!attribute [r] coords
+      # When the postal address is not sufficient, coordinates help locate the address more precisely.
+      # @return [GOBL::Org::Coordinates]
+      attribute? :coords, GOBL::Org::Coordinates.optional
+
+      # @!attribute [r] meta
+      # Any additional semi-structure details about the address.
+      # @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 [Address] 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,
+          label: data['label'],
+          po_box: data['po_box'],
+          num: data['num'],
+          floor: data['floor'],
+          block: data['block'],
+          door: data['door'],
+          street: data['street'],
+          street_extra: data['street_extra'],
+          locality: data['locality'],
+          region: data['region'],
+          code: data['code'],
+          country: data['country'] ? GOBL::L10n::CountryCode.from_gobl!(data['country']) : nil,
+          coords: data['coords'] ? GOBL::Org::Coordinates.from_gobl!(data['coords']) : 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
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'label' => attributes[:label],
+          'po_box' => attributes[:po_box],
+          'num' => attributes[:num],
+          'floor' => attributes[:floor],
+          'block' => attributes[:block],
+          'door' => attributes[:door],
+          'street' => attributes[:street],
+          'street_extra' => attributes[:street_extra],
+          'locality' => attributes[:locality],
+          'region' => attributes[:region],
+          'code' => attributes[:code],
+          'country' => attributes[:country]&.to_gobl,
+          'coords' => attributes[:coords]&.to_gobl,
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Address} 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 [Address] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/code.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Short upper-case identifier.
+    class Code < GOBL::Struct
+      # The Schema ID of the GOBL Code structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/code'
+
+      attribute :_value, GOBL::Types::String
+      private :_value
+
+      # Creates a new object from a GOBL value
+      #
+      # @param data [String] the GOBL value
+      #
+      # @return [Code] the object created from the given data
+      def self.from_gobl!(data)
+        new(_value: data)
+      end
+
+      # Returns a GOBL value representing the current object
+      #
+      # @return [String] the GOBL value that represents the current object
+      def to_gobl
+        _value
+      end
+
+      # Returns a {Code} that corresponds to a given object. The object can be a
+      # `Symbol`, a `String` or anything coercible into one (via `#to_s`).
+      #
+      # @param object [Symbol, String, #to_s] the value of the object.
+      #
+      # @return [Code] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   code = GOBL::Org::Code.new(:value)
+      #
+      # @example Instantiating from a string
+      #   code = GOBL::Org::Code.new('value')
+      def self.new(object)
+        case object
+        when Hash, self # internal use, not to be used in public calls
+          super
+        when Symbol
+          new object.to_s
+        else
+          super _value: object.to_s
+        end
+      end
+
+      # Returns the string representation of the current object
+      #
+      # @return [String] the string representation of the current object
+      def to_s
+        _value.to_s
+      end
+
+      # Returns the symbol representation of the current object
+      #
+      # @return [Symbol] the symbol representation of the current object
+      def to_sym
+        to_s.parameterize.underscore.to_sym
+      end
+
+      # Returns whether the current object is equivalent to a given one. In addition
+      # to {Code} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [Code, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {Code} object
+      #   code = GOBL::Org::Code.new('value')
+      #   code == GOBL::Org::Code.new('value') #=> true
+      #   code == GOBL::Org::Code.new('other') #=> false
+      #
+      # @example Comparing to a string
+      #   code = GOBL::Org::Code.new('value')
+      #   code == 'value' #=> true
+      #   code == 'other' #=> false
+      #
+      # @example Comparing to a symbol
+      #   code = GOBL::Org::Code.new('value')
+      #   code == :value #=> true
+      #   code == :other #=> false
+      def ==(other)
+        case other
+        when self.class
+          super
+        when Symbol
+          to_sym == other
+        else
+          to_s == other.to_s
+        end
+      end
+    end
+  end
+end

data/lib/gobl/org/coordinates.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 Org
+    # Coordinates describes an exact geographical location in the world.
+    class Coordinates < GOBL::Struct
+      # The Schema ID of the GOBL Coordinates structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/coordinates'
+
+      # @!attribute [r] lat
+      # Decimal latitude coordinate.
+      # @return [Float]
+      attribute? :lat, GOBL::Types::Double.optional
+
+      # @!attribute [r] lon
+      # Decimal longitude coordinate.
+      # @return [Float]
+      attribute? :lon, GOBL::Types::Double.optional
+
+      # @!attribute [r] w3w
+      # Text coordinates compose of three words.
+      # @return [String]
+      attribute? :w3w, GOBL::Types::String.optional
+
+      # @!attribute [r] geohash
+      # Single string coordinate based on geohash standard.
+      # @return [String]
+      attribute? :geohash, GOBL::Types::String.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Coordinates] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          lat: data['lat'],
+          lon: data['lon'],
+          w3w: data['w3w'],
+          geohash: data['geohash']
+        )
+      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
+        {
+          'lat' => attributes[:lat],
+          'lon' => attributes[:lon],
+          'w3w' => attributes[:w3w],
+          'geohash' => attributes[:geohash]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Coordinates} 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 [Coordinates] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/email.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 Org
+    # Email describes the electronic mailing details.
+    class Email < GOBL::Struct
+      # The Schema ID of the GOBL Email structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/email'
+
+      # @!attribute [r] uuid
+      # Unique identity code
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] label
+      # Identifier for the email.
+      # @return [String]
+      attribute? :label, GOBL::Types::String.optional
+
+      # @!attribute [r] addr
+      # Electronic mailing address.
+      # @return [String]
+      attribute :addr, GOBL::Types::String
+
+      # @!attribute [r] meta
+      # Additional fields.
+      # @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 [Email] 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,
+          label: data['label'],
+          addr: data['addr'],
+          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,
+          'label' => attributes[:label],
+          'addr' => attributes[:addr],
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Email} 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 [Email] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/inbox.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+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.
+    class Inbox < GOBL::Struct
+      # The Schema ID of the GOBL Inbox structure
+      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]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] key
+      # Type of inbox being defined.
+      # @return [GOBL::Org::Key]
+      attribute :key, GOBL::Org::Key
+
+      # @!attribute [r] role
+      # Role assigned to this inbox that may be relevant for the consumer.
+      # @return [GOBL::Org::Key]
+      attribute? :role, GOBL::Org::Key.optional
+
+      # @!attribute [r] name
+      # Human name for the inbox.
+      # @return [String]
+      attribute? :name, GOBL::Types::String.optional
+
+      # @!attribute [r] code
+      # Actual Code or ID that identifies the Inbox.
+      # @return [String]
+      attribute :code, GOBL::Types::String
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Inbox] 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,
+          key: GOBL::Org::Key.from_gobl!(data['key']),
+          role: data['role'] ? GOBL::Org::Key.from_gobl!(data['role']) : nil,
+          name: data['name'],
+          code: data['code']
+        )
+      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,
+          'key' => attributes[:key]&.to_gobl,
+          'role' => attributes[:role]&.to_gobl,
+          'name' => attributes[:name],
+          'code' => attributes[:code]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Inbox} 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 [Inbox] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/item.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Item is used to describe a single product or service.
+    class Item < GOBL::Struct
+      # The Schema ID of the GOBL Item structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/item'
+
+      # @!attribute [r] uuid
+      # Unique identify of this item independent of the Supplier IDs
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] ref
+      # Primary reference code that identifies this item. Additional codes can be provided in the 'codes' field.
+      # @return [String]
+      attribute? :ref, GOBL::Types::String.optional
+
+      # @!attribute [r] name
+      # Brief name of the item
+      # @return [String]
+      attribute :name, GOBL::Types::String
+
+      # @!attribute [r] desc
+      # Detailed description
+      # @return [String]
+      attribute? :desc, GOBL::Types::String.optional
+
+      # @!attribute [r] currency
+      # Currency used for the item's price.
+      # @return [String]
+      attribute? :currency, GOBL::Types::String.optional
+
+      # @!attribute [r] price
+      # Base price of a single unit to be sold.
+      # @return [GOBL::Num::Amount]
+      attribute :price, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] unit
+      # Unit of measure.
+      # @return [GOBL::Org::Unit]
+      attribute? :unit, GOBL::Org::Unit.optional
+
+      # @!attribute [r] codes
+      # List of additional codes, IDs, or SKUs which can be used to identify the item. The should be agreed upon between supplier and customer.
+      # @return [Array<ItemCode>]
+      attribute? :codes, GOBL::Types::Array.of(ItemCode).optional
+
+      # @!attribute [r] origin
+      # Country code of where this item was from originally.
+      # @return [GOBL::L10n::CountryCode]
+      attribute? :origin, GOBL::L10n::CountryCode.optional
+
+      # @!attribute [r] meta
+      # Additional meta information that may be useful
+      # @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 [Item] 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,
+          ref: data['ref'],
+          name: data['name'],
+          desc: data['desc'],
+          currency: data['currency'],
+          price: data['price'],
+          unit: data['unit'] ? GOBL::Org::Unit.from_gobl!(data['unit']) : nil,
+          codes: data['codes']&.map { |item| ItemCode.from_gobl!(item) },
+          origin: data['origin'] ? GOBL::L10n::CountryCode.from_gobl!(data['origin']) : 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
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'ref' => attributes[:ref],
+          'name' => attributes[:name],
+          'desc' => attributes[:desc],
+          'currency' => attributes[:currency],
+          'price' => attributes[:price]&.to_gobl,
+          'unit' => attributes[:unit]&.to_gobl,
+          'codes' => attributes[:codes]&.map { |item| item&.to_gobl },
+          'origin' => attributes[:origin]&.to_gobl,
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Item} 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 [Item] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/item_code.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # ItemCode contains a value and optional label property that means additional codes can be added to an item.
+    class ItemCode < GOBL::Struct
+      # The Schema ID of the GOBL ItemCode structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/item#/$defs/ItemCode'
+
+      # @!attribute [r] label
+      # Local or human reference for the type of code the value represents.
+      # @return [String]
+      attribute? :label, GOBL::Types::String.optional
+
+      # @!attribute [r] value
+      # The item code's value.
+      # @return [String]
+      attribute :value, GOBL::Types::String
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [ItemCode] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          label: data['label'],
+          value: data['value']
+        )
+      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
+        {
+          'label' => attributes[:label],
+          'value' => attributes[:value]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {ItemCode} 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 [ItemCode] the object corresponding to the given input
+    end
+  end
+end