didit-sdk 1.0.0

data/lib/didit/resources/workflows.rb

@@ -0,0 +1,214 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +workflows+ resource.
+    class Workflows < Didit::Resource
+      # Create workflow
+      #
+      # Create a simple workflow. Send `features` in execution order (ordering rules apply); defaults to `published`
+      # v1. The body accepts ONLY the fields listed in `SimpleWorkflowRequest` - any other key (including
+      # `workflow_type`) is rejected with a 400. Not idempotent - each call creates a new workflow. Maximum 50
+      # workflows per application.
+      #
+      # +POST /v3/workflows/+
+      #
+      # @param features [Array<Hash>] Verification features in execution order. The API links each item to the next
+      #   one and adds one final status node automatically.
+      # @param workflow_label [String] Display name for the workflow (max 50 characters). Defaults to `"ID
+      #   Verification"` when omitted - always set it so workflows stay distinguishable.
+      # @param is_default [Boolean] Set this workflow as the default for new sessions.
+      # @param status [String] Omit this field to create a published workflow ready for sessions. Use `draft` only
+      #   when you want to save without publishing.
+      # @param is_white_label_enabled [Boolean] Enable white-label customization for sessions created with this
+      #   workflow.
+      # @param is_desktop_allowed [Boolean] Allow the verification flow to run on desktop browsers.
+      # @param max_retry_attempts [Integer] Maximum retry attempts allowed after a declined verification. `0` blocks
+      #   the user after the first decline.
+      # @param retry_window_days [Integer, nil] Rolling window in days used to count retries. `null` enforces an
+      #   all-time limit.
+      # @param face_liveness_max_attempts [Integer] Maximum liveness submissions per session. Default 3: one initial
+      #   attempt plus two retries. This value is also copied into generated liveness and age-estimation workflow nodes
+      #   unless the feature-level config overrides it.
+      # @param face_match_max_attempts [Integer] Maximum face-match submissions per session. Default 3: one initial
+      #   attempt plus two retries. This value is also copied into generated face-match workflow nodes unless the
+      #   feature-level config overrides it.
+      # @param session_expiration_time [Integer] Seconds before an unfinished session expires. Minimum 1 hour (3600),
+      #   maximum 4 weeks (2419200).
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::WorkflowDetail]
+      def create(
+        features:,
+        workflow_label: OMIT,
+        is_default: OMIT,
+        status: OMIT,
+        is_white_label_enabled: OMIT,
+        is_desktop_allowed: OMIT,
+        max_retry_attempts: OMIT,
+        retry_window_days: OMIT,
+        face_liveness_max_attempts: OMIT,
+        face_match_max_attempts: OMIT,
+        session_expiration_time: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :post,
+          "/v3/workflows/",
+          body: {
+            "features" => features,
+            "workflow_label" => workflow_label,
+            "is_default" => is_default,
+            "status" => status,
+            "is_white_label_enabled" => is_white_label_enabled,
+            "is_desktop_allowed" => is_desktop_allowed,
+            "max_retry_attempts" => max_retry_attempts,
+            "retry_window_days" => retry_window_days,
+            "face_liveness_max_attempts" => face_liveness_max_attempts,
+            "face_match_max_attempts" => face_match_max_attempts,
+            "session_expiration_time" => session_expiration_time
+          },
+          response: Types::WorkflowDetail,
+          request_options: request_options
+        )
+      end
+
+      # Delete workflow
+      #
+      # Permanently delete one workflow version (no undo). Existing sessions keep their verification results but their
+      # workflow reference is cleared; other versions in the same `workflow_id` group are not deleted.
+      #
+      # +DELETE /v3/workflows/{settings_uuid}/+
+      #
+      # @param settings_uuid [String] Per-version UUID of the workflow to delete.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [nil]
+      def delete(settings_uuid, request_options: nil)
+        @client.request(
+          :delete,
+          "/v3/workflows/{settings_uuid}/",
+          path_params: { "settings_uuid" => settings_uuid },
+          request_options: request_options
+        )
+      end
+
+      # List workflows
+      #
+      # List your workflows, newest first, in a limit/offset pagination envelope (`{count, next, previous, results}`,
+      # default page size 50). Each row is one version; `workflow_id` is the stable group ID and new sessions use the
+      # latest `published` version.
+      #
+      # +GET /v3/workflows/+
+      #
+      # @param limit [Integer] Page size (number of workflows per page).
+      # @param offset [Integer] Number of rows to skip before the first returned workflow.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Page<Didit::Types::WorkflowListItem>]
+      def list(limit: OMIT, offset: OMIT, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/workflows/",
+          query: {
+            "limit" => limit,
+            "offset" => offset
+          },
+          page: Types::WorkflowListItem,
+          request_options: request_options
+        )
+      end
+
+      # Get workflow
+      #
+      # Fetch full configuration for one workflow version by `settings_uuid`: feature toggles, thresholds, allowed
+      # documents, graph, retry policy, callbacks, and pricing.
+      #
+      # +GET /v3/workflows/{settings_uuid}/+
+      #
+      # @param settings_uuid [String] Per-version UUID of the workflow (the `uuid` value returned by the list
+      #   endpoint). Each version of a workflow has its own `settings_uuid`.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::WorkflowDetail]
+      def retrieve(settings_uuid, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/workflows/{settings_uuid}/",
+          path_params: { "settings_uuid" => settings_uuid },
+          response: Types::WorkflowDetail,
+          request_options: request_options
+        )
+      end
+
+      # Update workflow
+      #
+      # Update a workflow. Versioning depends on the `status` field you send and the current state of the version: (1)
+      # no `status` on a **published** version → the published version is updated in place (same `uuid`, same
+      # `version`); (2) no `status` on a **draft** → the draft is updated and immediately published; (3) `status:
+      # "published"` on a **published** version → a NEW published version is created under the same `workflow_id` (new
+      # `uuid`, `version` + 1) and returned, and any existing draft in the group is deleted; (4) `status: "draft"`
+      # keeps a draft as a draft (autosave) but is rejected with 400 on a published version (`"Cannot revert a
+      # published version to draft."`). The body accepts the same strict field whitelist as create - unknown keys are
+      # rejected with 400.
+      #
+      # +PATCH /v3/workflows/{settings_uuid}/+
+      #
+      # @param settings_uuid [String] Per-version UUID of the workflow to update.
+      # @param workflow_label [String] Display name for the workflow (max 50 characters).
+      # @param is_default [Boolean] Set this workflow as the default for new sessions.
+      # @param status [String] Controls versioning. Omit to update the current version in place (drafts auto-publish).
+      #   `published` on an already-published version creates and returns a NEW version. `draft` is only valid while the
+      #   version is still a draft.
+      # @param features [Array<Hash>] If provided, this replaces the full feature order and configuration.
+      # @param is_white_label_enabled [Boolean] Enable white-label customization for sessions created with this
+      #   workflow.
+      # @param is_desktop_allowed [Boolean] Allow the verification flow to run on desktop browsers.
+      # @param max_retry_attempts [Integer] Maximum retry attempts allowed after a declined verification. `0` blocks
+      #   the user after the first decline.
+      # @param retry_window_days [Integer, nil] Rolling window in days used to count retries. `null` enforces an
+      #   all-time limit.
+      # @param face_liveness_max_attempts [Integer] Maximum liveness submissions per session. This value is also
+      #   copied into generated liveness and age-estimation workflow nodes unless the feature-level config overrides it.
+      # @param face_match_max_attempts [Integer] Maximum face-match submissions per session. This value is also copied
+      #   into generated face-match workflow nodes unless the feature-level config overrides it.
+      # @param session_expiration_time [Integer] Seconds before an unfinished session expires. Minimum 1 hour (3600),
+      #   maximum 4 weeks (2419200).
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::WorkflowDetail]
+      def update(
+        settings_uuid,
+        workflow_label: OMIT,
+        is_default: OMIT,
+        status: OMIT,
+        features: OMIT,
+        is_white_label_enabled: OMIT,
+        is_desktop_allowed: OMIT,
+        max_retry_attempts: OMIT,
+        retry_window_days: OMIT,
+        face_liveness_max_attempts: OMIT,
+        face_match_max_attempts: OMIT,
+        session_expiration_time: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :patch,
+          "/v3/workflows/{settings_uuid}/",
+          path_params: { "settings_uuid" => settings_uuid },
+          body: {
+            "workflow_label" => workflow_label,
+            "is_default" => is_default,
+            "status" => status,
+            "features" => features,
+            "is_white_label_enabled" => is_white_label_enabled,
+            "is_desktop_allowed" => is_desktop_allowed,
+            "max_retry_attempts" => max_retry_attempts,
+            "retry_window_days" => retry_window_days,
+            "face_liveness_max_attempts" => face_liveness_max_attempts,
+            "face_match_max_attempts" => face_match_max_attempts,
+            "session_expiration_time" => session_expiration_time
+          },
+          response: Types::WorkflowDetail,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/didit/resources.rb

@@ -0,0 +1,263 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  # One class per API resource, one method per operation (docs/DESIGN.md section 4).
+  module Resources
+    autoload :Account, "didit/resources/account"
+    autoload :AddressValidation, "didit/resources/address_validation"
+    autoload :AgeEstimation, "didit/resources/age_estimation"
+    autoload :Aml, "didit/resources/aml"
+    autoload :AmlMonitoring, "didit/resources/aml_monitoring"
+    autoload :Analytics, "didit/resources/analytics"
+    autoload :Bank, "didit/resources/bank"
+    autoload :Billing, "didit/resources/billing"
+    autoload :BiometricTemplates, "didit/resources/biometric_templates"
+    autoload :Blocklist, "didit/resources/blocklist"
+    autoload :BusinessSessions, "didit/resources/business_sessions"
+    autoload :Businesses, "didit/resources/businesses"
+    autoload :Cases, "didit/resources/cases"
+    autoload :Customization, "didit/resources/customization"
+    autoload :DatabaseValidation, "didit/resources/database_validation"
+    autoload :DocumentAi, "didit/resources/document_ai"
+    autoload :Email, "didit/resources/email"
+    autoload :FaceMatch, "didit/resources/face_match"
+    autoload :FaceSearch, "didit/resources/face_search"
+    autoload :FraudChecks, "didit/resources/fraud_checks"
+    autoload :IdVerification, "didit/resources/id_verification"
+    autoload :IdWallets, "didit/resources/id_wallets"
+    autoload :Investigator, "didit/resources/investigator"
+    autoload :Ip, "didit/resources/ip"
+    autoload :Kyb, "didit/resources/kyb"
+    autoload :Lists, "didit/resources/lists"
+    autoload :MonitoringEvents, "didit/resources/monitoring_events"
+    autoload :Networks, "didit/resources/networks"
+    autoload :PassiveLiveness, "didit/resources/passive_liveness"
+    autoload :Phone, "didit/resources/phone"
+    autoload :Pricing, "didit/resources/pricing"
+    autoload :ProofOfAddress, "didit/resources/proof_of_address"
+    autoload :Questionnaires, "didit/resources/questionnaires"
+    autoload :RegulatoryReports, "didit/resources/regulatory_reports"
+    autoload :ReportTemplates, "didit/resources/report_templates"
+    autoload :Sessions, "didit/resources/sessions"
+    autoload :Transactions, "didit/resources/transactions"
+    autoload :TravelRule, "didit/resources/travel_rule"
+    autoload :Users, "didit/resources/users"
+    autoload :WalletScreening, "didit/resources/wallet_screening"
+    autoload :Webhooks, "didit/resources/webhooks"
+    autoload :Workflows, "didit/resources/workflows"
+
+    # The top-level resources of Didit::Client.
+    module ClientMethods
+      # @return [Didit::Resources::Account]
+      def account
+        @account ||= Resources::Account.new(self)
+      end
+
+      # @return [Didit::Resources::AddressValidation]
+      def address_validation
+        @address_validation ||= Resources::AddressValidation.new(self)
+      end
+
+      # @return [Didit::Resources::AgeEstimation]
+      def age_estimation
+        @age_estimation ||= Resources::AgeEstimation.new(self)
+      end
+
+      # @return [Didit::Resources::Aml]
+      def aml
+        @aml ||= Resources::Aml.new(self)
+      end
+
+      # @return [Didit::Resources::AmlMonitoring]
+      def aml_monitoring
+        @aml_monitoring ||= Resources::AmlMonitoring.new(self)
+      end
+
+      # @return [Didit::Resources::Analytics]
+      def analytics
+        @analytics ||= Resources::Analytics.new(self)
+      end
+
+      # @return [Didit::Resources::Bank]
+      def bank
+        @bank ||= Resources::Bank.new(self)
+      end
+
+      # @return [Didit::Resources::Billing]
+      def billing
+        @billing ||= Resources::Billing.new(self)
+      end
+
+      # @return [Didit::Resources::BiometricTemplates]
+      def biometric_templates
+        @biometric_templates ||= Resources::BiometricTemplates.new(self)
+      end
+
+      # @return [Didit::Resources::Blocklist]
+      def blocklist
+        @blocklist ||= Resources::Blocklist.new(self)
+      end
+
+      # @return [Didit::Resources::BusinessSessions]
+      def business_sessions
+        @business_sessions ||= Resources::BusinessSessions.new(self)
+      end
+
+      # @return [Didit::Resources::Businesses]
+      def businesses
+        @businesses ||= Resources::Businesses.new(self)
+      end
+
+      # @return [Didit::Resources::Cases]
+      def cases
+        @cases ||= Resources::Cases.new(self)
+      end
+
+      # @return [Didit::Resources::Customization]
+      def customization
+        @customization ||= Resources::Customization.new(self)
+      end
+
+      # @return [Didit::Resources::DatabaseValidation]
+      def database_validation
+        @database_validation ||= Resources::DatabaseValidation.new(self)
+      end
+
+      # @return [Didit::Resources::DocumentAi]
+      def document_ai
+        @document_ai ||= Resources::DocumentAi.new(self)
+      end
+
+      # @return [Didit::Resources::Email]
+      def email
+        @email ||= Resources::Email.new(self)
+      end
+
+      # @return [Didit::Resources::FaceMatch]
+      def face_match
+        @face_match ||= Resources::FaceMatch.new(self)
+      end
+
+      # @return [Didit::Resources::FaceSearch]
+      def face_search
+        @face_search ||= Resources::FaceSearch.new(self)
+      end
+
+      # @return [Didit::Resources::FraudChecks]
+      def fraud_checks
+        @fraud_checks ||= Resources::FraudChecks.new(self)
+      end
+
+      # @return [Didit::Resources::IdVerification]
+      def id_verification
+        @id_verification ||= Resources::IdVerification.new(self)
+      end
+
+      # @return [Didit::Resources::IdWallets]
+      def id_wallets
+        @id_wallets ||= Resources::IdWallets.new(self)
+      end
+
+      # @return [Didit::Resources::Investigator]
+      def investigator
+        @investigator ||= Resources::Investigator.new(self)
+      end
+
+      # @return [Didit::Resources::Ip]
+      def ip
+        @ip ||= Resources::Ip.new(self)
+      end
+
+      # @return [Didit::Resources::Kyb]
+      def kyb
+        @kyb ||= Resources::Kyb.new(self)
+      end
+
+      # @return [Didit::Resources::Lists]
+      def lists
+        @lists ||= Resources::Lists.new(self)
+      end
+
+      # @return [Didit::Resources::MonitoringEvents]
+      def monitoring_events
+        @monitoring_events ||= Resources::MonitoringEvents.new(self)
+      end
+
+      # @return [Didit::Resources::Networks]
+      def networks
+        @networks ||= Resources::Networks.new(self)
+      end
+
+      # @return [Didit::Resources::PassiveLiveness]
+      def passive_liveness
+        @passive_liveness ||= Resources::PassiveLiveness.new(self)
+      end
+
+      # @return [Didit::Resources::Phone]
+      def phone
+        @phone ||= Resources::Phone.new(self)
+      end
+
+      # @return [Didit::Resources::Pricing]
+      def pricing
+        @pricing ||= Resources::Pricing.new(self)
+      end
+
+      # @return [Didit::Resources::ProofOfAddress]
+      def proof_of_address
+        @proof_of_address ||= Resources::ProofOfAddress.new(self)
+      end
+
+      # @return [Didit::Resources::Questionnaires]
+      def questionnaires
+        @questionnaires ||= Resources::Questionnaires.new(self)
+      end
+
+      # @return [Didit::Resources::RegulatoryReports]
+      def regulatory_reports
+        @regulatory_reports ||= Resources::RegulatoryReports.new(self)
+      end
+
+      # @return [Didit::Resources::ReportTemplates]
+      def report_templates
+        @report_templates ||= Resources::ReportTemplates.new(self)
+      end
+
+      # @return [Didit::Resources::Sessions]
+      def sessions
+        @sessions ||= Resources::Sessions.new(self)
+      end
+
+      # @return [Didit::Resources::Transactions]
+      def transactions
+        @transactions ||= Resources::Transactions.new(self)
+      end
+
+      # @return [Didit::Resources::TravelRule]
+      def travel_rule
+        @travel_rule ||= Resources::TravelRule.new(self)
+      end
+
+      # @return [Didit::Resources::Users]
+      def users
+        @users ||= Resources::Users.new(self)
+      end
+
+      # @return [Didit::Resources::WalletScreening]
+      def wallet_screening
+        @wallet_screening ||= Resources::WalletScreening.new(self)
+      end
+
+      # @return [Didit::Resources::Webhooks]
+      def webhooks
+        @webhooks ||= Resources::Webhooks.new(self)
+      end
+
+      # @return [Didit::Resources::Workflows]
+      def workflows
+        @workflows ||= Resources::Workflows.new(self)
+      end
+    end
+  end
+end

data/lib/didit/types/account.rb

@@ -0,0 +1,11 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    class AccountResendOtpResponse < Didit::Model
+      field :message, "message", :string
+      field :email, "email", :string
+    end
+  end
+end

data/lib/didit/types/account_components.rb

@@ -0,0 +1,105 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # `identity` (Identity verification), `transactions` (Transaction monitoring) or `authentication`
+    # (Authentication).
+    module ApplicationProductProduct
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+      AUTHENTICATION = "authentication"
+
+      VALUES = [IDENTITY, TRANSACTIONS, AUTHENTICATION].freeze
+    end
+
+    # Whether the product is on for this application. `early_access` applies only to `authentication`, which Didit
+    # turns on for you.
+    module ApplicationProductStatus
+      ENABLED = "enabled"
+      EARLY_ACCESS = "early_access"
+      DISABLED = "disabled"
+
+      VALUES = [ENABLED, EARLY_ACCESS, DISABLED].freeze
+    end
+
+    # Full application record. `uuid`, `client_id`, and `api_key` never change after creation.
+    class Application < Didit::Model
+      field :uuid, "uuid", :string
+      field :name, "name", :string
+      field :client_id, "client_id", :string
+      field :api_key, "api_key", :string
+      field :website_url, "website_url", :string
+      field :redirect_uris, "redirect_uris", [:array, :string]
+      field :terms_url, "terms_url", :string
+      field :privacy_url, "privacy_url", :string
+      field :description, "description", :string
+      field :created_at, "created_at", :datetime
+      field :products, "products", [:array, "ApplicationProduct"]
+    end
+
+    # Minimal application shape returned inline by `POST /programmatic/verify-email/`. Persist the `api_key`
+    # immediately.
+    class ApplicationCredentialsSummary < Didit::Model
+      field :uuid, "uuid", :string
+      field :name, "name", :string
+      field :client_id, "client_id", :string
+      field :api_key, "api_key", :string
+    end
+
+    # One product of an application and its state. Read-only: the application endpoints return it and ignore it in a
+    # request body.
+    class ApplicationProduct < Didit::Model
+      field :product, "product", :string
+      field :status, "status", :string
+      field :modules, "modules", [:map, :boolean]
+    end
+
+    class LoginResponse < Didit::Model
+      field :access_token, "access_token", :string
+      field :refresh_token, "refresh_token", :string
+      field :expires_in, "expires_in", :integer
+      field :message, "message", :string
+    end
+
+    class Organization < Didit::Model
+      field :uuid, "uuid", :string
+      field :name, "name", :string
+      field :contact_email, "contact_email", :string
+      field :created_at, "created_at", :datetime
+    end
+
+    # Minimal organization shape returned inline by `POST /programmatic/verify-email/`.
+    class OrganizationSummary < Didit::Model
+      field :uuid, "uuid", :string
+      field :name, "name", :string
+    end
+
+    class PaginatedApplicationList < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "Application"]
+    end
+
+    class PaginatedOrganizationList < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "Organization"]
+    end
+
+    class RegisterResponse < Didit::Model
+      field :message, "message", :string
+      field :email, "email", :string
+    end
+
+    class VerifyEmailResponse < Didit::Model
+      field :access_token, "access_token", :string
+      field :refresh_token, "refresh_token", :string
+      field :expires_in, "expires_in", :integer
+      field :organization, "organization", "OrganizationSummary"
+      field :application, "application", "ApplicationCredentialsSummary"
+    end
+  end
+end

data/lib/didit/types/address_validation.rb

@@ -0,0 +1,8 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+
+  end
+end

data/lib/didit/types/age_estimation.rb

@@ -0,0 +1,89 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Liveness method. Always `PASSIVE` on this endpoint (single-image, no user challenge).
+    module AgeEstimationEstimateResponseAgeEstimationMethod
+      PASSIVE = "PASSIVE"
+
+      VALUES = [PASSIVE].freeze
+    end
+
+    # `Approved` when no warnings were raised; `Declined` otherwise (every warning this endpoint produces declines).
+    module AgeEstimationEstimateResponseAgeEstimationStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, DECLINED].freeze
+    end
+
+    # Feature that raised the warning. Always `LIVENESS` on this endpoint.
+    module AgeEstimationEstimateResponseAgeEstimationWarningsFeature
+      LIVENESS = "LIVENESS"
+
+      VALUES = [LIVENESS].freeze
+    end
+
+    # Severity. Every warning this endpoint produces is an `error` and sets `status` to `Declined`.
+    module AgeEstimationEstimateResponseAgeEstimationWarningsLogType
+      ERROR = "error"
+
+      VALUES = [ERROR].freeze
+    end
+
+    # Machine-readable risk code. `NO_FACE_DETECTED` - the liveness model found no face; `LOW_LIVENESS_SCORE` -
+    # liveness `score` at or below `face_liveness_score_decline_threshold`; `LIVENESS_FACE_ATTACK` - a presentation
+    # attack (photo/screen/mask) was detected; `AGE_NOT_DETECTED` - no face age could be estimated;
+    # `AGE_BELOW_MINIMUM` - estimated age below `age_estimation_decline_threshold`. `NO_FACE_DETECTED` and
+    # `LOW_LIVENESS_SCORE` are mutually exclusive - when no face is found only `NO_FACE_DETECTED` is emitted.
+    module AgeEstimationEstimateResponseAgeEstimationWarningsRisk
+      NO_FACE_DETECTED = "NO_FACE_DETECTED"
+      LOW_LIVENESS_SCORE = "LOW_LIVENESS_SCORE"
+      LIVENESS_FACE_ATTACK = "LIVENESS_FACE_ATTACK"
+      AGE_NOT_DETECTED = "AGE_NOT_DETECTED"
+      AGE_BELOW_MINIMUM = "AGE_BELOW_MINIMUM"
+
+      VALUES = [NO_FACE_DETECTED, LOW_LIVENESS_SCORE, LIVENESS_FACE_ATTACK, AGE_NOT_DETECTED, AGE_BELOW_MINIMUM].freeze
+    end
+
+    class AgeEstimationEstimateResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :age_estimation, "age_estimation", "AgeEstimationEstimateResponseAgeEstimation"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class AgeEstimationEstimateResponseAgeEstimation < Didit::Model
+      field :status, "status", :string
+      field :method_, "method", :string
+      field :score, "score", :float
+      field :user_image, "user_image", "AgeEstimationEstimateResponseAgeEstimationUserImage"
+      field :age_estimation, "age_estimation", :float
+      field :warnings, "warnings", [:array, "AgeEstimationEstimateResponseAgeEstimationWarnings"]
+    end
+
+    # Face-detection results for the analyzed image.
+    class AgeEstimationEstimateResponseAgeEstimationUserImage < Didit::Model
+      field :entities, "entities", [:array, "AgeEstimationEstimateResponseAgeEstimationUserImageEntities"]
+      field :best_angle, "best_angle", :integer
+    end
+
+    class AgeEstimationEstimateResponseAgeEstimationUserImageEntities < Didit::Model
+      field :age, "age", :float
+      field :bbox, "bbox", [:array, :integer]
+      field :confidence, "confidence", :float
+      field :gender, "gender", :string
+    end
+
+    class AgeEstimationEstimateResponseAgeEstimationWarnings < Didit::Model
+      field :risk, "risk", :string
+      field :feature, "feature", :string
+      field :additional_data, "additional_data", :any
+      field :log_type, "log_type", :string
+      field :short_description, "short_description", :string
+      field :long_description, "long_description", :string
+    end
+  end
+end