✨ add support for Bank Account Details V2 & product refacto (#40)

- ♻️ refacto & add wrapper class for prediction pages
- ♻️ uniformization of already existing prediction classes to match generated output
- ♻️ updated tests to match new implementation
- ✨ add support for bank_account_details v2

Author: sebastianMindee

README.md

@@ -32,7 +32,7 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 result = mindee_client.parse(
   input_source,
@@ -50,7 +50,7 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 result = mindee_client.parse(
@@ -73,7 +73,7 @@ endpoint = mindee_client.create_endpoint(
   account_name: 'my-account'
 )
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 result = mindee_client.parse(

docs/code_samples/bank_account_details_v2.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.parse(
+  input_source,
+  Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2
+)
+
+# 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

docs/code_samples/custom_v1.txt

@@ -3,7 +3,7 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Initialize a custom endpoint for this product
@@ -12,7 +12,7 @@ custom_endpoint = mindee_client.create_endpoint(
   endpoint_name: 'my-endpoint'
 )
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::Custom::CustomV1,

docs/code_samples/expense_receipts_v4.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::Receipt::ReceiptV4

docs/code_samples/expense_receipts_v5.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::Receipt::ReceiptV5

docs/code_samples/financial_document_v1.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::FinancialDocument::FinancialDocumentV1

docs/code_samples/idcard_fr_v1.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::FR::IdCard::IdCardV1

docs/code_samples/invoices_v4.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::Invoice::InvoiceV4

docs/code_samples/license_plates_v1.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::EU::LicensePlate::LicensePlateV1

docs/code_samples/passport_v1.txt

@@ -3,10 +3,10 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
+# Load a file from disk
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Send our document
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::Passport::PassportV1