mindee 3.19.1 → 4.0.0

data/docs/{financial_document_v1.md → global_products/financial_document_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: Financial Document OCR Ruby
+title: Ruby Client Library - Financial Document
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-financial-document-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Financial Document API](https://platform.mindee.com/mindee/financial_document).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/financial_document/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [Financial Document API](https://platform.mindee.com/mindee/financial_document).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `financial_document`                               |
+> | Recommended Version            | `v1.11`                                            |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/financial_document/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Financial Document sample](https://github.com/mindee/client-lib-test-data/blob/main/products/financial_document/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -22,7 +48,8 @@ input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 # Parse the file
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::FinancialDocument::FinancialDocumentV1
+  Mindee::Product::FinancialDocument::FinancialDocumentV1,
+  enqueue: false
 )
 
 # Print a full summary of the parsed data in RST format
@@ -30,12 +57,16 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 You can also call this product asynchronously:
 
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -45,7 +76,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::FinancialDocument::FinancialDocumentV1
 )
@@ -55,7 +86,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -63,7 +93,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 +110,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 +162,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:
@@ -181,12 +211,12 @@ These fields are generic and used in several products.
 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.
+* **value** (`String`, `Float`, `Integer`, `bool`): 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).
+* **reconstructed** (`bool`): 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.
@@ -197,30 +227,35 @@ The amount field `AmountField` only has one constraint: its **value** is a `Floa
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always a `String`.
 
 
 ### Company Registration Field
-Aside from the basic `Field` attributes, the company registration field `CompanyRegistrationField` also implements the following:
+Aside from the basic `Field` attributes, the company registration field `CompanyRegistrationField` also implements the
+following:
 
 * **type** (`String`): the type of company.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+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.
 
 ### Locale Field
-The locale field `LocaleField` only implements the **value**, **confidence** and **page_id** base `Field` attributes, but it comes with its own:
+The locale field `LocaleField` only implements the **value**, **confidence** and **page_id** base `Field` attributes,
+but it comes with its own:
 
 * **language** (`String`): ISO 639-1 language code (e.g.: `en` for English). Can be `nil`.
-* **country** (`String`): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: `GRB` or `GB` for "Great Britain"). Can be `nil`.
+* **country** (`String`): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: `GRB` or `GB` for "Great
+Britain"). Can be `nil`.
 * **currency** (`String`): ISO 4217 code for currencies (e.g.: `USD` for "US Dollars"). Can be `nil`.
 
 ### Payment Details Field
-Aside from the basic `Field` attributes, the payment details field `PaymentDetailsField` also implements the following:
+Aside from the basic `Field` attributes, the payment details field `PaymentDetailsField` also implements the
+following:
 
 * **account_number** (`String`): number of an account, expressed as a string. Can be `nil`.
 * **iban** (`String`): International Bank Account Number. Can be `nil`.
@@ -238,10 +273,12 @@ Aside from the basic `Field` attributes, the tax field `TaxField` also implement
 * **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
 * **base** (`Float`): base amount used for the tax. Can be `nil`.
 
-> Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like structure.
+> Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like
+structure.
 
 #### Taxes (Array)
-The `Taxes` field represents an array-like collection of `TaxField` objects. As it is the representation of several objects, it has access to a custom `to_s` method that can render a `TaxField` object as a table line.
+The `Taxes` field represents an array-like collection of `TaxField` objects. As it is the representation of several
+objects, it has access to a custom `to_s` method that can render a `TaxField` object as a table line.
 
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
@@ -298,7 +335,7 @@ puts result.document.inference.prediction.customer_address.value
 **customer_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the customer.
 
 ```rb
-for customer_company_registrations_elem in result.document.inference.prediction.customer_company_registrations do
+result.document.inference.prediction.customer_company_registrations do |customer_company_registrations_elem|
   puts customer_company_registrations_elem.value
 end
 ```
@@ -362,7 +399,7 @@ puts result.document.inference.prediction.invoice_number.value
 **line_items** (Array<[FinancialDocumentV1LineItem](#line-items-field)>): List of line item details.
 
 ```rb
-for line_items_elem in result.document.inference.prediction.line_items do
+result.document.inference.prediction.line_items do |line_items_elem|
   puts line_items_elem.value
 end
 ```
@@ -399,7 +436,7 @@ puts result.document.inference.prediction.receipt_number.value
 **reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
 
 ```rb
-for reference_numbers_elem in result.document.inference.prediction.reference_numbers do
+result.document.inference.prediction.reference_numbers do |reference_numbers_elem|
   puts reference_numbers_elem.value
 end
 ```
@@ -436,7 +473,7 @@ puts result.document.inference.prediction.supplier_address.value
 **supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the supplier.
 
 ```rb
-for supplier_company_registrations_elem in result.document.inference.prediction.supplier_company_registrations do
+result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
   puts supplier_company_registrations_elem.value
 end
 ```
@@ -459,11 +496,11 @@ puts result.document.inference.prediction.supplier_name.value
 **supplier_payment_details** (Array<[PaymentDetailsField](#payment-details-field)>): List of payment details associated to the supplier.
 
 ```rb
-for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
+result.document.inference.prediction.supplier_payment_details do |supplier_payment_details_elem|
   puts supplier_payment_details_elem.value
-    puts supplier_payment_details_elem.rate
-    puts supplier_payment_details_elem.code
-    puts supplier_payment_details_elem.basis
+  puts supplier_payment_details_elem.rate
+  puts supplier_payment_details_elem.code
+  puts supplier_payment_details_elem.basis
 end
 ```
 
@@ -485,7 +522,7 @@ puts result.document.inference.prediction.supplier_website.value
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax lines information.
 
 ```rb
-for taxes_elem in result.document.inference.prediction.taxes do
+result.document.inference.prediction.taxes do |taxes_elem|
   puts taxes_elem.value
 end
 ```

data/docs/{international_id_v2.md → global_products/international_id_v2.md}

@@ -1,16 +1,42 @@
 ---
-title: International ID OCR Ruby
+title: Ruby Client Library - International ID
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-international-id-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [International ID API](https://platform.mindee.com/mindee/international_id).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [International ID API](https://platform.mindee.com/mindee/international_id).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `international_id`                                 |
+> | Recommended Version            | `v2.1`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![International ID sample](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -20,7 +46,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::InternationalId::InternationalIdV2
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -76,24 +101,25 @@ These fields are generic and used in several products.
 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.
+* **value** (`String`, `Float`, `Integer`, `bool`): 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).
+* **reconstructed** (`bool`): 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.
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always a `String`.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+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.
 
@@ -164,7 +190,7 @@ puts result.document.inference.prediction.expiry_date.value
 **given_names** (Array<[StringField](#string-field)>): The list of the document holder's given names.
 
 ```rb
-for given_names_elem in result.document.inference.prediction.given_names do
+result.document.inference.prediction.given_names do |given_names_elem|
   puts given_names_elem.value
 end
 ```
@@ -229,7 +255,7 @@ puts result.document.inference.prediction.state_of_issue.value
 **surnames** (Array<[StringField](#string-field)>): The list of the document holder's family names.
 
 ```rb
-for surnames_elem in result.document.inference.prediction.surnames do
+result.document.inference.prediction.surnames do |surnames_elem|
   puts surnames_elem.value
 end
 ```

data/docs/{invoice_splitter_v1.md → global_products/invoice_splitter_v1.md}

@@ -2,11 +2,30 @@
 title: Invoice Splitter API Ruby
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-invoice-splitter-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Invoice Splitter API](https://platform.mindee.com/mindee/invoice_splitter).
-
-Using [this sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf), we are going to illustrate how to detect the pages of multiple invoices within the same document.
+The Ruby Client Library supports the [Invoice Splitter API](https://platform.mindee.com/mindee/invoice_splitter).
+
+> 📝 Product Specs
+>
+> | Specification                  | Details            |
+> | ------------------------------ |--------------------|
+> | Endpoint Name                  | `invoice_splitter` |
+> | Recommended Version            | `v1.2`             |
+> | Supports Polling/Webhooks      | ✔️ Yes             |
+> | Support Synchronous HTTP Calls | ❌ No               |
+> | Geography                      | 🌐 Global          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- |---------------|
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+Using [this sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf), we are going to illustrate detect the pages of multiple invoices within the same document using the
+Ruby Client Library.
 
 # Quick-Start
 
@@ -19,7 +38,7 @@ 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')
 
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::InvoiceSplitter::InvoiceSplitterV1
 )
@@ -79,7 +98,7 @@ The following fields are extracted for Invoice Splitter V1:
 **invoice_page_groups** (Array<[InvoiceSplitterV1PageGroup](#invoice-splitter-v1-page-group)>): List of page indexes that belong to the same invoice in the PDF.
 
 ```rb
-for invoice_page_groups_elem in result.document.inference.prediction.invoice_page_groups do 
+result.document.inference.prediction.invoice_page_groups.each do |invoice_page_groups_elem|
   puts invoice_page_groups_elem.page_indexes.join(', ')
 end
 ```

data/docs/{invoices_v4.md → global_products/invoices_v4.md}

@@ -1,16 +1,42 @@
 ---
-title: Invoice OCR Ruby
+title: Ruby Client Library - Invoice
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-invoice-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Invoice API](https://platform.mindee.com/mindee/invoices).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [Invoice API](https://platform.mindee.com/mindee/invoices).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `invoices`                                         |
+> | Recommended Version            | `v4.9`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Invoice sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -22,7 +48,8 @@ input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 # Parse the file
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::Invoice::InvoiceV4
+  Mindee::Product::Invoice::InvoiceV4,
+  enqueue: false
 )
 
 # Print a full summary of the parsed data in RST format
@@ -30,12 +57,16 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 You can also call this product asynchronously:
 
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -45,7 +76,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::Invoice::InvoiceV4
 )
@@ -55,7 +86,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -63,7 +93,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 +108,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 +154,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
@@ -169,12 +199,12 @@ These fields are generic and used in several products.
 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.
+* **value** (`String`, `Float`, `Integer`, `bool`): 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).
+* **reconstructed** (`bool`): 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.
@@ -185,30 +215,35 @@ The amount field `AmountField` only has one constraint: its **value** is a `Floa
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always a `String`.
 
 
 ### Company Registration Field
