mindee 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6c09d5108c2470661075484f14849c7205cbef88d481427bcb612d36ede9835
-  data.tar.gz: e7b6fa99499a9c3a3d82a9c87ab40dc07cbecd48a4f2d82200cfea2729f9d5cb
+  metadata.gz: 05c6fc0946b9d844042798b1b01160d5fbbdfa69f7b4a4e02ffb79e062680671
+  data.tar.gz: 23bfb847706e7c3d9bb15cd0acae3aa25d33c8fbbd126d8a6db0d55a00cb268c
 SHA512:
-  metadata.gz: b97c068ddeefb0908e7d9753c0439c86393d1a04b13bf8f256c3dbc93399f213b0405375a036715906a8087eba3eb5126d8e69880c819ef4b0d5b7bf61459e88
-  data.tar.gz: a15ff1b478675ec58dfd61d0f0483dcc7ab23df1fc02624e8133d5f636101e82f1eeb4f823ebe19a3a06ce70c4288270ebaca7029514e91f204298ad5843c924
+  metadata.gz: d693ccee678f81b71efaf221b6a5342e55e826458d345a9d5ae4f2d8644a729be6cd58b50e43481d12b5d8ed46afe02772acdc3c4b7f2fb9442de35e3d971b15
+  data.tar.gz: ee173692eff34f62deed6930e703d25996cdaf5910e5ff8a6ec6f771ad366af397122cb45f99a96755f0014a517b226c13f1c5a2af83588d1697f0599425a13f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Mindee Ruby API Library Changelog
 
+## v4.3.0 - 2025-04-08
+### Changes
+* :sparkles: add support for Financial Document V1.12
+* :sparkles: add support for Invoices V4.10
+* :sparkles: add support for US Healthcare Cards V1.2
+
+
 ## v4.2.0 - 2025-03-28
 ### Changes
 * :coffin: remove support for US W9

data/docs/global_products/financial_document_v1.md

