mindee 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d657be2dabdd3f93c49ead9299fa47fdad4d1afbc0115224668ffc43489b923e
-  data.tar.gz: 3f36429f4d0302573f0619818f0eb1f26177fbf839f9fbb47ed6b8d5a2abd067
+  metadata.gz: 3a863bb97566add59f1d2385e9688cab9841a3c4b22228138dd72023ad0521fc
+  data.tar.gz: ff3097cb84eba1ceef71f229a1b6f0152ba2a5659b5b9955dae313046eacfc39
 SHA512:
-  metadata.gz: 4457a03fac7ad60960fe271d4672b17615be5e2bedc34d4b679a17ded4a52afa01cdf1d70f01efae77ff34c6f9e5ebb107098c2e33bc2055d9a7275194a95c4e
-  data.tar.gz: b2671d071bbef4afc2764f9d56a7d8e60022b403ab77b845b0e74b0f33a3ed47a8b9968308baa3595b9db220516d675250d2c20231c9403a0c3f0e74e96fc5a9
+  metadata.gz: 26c78e63b0464261718d20718628d30df2f1b805c55e9d0d87670abfc4d97e7f0b0fdcab21c8e7810cffe0562923dde6a551fb59a8a8d393c535e89e7ed12d3c
+  data.tar.gz: dd333f2e4169061884be3bc39649862fab3fdcfc2bc9039f0b850cc2e5690194fa5915917dcaeb5d622b0df444bf8a8e81647ea9edc6b940c94324c37aefa7d6

data/.rubocop.yml

@@ -32,7 +32,7 @@ Metrics/BlockLength:
     - '**/*.gemspec'
 
 Metrics/MethodLength:
-  Max: 45
+  Max: 50
 
 Metrics/ClassLength:
   Max: 200

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v3.9.0 - 2024-05-16
+### Changes
+* :sparkles: update financial document to v1.7 & receipts to v5.2
+
+
 ## v3.8.0 - 2024-05-02
 ### Changes
 * :recycle: update products to newer syntax

data/docs/expense_receipts_v5.md

@@ -221,6 +221,13 @@ end
 puts result.document.inference.prediction.locale.value
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#string-field)): The receipt number or identifier.
+
+```rb
+puts result.document.inference.prediction.receipt_number.value
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 

data/docs/financial_document_v1.md

@@ -276,6 +276,13 @@ puts result.document.inference.prediction.customer_name.value
 puts result.document.inference.prediction.date.value
 ```
 
+## Document Number
+**document_number** ([StringField](#string-field)): The document number or identifier.
+
+```rb
+puts result.document.inference.prediction.document_number.value
+```
+
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
@@ -291,7 +298,7 @@ puts result.document.inference.prediction.due_date.value
 ```
 
 ## Invoice Number
-**invoice_number** ([StringField](#string-field)): The invoice number or identifier.
+**invoice_number** ([StringField](#string-field)): The invoice number or identifier only if document is an invoice.
 
 ```rb
 puts result.document.inference.prediction.invoice_number.value
@@ -313,6 +320,13 @@ end
 puts result.document.inference.prediction.locale.value
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#string-field)): The receipt number or identifier only if document is a receipt.
+
+```rb
+puts result.document.inference.prediction.receipt_number.value
+```
+
 ## Reference Numbers
 **reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
 

data/lib/mindee/product/financial_document/financial_document_v1_document.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_line_item'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.6 document data.
+      # Financial Document API version 1.7 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -30,13 +30,16 @@ module Mindee
         # The date the purchase was made.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :date
+        # The document number or identifier.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :document_number
         # One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
         # The date on which the payment is due.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :due_date
-        # The invoice number or identifier.
+        # The invoice number or identifier only if document is an invoice.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of line item details.
@@ -45,6 +48,9 @@ module Mindee
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
+        # The receipt number or identifier only if document is a receipt.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :receipt_number
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
@@ -108,6 +114,7 @@ module Mindee
           @customer_id = StringField.new(prediction['customer_id'], page_id)
           @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
+          @document_number = StringField.new(prediction['document_number'], page_id)
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
           @due_date = DateField.new(prediction['due_date'], page_id)
           @invoice_number = StringField.new(prediction['invoice_number'], page_id)
@@ -116,6 +123,7 @@ module Mindee
             @line_items.push(FinancialDocumentV1LineItem.new(item, page_id))
           end
           @locale = LocaleField.new(prediction['locale'], page_id)
+          @receipt_number = StringField.new(prediction['receipt_number'], page_id)
           @reference_numbers = []
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
@@ -153,6 +161,8 @@ module Mindee
           out_str = String.new
           out_str << "\n:Locale: #{@locale}".rstrip
           out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
+          out_str << "\n:Receipt Number: #{@receipt_number}".rstrip
+          out_str << "\n:Document Number: #{@document_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

data/lib/mindee/product/financial_document/financial_document_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_document'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.6 page data.
+      # Financial Document API version 1.7 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/receipt/receipt_v5_document.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_line_item'
 module Mindee
   module Product
     module Receipt
-      # Receipt API version 5.1 document data.
+      # Receipt API version 5.2 document data.
       class ReceiptV5Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The purchase category among predefined classes.
@@ -24,6 +24,9 @@ module Mindee
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
+        # The receipt number or identifier.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :receipt_number
         # The purchase subcategory among predefined classes for transport and food.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :subcategory
@@ -70,6 +73,7 @@ module Mindee
             @line_items.push(ReceiptV5LineItem.new(item, page_id))
           end
           @locale = LocaleField.new(prediction['locale'], page_id)
+          @receipt_number = StringField.new(prediction['receipt_number'], page_id)
           @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
           @supplier_address = StringField.new(prediction['supplier_address'], page_id)
           @supplier_company_registrations = []
@@ -106,6 +110,7 @@ module Mindee
           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:Receipt Number: #{@receipt_number}".rstrip
           out_str << "\n:Line Items:"
           out_str << line_items
           out_str[1..].to_s

data/lib/mindee/product/receipt/receipt_v5_page.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_document'
 module Mindee
   module Product
     module Receipt
-      # Receipt API version 5.1 page data.
+      # Receipt API version 5.2 page data.
       class ReceiptV5Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.8.0'
+  VERSION = '3.9.0'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel