mindee 3.19.1 → 4.0.0

data/docs/code_samples/default.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -16,8 +21,9 @@ custom_endpoint = mindee_client.create_endpoint(
 # Parse the file
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::Generated::GeneratedV1,
-  endpoint: custom_endpoint
+  Mindee::Product::Universal::Universal,
+  endpoint: custom_endpoint,
+  enqueue: false
 )
 
 # Print a full summary of the parsed data in RST format

data/docs/code_samples/default_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -14,9 +19,9 @@ custom_endpoint = mindee_client.create_endpoint(
 )
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
-  Mindee::Product::Generated::GeneratedV1,
+  Mindee::Product::Universal::Universal,
   endpoint: custom_endpoint
 )
 

data/docs/code_samples/delivery_notes_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::DeliveryNote::DeliveryNoteV1
 )

data/docs/code_samples/driver_license_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::DriverLicense::DriverLicenseV1
 )

data/docs/code_samples/energy_bill_fra_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::EnergyBill::EnergyBillV1
 )

data/docs/code_samples/expense_receipts_v5.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -9,7 +14,8 @@ input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 # Parse the file
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::Receipt::ReceiptV5
+  Mindee::Product::Receipt::ReceiptV5,
+  enqueue: false
 )
 
 # Print a full summary of the parsed data in RST format

data/docs/code_samples/expense_receipts_v5_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::Receipt::ReceiptV5
 )

data/docs/code_samples/financial_document_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -9,7 +14,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

data/docs/code_samples/financial_document_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/french_healthcard_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::HealthCard::HealthCardV1
 )

data/docs/code_samples/idcard_fr_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client

data/docs/code_samples/idcard_fr_v2.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client

data/docs/code_samples/ind_passport_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::IND::IndianPassport::IndianPassportV1
 )

data/docs/code_samples/international_id_v2_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/invoice_splitter_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -6,7 +11,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
 )

data/docs/code_samples/invoices_v4.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -9,7 +14,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

data/docs/code_samples/invoices_v4_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/license_plates_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client

data/docs/code_samples/multi_receipts_detector_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client

data/docs/code_samples/nutrition_facts_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::NutritionFactsLabel::NutritionFactsLabelV1
 )

data/docs/code_samples/passport_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client

data/docs/code_samples/payslip_fra_v2_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::PayslipV2
 )

data/docs/code_samples/payslip_fra_v3_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/resume_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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::Resume::ResumeV1
 )

data/docs/code_samples/us_healthcare_cards_v1_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/us_mail_v3_async.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -7,7 +12,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
 )

data/docs/code_samples/us_w9_v1.txt

@@ -1,3 +1,8 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client