@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Financial Document API](https://platform.m
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `financial_document`                               |
-> | Recommended Version            | `v1.11`                                            |
+> | Recommended Version            | `v1.12`                                            |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ✔️ Yes                                             |
 > | Geography                      | 🌐 Global                                          |
@@ -93,7 +93,7 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: f469a24d-3875-4a83-ad43-e0d5aa9da604
+:Mindee ID: a80ac0ee-26f6-4e2e-988a-960b240d5ba7
 :Filename: default_sample.jpg
 
 Inference
@@ -118,7 +118,7 @@ Prediction
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
-  |               |        | 5.00     | 9.75          |
+  | 195.00        |        | 5.00     | 9.75          |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
 :Supplier Name: JOHN SMITH
@@ -170,7 +170,7 @@ Page 0
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
-  |               |        | 5.00     | 9.75          |
+  | 195.00        |        | 5.00     | 9.75          |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
 :Supplier Name: JOHN SMITH
@@ -382,6 +382,24 @@ puts result.document.inference.prediction.document_number.value
 puts result.document.inference.prediction.document_type.value
 ```
 
+## Document Type Extended
+**document_type_extended** ([ClassificationField](#classification-field)): Document type extended.
+
+#### Possible values include:
+ - 'CREDIT NOTE'
+ - 'INVOICE'
+ - 'OTHER'
+ - 'OTHER_FINANCIAL'
+ - 'PAYSLIP'
+ - 'PURCHASE ORDER'
+ - 'QUOTE'
+ - 'RECEIPT'
+ - 'STATEMENT'
+
+```rb
+puts result.document.inference.prediction.document_type_extended.value
+```
+
 ## Due Date
 **due_date** ([DateField](#date-field)): The date on which the payment is due.
 

data/docs/global_products/invoices_v4.md

@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Invoice API](https://platform.mindee.com/m
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `invoices`                                         |
-> | Recommended Version            | `v4.9`                                             |
+> | Recommended Version            | `v4.10`                                            |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ✔️ Yes                                             |
 > | Geography                      | 🌐 Global                                          |
@@ -93,7 +93,7 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 86b1833f-138b-4a01-8387-860204b0e631
+:Mindee ID: b55db8f9-ae3b-4f05-b2f1-ec0ced5e5b70
 :Filename: default_sample.jpg
 
 Inference
@@ -117,7 +117,7 @@ Prediction
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
-  |               |        | 8.00     | 193.20        |
+  | 2145.00       |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
@@ -163,7 +163,7 @@ Page 0
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
-  |               |        | 8.00     | 193.20        |
+  | 2145.00       |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
@@ -344,6 +344,24 @@ puts result.document.inference.prediction.date.value
 puts result.document.inference.prediction.document_type.value
 ```
 
+## Document Type Extended
+**document_type_extended** ([ClassificationField](#classification-field)): Document type extended.
+
+#### Possible values include:
+ - 'CREDIT NOTE'
+ - 'INVOICE'
+ - 'OTHER'
+ - 'OTHER_FINANCIAL'
+ - 'PAYSLIP'
+ - 'PURCHASE ORDER'
+ - 'QUOTE'
+ - 'RECEIPT'
+ - 'STATEMENT'
+
+```rb
+puts result.document.inference.prediction.document_type_extended.value
+```
+
 ## Due Date
 **due_date** ([DateField](#date-field)): The date on which the payment is due.
 

data/docs/localized_products/us_healthcare_cards_v1.md

@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Healthcare Card API](https://platform.mind
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `us_healthcare_cards`                              |
-> | Recommended Version            | `v1.1`                                             |
+> | Recommended Version            | `v1.2`                                             |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ❌ No                                              |
 > | Geography                      | 🇺🇸 United States                                   |
@@ -138,6 +138,15 @@ A `HealthcareCardV1Copay` implements the following attributes:
 * `service_fees` (Float): The price of service.
 * `service_name` (String): The name of service of the copay.
 
+#### Possible values include:
+ - primary_care
+ - emergency_room
+ - urgent_care
+ - specialist
+ - office_visit
+ - prescription
+        
+
 # Attributes
 The following fields are extracted for Healthcare Card V1:
 
@@ -222,6 +231,13 @@ puts result.document.inference.prediction.rx_bin.value
 puts result.document.inference.prediction.rx_grp.value
 ```
 
+## RX ID
+**rx_id** ([StringField](#string-field)): The ID number for prescription drug coverage.
+
+```rb
+puts result.document.inference.prediction.rx_id.value
+```
+
 ## RX PCN
 **rx_pcn** ([StringField](#string-field)): The PCN number for prescription drug coverage.
 

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

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_line_items'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.11 document data.
+      # Financial Document API version 1.12 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -37,6 +37,9 @@ module Mindee
         # RECEIPT if it is a receipt.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
+        # Document type extended.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type_extended
         # The date on which the payment is due.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :due_date
@@ -144,6 +147,10 @@ module Mindee
             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
@@ -262,6 +269,7 @@ module Mindee
           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:Total Tax: #{@total_tax}".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.11 page data.
+      # Financial Document API version 1.12 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_items'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.9 document data.
+      # Invoice API version 4.10 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer billing address.
@@ -30,6 +30,9 @@ module Mindee
         # Document type: INVOICE or CREDIT NOTE.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
+        # Document type extended.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type_extended
         # The date on which the payment is due.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :due_date
@@ -117,6 +120,10 @@ module Mindee
             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
@@ -222,6 +229,7 @@ module Mindee
           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:Line Items:"
           out_str << line_items
           out_str[1..].to_s

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.9 page data.
+      # Invoice API version 4.10 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rb

@@ -39,7 +39,7 @@ module Mindee
             printable = {}
             printable[:service_fees] =
               @service_fees.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@service_fees)
-            printable[:service_name] = format_for_display(@service_name, nil)
+            printable[:service_name] = format_for_display(@service_name, 20)
             printable
           end
 
@@ -48,7 +48,7 @@ module Mindee
             printable = table_printable_values
             out_str = String.new
             out_str << format('| %- 13s', printable[:service_fees])
-            out_str << format('| %- 13s', printable[:service_name])
+            out_str << format('| %- 21s', printable[:service_name])
             out_str << '|'
           end
 

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rb

@@ -27,7 +27,7 @@ module Mindee
           def self.line_items_separator(char)
             out_str = String.new
             out_str << "+#{char * 14}"
-            out_str << "+#{char * 14}"
+            out_str << "+#{char * 22}"
             out_str
           end
 
@@ -41,7 +41,7 @@ module Mindee
             out_str = String.new
             out_str << ("\n#{self.class.line_items_separator('-')}\n ")
             out_str << ' | Service Fees'
-            out_str << ' | Service Name'
+            out_str << ' | Service Name        '
             out_str << (" |\n#{self.class.line_items_separator('=')}")
             out_str + lines
           end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module HealthcareCard
-        # Healthcare Card API version 1.1 document data.
+        # Healthcare Card API version 1.2 document data.
         class HealthcareCardV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the company that provides the healthcare plan.
@@ -43,6 +43,9 @@ module Mindee
           # The group number for prescription drug coverage.
           # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :rx_grp
+          # The ID number for prescription drug coverage.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :rx_id
           # The PCN number for prescription drug coverage.
           # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :rx_pcn
@@ -92,6 +95,7 @@ module Mindee
               prediction['rx_grp'],
               page_id
             )
+            @rx_id = Parsing::Standard::StringField.new(prediction['rx_id'], page_id)
             @rx_pcn = Parsing::Standard::StringField.new(
               prediction['rx_pcn'],
               page_id
@@ -111,6 +115,7 @@ module Mindee
             out_str << "\n:Group Number: #{@group_number}".rstrip
             out_str << "\n:Payer ID: #{@payer_id}".rstrip
             out_str << "\n:RX BIN: #{@rx_bin}".rstrip
+            out_str << "\n:RX ID: #{@rx_id}".rstrip
             out_str << "\n:RX GRP: #{@rx_grp}".rstrip
             out_str << "\n:RX PCN: #{@rx_pcn}".rstrip
             out_str << "\n:copays:"
@@ -127,7 +132,7 @@ module Mindee
             out_str = String.new
             out_str << '  '
             out_str << "+#{char * 14}"
-            out_str << "+#{char * 14}"
+            out_str << "+#{char * 22}"
             out_str << '+'
             out_str
           end
@@ -141,7 +146,7 @@ module Mindee
             out_str << "\n#{copays_separator('-')}"
             out_str << "\n  |"
             out_str << ' Service Fees |'
-            out_str << ' Service Name |'
+            out_str << ' Service Name         |'
             out_str << "\n#{copays_separator('=')}"
             out_str << "\n  #{line_items}"
             out_str << "\n#{copays_separator('-')}"

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module HealthcareCard
-        # Healthcare Card API version 1.1 page data.
+        # Healthcare Card API version 1.2 page data.
         class HealthcareCardV1Page < 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 = '4.2.0'
+  VERSION = '4.3.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[Symbol | String, Regexp], Nil?]

data/sig/mindee/product/financial_document/financial_document_v1_document.rbs

@@ -14,6 +14,7 @@ module Mindee
         def date: -> (Parsing::Standard::DateField)
         def document_number: -> (Parsing::Standard::StringField)
         def document_type: -> (Parsing::Standard::ClassificationField)
+        def document_type_extended: -> (Parsing::Standard::ClassificationField)
         def due_date: -> (Parsing::Standard::DateField)
         def invoice_number: -> (Parsing::Standard::StringField)
         def line_items: -> (Product::FinancialDocument::FinancialDocumentV1LineItems)

data/sig/mindee/product/invoice/invoice_v4_document.rbs

@@ -12,6 +12,7 @@ module Mindee
         def customer_name: -> (Parsing::Standard::StringField)
         def date: -> (Parsing::Standard::DateField)
         def document_type: -> (Parsing::Standard::ClassificationField)
+        def document_type_extended: -> (Parsing::Standard::ClassificationField)
         def due_date: -> (Parsing::Standard::DateField)
         def invoice_number: -> (Parsing::Standard::StringField)
         def line_items: -> (Product::Invoice::InvoiceV4LineItems)

data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_document.rbs

@@ -17,6 +17,7 @@ module Mindee
           def payer_id: -> (Parsing::Standard::StringField)
           def rx_bin: -> (Parsing::Standard::StringField)
           def rx_grp: -> (Parsing::Standard::StringField)
+          def rx_id: -> (Parsing::Standard::StringField)
           def rx_pcn: -> (Parsing::Standard::StringField)
           def copays_separator: (String) -> String
           def copays_to_s: -> String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64