mindee 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c6039978a362b6a5faab3b92fb4ef24fd9cbf85060f66614b007b371d851843
-  data.tar.gz: 4aa9ef461ee5fcc19f483dde6f584c583390e53ebba1889d5283b1864a26169c
+  metadata.gz: fe1aef5bf5c30b3b599d426140de05074840a57f29800129359d647e7ee1bbd5
+  data.tar.gz: 43c93a85a9a6d65fcba85345d1410844b07b5ca7d49a8a8f2487ccd5adcf767f
 SHA512:
-  metadata.gz: 226aa7601ad8b1a80dc6fb1071ad655a9aae647d70118184d0ada431b314503eb3f6157abdc59eb0205e157c3d7d8cc501ceb26258690ed9ad038b4d41336f93
-  data.tar.gz: a1d215cb0834ded50c9bcb913d2cf074d7e711ec73aaa67380705c71d51e29b6c15a162fa7afcadcab027954831155fdf065563cee1ce2aa0a7b300359cd7421
+  metadata.gz: eff5e3f90cb351664059c4d6dcf78b839dca0e463d0d09b1b4b15a963828355c372845b0806369c21d6b46ed3b2ce45fd199e0bf7aa4c874df3fc06cae569d22
+  data.tar.gz: cb724d0b07bc0a4729d288076b26221fb99fc74d146d181bdae578b95fa9a374ae7deb43e3bb8cadbf7a8d3e5d9e98ea6737c7917565e375668d1fc4e93f95e3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Mindee Ruby API Library Changelog
 
+## v3.4.0 - 2024-01-30
+### Changes
+* :arrow_up: update invoices to v4.4
+* :sparkles: add support for `raw_value` in string fields
+
+
 ## v3.3.1 - 2023-12-15
 ### Changes
 * :recycle: tweak async delays & retry

data/docs/invoices_v4.md

@@ -34,12 +34,12 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 16bd8752-8c4d-450f-8213-f33b2097504c
+:Mindee ID: 80f2328c-58a5-486a-9599-eb2d738680f0
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.2
+:Product: mindee/invoices v4.4
 :Rotation applied: Yes
 
 Prediction
@@ -51,6 +51,7 @@ Prediction
 :Due Date: 2018-09-25
 :Total Net:
 :Total Amount: 2608.20
+:Total Tax: 193.20
 :Taxes:
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
@@ -58,7 +59,7 @@ Prediction
   |               |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
-:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
 :Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
 :Customer Name: JIRO DOI
@@ -88,6 +89,7 @@ Page 0
 :Due Date: 2018-09-25
 :Total Net:
 :Total Amount: 2608.20
+:Total Tax: 193.20
 :Taxes:
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
@@ -95,7 +97,7 @@ Page 0
   |               |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
-:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
 :Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
 :Customer Name: JIRO DOI
@@ -308,9 +310,6 @@ puts result.document.inference.prediction.supplier_name.value
 ```rb
 for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
   puts supplier_payment_details_elem.value
-    puts supplier_payment_details_elem.rate
-    puts supplier_payment_details_elem.code
-    puts supplier_payment_details_elem.basis
 end
 ```
 
@@ -319,7 +318,7 @@ end
 
 ```rb
 for taxes_elem in result.document.inference.prediction.taxes do
-  puts taxes_elem.value
+  puts taxes_elem.to_s
 end
 ```
 
@@ -337,5 +336,12 @@ puts result.document.inference.prediction.total_amount.value
 puts result.document.inference.prediction.total_net.value
 ```
 
+## Total Tax
+**total_tax** ([AmountField](#amount-field)): The total tax: includes all the taxes paid for this invoice.
+
+```rb
+puts result.document.inference.prediction.total_tax.value
+```
+
 # Questions?
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/lib/mindee/parsing/standard/string_field.rb

@@ -10,6 +10,14 @@ module Mindee
         # Value as String
         # @return [String, nil]
         attr_reader :value
+        # Value as String
+        # @return [String, nil]
+        attr_reader :raw_value
+
+        def initialize(prediction, page_id = nil, reconstructed: false)
+          super
+          @raw_value = prediction['raw_value']
+        end
       end
     end
   end

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

@@ -60,6 +60,9 @@ module Mindee
         # The net amount paid: does not include taxes, fees, and discounts.
         # @return [Mindee::Parsing::Standard::AmountField]
         attr_reader :total_net
+        # The total tax: includes all the taxes paid for this invoice.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_tax
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
@@ -97,6 +100,7 @@ module Mindee
           @taxes = Taxes.new(prediction['taxes'], page_id)
           @total_amount = AmountField.new(prediction['total_amount'], page_id)
           @total_net = AmountField.new(prediction['total_net'], page_id)
+          @total_tax = AmountField.new(prediction['total_tax'], page_id)
         end
 
         # @return [String]
@@ -114,6 +118,7 @@ module Mindee
           out_str << "\n:Due Date: #{@due_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

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.3.1'
+  VERSION = '3.4.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.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel