mindee 3.20.0 → 4.0.0

data/docs/{payslip_fra_v3.md → localized_products/payslip_fra_v3.md}

@@ -1,16 +1,42 @@
 ---
-title: FR Payslip OCR Ruby
+title: Ruby Client Library - FR Payslip
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-payslip-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Payslip API](https://platform.mindee.com/mindee/payslip_fra).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/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 [Payslip API](https://platform.mindee.com/mindee/payslip_fra).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `payslip_fra`                                      |
+> | Recommended Version            | `v3.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇫🇷 France                                          |
+
+> 🔐 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/payslip_fra/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Payslip sample](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/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::FR::Payslip::PayslipV3
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -123,12 +148,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.
@@ -136,14 +161,16 @@ Aside from the previous attributes, all basic fields have access to a `to_s` met
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
-### Bank Account Details Field
-Information about the employee's bank account.
+### Pay Period Field
+Information about the pay period.
 
-A `PayslipV3BankAccountDetail` implements the following attributes:
+A `PayslipV3PayPeriod` implements the following attributes:
 
-* `bank_name` (String): The name of the bank.
-* `iban` (String): The IBAN of the bank account.
-* `swift` (String): The SWIFT code of the bank.
+* `end_date` (String): The end date of the pay period.
+* `month` (String): The month of the pay period.
+* `payment_date` (String): The date of payment for the pay period.
+* `start_date` (String): The start date of the pay period.
+* `year` (String): The year of the pay period.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Employee Field
@@ -174,6 +201,16 @@ A `PayslipV3Employer` implements the following attributes:
 * `urssaf_number` (String): The URSSAF number of the employer.
 Fields which are specific to this product; they are not used in any other product.
 
+### Bank Account Details Field
+Information about the employee's bank account.
+
+A `PayslipV3BankAccountDetail` implements the following attributes:
+
+* `bank_name` (String): The name of the bank.
+* `iban` (String): The IBAN of the bank account.
+* `swift` (String): The SWIFT code of the bank.
+Fields which are specific to this product; they are not used in any other product.
+
 ### Employment Field
 Information about the employment.
 
@@ -188,28 +225,16 @@ A `PayslipV3Employment` implements the following attributes:
 * `start_date` (String): The start date of the employment.
 Fields which are specific to this product; they are not used in any other product.
 
-### Paid Time Off Field
-Information about paid time off.
-
-A `PayslipV3PaidTimeOff` implements the following attributes:
-
-* `accrued` (Float): The amount of paid time off accrued in the period.
-* `period` (String): The paid time off period.
-
-#### Possible values include:
- - N
- - N-1
- - N-2
-
-* `pto_type` (String): The type of paid time off.
+### Salary Details Field
+Detailed information about the earnings.
 
-#### Possible values include:
- - VACATION
- - RTT
- - COMPENSATORY
+A `PayslipV3SalaryDetail` implements the following attributes:
 
-* `remaining` (Float): The remaining amount of paid time off at the end of the period.
-* `used` (Float): The amount of paid time off used in the period.
+* `amount` (Float): The amount of the earning.
+* `base` (Float): The base rate value of the earning.
+* `description` (String): The description of the earnings.
+* `number` (Float): The number of units in the earning.
+* `rate` (Float): The rate of the earning.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Pay Detail Field
@@ -229,28 +254,28 @@ A `PayslipV3PayDetail` implements the following attributes:
 * `total_taxes_and_deductions` (Float): The total taxes and deductions of the employee.
 Fields which are specific to this product; they are not used in any other product.
 
-### Pay Period Field
-Information about the pay period.
-
-A `PayslipV3PayPeriod` implements the following attributes:
+### Paid Time Off Field
+Information about paid time off.
 
-* `end_date` (String): The end date of the pay period.
-* `month` (String): The month of the pay period.
-* `payment_date` (String): The date of payment for the pay period.
-* `start_date` (String): The start date of the pay period.
-* `year` (String): The year of the pay period.
-Fields which are specific to this product; they are not used in any other product.
+A `PayslipV3PaidTimeOff` implements the following attributes:
 
-### Salary Details Field
-Detailed information about the earnings.
+* `accrued` (Float): The amount of paid time off accrued in the period.
+* `period` (String): The paid time off period.
 
-A `PayslipV3SalaryDetail` implements the following attributes:
+#### Possible values include:
+ - N
+ - N-1
+ - N-2
+        
+* `pto_type` (String): The type of paid time off.
 
-* `amount` (Float): The amount of the earning.
-* `base` (Float): The base rate value of the earning.
-* `description` (String): The description of the earnings.
-* `number` (Float): The number of units in the earning.
-* `rate` (Float): The rate of the earning.
+#### Possible values include:
+ - VACATION
+ - RTT
+ - COMPENSATORY
+        
+* `remaining` (Float): The remaining amount of paid time off at the end of the period.
+* `used` (Float): The amount of paid time off used in the period.
 
 # Attributes
 The following fields are extracted for Payslip V3:
@@ -287,7 +312,7 @@ puts result.document.inference.prediction.employment.value
 **paid_time_off** (Array<[PayslipV3PaidTimeOff](#paid-time-off-field)>): Information about paid time off.
 
 ```rb
-for paid_time_off_elem in result.document.inference.prediction.paid_time_off do
+result.document.inference.prediction.paid_time_off do |paid_time_off_elem|
   puts paid_time_off_elem.value
 end
 ```
@@ -310,7 +335,7 @@ puts result.document.inference.prediction.pay_period.value
 **salary_details** (Array<[PayslipV3SalaryDetail](#salary-details-field)>): Detailed information about the earnings.
 
 ```rb
-for salary_details_elem in result.document.inference.prediction.salary_details do
+result.document.inference.prediction.salary_details do |salary_details_elem|
   puts salary_details_elem.value
 end
 ```

data/docs/{us_healthcare_cards_v1.md → localized_products/us_healthcare_cards_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: US Healthcare Card OCR Ruby
+title: Ruby Client Library - US Healthcare Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-healthcare-card-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Healthcare Card API](https://platform.mindee.com/mindee/us_healthcare_cards).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_healthcare_cards/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 [Healthcare Card API](https://platform.mindee.com/mindee/us_healthcare_cards).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `us_healthcare_cards`                              |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇺🇸 United States                                   |
+
+> 🔐 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/us_healthcare_cards/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Healthcare Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_healthcare_cards/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::US::HealthcareCard::HealthcareCardV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -84,18 +109,18 @@ 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.
 
 ### 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.
 
@@ -127,7 +152,7 @@ puts result.document.inference.prediction.company_name.value
 **copays** (Array<[HealthcareCardV1Copay](#copays-field)>): Is a fixed amount for a covered service.
 
 ```rb
-for copays_elem in result.document.inference.prediction.copays do
+result.document.inference.prediction.copays do |copays_elem|
   puts copays_elem.value
 end
 ```
@@ -136,7 +161,7 @@ end
 **dependents** (Array<[StringField](#string-field)>): The list of dependents covered by the healthcare plan.
 
 ```rb
-for dependents_elem in result.document.inference.prediction.dependents do
+result.document.inference.prediction.dependents do |dependents_elem|
   puts dependents_elem.value
 end
 ```

data/docs/{us_mail_v3.md → localized_products/us_mail_v3.md}

@@ -1,16 +1,42 @@
 ---
-title: US US Mail OCR Ruby
+title: Ruby Client Library - US US Mail
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-us-mail-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/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 [US Mail API](https://platform.mindee.com/mindee/us_mail).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `us_mail`                                          |
+> | Recommended Version            | `v3.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇺🇸 United States                                   |
+
+> 🔐 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/us_mail/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/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::US::UsMail::UsMailV3
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -73,12 +98,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.
@@ -89,6 +114,18 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
+### Sender Address Field
+The address of the sender.
+
+A `UsMailV3SenderAddress` implements the following attributes:
+
+* `city` (String): The city of the sender's address.
+* `complete` (String): The complete address of the sender.
+* `postal_code` (String): The postal code of the sender's address.
+* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+* `street` (String): The street of the sender's address.
+Fields which are specific to this product; they are not used in any other product.
+
 ### Recipient Addresses Field
 The addresses of the recipients.
 
@@ -96,24 +133,12 @@ A `UsMailV3RecipientAddress` implements the following attributes:
 
 * `city` (String): The city of the recipient's address.
 * `complete` (String): The complete address of the recipient.
-* `is_address_change` (Boolean): Indicates if the recipient's address is a change of address.
+* `is_address_change` (bool): Indicates if the recipient's address is a change of address.
 * `postal_code` (String): The postal code of the recipient's address.
 * `private_mailbox_number` (String): The private mailbox number of the recipient's address.
 * `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
 * `street` (String): The street of the recipient's address.
 * `unit` (String): The unit number of the recipient's address.
-Fields which are specific to this product; they are not used in any other product.
-
-### Sender Address Field
-The address of the sender.
-
-A `UsMailV3SenderAddress` implements the following attributes:
-
-* `city` (String): The city of the sender's address.
-* `complete` (String): The complete address of the sender.
-* `postal_code` (String): The postal code of the sender's address.
-* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-* `street` (String): The street of the sender's address.
 
 # Attributes
 The following fields are extracted for US Mail V3:
@@ -129,7 +154,7 @@ puts result.document.inference.prediction.is_return_to_sender.value
 **recipient_addresses** (Array<[UsMailV3RecipientAddress](#recipient-addresses-field)>): The addresses of the recipients.
 
 ```rb
-for recipient_addresses_elem in result.document.inference.prediction.recipient_addresses do
+result.document.inference.prediction.recipient_addresses do |recipient_addresses_elem|
   puts recipient_addresses_elem.value
 end
 ```
@@ -138,7 +163,7 @@ end
 **recipient_names** (Array<[StringField](#string-field)>): The names of the recipients.
 
 ```rb
-for recipient_names_elem in result.document.inference.prediction.recipient_names do
+result.document.inference.prediction.recipient_names do |recipient_names_elem|
   puts recipient_names_elem.value
 end
 ```