mindee-lite 5.0.0.beta1

data/lib/mindee/v1/product/international_id/international_id_v2_page.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'international_id_v2_document'
+
+module Mindee
+  module V1
+    module Product
+      module InternationalId
+        # International ID API version 2.2 page data.
+        class InternationalIdV2Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            InternationalIdV2PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          end
+        end
+
+        # International ID V2 page prediction.
+        class InternationalIdV2PagePrediction < InternationalIdV2Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice/invoice_v4.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_document'
+require_relative 'invoice_v4_page'
+
+module Mindee
+  module V1
+    module Product
+      # Invoice module.
+      module Invoice
+        # Invoice API version 4 inference prediction.
+        class InvoiceV4 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'invoices'
+          @endpoint_version = '4'
+          @has_async = true
+          @has_sync = true
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(InvoiceV4Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice/invoice_v4_document.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_line_items'
+
+module Mindee
+  module V1
+    module Product
+      module Invoice
+        # Invoice API version 4.11 document data.
+        class InvoiceV4Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # The customer billing address.
+          # @return [Mindee::V1::Parsing::Standard::AddressField]
+          attr_reader :billing_address
+          # The purchase category.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :category
+          # The address of the customer.
+          # @return [Mindee::V1::Parsing::Standard::AddressField]
+          attr_reader :customer_address
+          # List of company registration numbers associated to the customer.
+          # @return [Array<Mindee::V1::Parsing::Standard::CompanyRegistrationField>]
+          attr_reader :customer_company_registrations
+          # The customer account number or identifier from the supplier.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :customer_id
+          # The name of the customer or client.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :customer_name
+          # The date the purchase was made.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :date
+          # Document type: INVOICE or CREDIT NOTE.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+          # Document type extended.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :document_type_extended
+          # The date on which the payment is due.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :due_date
+          # The invoice number or identifier.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :invoice_number
+          # List of all the line items present on the invoice.
+          # @return [Mindee::V1::Product::Invoice::InvoiceV4LineItems]
+          attr_reader :line_items
+          # The locale of the document.
+          # @return [Mindee::V1::Parsing::Standard::LocaleField]
+          attr_reader :locale
+          # The date on which the payment is due / was full-filled.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :payment_date
+          # The purchase order number.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :po_number
+          # List of all reference numbers on the invoice, including the purchase order number.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :reference_numbers
+          # Customer's delivery address.
+          # @return [Mindee::V1::Parsing::Standard::AddressField]
+          attr_reader :shipping_address
+          # The purchase subcategory for transport, food and shopping.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :subcategory
+          # The address of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::AddressField]
+          attr_reader :supplier_address
+          # List of company registration numbers associated to the supplier.
+          # @return [Array<Mindee::V1::Parsing::Standard::CompanyRegistrationField>]
+          attr_reader :supplier_company_registrations
+          # The email address of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_email
+          # The name of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_name
+          # List of payment details associated to the supplier of the invoice.
+          # @return [Array<Mindee::V1::Parsing::Standard::PaymentDetailsField>]
+          attr_reader :supplier_payment_details
+          # The phone number of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_phone_number
+          # The website URL of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_website
+          # List of taxes. Each item contains the detail of the tax.
+          # @return [Mindee::V1::Parsing::Standard::Taxes]
+          attr_reader :taxes
+          # The total amount of the invoice: includes taxes, tips, fees, and other charges.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_amount
+          # The net amount of the invoice: does not include taxes, fees, and discounts.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_net
+          # The total tax: the sum of all the taxes for this invoice.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_tax
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @billing_address = Parsing::Standard::AddressField.new(
+              prediction['billing_address'],
+              page_id
+            )
+            @category = Parsing::Standard::ClassificationField.new(
+              prediction['category'],
+              page_id
+            )
+            @customer_address = Parsing::Standard::AddressField.new(
+              prediction['customer_address'],
+              page_id
+            )
+            @customer_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
+            prediction['customer_company_registrations'].each do |item|
+              @customer_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
+            end
+            @customer_id = Parsing::Standard::StringField.new(
+              prediction['customer_id'],
+              page_id
+            )
+            @customer_name = Parsing::Standard::StringField.new(
+              prediction['customer_name'],
+              page_id
+            )
+            @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
+            @document_type = Parsing::Standard::ClassificationField.new(
+              prediction['document_type'],
+              page_id
+            )
+            @document_type_extended = Parsing::Standard::ClassificationField.new(
+              prediction['document_type_extended'],
+              page_id
+            )
+            @due_date = Parsing::Standard::DateField.new(
+              prediction['due_date'],
+              page_id
+            )
+            @invoice_number = Parsing::Standard::StringField.new(
+              prediction['invoice_number'],
+              page_id
+            )
+            @line_items = Product::Invoice::InvoiceV4LineItems.new(prediction['line_items'], page_id)
+            @locale = Parsing::Standard::LocaleField.new(
+              prediction['locale'],
+              page_id
+            )
+            @payment_date = Parsing::Standard::DateField.new(
+              prediction['payment_date'],
+              page_id
+            )
+            @po_number = Parsing::Standard::StringField.new(
+              prediction['po_number'],
+              page_id
+            )
+            @reference_numbers = [] # : Array[Parsing::Standard::StringField]
+            prediction['reference_numbers'].each do |item|
+              @reference_numbers.push(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @shipping_address = Parsing::Standard::AddressField.new(
+              prediction['shipping_address'],
+              page_id
+            )
+            @subcategory = Parsing::Standard::ClassificationField.new(
+              prediction['subcategory'],
+              page_id
+            )
+            @supplier_address = Parsing::Standard::AddressField.new(
+              prediction['supplier_address'],
+              page_id
+            )
+            @supplier_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
+            prediction['supplier_company_registrations'].each do |item|
+              @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
+            end
+            @supplier_email = Parsing::Standard::StringField.new(
+              prediction['supplier_email'],
+              page_id
+            )
+            @supplier_name = Parsing::Standard::StringField.new(
+              prediction['supplier_name'],
+              page_id
+            )
+            @supplier_payment_details = [] # : Array[Parsing::Standard::PaymentDetailsField]
+            prediction['supplier_payment_details'].each do |item|
+              @supplier_payment_details.push(Parsing::Standard::PaymentDetailsField.new(item, page_id))
+            end
+            @supplier_phone_number = Parsing::Standard::StringField.new(
+              prediction['supplier_phone_number'],
+              page_id
+            )
+            @supplier_website = Parsing::Standard::StringField.new(
+              prediction['supplier_website'],
+              page_id
+            )
+            @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
+            @total_amount = Parsing::Standard::AmountField.new(
+              prediction['total_amount'],
+              page_id
+            )
+            @total_net = Parsing::Standard::AmountField.new(
+              prediction['total_net'],
+              page_id
+            )
+            @total_tax = Parsing::Standard::AmountField.new(
+              prediction['total_tax'],
+              page_id
+            )
+          end
+
+          # @return [String]
+          def to_s
+            reference_numbers = @reference_numbers.join("\n #{' ' * 19}")
+            supplier_payment_details = @supplier_payment_details.join("\n #{' ' * 26}")
+            supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
+            customer_company_registrations = @customer_company_registrations.join("\n #{' ' * 32}")
+            line_items = line_items_to_s
+            out_str = String.new
+            out_str << "\n:Locale: #{@locale}".rstrip
+            out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
+            out_str << "\n:Purchase Order Number: #{@po_number}".rstrip
+            out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
+            out_str << "\n:Purchase Date: #{@date}".rstrip
+            out_str << "\n:Due Date: #{@due_date}".rstrip
+            out_str << "\n:Payment Date: #{@payment_date}".rstrip
+            out_str << "\n:Total Net: #{@total_net}".rstrip
+            out_str << "\n:Total Amount: #{@total_amount}".rstrip
+            out_str << "\n:Total Tax: #{@total_tax}".rstrip
+            out_str << "\n:Taxes:#{@taxes}".rstrip
+            out_str << "\n:Supplier Payment Details: #{supplier_payment_details}".rstrip
+            out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+            out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
+            out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+            out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
+            out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
+            out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
+            out_str << "\n:Customer Name: #{@customer_name}".rstrip
+            out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
+            out_str << "\n:Customer Address: #{@customer_address}".rstrip
+            out_str << "\n:Customer ID: #{@customer_id}".rstrip
+            out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
+            out_str << "\n:Billing Address: #{@billing_address}".rstrip
+            out_str << "\n:Document Type: #{@document_type}".rstrip
+            out_str << "\n:Document Type Extended: #{@document_type_extended}".rstrip
+            out_str << "\n:Purchase Subcategory: #{@subcategory}".rstrip
+            out_str << "\n:Purchase Category: #{@category}".rstrip
+            out_str << "\n:Line Items:"
+            out_str << line_items
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def line_items_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 17}"
+            out_str << "+#{char * 12}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def line_items_to_s
+            return '' if @line_items.empty?
+
+            line_items = @line_items.map(&:to_table_line).join("\n#{line_items_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{line_items_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Description                          |'
+            out_str << ' Product code |'
+            out_str << ' Quantity |'
+            out_str << ' Tax Amount |'
+            out_str << ' Tax Rate (%) |'
+            out_str << ' Total Amount |'
+            out_str << ' Unit of measure |'
+            out_str << ' Unit Price |'
+            out_str << "\n#{line_items_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{line_items_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice/invoice_v4_line_item.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Invoice
+        # List of all the line items present on the invoice.
+        class InvoiceV4LineItem < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::Parsing::Standard
+
+          # The item description.
+          # @return [String]
+          attr_reader :description
+          # The product code of the item.
+          # @return [String]
+          attr_reader :product_code
+          # The item quantity
+          # @return [Float]
+          attr_reader :quantity
+          # The item tax amount.
+          # @return [Float]
+          attr_reader :tax_amount
+          # The item tax rate in percentage.
+          # @return [Float]
+          attr_reader :tax_rate
+          # The item total amount.
+          # @return [Float]
+          attr_reader :total_amount
+          # The item unit of measure.
+          # @return [String]
+          attr_reader :unit_measure
+          # The item unit price.
+          # @return [Float]
+          attr_reader :unit_price
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @description = prediction['description']
+            @product_code = prediction['product_code']
+            @quantity = prediction['quantity']
+            @tax_amount = prediction['tax_amount']
+            @tax_rate = prediction['tax_rate']
+            @total_amount = prediction['total_amount']
+            @unit_measure = prediction['unit_measure']
+            @unit_price = prediction['unit_price']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:description] = format_for_display(@description)
+            printable[:product_code] = format_for_display(@product_code)
+            printable[:quantity] =
+              @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+            printable[:tax_amount] =
+              @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total_amount] =
+              @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
+            printable[:unit_measure] = format_for_display(@unit_measure)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:description] = format_for_display(@description, 36)
+            printable[:product_code] = format_for_display(@product_code, nil)
+            printable[:quantity] =
+              @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+            printable[:tax_amount] =
+              @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total_amount] =
+              @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
+            printable[:unit_measure] = format_for_display(@unit_measure, nil)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 37s', printable[:description])
+            out_str << format('| %- 13s', printable[:product_code])
+            out_str << format('| %- 9s', printable[:quantity])
+            out_str << format('| %- 11s', printable[:tax_amount])
+            out_str << format('| %- 13s', printable[:tax_rate])
+            out_str << format('| %- 13s', printable[:total_amount])
+            out_str << format('| %- 16s', printable[:unit_measure])
+            out_str << format('| %- 11s', printable[:unit_price])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Description: #{printable[:description]}"
+            out_str << "\n  :Product code: #{printable[:product_code]}"
+            out_str << "\n  :Quantity: #{printable[:quantity]}"
+            out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
+            out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
+            out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+            out_str << "\n  :Unit of measure: #{printable[:unit_measure]}"
+            out_str << "\n  :Unit Price: #{printable[:unit_price]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice/invoice_v4_line_items.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'invoice_v4_line_item'
+
+module Mindee
+  module V1
+    module Product
+      module Invoice
+        # List of all the line items present on the invoice.
+        class InvoiceV4LineItems < Array
+          # Entries.
+          # @return [Array<InvoiceV4LineItem>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              Invoice::InvoiceV4LineItem.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 17}"
+            out_str << "+#{char * 12}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << "\n#{self.class.line_items_separator('-')}\n "
+            out_str << ' | Description                         '
+            out_str << ' | Product code'
+            out_str << ' | Quantity'
+            out_str << ' | Tax Amount'
+            out_str << ' | Tax Rate (%)'
+            out_str << ' | Total Amount'
+            out_str << ' | Unit of measure'
+            out_str << ' | Unit Price'
+            out_str << " |\n#{self.class.line_items_separator('=')}"
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice/invoice_v4_page.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_document'
+
+module Mindee
+  module V1
+    module Product
+      module Invoice
+        # Invoice API version 4.11 page data.
+        class InvoiceV4Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            InvoiceV4PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          end
+        end
+
+        # Invoice V4 page prediction.
+        class InvoiceV4PagePrediction < InvoiceV4Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_splitter_v1_document'
+require_relative 'invoice_splitter_v1_page'
+
+module Mindee
+  module V1
+    module Product
+      # Invoice Splitter module.
+      module InvoiceSplitter
+        # Invoice Splitter API version 1 inference prediction.
+        class InvoiceSplitterV1 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'invoice_splitter'
+          @endpoint_version = '1'
+          @has_async = true
+          @has_sync = false
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = InvoiceSplitterV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(InvoiceSplitterV1Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end