mindee 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6802405a95660a531eb6a47c316a35813343aa8a045fec4ec20d1de42b12648
-  data.tar.gz: ceadc33d7e44f574d9657124ba17683c996af4f0433c94ccba165908899fe422
+  metadata.gz: f836bb72cfae4c43ad226be7bcbfc3e39606b4df6dae6ef9fece37ec0a957d4c
+  data.tar.gz: 155f5b82fe3e3fcecb17400040ad3543304b6dc6dbd94a9870ebc6b8b0dcf3bb
 SHA512:
-  metadata.gz: e5d6007f102875dffc6625fcee82f0ffc24427af33773ab7905c90a8be2da48cdeebeb94f3d110d352f6a1c07698606c34f57a7508c230c729a58725b2ad716c
-  data.tar.gz: c1fbfff08eca29a3d0e2d64d00f8b46fd6b85a6fa50b809dc9ba89e42ba999985b00b244a4ff10d2db34e66dbce2ab714afd811b8fa06b0c40c6f8b999beae99
+  metadata.gz: 87625c60d12034c9914e18acf6cf93e226cce1a3fac810849fb73d009964e825d933e9ea370e54c89a2d43e2fb5457c50dad7aab2183ad6ccc2645806749554f
+  data.tar.gz: c5a21cefe733fadb998c5ed051754f1e8193ea9682c0cf52fa32a8c7345cd45d89e27f1b02a9b062a1713197a6f2735ca7cfa462f3cd5d131a2b25a1de610939

data/.betterleaks.toml

@@ -0,0 +1,15 @@
+[extend]
+useDefault = true
+
+[[allowlists]]
+description = "RBS type signatures are not secrets"
+condition = "AND"
+regexTarget = "match"
+paths = ['''^sig/.*\.rbs$''']
+regexes = ['''password:\s*String\??''']
+
+[[allowlists]]
+description = "Dummy HMAC secret used in LocalResponse unit tests"
+condition = "AND"
+paths = ['''^spec/.*\.rb$''']
+regexes = ['''ogNjY44MhvKPGTtVsI8zG82JqWQa68woYQH''']

data/.editorconfig

@@ -12,7 +12,7 @@ trim_trailing_whitespace = false
 indent_style = space
 indent_size = 2
 
-[*.{yml,yaml,json}]
+[*.{yml,yaml,json,toml}]
 indent_style = space
 indent_size = 2
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Mindee Ruby API Library Changelog
 
+## v5.6.0 - 2026-11-04
+### Changes
+* coffin: remove dead v1 products and workflow methods
+* :sparkles: add get by URL methods
+
+
 ## v5.5.0 - 2026-09-30
 ### Changes
 * :sparkles: add support for RAG search

data/CONTRIBUTING.md

@@ -123,77 +123,37 @@ bundle exec rake spec
 
 ## Local Quality Checks
 