-Aside from the basic `Field` attributes, the company registration field `CompanyRegistrationField` also implements the following:
+Aside from the basic `Field` attributes, the company registration field `CompanyRegistrationField` also implements the
+following:
 
 * **type** (`String`): the type of company.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+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.
 
 ### Locale Field
-The locale field `LocaleField` only implements the **value**, **confidence** and **page_id** base `Field` attributes, but it comes with its own:
+The locale field `LocaleField` only implements the **value**, **confidence** and **page_id** base `Field` attributes,
+but it comes with its own:
 
 * **language** (`String`): ISO 639-1 language code (e.g.: `en` for English). Can be `nil`.
-* **country** (`String`): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: `GRB` or `GB` for "Great Britain"). Can be `nil`.
+* **country** (`String`): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: `GRB` or `GB` for "Great
+Britain"). Can be `nil`.
 * **currency** (`String`): ISO 4217 code for currencies (e.g.: `USD` for "US Dollars"). Can be `nil`.
 
 ### Payment Details Field
-Aside from the basic `Field` attributes, the payment details field `PaymentDetailsField` also implements the following:
+Aside from the basic `Field` attributes, the payment details field `PaymentDetailsField` also implements the
+following:
 
 * **account_number** (`String`): number of an account, expressed as a string. Can be `nil`.
 * **iban** (`String`): International Bank Account Number. Can be `nil`.
@@ -226,10 +261,12 @@ Aside from the basic `Field` attributes, the tax field `TaxField` also implement
 * **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
 * **base** (`Float`): base amount used for the tax. Can be `nil`.
 
-> Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like structure.
+> Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like
+structure.
 
 #### Taxes (Array)
-The `Taxes` field represents an array-like collection of `TaxField` objects. As it is the representation of several objects, it has access to a custom `to_s` method that can render a `TaxField` object as a table line.
+The `Taxes` field represents an array-like collection of `TaxField` objects. As it is the representation of several
+objects, it has access to a custom `to_s` method that can render a `TaxField` object as a table line.
 
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
@@ -269,7 +306,7 @@ puts result.document.inference.prediction.customer_address.value
 **customer_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the customer.
 
 ```rb
-for customer_company_registrations_elem in result.document.inference.prediction.customer_company_registrations do
+result.document.inference.prediction.customer_company_registrations do |customer_company_registrations_elem|
   puts customer_company_registrations_elem.value
 end
 ```
@@ -324,7 +361,7 @@ puts result.document.inference.prediction.invoice_number.value
 **line_items** (Array<[InvoiceV4LineItem](#line-items-field)>): List of line item details.
 
 ```rb
-for line_items_elem in result.document.inference.prediction.line_items do
+result.document.inference.prediction.line_items do |line_items_elem|
   puts line_items_elem.value
 end
 ```
@@ -354,7 +391,7 @@ puts result.document.inference.prediction.po_number.value
 **reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
 
 ```rb
-for reference_numbers_elem in result.document.inference.prediction.reference_numbers do
+result.document.inference.prediction.reference_numbers do |reference_numbers_elem|
   puts reference_numbers_elem.value
 end
 ```
@@ -377,7 +414,7 @@ puts result.document.inference.prediction.supplier_address.value
 **supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the supplier.
 
 ```rb
-for supplier_company_registrations_elem in result.document.inference.prediction.supplier_company_registrations do
+result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
   puts supplier_company_registrations_elem.value
 end
 ```
@@ -400,11 +437,11 @@ puts result.document.inference.prediction.supplier_name.value
 **supplier_payment_details** (Array<[PaymentDetailsField](#payment-details-field)>): List of payment details associated to the supplier.
 
 ```rb
-for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
+result.document.inference.prediction.supplier_payment_details do |supplier_payment_details_elem|
   puts supplier_payment_details_elem.value
-    puts supplier_payment_details_elem.rate
-    puts supplier_payment_details_elem.code
-    puts supplier_payment_details_elem.basis
+  puts supplier_payment_details_elem.rate
+  puts supplier_payment_details_elem.code
+  puts supplier_payment_details_elem.basis
 end
 ```
 
@@ -426,7 +463,7 @@ puts result.document.inference.prediction.supplier_website.value
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax line details.
 
 ```rb
-for taxes_elem in result.document.inference.prediction.taxes do
+result.document.inference.prediction.taxes do |taxes_elem|
   puts taxes_elem.value
 end
 ```