mindee 3.20.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ac099d28439b6b41128226d0ef764b98fb5dfd290f36b9e7406b94f5bace85
-  data.tar.gz: 5ce4b7983bc953a9e26976eedf28674e5854a5e1280261c711d213ee6912a6a9
+  metadata.gz: 6f26259f4793d7a6c22538752dccf0c509298fa6223c53b1ecbe7655e6097faa
+  data.tar.gz: 96033b30171bee1e5117a64460fedecbdbbe86e950704875bb0d3eb03e66c05e
 SHA512:
-  metadata.gz: 2fc033f2699ab4eafd13cbe7dc54c93c162bca731f39fd0efb7a79ff0110cd4184d60343121eb6ef517dd85b281af92ce4ef55232ddb4a05dcf4cd4b5522ec49
-  data.tar.gz: 5de541e8d42968c167731d555b51502b6a01a55daeb8e6b1c2c408892d1d511f9c2b553abfd2cd3f79ba1ccc16ffb2af7d7c50f1fae630336a4d7f511a022587
+  metadata.gz: c8e51951deec5d25e5c19a0448cb055e0531e59836d2b21d0b51a019155adfe100582ba636fd2e14233f146cefdafcfc04a55435b02db508efff9d9a6774ce50
+  data.tar.gz: 816b54d06da35b3075d0f353bb330b5cc1ef8a42e6669161f9db48b2148b86f0e02f6a205c38bba952e67777d3a7b604b14c73249af3cb6cd888f52834e05277

data/.rubocop.yml

