mindee 3.19.0 → 3.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef56483dc0576b931b3d88b57e4512abd44ea4e216ed29dc1097ada3fa5b00fb
-  data.tar.gz: 8d4f6c2b99c113439b2332244cd89619189704bc75655121c26ba0122118d539
+  metadata.gz: 59ac099d28439b6b41128226d0ef764b98fb5dfd290f36b9e7406b94f5bace85
+  data.tar.gz: 5ce4b7983bc953a9e26976eedf28674e5854a5e1280261c711d213ee6912a6a9
 SHA512:
-  metadata.gz: a0461aea7ba2804e36ddc833e1ec24888227484d1ad1f1471b8b8859cfaffc14a94f623672b749fe0f73584c6c215f26d87f2e11cbeb701fc8cc9cf86088ec6f
-  data.tar.gz: aed38431cddde8abc620cf4701ecf7299929a0216b0a9e717d7ef56732211fb38ae12d093fca8839cbd981c43047f0a87088587c44fc7f4c9ff9f4ae56438f7d
+  metadata.gz: 2fc033f2699ab4eafd13cbe7dc54c93c162bca731f39fd0efb7a79ff0110cd4184d60343121eb6ef517dd85b281af92ce4ef55232ddb4a05dcf4cd4b5522ec49
+  data.tar.gz: 5de541e8d42968c167731d555b51502b6a01a55daeb8e6b1c2c408892d1d511f9c2b553abfd2cd3f79ba1ccc16ffb2af7d7c50f1fae630336a4d7f511a022587

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Mindee Ruby API Library Changelog
 
+## v3.20.0 - 2025-02-26
+### Changes
+* :sparkles: add support for FR Banks Statement V2
+
+
+## v3.19.1 - 2025-01-21
+### Changes
+* :bug: fix extras failing at document level if missing from prediction
+
+
 ## v3.19.0 - 2025-01-14
 ### Changes
 * :sparkles: add support for US Mail V3

data/README.md