-We use [`overcommit`](https://github.com/sds/overcommit) to run quality and security checks before
-changes are committed and pushed. It is a development dependency of the gem, so `bundle install`
-already installed it. The hooks are configured in [`.overcommit.yml`](.overcommit.yml), and
-repository-local custom hooks live in [`.git-hooks`](.git-hooks).
+We use [`prek`](https://prek.j178.dev/) to run quality and security checks before changes are committed and pushed.
 
 The same checks run in CI, see
 [`.github/workflows/_static-analysis.yml`](.github/workflows/_static-analysis.yml).
 
-### Install `gitleaks`
-
-The `Gitleaks` pre-commit hook shells out to the
-[`gitleaks`](https://github.com/gitleaks/gitleaks) binary, which is not a gem and must be installed
-separately:
-
-```shell
-brew install gitleaks
-```
-
-Otherwise, grab a binary from the
-[releases page](https://github.com/gitleaks/gitleaks/releases) and put it on your `PATH`.
-
 ### Install the hooks
 
-Run this once, after cloning:
-
-```shell
-bundle exec overcommit --install
-bundle exec overcommit --sign
-bundle exec overcommit --sign pre-commit
-```
-
-`--install` writes the git hook stubs into `.git/hooks`, and the `--sign` calls tell overcommit you
-trust the current contents of `.overcommit.yml` and of the custom hooks in `.git-hooks`.
+https://prek.j178.dev/installation/
 
-### What runs, and when
-
-* **pre-commit:** merge conflict markers, YAML syntax, trailing whitespace, file size, `rubocop`,
-  `steep check` (type checking) and `gitleaks` (secret scanning).
-* **pre-push:** `bundle-audit` (dependency vulnerability check).
-
-### Run the hooks manually
+Then install the hooks:
 
 ```shell
-bundle exec overcommit --list-hooks         # show which hooks are enabled
-bundle exec overcommit --run                # run the pre-commit hooks on all tracked files
-bundle exec overcommit --run pre_push       # run the pre-push hooks
-bundle exec overcommit --diff main          # run the pre-commit hooks on the diff against main
+prek install
 ```
 
-### Skipping hooks
-
-Skip one or more hooks for a single run, by name:
+Now, when you run `git commit`, `prek` will automatically run the quality and security checks.
 
-```shell
-SKIP=Gitleaks,Steep git commit
-```
+### Run the hooks manually
 
-To bypass overcommit entirely (please use sparingly, CI runs the same checks):
+If you need to run the hooks manually, use the following command:
 
 ```shell
-OVERCOMMIT_DISABLE=1 git commit
+prek run --all-files
 ```
 
-### Troubleshooting
+### Skipping hooks
 
-If overcommit refuses to run and warns that the configuration or the hooks have changed, review the
-diff and then re-sign:
+Skip one or more hooks for a single run, by ID:
 
 ```shell
-bundle exec overcommit --sign
-bundle exec overcommit --sign pre-commit
+PREK_SKIP=rubocop
 ```
 
 ## Styleguides

data/bin/v1/products.rb

@@ -7,12 +7,6 @@ V1_PRODUCTS = {
     sync: true,
     async: true,
   },
-  'barcode-reader' => {
-    description: 'Barcode Reader',
-    doc_class: Mindee::V1::Product::BarcodeReader::BarcodeReaderV1,
-    sync: true,
-    async: false,
-  },
   'cropper' => {
     description: 'Cropper',
     doc_class: Mindee::V1::Product::Cropper::CropperV1,

data/lib/mindee/v1/client.rb

@@ -54,39 +54,6 @@ module Mindee
       end
     end
 
-    # Class for configuration options in workflow executions.
-    #
-    # @!attribute document_alias [String, nil] Alias to give to the document.
-    # @!attribute priority [Symbol, nil] Priority to give to the document.
-    # @!attribute full_text [bool] Whether to include the full OCR text response in compatible APIs.
-    #   This performs a full OCR operation on the server and may increase response time.
-    # @!attribute public_url [String, nil] A unique, encrypted URL for accessing the document validation interface
-    # without requiring authentication.
-    # @!attribute rag [bool, nil] Whether to enable Retrieval-Augmented Generation.
-    # @!attribute page_options [PageOptions, Hash, nil] Page cutting/merge options:
-    #   * `:page_indexes` Zero-based list of page indexes.
-    #   * `:operation` Operation to apply on the document, given the specified page indexes:
-    #       * `:KEEP_ONLY` - keep only the specified pages, and remove all others.
-    #       * `:REMOVE` - remove the specified pages, and keep all others.
-    #   * `:on_min_pages` Apply the operation only if the document has at least this many pages.
-    # @!attribute close_file [bool, nil] Whether to close the file after sending it. Defaults to true.
-    class WorkflowOptions
-      attr_accessor :document_alias, :priority, :full_text, :public_url, :page_options, :rag, :close_file
-
-      def initialize(params: {})
-        params = params.transform_keys(&:to_sym)
-        @document_alias = params.fetch(:document_alias, nil)
-        @priority = params.fetch(:priority, nil)
-        @full_text = params.fetch(:full_text, false)
-        @public_url = params.fetch(:public_url, nil)
-        @rag = params.fetch(:rag, nil)
-        raw_page_options = params.fetch(:page_options, nil)
-        raw_page_options = PageOptions.new(params: raw_page_options) unless raw_page_options.is_a?(PageOptions)
-        @page_options = raw_page_options
-        @close_file = params.fetch(:close_file, true)
-      end
-    end
-
     # Mindee API Client.
     # See: https://developers.mindee.com/docs
     class Client
@@ -219,7 +186,6 @@ module Mindee
         Mindee::V1::Parsing::Common::ApiResponse.new(product_class, prediction, raw_http)
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       # Enqueue a document for async parsing and automatically try to retrieve it
       #
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
@@ -250,7 +216,7 @@ module Mindee
       # @param endpoint [Mindee::V1::HTTP::Endpoint] Endpoint of the API.
       # @param cancellation_token [Mindee::HTTP::CancellationToken, nil] Token for cancellation.
       # @return [Mindee::V1::Parsing::Common::ApiResponse]
-      # rubocop:disable-next Metrics/PerceivedComplexity
+      # rubocop:disable-next Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def enqueue_and_parse(
         input_source,
         product_class,
@@ -294,45 +260,6 @@ module Mindee
         queue_res
       end
 
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # Sends a document to a workflow.
-      #
-      # Accepts options either as a Hash or as a WorkflowOptions struct.
-      #
-      # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-      # @param workflow_id [String]
-      # @param options [Hash, WorkflowOptions] Options to configure workflow behavior.  Possible keys:
-      #   * `document_alias` [String, nil] Alias to give to the document.
-      #   * `priority` [Symbol, nil] Priority to give to the document.
-      #   * `full_text` [bool] Whether to include the full OCR text response in compatible APIs.
-      #   * `rag` [bool, nil] Whether to enable Retrieval-Augmented Generation.
-      #
-      #   * `public_url` [String, nil] A unique, encrypted URL for accessing the document validation interface without
-      # requiring authentication.
-      #   * `page_options` [Hash, nil] Page cutting/merge options:
-      #     * `:page_indexes` Zero-based list of page indexes.
-      #       * `:operation` Operation to apply on the document, given the `page_indexes specified:
-      #          * `:KEEP_ONLY` - keep only the specified pages, and remove all others.
-      #          * `:REMOVE` - remove the specified pages, and keep all others.
-      #      * `:on_min_pages` Apply the operation only if document has at least this many pages.
-      # @return [Mindee::V1::Parsing::Common::WorkflowResponse]
-      def execute_workflow(input_source, workflow_id, options: {})
-        opts = options.is_a?(WorkflowOptions) ? options : WorkflowOptions.new(params: options)
-        if opts.respond_to?(:page_options) && input_source.is_a?(Input::Source::LocalInputSource)
-          process_pdf_if_required(input_source, opts)
-        end
-
-        workflow_endpoint = V1::HTTP::WorkflowEndpoint.new(workflow_id, api_key: @api_key.to_s)
-        logger.debug("Sending document to workflow '#{workflow_id}'")
-
-        prediction, raw_http = workflow_endpoint.execute_workflow(
-          input_source,
-          opts
-        )
-
-        Mindee::V1::Parsing::Common::WorkflowResponse.new(V1::Product::Universal::Universal, prediction, raw_http)
-      end
-
       # Load a prediction.
       #
       # @param product_class [Mindee::Inference] class of the product

data/lib/mindee/v1/http.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require_relative 'http/workflow_endpoint'
 require_relative 'http/endpoint'

data/lib/mindee/v1/product.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'product/barcode_reader/barcode_reader_v1'
 require_relative 'product/cropper/cropper_v1'
 require_relative 'product/financial_document/financial_document_v1'
-require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v2'
-require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/international_id/international_id_v2'
 require_relative 'product/invoice/invoice_v4'

data/lib/mindee/v2/client.rb

@@ -18,22 +18,7 @@ module Mindee
         @mindee_api = Mindee::V2::HTTP::MindeeApiV2.new(api_key: api_key)
       end
 
-      # Retrieves a result from a given queue or URL to the result.
-      # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
-      # @param resource [String] ID of the inference or URL to the result.
-      # @return [Mindee::V2::Parsing::BaseResponse]
-      def get_result(product, resource)
-        @mindee_api.req_get_result(product, resource)
-      end
-
-      # Retrieves an inference from a given queue or URL to the job.
-      # @param job_id [String] ID of the job.
-      # @return [Mindee::V2::Parsing::JobResponse]
-      def get_job(job_id)
-        @mindee_api.req_get_job(job_id)
-      end
-
-      # Enqueue a document for async parsing.
+      # Send a file to the asynchronous processing queue for inference.
       # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
       #   The source of the input document (local file or URL).
@@ -51,8 +36,40 @@ module Mindee
         @mindee_api.req_post_product_enqueue(input_source, normalized_params)
       end
 
-      # Enqueues to an asynchronous endpoint and automatically polls for a response.
-      #
+      # Get the status of an inference that was previously enqueued.
+      # Can be used for polling.
+      # @param url [String] HTTPS URL to the job.
+      # @return [Mindee::V2::Parsing::JobResponse]
+      def get_job_by_url(url)
+        @mindee_api.req_get_job_by_url(url)
+      end
+
+      # Get the result of an inference that was previously enqueued.
+      # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
+      # @param url [String] HTTPS URL to the result.
+      # @return [Mindee::V2::Parsing::BaseResponse]
+      def get_result_by_url(product, url)
+        @mindee_api.req_get_result_by_url(product, url)
+      end
+
+      # Get the result of an inference that was previously enqueued.
+      # Prefer using `get_result_by_url` using the result URL returned by the Job.
+      # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
+      # @param resource [String] ID of the inference or URL to the result.
+      # @return [Mindee::V2::Parsing::BaseResponse]
+      def get_result(product, resource)
+        @mindee_api.req_get_result_by_id(product, resource)
+      end
+
+      # Get the status of an inference that was previously enqueued.
+      # Prefer using `get_job_by_url` with the polling URL returned by enqueue.
+      # @param job_id [String] ID of the job.
+      # @return [Mindee::V2::Parsing::JobResponse]
+      def get_job(job_id)
+        @mindee_api.req_get_job_by_id(job_id)
+      end
+
+      # Send a file to the inference queue and return the results when complete.
       # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
       #   The source of the input document (local file or URL).
@@ -60,7 +77,7 @@ module Mindee
       # @param polling_options [Hash, PollingOptions, nil] Parameters for polling.
       # @param cancellation_token [Mindee::HTTP::CancellationToken, nil] Token for cancellation.
       # @return [Parsing::BaseResponse]
-      # rubocop:disable-next Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable-next Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       def enqueue_and_get_result(
         product,
         input_source,
@@ -84,29 +101,31 @@ module Mindee
 
         sleep(normalized_params.polling_options.initial_delay_sec)
         retry_counter = 1
-        poll_results = get_job(job_id)
+        polling_url = enqueue_response.job.polling_url
+
+        job_response = get_job_by_url(polling_url)
 
         while retry_counter < normalized_params.polling_options.max_retries
-          if poll_results.job.status == 'Failed'
+          if job_response.job.status == 'Failed'
             break
-          elsif !poll_results.job.result_url.nil?
-            return get_result(product, poll_results.job.result_url)
+          elsif !job_response.job.result_url.nil?
+            return get_result_by_url(product, job_response.job.result_url)
           end
 
           logger.debug(
             "Successfully enqueued inference with job id: #{job_id}.\n" \
             "Attempt n°#{retry_counter}/#{normalized_params.polling_options.max_retries}.\n" \
-            "Job status: #{poll_results.job.status}."
+            "Job status: #{job_response.job.status}."
           )
 
           raise Mindee::Error::MindeeError, 'Enqueueing of the document was canceled.' if cancellation_token&.canceled?
 
           sleep(normalized_params.polling_options.delay_sec)
-          poll_results = get_job(job_id)
+          job_response = get_job_by_url(polling_url)
           retry_counter += 1
         end
 
-        error = poll_results.job.error
+        error = job_response.job.error
         unless error.nil?
           err_to_raise = Mindee::Error::MindeeHTTPErrorV2.new(error)
           # NOTE: purposefully decoupled from the line above, otherwise rubocop thinks `error` is a `message` param.

data/lib/mindee/v2/http/mindee_api_v2.rb

@@ -33,30 +33,44 @@ module Mindee
         end
 
         # Retrieves a result from a given queue.
-        # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
-        # @param resource [String] ID of the inference or URL to the result.
+        # @param product [Class<Mindee::V2::Product::BaseProduct>]
+        # @param inference_id [String] ID of the inference or URL to the result.
         # @return [Mindee::V2::Parsing::BaseResponse]
-        def req_get_result(product, resource)
-          return req_get_result_url(product.response_type, resource) if uri?(resource)
-
-          @settings.check_api_key
-          response = result_req_get(
-            resource,
-            product
-          )
-          product.response_type.new(process_response(response))
+        def req_get_result_by_id(product, inference_id)
+          req_get_result_by_url(product, "#{@settings.base_url}/v2/products/#{product.slug}/results/#{inference_id}")
         end
 
         # Retrieves a queued job.
         #
         # @param job_id [String] ID of the job or URL to the job.
         # @return [Mindee::V2::Parsing::JobResponse]
-        def req_get_job(job_id)
+        def req_get_job_by_id(job_id)
+          req_get_job_by_url("#{@settings.base_url}/v2/jobs/#{job_id}")
+        end
+
+        # Retrieves a queued job from its polling URL.
+        #
+        # @param url [String] HTTPS URL to the job.
+        # @return [Mindee::V2::Parsing::JobResponse]
+        def req_get_job_by_url(url)
+          validate_https_url!(url)
           @settings.check_api_key
-          response = poll("#{@settings.base_url}/v2/jobs/#{job_id}")
+          response = poll(url)
           Mindee::V2::Parsing::JobResponse.new(process_response(response))
         end
 
+        # Retrieves a result from its URL.
+        #
+        # @param product [Class<Mindee::V2::Product::BaseProduct>]
+        # @param url [String] HTTPS URL to the result.
+        # @return [Mindee::V2::Parsing::BaseResponse]
+        def req_get_result_by_url(product, url)
+          validate_https_url!(url)
+          @settings.check_api_key
+          response = poll(url)
+          product.response_type.new(process_response(response))
+        end
+
         # Retrieves a list of resources with the given criteria.
         # @param params [ClientOptions::BaseSearchParameters] Search parameters.
         # @return [Mindee::V2::Parsing::Search::BaseSearchResponse] A search response containing the matching
@@ -85,35 +99,15 @@ module Mindee
 
         private
 
-        # @param resource [String] Resource to check.
-        # @return [Boolean]
-        def uri?(resource)
-          uri = URI.parse(resource)
-          throw Mindee::Error::MindeeError, 'HTTP is not supported.' if uri.scheme == 'http'
-          uri.scheme == 'https'
-        rescue URI::BadURIError, URI::InvalidURIError
-          false
-        end
-
-        # Retrieves a queued job.
-        #
-        # @param url [String]
-        # @return [Mindee::V2::Parsing::JobResponse]
-        def req_get_job_url(url)
-          @settings.check_api_key
-          response = poll(url)
-          Mindee::V2::Parsing::JobResponse.new(process_response(response))
-        end
-
-        # Retrieves a queued job.
+        # Validates that a URL uses HTTPS and includes a host.
         #
-        # @param result_class [Class<Mindee::V2::Parsing::BaseResponse>]
         # @param url [String]
-        # @return [Mindee::V2::Parsing::BaseResponse]
-        def req_get_result_url(result_class, url)
-          @settings.check_api_key
-          response = poll(url)
-          result_class.new(process_response(response))
+        # @return [void]
+        def validate_https_url!(url)
+          uri = URI.parse(url)
+          raise Mindee::Error::MindeeError, "Invalid URL: #{url}" unless uri.scheme == 'https' && !uri.host.to_s.empty?
+        rescue URI::BadURIError, URI::InvalidURIError
+          raise Mindee::Error::MindeeError, "Invalid URL: #{url}"
         end
 
         # Converts an HTTP response to a parsed response object.
@@ -156,15 +150,6 @@ module Mindee
           raise Mindee::Error::MindeeError, 'Could not resolve server response.'
         end
 
-        # Polls the API for the result of an inference.
-        #
-        # @param queue_id [String] ID of the queue.
-        # @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
-        # @return [Net::HTTPResponse]
-        def result_req_get(queue_id, product)
-          poll("#{@settings.base_url}/v2/products/#{product.slug}/results/#{queue_id}")
-        end
-
         # Handle parameters for the enqueue form
         # @param form_data [Array] Array of form fields
         # @param params [V2::Product::Extraction::Params::ExtractionParameters] Inference options.

data/lib/mindee/v2/product/classification/classification_classifier.rb

@@ -13,10 +13,11 @@ module Mindee
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @document_type = server_response['document_type']
-            # rubocop:disable-next Style/GuardClause
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           end
 
           # @return [String] String representation.

data/lib/mindee/v2/product/crop/crop_item.rb

@@ -16,10 +16,11 @@ module Mindee
           def initialize(server_response)
             @object_type = server_response['object_type']
             @location = Mindee::V2::Parsing::Field::FieldLocation.new(server_response['location'])
-            # rubocop:disable-next Style/GuardClause
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           end
 
           # String representation.

data/lib/mindee/v2/product/split/split_range.rb

@@ -17,10 +17,11 @@ module Mindee
           def initialize(server_response)
             @page_range = server_response['page_range']
             @document_type = server_response['document_type']
-            # rubocop:disable-next Style/GuardClause
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           end
 
           # String representation.

data/lib/mindee/v2/search/models/model_search_parameters.rb

@@ -4,16 +4,19 @@ module Mindee
   module V2
     module Search
       module Models
-        # Search parameters for models.
+        # Search for models within the organization linked to the API key.
+        # All search filters are optional.
+        # If no search filters are given, all models belonging to the organization are returned.
+        # Results are paginated.
         class ModelSearchParameters < Mindee::V2::ClientOptions::BaseSearchParameters
-          # @return [String, nil] Case-insensitive search term for the model name.
+          # @return [String, nil] Filter models by partial name match, case-insensitive.
           attr_reader :name
 
-          # @return [String, nil] Case-insensitive search term for the model type.
+          # @return [String, nil] Filter by an exact model type.
           attr_reader :model_type
 
-          # @param name [String, nil] Case-insensitive search term for the model name.
-          # @param model_type [String, nil] Case-insensitive search term for the model type.
+          # @param name [String, nil] Filter models by partial name match, case-insensitive.
+          # @param model_type [String, nil] Filter by an exact model type.
           # @param page [Integer, nil] 1-based page index.
           # @param per_page [Integer, nil] Number of items per page.
           def initialize(name: nil, model_type: nil, page: nil, per_page: nil)

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '5.5.0'
+  VERSION = '5.6.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/mindee.gemspec

@@ -37,9 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pdf-reader', '~> 2.15'
 
   spec.add_development_dependency 'bundle-audit', '~> 0.2.0'
-  spec.add_development_dependency 'overcommit', '~> 0.71'
   spec.add_development_dependency 'rbs', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.86'
+  spec.add_development_dependency 'rubocop', '~> 1.91.0'
   spec.add_development_dependency 'steep', '~> 1.10'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/prek.toml

@@ -0,0 +1,45 @@
+# Configuration file for `prek`, a git hook framework written in Rust.
+# See https://prek.j178.dev for more information.
+#:schema https://www.schemastore.org/prek.json
+
+[[repos]]
+repo = "builtin"
+hooks = [
+  { id = "trailing-whitespace" },
+  { id = "check-yaml" },
+  { id = "check-merge-conflict" },
+  { id = "check-added-large-files", args = ["--maxkb=1024"] },
+]
+
+[[repos]]
+repo = "https://github.com/betterleaks/betterleaks"
+rev = "v1.9.0"
+hooks = [
+  { id = "betterleaks" },
+]
+
+[[repos]]
+repo = "local"
+hooks = [
+  {
+    id = "rubocop",
+    name = "RuboCop",
+    entry = "bundle exec rubocop --force-exclusion --no-server",
+    language = "system",
+    types = ["ruby"]
+  },
+  {
+    id = "steep-check",
+    name = "Run Steep type checking",
+    entry = "bundle exec steep check",
+    language = "system",
+    pass_filenames = false
+  },
+  {
+    id = "bundle-audit",
+    name = "bundle-audit",
+    entry = "bundle exec bundle-audit check",
+    language = "system",
+    pass_filenames = false
+  },
+]