@@ -8,8 +8,9 @@ AllCops:
     - 'bin/*'
     - _test.rb
     - local_test/*
+    - Steepfile
 
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   SuggestExtensions: false
 
 Gemspec/DevelopmentDependencies:

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Mindee Ruby API Library Changelog
 
+## v4.0.0 - 2025-02-27
+### ¡Breaking Changes!
+* :boom: drop support for ruby versions < 3.0
+* :boom: refactor error-handling
+* :boom: merge enqueue_and_parse() into parse()
+* :boom: allow access to page-level extras, even when the page predictions are empty
+* :boom: deprecate CustomV1 & GeneratedV1 in favor of Universal
+### Changes
+* :sparkles: add support for logging
+* :sparkles: add typing support through RBS
+* :sparkles: add support for multiple feature classes, inheriting from Array
+* :recycle: refactor internal modules
+* :recycle: refactor test module
+* :coffin: remove support for US Mail V2
+* :coffin: remove support for FR Bank Statement V1
+* :recycle: update `UrlInputSource` to `URLInputSource`
+* :memo: update documentation structure
+### Fixes
+* :bug: fix miscellaneous bugs relating to image extraction
+* :bug: fix miscellaneous bugs relating to pdf extraction
+* :bug: fix improper saving mechanism
+
+
 ## v3.20.0 - 2025-02-26
 ### Changes
 * :sparkles: add support for FR Banks Statement V2

data/README.md

@@ -6,7 +6,7 @@ Quickly and easily connect to Mindee's API services using Ruby.
 
 ## Requirements
 
-The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1, 3.2
+The following Ruby versions are tested and supported: 3.0, 3.1, 3.2, 3.3, 3.4
 
 ## Quick Start
 
@@ -39,15 +39,18 @@ specific reason. Accidentally overwriting them can lead to unexpected behavior.
 Before making any changes, we recommend reviewing the following information to understand the purpose and potential
 impact of each environment variable:
 
-* `MINDEE_API_KEY`: 
-  * **Description**: Your personal Mindee API Key as shown on the platform. Be careful not to show this publicly!
-  * **Default Value**: `nil`
+* `MINDEE_API_KEY`:
+    * **Description**: Your personal Mindee API Key as shown on the platform. Be careful not to show this publicly!
+    * **Default Value**: `nil`
 * `MINDEE_BASE_URL`:
-  * **Description**: The default base URL of the API endpoint. Use this variable to specify the root URL for API requests. Modify as needed for proxy configurations or changes in API endpoint location.
-  * **Default Value**: `https://api.mindee.net/v1`
+    * **Description**: The default base URL of the API endpoint. Use this variable to specify the root URL for API requests. Modify as needed for proxy configurations or changes in API endpoint location.
+    * **Default Value**: `https://api.mindee.net/v1`
 * `MINDEE_REQUEST_TIMEOUT`:
-  * **Description**: The default timeout for HTTP requests (in seconds).
-  * **Default Value**: `120`
+    * **Description**: The default timeout for HTTP requests (in seconds).
+    * **Default Value**: `120`
+* `MINDEE_LOG_LEVEL`:
+    * **Description**: The default logging level for the mindee logger.
+    * **Default Value**: `WARN`
 
 ### Loading a File and Parsing It
 
@@ -62,8 +65,8 @@ 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.parse(
-  input_source,
-  Mindee::Product::Invoice::InvoiceV4
+        input_source,
+        Mindee::Product::Invoice::InvoiceV4
 )
 
 # Print a full summary of the parsed data in RST format
@@ -108,15 +111,17 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 result = mindee_client.parse(
-  input_source,
-  Mindee::Product::EU::LicensePlate::LicensePlateV1
+        input_source,
+        Mindee::Product::EU::LicensePlate::LicensePlateV1
 )
 
 # Print a full summary of the parsed data in RST format
 puts result.document
 ```
 
-### Custom Documents (docTI & Custom APIs)
+### Universal - All Other Documents
+
+The Universal product acts as a catch-all for every and any API if it doesn't have an assigned product name.
 
 ```ruby
 require 'mindee'
@@ -131,9 +136,9 @@ endpoint = mindee_client.create_endpoint(
 # 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::Generated::GeneratedV1,
+  Mindee::Product::Universal::Universal,
   endpoint: endpoint
 )
 
@@ -147,15 +152,10 @@ 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.
 
+## Enqueueing and Parse a Webhook Response
 
-### Enqueue and Parse a Webhook Response
 This is an optional way of handling asynchronous APIs.
 
 ```rb
@@ -168,7 +168,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
+# Send the file to the server
 enqueue_response = mindee_client.enqueue(
   input_source,
   Mindee::Product::InternationalId::InternationalIdV2
@@ -225,28 +225,9 @@ There's more to it than that for those that need more features, or want to
 customize the experience.
 
 * [Ruby Overview](https://developers.mindee.com/docs/ruby-getting-started)
-* [Custom OCR Ruby (Deprecated)](https://developers.mindee.com/docs/ruby-api-builder-ocr)
-* [Generated API Ruby](https://developers.mindee.com/docs/ruby-generated-ocr)
-* [Invoice OCR Ruby](https://developers.mindee.com/docs/ruby-invoice-ocr)
-* [International Id OCR Ruby](https://developers.mindee.com/docs/ruby-international-id-ocr)
-* [Financial Document OCR Ruby](https://developers.mindee.com/docs/ruby-financial-document-ocr)
-* [Passport OCR Ruby](https://developers.mindee.com/docs/ruby-passport-ocr)
-* [Proof of Address OCR Ruby](https://developers.mindee.com/docs/ruby-proof-of-address-ocr)
-* [Receipt OCR Ruby](https://developers.mindee.com/docs/ruby-receipt-ocr)
-* [Resume OCR Ruby](https://developers.mindee.com/docs/ruby-resume-ocr)
-* [EU License Plate OCR Ruby](https://developers.mindee.com/docs/ruby-eu-license-plate-ocr)
-* [EU Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-eu-driver-license-ocr)
-* [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-account-details-ocr)
-* [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-statement-ocr)
-* [FR Health Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-health-card-ocr)
-* [FR ID Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-nationale-didentite-ocr)
-* [US Bank Check OCR Ruby](https://developers.mindee.com/docs/ruby-us-bank-check-ocr)
-* [US Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-us-driver-license-ocr)
-* [US W9 API Ruby](https://developers.mindee.com/docs/ruby-us-w9-ocr)
-* [Barcode Reader API Ruby](https://developers.mindee.com/docs/ruby-barcode-reader-ocr)
-* [Cropper API Ruby](https://developers.mindee.com/docs/ruby-cropper-ocr)
-* [Invoice Splitter API Ruby](https://developers.mindee.com/docs/ruby-invoice-splitter-ocr)
-* [Multi Receipts Detector API Ruby](https://developers.mindee.com/docs/ruby-multi-receipts-detector-ocr)
+* [Common file operations](https://developers.mindee.com/docs/ruby-common-file-operations)
+* [Global products](https://developers.mindee.com/docs/ruby-global-products)
+* [Localized products](https://developers.mindee.com/docs/ruby-localized-products)
 
 You can also take a look at the
 [Reference Documentation](https://mindee.github.io/mindee-api-ruby/).

data/Steepfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature 'sig/custom/*.rbs'
+  signature 'sig/mindee/**/*.rbs'
+
+  check 'lib/mindee/**/*.rb'
+  # check 'bin' # CLI files are ignored
+
+  # NOTE: Steep does not support some libraries:
+  # - net/http.
+  # - marcel
+  # - mini_magick
+  # - origami (my bad)
+  # Do NOT enable them.
+  # Use the stubs located at sig/custom/<library_name>.rbs instead.
+  library 'date'
+  library 'fileutils'
+  library 'logger'
+  library 'json'
+  library 'openssl'
+  library 'pathname'
+  library 'tempfile'
+  library 'time'
+  library 'uri'
+
+  configure_code_diagnostics(D::Ruby.default) # `default` diagnostics setting (applies by default)
+end
+

data/bin/mindee.rb

@@ -5,26 +5,13 @@ require 'bundler/setup'
 require 'optparse'
 require 'mindee'
 
-options = {}
 DOCUMENTS = {
-  "custom" => {
-    description: "Custom document type from API builder",
-    doc_class: Mindee::Product::Custom::CustomV1,
-    sync: true,
-    async: false,
-  },
-  "generated" => {
-    description: "Generated document type from API builder",
-    doc_class: Mindee::Product::Generated::GeneratedV1,
+  "universal" => {
+    description: "Universal document type from API builder",
+    doc_class: Mindee::Product::Universal::Universal,
     sync: true,
     async: true,
   },
-  "proof-of-address" => {
-    description: 'Proof of Address',
-    doc_class: Mindee::Product::ProofOfAddress::ProofOfAddressV1,
-    sync: true,
-    async: false,
-  },
   "cropper" => {
     description: 'Cropper',
     doc_class: Mindee::Product::Cropper::CropperV1,
@@ -79,12 +66,6 @@ DOCUMENTS = {
     sync: true,
     async: false,
   },
-  "eu-driver-license" => {
-    description: "EU Driver License",
-    doc_class: Mindee::Product::EU::DriverLicense::DriverLicenseV1,
-    sync: true,
-    async: false,
-  },
   "fr-bank-account-details" => {
     description: "FR Bank Account Details",
     doc_class: Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2,
@@ -93,7 +74,7 @@ DOCUMENTS = {
   },
   "fr-bank-statement" => {
     description: "FR Bank Statement",
-    doc_class: Mindee::Product::FR::BankStatement::BankStatementV1,
+    doc_class: Mindee::Product::FR::BankStatement::BankStatementV2,
     sync: false,
     async: true,
   },
@@ -121,12 +102,6 @@ DOCUMENTS = {
     sync: true,
     async: false,
   },
-  "us-driver-license" => {
-    description: "US Driver License",
-    doc_class: Mindee::Product::US::DriverLicense::DriverLicenseV1,
-    sync: true,
-    async: false,
-  },
   "us-heathcare-card" => {
     description: "US Healthcare Card",
     doc_class: Mindee::Product::US::HealthcareCard::HealthcareCardV1,
@@ -148,13 +123,8 @@ DOCUMENTS = {
 }
 
 options = {}
-DEFAULT_CUTTING = {
-  page_indexes: [0, 1, 2, 3, 4],
-  operation: :KEEP_ONLY,
-  on_min_pages: 0,
-}
 
-# Initializes custom & generated-specific options
+# Initializes universal-specific options
 # @param cli_parser [OptionParser]
 def custom_subcommand(cli_parser, options)
   cli_parser.on('-v [VERSION]', '--version [VERSION]', 'Model version for the API') do |v|
@@ -171,7 +141,7 @@ DOCUMENTS.each do |doc_key, doc_value|
     opts.on('-w', '--all-words', 'Include words in response') do |v|
       options[:all_words] = v
     end
-    opts.on('-c', '--cut-pages', "Don't cut document pages") do |v|
+    opts.on('-c', '--cut-pages', "Cut document pages") do |v|
       options[:cut_pages] = v
     end
     opts.on('-k [KEY]', '--key [KEY]', 'API key for the endpoint') do |v|
@@ -181,12 +151,10 @@ DOCUMENTS.each do |doc_key, doc_value|
       options[:print_full] = true
     end
     opts.on('-F', '--fix-pdf', "Attempts to fix broken PDF files before sending them to the server.") do |v|
-      options[:fix_pdf] = true
+      options[:repair_pdf] = true
     end
-    if (doc_key != 'custom' && doc_key != 'generated')
-      opts.banner = "Product: #{doc_value[:description]}. \nUsage: mindee.rb #{doc_key} [options] file"
-    else
-      opts.banner = "#{doc_value[:description]}. \nUsage: \nmindee.rb custom [options] endpoint_name file\nor\nmindee.rb generated [options] endpoint_name file"
+    if doc_key != 'universal'
+      opts.banner = "#{doc_value[:description]}. \nUsage: \nmindee.rb universal [options] endpoint_name file\nor\nmindee.rb universal [options] endpoint_name file"
       custom_subcommand(opts, options)
     end
     if doc_value[:async]
@@ -206,13 +174,13 @@ global_parser = OptionParser.new do |opts|
 end
 
 command = ARGV.shift
-if !DOCUMENTS.include?(command)
+unless DOCUMENTS.include?(command)
   abort(global_parser.help)
 end
 doc_class = DOCUMENTS[command][:doc_class]
 product_parser[command].parse!
 
-if command == 'custom' || command == 'generated'
+if command == 'universal'
   if ARGV.length < 2
     $stderr.puts "The '#{command}' command requires both ENDPOINT_NAME and file arguments."
     abort(product_parser[command].help)
@@ -229,13 +197,13 @@ else
 end
 
 mindee_client = Mindee::Client.new(api_key: options[:api_key])
-if (options[:file_path].start_with?("https://"))
+if options[:file_path].start_with?("https://")
   input_source = mindee_client.source_from_url(options[:file_path])
 else
-  input_source = mindee_client.source_from_path(options[:file_path], fix_pdf: options[:fix_pdf])
+  input_source = mindee_client.source_from_path(options[:file_path], repair_pdf: options[:repair_pdf])
 end
 
-if command == 'custom' || command == 'generated'
+if command == 'universal'
   custom_endpoint = mindee_client.create_endpoint(
     endpoint_name: endpoint_name,
     account_name: options[:account_name],
@@ -245,7 +213,16 @@ else
   custom_endpoint = nil
 end
 
-page_options = options[:cut_pages].nil? ? nil : default_cutting
+if options[:cut_pages].nil? || !options[:cut_pages].is_a?(Integer) || options[:cut_pages] < 0
+  page_options = options[:cut_pages].nil?
+else
+  page_options = Mindee::PageOptions.new(params: {
+    page_indexes: (0..options[:cut_pages].to_i).to_a,
+    operation: :KEEP_ONLY,
+    on_min_pages: 0,
+  })
+end
+
 if options[:parse_async].nil?
   if !DOCUMENTS[command][:sync]
     options[:parse_async] = true
@@ -253,21 +230,12 @@ if options[:parse_async].nil?
     options[:parse_async] = false
   end
 end
-if options[:parse_async]
-  result = mindee_client.enqueue_and_parse(
-    input_source,
-    DOCUMENTS[command][:doc_class],
-    endpoint: custom_endpoint,
-    page_options: page_options,
-  )
-else
-  result = mindee_client.parse(
-    input_source,
-    DOCUMENTS[command][:doc_class],
-    endpoint: custom_endpoint,
-    page_options: page_options,
-  )
-end
+result = mindee_client.parse(
+  input_source,
+  doc_class,
+  options: { endpoint: custom_endpoint,
+             options: Mindee::ParseOptions.new(params: { page_options: page_options }), enqueue: options[:parse_async] }
+)
 
 if options[:print_full]
   puts result.document

data/docs/advanced_file_operations.md

@@ -0,0 +1,111 @@
+---
+title: Advanced File Operations
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-advanced-file-operations
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+
+> ❗️ Disclaimer: the file operations listed below do not directly manipulate the files you will pass to the library,
+> they will instead create a copy before applying any operations, which means that the file you send may not be an
+> exact copy of the file the server will receive.
+> To avoid any unexpected or unwanted result, you can save a copy of the created file locally to inspect it visually
+> before sending it.
+
+## Image compression
+
+The compression functionality for image files (JPEG, PNG, etc.) via the `compress!` method available on a
+LocalInputSource. This method allows you to reduce file size by specifying quality and dimension constraints.
+
+Example:
+
+```rb
+# Compress an image with custom parameters.
+input_source.compress!(quality: 85, max_width: 1024, max_height: 768)
+```
+> ⚠️ Warning: Compression alters the original image data.
+> We strongly advise you inspect a compressed file before sending it:
+> ```rb
+> # Compress using a quality of 50%:
+> input_source.compress!(quality: 50)
+> input_source.write_to_file('path/to/my/compressed/file_50.jpg')
+> ```
+
+For reference, here's what the following levels of compression on this image will look like:
+
+Original:
+![Invoice sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg?raw=true)
+
+
+85% compressed:
+![85% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_85.jpg?raw=true)
+
+50% compressed:
+![50% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_50.jpg?raw=true)
+
+10% compressed:
+![10% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_10.jpg?raw=true)
+
+
+## PDF operations
+
+PDF operations include both compression and fixing features.
+These are specifically designed to handle challenges associated with PDF files, such as large file sizes and formatting
+issues.
+
+### PDF compression
+
+> 🧪 PDF compression is an **experimental** feature that rasterizes each page of the PDF (similar to how images are
+> compressed) to reduce its overall size.
+> 
+> Because the process involves re-rendering the PDF’s contents, some source text may be lost or rendered differently.
+> Use this feature with caution.
+
+
+```rb
+# Load a local input source.
+input_file_path = "path/to/your/file.pdf"
+output_file_path = "path/to/the/compressed/file.pdf"
+pdf_input = Mindee::Input::Source::PathInputSource.new(input_file_path)
+
+# We advise you test the quality value yourself, as results may vary greatly depending on the input file
+pdf_input.compress!(quality: 50)
+
+# Write the output file locally for visual checking:
+File.write(output_file_path, pdf_input.io_stream.read)
+```
+
+> 🚧 Be warned that the source text (the text embedded in the PDF itself) might not render properly,
+> and so source PDFs will be ignored by default.
+> You can bypass this using:
+
+```rb
+pdf_input.compress!(quality: 50, force_source_text: true)
+```
+
+Or alternatively, you can try to approximate the re-rendering of the source-text using:
+
+```rb
+pdf_input.compress!(quality: 50, force_source_text: true, disable_source_text: false)
+```
+
+### PDF Repair
+
+The PDF repair feature attempts to rescue PDFs with invalid or broken header information.
+This can sometimes help when files get rejected by the server.
+
+Example:
+```rb
+# Load a PDF file with the repair_pdf flag enabled.
+input_source = mindee_client.source_from_file(file, "document.pdf", repair_pdf: true)
+```
+
+> ⚠️ Warning: PDF fixing alters the input file by re-writing header information.
+> Use this feature only when required, as it might affect the integrity of the document file.
+
+---
+
+Feel free to expand these examples and adjust the parameters as needed for your projects. For further details on
+authentication and usage, you can refer to the [Getting Started Guide](getting_started.md).
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/code_samples/bank_account_details_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/bank_account_details_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/bank_check_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/bank_statement_fr_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::BankStatement::BankStatementV2
 )

data/docs/code_samples/barcode_reader_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/bill_of_lading_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::BillOfLading::BillOfLadingV1
 )

data/docs/code_samples/business_card_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::BusinessCard::BusinessCardV1
 )

data/docs/code_samples/carte_grise_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/cropper_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/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
 )