@@ -147,21 +147,78 @@ result.document.inference.prediction.fields.each do |field_name, field_data|
   puts field_data.to_s
 end
 ```
+## Asynchronously Parsing a File
+
+This allows for easier handling of bursts of documents sent.
+
+Some products are only available asynchronously, check the example code
+directly on the Mindee platform.
+
+
+### Enqueue and Parse a Webhook Response
+This is an optional way of handling asynchronous APIs.
+
+```rb
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+
+# Parse the file
+enqueue_response = mindee_client.enqueue(
+  input_source,
+  Mindee::Product::InternationalId::InternationalIdV2
+)
+
+job_id = enqueue_response.job.id
+
+# Load the JSON string sent by the Mindee webhook POST callback.
+# Reading the callback data will vary greatly depending on your HTTP server.
+# This is therefore beyond the scope of this example.
+
+local_response = Mindee::Input::LocalResponse.new(request.body.string)
+
+# You can also use a File object as the input.
+# FILE_PATH = File.join('path', 'to', 'file.json').freeze
+# local_response = Mindee::Input::LocalResponse.new(FILE_PATH);
+
+# Optional: verify the HMAC signature.
+unless local_response.valid_hmac_signature?(my_secret_key, 'invalid signature')
+  raise "Invalid HMAC signature!"
+end
+
+
+# Deserialize the response:
+result = mindee_client.load_prediction(
+        Mindee::Product::InternationalId::InternationalIdV2,
+        local_response
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+```
+
 
 ## CLI Tool
 
 A command-line interface tool is available to quickly test documents:
 
 ```sh
-ruby ./bin/mindee.rb invoice path/to/your/file.ext
+ruby ./bin/mindee.rb <product_name> path/to/your/file.ext
 ```
 
 Using the ruby bundler:
 
 ```sh
-bundle exec ruby ./bin/mindee.rb invoice path/to/your/file.ext
+bundle exec ruby ./bin/mindee.rb <product_name> path/to/your/file.ext
 ```
 
+Where possible values for `<product_name>` can be displayed by running the command with no arguments.
+
 ## Further Reading
 
 There's more to it than that for those that need more features, or want to

data/docs/bank_statement_fr_v2.md

@@ -0,0 +1,244 @@
+---
+title: FR Bank Statement OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-bank-statement-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Bank Statement API](https://platform.mindee.com/mindee/bank_statement_fr).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Bank Statement sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg?raw=true)
+
+# Quick-Start
+```rb
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.enqueue_and_parse(
+  input_source,
+  Mindee::Product::FR::BankStatement::BankStatementV2
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+
+# Print the document-level parsed data
+# puts result.document.inference.prediction
+
+```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 3c1811c0-9876-45ae-91ad-c2e9cd75dd83
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/bank_statement_fr v2.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Account Number: XXXXXXXXXXXXXX
+:Bank Name: Banque lafinancepourtous
+:Bank Address: 1 rue de la Banque, 100210 Cassette
+:Client Names: Karine Plume
+:Client Address: 1 rue des Cigales, 100210 Cassette
+:Statement Date: 2002-02-28
+:Statement Start Date: 2002-02-01
+:Statement End Date: 2002-02-28
+:Opening Balance: 22.15
+:Closing Balance: -278.96
+:Transactions:
+  +------------+------------+--------------------------------------+
+  | Amount     | Date       | Description                          |
+  +============+============+======================================+
+  | 1240.00    | 2002-02-01 | Virement salaire                     |
+  +------------+------------+--------------------------------------+
+  | -520.00    | 2002-02-02 | Virement loyer                       |
+  +------------+------------+--------------------------------------+
+  | -312.00    | 2002-02-03 | Débit Carte nºxxxx                   |
+  +------------+------------+--------------------------------------+
+  | 12.47      | 2002-02-04 | Virement CPAM                        |
+  +------------+------------+--------------------------------------+
+  | 65.00      | 2002-02-05 | Virement APL                         |
+  +------------+------------+--------------------------------------+
+  | -110.00    | 2002-02-07 | Débit Carte nxxxxxxxxxxxxxxxx        |
+  +------------+------------+--------------------------------------+
+  | -3.30      | 2002-02-08 | Cotisation mensuelle carte bancaire  |
+  +------------+------------+--------------------------------------+
+  | -120.00    | 2002-02-09 | Chèque n° xxxxxx98                   |
+  +------------+------------+--------------------------------------+
+  | -60.00     | 2002-02-09 | Retrait espèces DAB                  |
+  +------------+------------+--------------------------------------+
+  | -55.00     | 2002-02-15 | Chèque n° xxxxxx99                   |
+  +------------+------------+--------------------------------------+
+  | -80.00     | 2002-02-16 | Prélèvement supercrédit              |
+  +------------+------------+--------------------------------------+
+  | -120.00    | 2002-02-17 | Chèque n° xxxxx 100                  |
+  +------------+------------+--------------------------------------+
+  | -163.25    | 2002-02-20 | Débit Carte nºxxxxxxxxxxxxx          |
+  +------------+------------+--------------------------------------+
+  | -25.50     | 2002-02-21 | Débit Carte n°xxxxxxxxxxxxxxxxxx     |
+  +------------+------------+--------------------------------------+
+  | -30.00     | 2002-02-24 | Prélèvement Opérateur téléphonique   |
+  +------------+------------+--------------------------------------+
+  | -6.53      | 2002-02-25 | Agios                                |
+  +------------+------------+--------------------------------------+
+  | -13.00     | 2002-02-28 | Frais irrégularités et incidents ... |
+  +------------+------------+--------------------------------------+
+:Total Debits: 1618.58
+:Total Credits: 1339.62
+```
+
+# Field Types
+## Standard Fields
+These fields are generic and used in several products.
+
+### Basic Field
+Each prediction object contains a set of fields that inherit from the generic `Field` class.
+A typical `Field` object will have the following attributes:
+
+* **value** (`String`, `Float`, `Integer`, `Boolean`): corresponds to the field value. Can be `nil` if no value was extracted.
+* **confidence** (Float, nil): the confidence score of the field prediction.
+* **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
+* **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
+* **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+
+
+Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
+
+
+### Amount Field
+The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
+
+### Date Field
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+
+* **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
+
+### String Field
+The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Transactions Field
+The list of values that represent the financial transactions recorded in a bank statement.
+
+A `BankStatementV2Transaction` implements the following attributes:
+
+* `amount` (Float): The monetary amount of the transaction.
+* `date` (String): The date on which the transaction occurred.
+* `description` (String): The additional information about the transaction.
+
+# Attributes
+The following fields are extracted for Bank Statement V2:
+
+## Account Number
+**account_number** ([StringField](#string-field)): The unique identifier for a customer's account in the bank's system.
+
+```rb
+puts result.document.inference.prediction.account_number.value
+```
+
+## Bank Address
+**bank_address** ([StringField](#string-field)): The physical location of the bank where the statement was issued.
+
+```rb
+puts result.document.inference.prediction.bank_address.value
+```
+
+## Bank Name
+**bank_name** ([StringField](#string-field)): The name of the bank that issued the statement.
+
+```rb
+puts result.document.inference.prediction.bank_name.value
+```
+
+## Client Address
+**client_address** ([StringField](#string-field)): The address of the client associated with the bank statement.
+
+```rb
+puts result.document.inference.prediction.client_address.value
+```
+
+## Client Names
+**client_names** (Array<[StringField](#string-field)>): The name of the clients who own the bank statement.
+
+```rb
+for client_names_elem in result.document.inference.prediction.client_names do
+  puts client_names_elem.value
+end
+```
+
+## Closing Balance
+**closing_balance** ([AmountField](#amount-field)): The final amount of money in the account at the end of the statement period.
+
+```rb
+puts result.document.inference.prediction.closing_balance.value
+```
+
+## Opening Balance
+**opening_balance** ([AmountField](#amount-field)): The initial amount of money in an account at the start of the period.
+
+```rb
+puts result.document.inference.prediction.opening_balance.value
+```
+
+## Statement Date
+**statement_date** ([DateField](#date-field)): The date on which the bank statement was generated.
+
+```rb
+puts result.document.inference.prediction.statement_date.value
+```
+
+## Statement End Date
+**statement_end_date** ([DateField](#date-field)): The date when the statement period ends.
+
+```rb
+puts result.document.inference.prediction.statement_end_date.value
+```
+
+## Statement Start Date
+**statement_start_date** ([DateField](#date-field)): The date when the bank statement period begins.
+
+```rb
+puts result.document.inference.prediction.statement_start_date.value
+```
+
+## Total Credits
+**total_credits** ([AmountField](#amount-field)): The total amount of money deposited into the account.
+
+```rb
+puts result.document.inference.prediction.total_credits.value
+```
+
+## Total Debits
+**total_debits** ([AmountField](#amount-field)): The total amount of money debited from the account.
+
+```rb
+puts result.document.inference.prediction.total_debits.value
+```
+
+## Transactions
+**transactions** (Array<[BankStatementV2Transaction](#transactions-field)>): The list of values that represent the financial transactions recorded in a bank statement.
+
+```rb
+for transactions_elem in result.document.inference.prediction.transactions do
+  puts transactions_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/code_samples/bank_statement_fr_v2_async.txt

@@ -0,0 +1,19 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.enqueue_and_parse(
+  input_source,
+  Mindee::Product::FR::BankStatement::BankStatementV2
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+
+# Print the document-level parsed data
+# puts result.document.inference.prediction

data/docs/driver_license_v1.md

@@ -6,7 +6,7 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/driver_license).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -32,6 +32,37 @@ puts result.document
 # puts result.document.inference.prediction
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: fbdeae38-ada3-43ac-aa58-e01a3d47e474
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/driver_license v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Country Code: USA
+:State: AZ
+:ID: D12345678
+:Category: D
+:Last Name: Sample
+:First Name: Jelani
+:Date of Birth: 1957-02-01
+:Place of Birth:
+:Expiry Date: 2018-02-01
+:Issued Date: 2013-01-10
+:Issuing Authority:
+:MRZ:
+:DD Number: DD1234567890123456
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

data/docs/financial_document_v1.md

@@ -63,7 +63,7 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: b26161ce-35d0-4984-b1ff-886645e160e6
+:Mindee ID: f469a24d-3875-4a83-ad43-e0d5aa9da604
 :Filename: default_sample.jpg
 
 Inference
@@ -80,8 +80,8 @@ Prediction
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
-:Due Date: 2019-02-26
-:Payment Date: 2019-02-26
+:Due Date: 2019-11-17
+:Payment Date: 2019-11-17
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes:
@@ -132,8 +132,8 @@ Page 0
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
-:Due Date: 2019-02-26
-:Payment Date: 2019-02-26
+:Due Date: 2019-11-17
+:Payment Date: 2019-11-17
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes:

data/docs/invoices_v4.md

@@ -63,7 +63,7 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: a67b70ea-4b1e-4eac-ae75-dda47a7064ae
+:Mindee ID: 86b1833f-138b-4a01-8387-860204b0e631
 :Filename: default_sample.jpg
 
 Inference
@@ -78,8 +78,8 @@ Prediction
 :Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2011-12-01
-:Payment Date: 2011-12-01
+:Due Date:
+:Payment Date:
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -124,8 +124,8 @@ Page 0
 :Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2011-12-01
-:Payment Date: 2011-12-01
+:Due Date:
+:Payment Date:
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20

data/lib/mindee/parsing/common/document.rb

@@ -61,8 +61,7 @@ module Mindee
         private
 
         def inject_full_text_ocr(raw_prediction)
-          return unless raw_prediction.dig('inference', 'pages') &&
-                        raw_prediction['inference']['pages'][0]['extras']['full_text_ocr']
+          return unless raw_prediction.dig('inference', 'pages', 0, 'extras', 'full_text_ocr')
 
           full_text_ocr = String.new
           raw_prediction.dig('inference', 'pages').each do |page|

data/lib/mindee/product/fr/bank_statement/bank_statement_v2.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_statement_v2_document'
+require_relative 'bank_statement_v2_page'
+
+module Mindee
+  module Product
+    module FR
+      # Bank Statement module.
+      module BankStatement
+        # Bank Statement API version 2 inference prediction.
+        class BankStatementV2 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'bank_statement_fr'
+          @endpoint_version = '2'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = BankStatementV2Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(BankStatementV2Page.new(page))
+              end
+            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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/bank_statement/bank_statement_v2_document.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_statement_v2_transaction'
+
+module Mindee
+  module Product
+    module FR
+      module BankStatement
+        # Bank Statement API version 2.0 document data.
+        class BankStatementV2Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The unique identifier for a customer's account in the bank's system.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :account_number
+          # The physical location of the bank where the statement was issued.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :bank_address
+          # The name of the bank that issued the statement.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :bank_name
+          # The address of the client associated with the bank statement.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :client_address
+          # The name of the clients who own the bank statement.
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
+          attr_reader :client_names
+          # The final amount of money in the account at the end of the statement period.
+          # @return [Mindee::Parsing::Standard::AmountField]
+          attr_reader :closing_balance
+          # The initial amount of money in an account at the start of the period.
+          # @return [Mindee::Parsing::Standard::AmountField]
+          attr_reader :opening_balance
+          # The date on which the bank statement was generated.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :statement_date
+          # The date when the statement period ends.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :statement_end_date
+          # The date when the bank statement period begins.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :statement_start_date
+          # The total amount of money deposited into the account.
+          # @return [Mindee::Parsing::Standard::AmountField]
+          attr_reader :total_credits
+          # The total amount of money debited from the account.
+          # @return [Mindee::Parsing::Standard::AmountField]
+          attr_reader :total_debits
+          # The list of values that represent the financial transactions recorded in a bank statement.
+          # @return [Array<Mindee::Product::FR::BankStatement::BankStatementV2Transaction>]
+          attr_reader :transactions
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @account_number = StringField.new(prediction['account_number'], page_id)
+            @bank_address = StringField.new(prediction['bank_address'], page_id)
+            @bank_name = StringField.new(prediction['bank_name'], page_id)
+            @client_address = StringField.new(prediction['client_address'], page_id)
+            @client_names = []
+            prediction['client_names'].each do |item|
+              @client_names.push(StringField.new(item, page_id))
+            end
+            @closing_balance = AmountField.new(prediction['closing_balance'], page_id)
+            @opening_balance = AmountField.new(prediction['opening_balance'], page_id)
+            @statement_date = DateField.new(prediction['statement_date'], page_id)
+            @statement_end_date = DateField.new(prediction['statement_end_date'], page_id)
+            @statement_start_date = DateField.new(prediction['statement_start_date'], page_id)
+            @total_credits = AmountField.new(prediction['total_credits'], page_id)
+            @total_debits = AmountField.new(prediction['total_debits'], page_id)
+            @transactions = []
+            prediction['transactions'].each do |item|
+              @transactions.push(BankStatementV2Transaction.new(item, page_id))
+            end
+          end
+
+          # @return [String]
+          def to_s
+            client_names = @client_names.join("\n #{' ' * 14}")
+            transactions = transactions_to_s
+            out_str = String.new
+            out_str << "\n:Account Number: #{@account_number}".rstrip
+            out_str << "\n:Bank Name: #{@bank_name}".rstrip
+            out_str << "\n:Bank Address: #{@bank_address}".rstrip
+            out_str << "\n:Client Names: #{client_names}".rstrip
+            out_str << "\n:Client Address: #{@client_address}".rstrip
+            out_str << "\n:Statement Date: #{@statement_date}".rstrip
+            out_str << "\n:Statement Start Date: #{@statement_start_date}".rstrip
+            out_str << "\n:Statement End Date: #{@statement_end_date}".rstrip
+            out_str << "\n:Opening Balance: #{@opening_balance}".rstrip
+            out_str << "\n:Closing Balance: #{@closing_balance}".rstrip
+            out_str << "\n:Transactions:"
+            out_str << transactions
+            out_str << "\n:Total Debits: #{@total_debits}".rstrip
+            out_str << "\n:Total Credits: #{@total_credits}".rstrip
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def transactions_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 38}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def transactions_to_s
+            return '' if @transactions.empty?
+
+            line_items = @transactions.map(&:to_table_line).join("\n#{transactions_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{transactions_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Amount     |'
+            out_str << ' Date       |'
+            out_str << ' Description                          |'
+            out_str << "\n#{transactions_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{transactions_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/bank_statement/bank_statement_v2_page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_statement_v2_document'
+
+module Mindee
+  module Product
+    module FR
+      module BankStatement
+        # Bank Statement API version 2.0 page data.
+        class BankStatementV2Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = BankStatementV2PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Bank Statement V2 page prediction.
+        class BankStatementV2PagePrediction < BankStatementV2Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/bank_statement/bank_statement_v2_transaction.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module BankStatement
+        # The list of values that represent the financial transactions recorded in a bank statement.
+        class BankStatementV2Transaction < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The monetary amount of the transaction.
+          # @return [Float]
+          attr_reader :amount
+          # The date on which the transaction occurred.
+          # @return [String]
+          attr_reader :date
+          # The additional information about the transaction.
+          # @return [String]
+          attr_reader :description
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @amount = prediction['amount']
+            @date = prediction['date']
+            @description = prediction['description']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:date] = format_for_display(@date)
+            printable[:description] = format_for_display(@description)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:date] = format_for_display(@date, 10)
+            printable[:description] = format_for_display(@description, 36)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 11s', printable[:amount])
+            out_str << format('| %- 11s', printable[:date])
+            out_str << format('| %- 37s', printable[:description])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Amount: #{printable[:amount]}"
+            out_str << "\n  :Date: #{printable[:date]}"
+            out_str << "\n  :Description: #{printable[:description]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product.rb

@@ -12,6 +12,7 @@ require_relative 'product/eu/driver_license/driver_license_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v1'
+require_relative 'product/fr/bank_statement/bank_statement_v2'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.19.0'
+  VERSION = '3.20.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.19.0
+  version: 3.20.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -154,6 +154,7 @@ files:
 - docs/bank_account_details_v2.md
 - docs/bank_check_v1.md
 - docs/bank_statement_fr_v1.md
+- docs/bank_statement_fr_v2.md
 - docs/barcode_reader_v1.md
 - docs/bill_of_lading_v1.md
 - docs/business_card_v1.md
@@ -162,6 +163,7 @@ files:
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
 - docs/code_samples/bank_statement_fr_v1_async.txt
+- docs/code_samples/bank_statement_fr_v2_async.txt
 - docs/code_samples/barcode_reader_v1.txt
 - docs/code_samples/bill_of_lading_v1_async.txt
 - docs/code_samples/business_card_v1_async.txt
@@ -356,6 +358,10 @@ files:
 - lib/mindee/product/fr/bank_statement/bank_statement_v1_document.rb
 - lib/mindee/product/fr/bank_statement/bank_statement_v1_page.rb
 - lib/mindee/product/fr/bank_statement/bank_statement_v1_transaction.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v2.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v2_document.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v2_page.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v2_transaction.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb