mindee 5.4.0 → 5.6.0

data/lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        module IdCard
-          # Carte Nationale d'Identité API version 1.1 document data.
-          class IdCardV1Document < Mindee::V1::Parsing::Common::Prediction
-            include Mindee::V1::Parsing::Standard
-
-            # The name of the issuing authority.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :authority
-            # The date of birth of the card holder.
-            # @return [Mindee::V1::Parsing::Standard::DateField]
-            attr_reader :birth_date
-            # The place of birth of the card holder.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :birth_place
-            # The expiry date of the identification card.
-            # @return [Mindee::V1::Parsing::Standard::DateField]
-            attr_reader :expiry_date
-            # The gender of the card holder.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :gender
-            # The given name(s) of the card holder.
-            # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
-            attr_reader :given_names
-            # The identification card number.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :id_number
-            # Machine Readable Zone, first line
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :mrz1
-            # Machine Readable Zone, second line
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :mrz2
-            # The surname of the card holder.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :surname
-
-            # @param prediction [Hash]
-            # @param page_id [Integer, nil]
-            def initialize(prediction, page_id)
-              super
-              @authority = Parsing::Standard::StringField.new(
-                prediction['authority'],
-                page_id
-              )
-              @birth_date = Parsing::Standard::DateField.new(
-                prediction['birth_date'],
-                page_id
-              )
-              @birth_place = Parsing::Standard::StringField.new(
-                prediction['birth_place'],
-                page_id
-              )
-              @expiry_date = Parsing::Standard::DateField.new(
-                prediction['expiry_date'],
-                page_id
-              )
-              @gender = Parsing::Standard::StringField.new(
-                prediction['gender'],
-                page_id
-              )
-              @given_names = [] # : Array[Parsing::Standard::StringField]
-              prediction['given_names'].each do |item|
-                @given_names.push(Parsing::Standard::StringField.new(item, page_id))
-              end
-              @id_number = Parsing::Standard::StringField.new(
-                prediction['id_number'],
-                page_id
-              )
-              @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
-              @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
-              @surname = Parsing::Standard::StringField.new(
-                prediction['surname'],
-                page_id
-              )
-            end
-
-            # @return [String]
-            def to_s
-              given_names = @given_names.join("\n #{' ' * 15}")
-              out_str = String.new
-              out_str << "\n:Identity Number: #{@id_number}".rstrip
-              out_str << "\n:Given Name(s): #{given_names}".rstrip
-              out_str << "\n:Surname: #{@surname}".rstrip
-              out_str << "\n:Date of Birth: #{@birth_date}".rstrip
-              out_str << "\n:Place of Birth: #{@birth_place}".rstrip
-              out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
-              out_str << "\n:Issuing Authority: #{@authority}".rstrip
-              out_str << "\n:Gender: #{@gender}".rstrip
-              out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
-              out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
-              out_str[1..].to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/fr/id_card/id_card_v1_page.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'id_card_v1_document'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        module IdCard
-          # Carte Nationale d'Identité API version 1.1 page data.
-          class IdCardV1Page < Mindee::V1::Parsing::Common::Page
-            # @param prediction [Hash]
-            def initialize(prediction)
-              super
-              @prediction = if prediction['prediction'].empty?
-                              nil
-                            else
-                              IdCardV1PagePrediction.new(
-                                prediction['prediction'],
-                                prediction['id']
-                              )
-                            end
-            end
-          end
-
-          # Carte Nationale d'Identité V1 page prediction.
-          class IdCardV1PagePrediction < IdCardV1Document
-            include Mindee::V1::Parsing::Standard
-
-            # The side of the document which is visible.
-            # @return [Mindee::V1::Parsing::Standard::ClassificationField]
-            attr_reader :document_side
-
-            # @param prediction [Hash]
-            # @param page_id [Integer, nil]
-            def initialize(prediction, page_id)
-              @document_side = Parsing::Standard::ClassificationField.new(
-                prediction['document_side'],
-                page_id
-              )
-              super
-            end
-
-            # @return [String]
-            def to_s
-              out_str = String.new
-              out_str << "\n:Document Side: #{@document_side}".rstrip
-              out_str << "\n#{super}"
-              out_str
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/input/base_parameters.rbs

@@ -1,36 +0,0 @@
-# lib/mindee/input/base_parameters.rb
-
-module Mindee
-  module Input
-    class BaseParameters
-      attr_reader self.slug: String
-
-      def self.from_hash: (params: Hash[String | Symbol, untyped]) -> BaseParameters
-      def self.load_from_hash: (params: Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
-
-      def slug: -> String
-
-      attr_reader model_id: String
-      attr_reader file_alias: String?
-      attr_reader webhook_ids: Array[String]?
-      attr_reader polling_options: PollingOptions
-      attr_reader close_file: bool
-
-      def initialize: (
-          String,
-          ?file_alias: String?,
-          ?webhook_ids: Array[String]?,
-          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions | nil,
-          ?close_file: bool?
-        ) -> void
-
-      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
-      def validate_async_params: () -> void
-      def polling_options=: (Hash[Symbol | String, untyped] | PollingOptions | nil) -> PollingOptions
-
-      private
-
-      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions | nil) -> PollingOptions
-    end
-  end
-end

data/sig/mindee/v1/http/workflow_endpoint.rbs

@@ -1,22 +0,0 @@
-# lib/mindee/v1/http/workflow_endpoint.rb
-module Mindee
-  module V1
-    module HTTP
-      class WorkflowEndpoint
-        def api_key: -> String
-
-        def request_timeout: -> Integer
-
-        def url: -> String
-
-        def initialize: (untyped, ?api_key: String) -> String
-
-        def execute_workflow: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> [Hash[String, untyped], String]
-
-        def workflow_execution_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> Net::HTTPResponse?
-
-        def check_api_key: -> nil
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1.rbs

@@ -1,13 +0,0 @@
-# lib/mindee/v1/product/barcode_reader/barcode_reader_v1.rb
-
-module Mindee
-  module V1
-    module Product
-    module BarcodeReader
-      class BarcodeReaderV1 < Parsing::Common::Inference
-        def initialize: (Hash[String | Symbol, untyped]) -> void
-      end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rbs

@@ -1,16 +0,0 @@
-# lib/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rb
-
-module Mindee
-  module V1
-    module Product
-    module BarcodeReader
-      class BarcodeReaderV1Document < Parsing::Common::Prediction
-        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-        def codes_1d: -> (Array[Parsing::Standard::StringField])
-        def codes_2d: -> (Array[Parsing::Standard::StringField])
-        def to_s: -> String
-      end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1_page.rbs

@@ -1,17 +0,0 @@
-# lib/mindee/v1/product/barcode_reader/barcode_reader_v1_page.rb
-
-module Mindee
-  module V1
-    module Product
-    module BarcodeReader
-      class BarcodeReaderV1Page < Parsing::Common::Page
-        def initialize: (Hash[String | Symbol, untyped]) -> void
-      end
-      class BarcodeReaderV1PagePrediction < BarcodeReaderV1Document
-        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-        def to_s: -> String
-      end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1.rbs

@@ -1,15 +0,0 @@
-# lib/mindee/v1/product/bank_account_details/bank_account_details_v1.rb
-
-module Mindee
-  module V1
-    module Product
-    module FR
-      module BankAccountDetails
-        class BankAccountDetailsV1 < Parsing::Common::Inference
-          def initialize: (Hash[String | Symbol, untyped]) -> void
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_document.rbs

@@ -1,19 +0,0 @@
-# lib/mindee/v1/product/bank_account_details/bank_account_details_v1_document.rb
-
-module Mindee
-  module V1
-    module Product
-    module FR
-      module BankAccountDetails
-        class BankAccountDetailsV1Document < Parsing::Common::Prediction
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def account_holder_name: -> (Parsing::Standard::StringField)
-          def iban: -> (Parsing::Standard::StringField)
-          def swift: -> (Parsing::Standard::StringField)
-          def to_s: -> String
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_page.rbs

@@ -1,19 +0,0 @@
-# lib/mindee/v1/product/bank_account_details/bank_account_details_v1_page.rb
-
-module Mindee
-  module V1
-    module Product
-    module FR
-      module BankAccountDetails
-        class BankAccountDetailsV1Page < Parsing::Common::Page
-          def initialize: (Hash[String | Symbol, untyped]) -> void
-        end
-        class BankAccountDetailsV1PagePrediction < BankAccountDetailsV1Document
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def to_s: -> String
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/id_card/id_card_v1.rbs

@@ -1,15 +0,0 @@
-# lib/mindee/v1/product/id_card/id_card_v1.rb
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        module IdCard
-          class IdCardV1 < Parsing::Common::Inference
-            def initialize: (Hash[String | Symbol, untyped]) -> void
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/id_card/id_card_v1_document.rbs

@@ -1,26 +0,0 @@
-# lib/mindee/v1/product/id_card/id_card_v1_document.rb
-
-module Mindee
-  module V1
-    module Product
-    module FR
-      module IdCard
-        class IdCardV1Document < Parsing::Common::Prediction
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def authority: -> (Parsing::Standard::StringField)
-          def birth_date: -> (Parsing::Standard::DateField)
-          def birth_place: -> (Parsing::Standard::StringField)
-          def expiry_date: -> (Parsing::Standard::DateField)
-          def gender: -> (Parsing::Standard::StringField)
-          def given_names: -> (Array[Parsing::Standard::StringField])
-          def id_number: -> (Parsing::Standard::StringField)
-          def mrz1: -> (Parsing::Standard::StringField)
-          def mrz2: -> (Parsing::Standard::StringField)
-          def surname: -> (Parsing::Standard::StringField)
-          def to_s: -> String
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/v1/product/fr/id_card/id_card_v1_page.rbs

@@ -1,20 +0,0 @@
-# lib/mindee/v1/product/id_card/id_card_v1_page.rb
-
-module Mindee
-  module V1
-    module Product
-    module FR
-      module IdCard
-        class IdCardV1Page < Parsing::Common::Page
-          def initialize: (Hash[String | Symbol, untyped]) -> void
-        end
-        class IdCardV1PagePrediction < IdCardV1Document
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def document_side: -> Parsing::Standard::ClassificationField
-          def to_s: -> String
-          end
-        end
-      end
-    end
-  end
-end