didit-sdk 1.0.0

data/lib/didit/types/aml.rb

@@ -0,0 +1,193 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # `available` when a reading exists; `not_configured` when dataset dates are not collected in this environment;
+    # `not_yet_collected` when collection is set up but no reading exists yet.
+    module AmlRetrieveDatasetFreshnessResponseAvailability
+      AVAILABLE = "available"
+      NOT_CONFIGURED = "not_configured"
+      NOT_YET_COLLECTED = "not_yet_collected"
+
+      VALUES = [AVAILABLE, NOT_CONFIGURED, NOT_YET_COLLECTED].freeze
+    end
+
+    # Type of entity to screen. Defaults to `person`.
+    module AmlScreenParamsEntityType
+      PERSON = "person"
+      COMPANY = "company"
+
+      VALUES = [PERSON, COMPANY].freeze
+    end
+
+    # Echo of the screened entity type.
+    module AmlScreenResponseAmlEntityType
+      PERSON = "person"
+      COMPANY = "company"
+
+      VALUES = [PERSON, COMPANY].freeze
+    end
+
+    # `False Positive` - `match_score` below `aml_match_score_threshold`, excluded from risk assessment. `Unreviewed`
+    # - possible match awaiting review. `Confirmed Match` / `Inconclusive` - set manually by a reviewer (via the
+    # Business Console) on saved sessions; that review capability is not part of this spec.
+    module AmlScreenResponseAmlHitsReviewStatus
+      FALSE_POSITIVE = "False Positive"
+      UNREVIEWED = "Unreviewed"
+      CONFIRMED_MATCH = "Confirmed Match"
+      INCONCLUSIVE = "Inconclusive"
+
+      VALUES = [FALSE_POSITIVE, UNREVIEWED, CONFIRMED_MATCH, INCONCLUSIVE].freeze
+    end
+
+    # Golden-key result for the document number comparison.
+    module AmlScreenResponseAmlHitsScoreBreakdownDocumentNumberMatchType
+      MATCH = "MATCH"
+      NEUTRAL = "NEUTRAL"
+      HARD_MISMATCH = "HARD_MISMATCH"
+
+      VALUES = [MATCH, NEUTRAL, HARD_MISMATCH].freeze
+    end
+
+    # `Declined` when `score` > `aml_score_review_threshold`; `In Review` when `score` >
+    # `aml_score_approve_threshold`; `Approved` otherwise (including when no score is available).
+    module AmlScreenResponseAmlStatus
+      APPROVED = "Approved"
+      IN_REVIEW = "In Review"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, IN_REVIEW, DECLINED].freeze
+    end
+
+    class AmlRetrieveDatasetFreshnessResponse < Didit::Model
+      field :dataset_freshness, "dataset_freshness", "AMLDatasetFreshness"
+      field :availability, "availability", :string
+    end
+
+    class AmlScreenResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :aml, "aml", "AmlScreenResponseAml"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class AmlScreenResponseAml < Didit::Model
+      field :status, "status", :string
+      field :total_hits, "total_hits", :integer
+      field :entity_type, "entity_type", :string
+      field :hits, "hits", [:array, "AmlScreenResponseAmlHits"]
+      field :score, "score", :float
+      field :screened_data, "screened_data", "AmlScreenResponseAmlScreenedData"
+      field :warnings, "warnings", [:array, "AmlScreenResponseAmlWarnings"]
+    end
+
+    # One screening hit. `match_score` (0-100) measures identity confidence - hits below `aml_match_score_threshold`
+    # are tagged `review_status: "False Positive"` and excluded from the risk assessment; hits at or above it are
+    # `"Unreviewed"` possible matches. `risk_score` (0-100) measures how risky the matched entity is and drives the
+    # top-level `aml.score`.
+    class AmlScreenResponseAmlHits < Didit::Model
+      field :id, "id", :string
+      field :url, "url", :string
+      field :match, "match", :boolean
+      field :score, "score", :float
+      field :match_score, "match_score", :float
+      field :risk_score, "risk_score", :float
+      field :target, "target", :boolean
+      field :caption, "caption", :string
+      field :datasets, "datasets", [:array, :string]
+      field :features, "features", :any
+      field :properties, "properties", :any
+      field :rca_name, "rca_name", :string
+      field :pep_matches, "pep_matches", [:array, "AmlScreenResponseAmlHitsPepMatches"]
+      field :sanction_matches, "sanction_matches", [:array, :any]
+      field :warning_matches, "warning_matches", [:array, :any]
+      field :adverse_media_matches, "adverse_media_matches", [:array, "AmlScreenResponseAmlHitsAdverseMediaMatches"]
+      field :adverse_media_details, "adverse_media_details", :any
+      field :first_seen, "first_seen", :datetime
+      field :last_seen, "last_seen", :datetime
+      field :linked_entities, "linked_entities", [:array, "AmlScreenResponseAmlHitsLinkedEntities"]
+      field :risk_view, "risk_view", :any
+      field :additional_information, "additional_information", :any
+      field :review_status, "review_status", :string
+      field :score_breakdown, "score_breakdown", "AmlScreenResponseAmlHitsScoreBreakdown"
+    end
+
+    class AmlScreenResponseAmlHitsAdverseMediaMatches < Didit::Model
+      field :headline, "headline", :string
+      field :summary, "summary", :string
+      field :sentiment, "sentiment", :string
+      field :sentiment_score, "sentiment_score", :float
+      field :source_url, "source_url", :string
+      field :thumbnail, "thumbnail", :string
+      field :country, "country", :string
+      field :author_name, "author_name", :string
+      field :publication_date, "publication_date", :string
+      field :adverse_keywords, "adverse_keywords", [:array, :string]
+      field :other_sources, "other_sources", [:array, :string]
+    end
+
+    class AmlScreenResponseAmlHitsLinkedEntities < Didit::Model
+      field :name, "name", [:array, :string]
+      field :relation, "relation", [:array, :string]
+      field :status, "status", [:array, :string]
+      field :details, "details", [:array, :string]
+      field :active, "active", [:array, :string]
+    end
+
+    class AmlScreenResponseAmlHitsPepMatches < Didit::Model
+      field :list_name, "list_name", :string
+      field :publisher, "publisher", :string
+      field :source_url, "source_url", :string
+      field :description, "description", :string
+      field :matched_name, "matched_name", :string
+      field :pep_position, "pep_position", :string
+      field :date_of_birth, "date_of_birth", :string
+      field :place_of_birth, "place_of_birth", :string
+      field :aliases, "aliases", [:array, :string]
+      field :education, "education", [:array, :string]
+      field :other_sources, "other_sources", [:array, :string]
+    end
+
+    # How `match_score` was computed. Name, date of birth, and country each contribute `<component>_score` ×
+    # `<component>_weight_normalized` points; weights are re-normalized when a component is missing from the screened
+    # data. The document number is not weighted - it acts as a 'golden key': `MATCH` overrides the score to 100,
+    # `NEUTRAL` leaves it unchanged, `HARD_MISMATCH` applies a penalty.
+    class AmlScreenResponseAmlHitsScoreBreakdown < Didit::Model
+      field :name_score, "name_score", :integer
+      field :name_weight, "name_weight", :integer
+      field :name_weight_normalized, "name_weight_normalized", :float
+      field :name_contribution, "name_contribution", :float
+      field :dob_score, "dob_score", :integer
+      field :dob_weight, "dob_weight", :integer
+      field :dob_weight_normalized, "dob_weight_normalized", :float
+      field :dob_contribution, "dob_contribution", :float
+      field :country_score, "country_score", :integer
+      field :country_weight, "country_weight", :integer
+      field :country_weight_normalized, "country_weight_normalized", :float
+      field :country_contribution, "country_contribution", :float
+      field :document_number_match_type, "document_number_match_type", :string
+      field :document_number_effect, "document_number_effect", :string
+      field :total_score, "total_score", :integer
+    end
+
+    # Echo of what was screened: `full_name`, `date_of_birth`, `nationality`, `document_number` (absent fields are
+    # `null`).
+    class AmlScreenResponseAmlScreenedData < Didit::Model
+      field :full_name, "full_name", :string
+      field :date_of_birth, "date_of_birth", :string
+      field :nationality, "nationality", :string
+      field :document_number, "document_number", :string
+    end
+
+    class AmlScreenResponseAmlWarnings < Didit::Model
+      field :feature, "feature", :string
+      field :risk, "risk", :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

data/lib/didit/types/aml_monitoring.rb

@@ -0,0 +1,73 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Known values of an open enum: the API may send others.
+    module AmlMonitoringRetrieveJobResponseResultsOutcome
+      ENABLED = "enabled"
+      SCREENED_AND_ENABLED = "screened_and_enabled"
+      ALREADY_ENABLED = "already_enabled"
+      DISABLED = "disabled"
+      SKIPPED_NO_IDENTITY_DATA = "skipped_no_identity_data"
+      SKIPPED_BLOCKED = "skipped_blocked"
+      SKIPPED_SANDBOX = "skipped_sandbox"
+      FAILED_PROVIDER = "failed_provider"
+      FAILED_INSUFFICIENT_BALANCE = "failed_insufficient_balance"
+
+      VALUES = [ENABLED, SCREENED_AND_ENABLED, ALREADY_ENABLED, DISABLED, SKIPPED_NO_IDENTITY_DATA, SKIPPED_BLOCKED, SKIPPED_SANDBOX, FAILED_PROVIDER, FAILED_INSUFFICIENT_BALANCE].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module AmlMonitoringRetrieveJobResponseStatus
+      PENDING = "PENDING"
+      PROCESSING = "PROCESSING"
+      COMPLETED = "COMPLETED"
+      FAILED = "FAILED"
+
+      VALUES = [PENDING, PROCESSING, COMPLETED, FAILED].freeze
+    end
+
+    # Which profile family the job toggles.
+    module AmlMonitoringRetrieveJobResponseTargetType
+      USER = "user"
+      BUSINESS = "business"
+
+      VALUES = [USER, BUSINESS].freeze
+    end
+
+    class AmlMonitoringRetrieveJobResponse < Didit::Model
+      field :job_id, "job_id", :string
+      field :status, "status", :string
+      field :is_enabled, "is_enabled", :boolean
+      field :target_type, "target_type", :string
+      field :total, "total", :integer
+      field :processed, "processed", :integer
+      field :outcomes, "outcomes", "AmlMonitoringRetrieveJobResponseOutcomes"
+      field :results, "results", [:array, "AmlMonitoringRetrieveJobResponseResults"]
+      field :error, "error", :string
+      field :created_at, "created_at", :datetime
+      field :completed_at, "completed_at", :datetime
+    end
+
+    # Per-record outcome counters. Every selected profile resolves to exactly one counter; nothing is silently
+    # skipped.
+    class AmlMonitoringRetrieveJobResponseOutcomes < Didit::Model
+      field :enabled, "enabled", :integer
+      field :screened_and_enabled, "screened_and_enabled", :integer
+      field :already_enabled, "already_enabled", :integer
+      field :disabled, "disabled", :integer
+      field :skipped_no_identity_data, "skipped_no_identity_data", :integer
+      field :skipped_blocked, "skipped_blocked", :integer
+      field :skipped_sandbox, "skipped_sandbox", :integer
+      field :failed_provider, "failed_provider", :integer
+      field :failed_insufficient_balance, "failed_insufficient_balance", :integer
+    end
+
+    class AmlMonitoringRetrieveJobResponseResults < Didit::Model
+      field :didit_internal_id, "didit_internal_id", :string
+      field :vendor_data, "vendor_data", :string
+      field :outcome, "outcome", :string
+    end
+  end
+end

data/lib/didit/types/analytics.rb

@@ -0,0 +1,62 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Known values of an open enum: the API may send others.
+    module AnalyticsRetrieveParamsScope
+      HOME = "home"
+      KYC = "kyc"
+      KYB = "kyb"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [HOME, KYC, KYB, TRANSACTIONS].freeze
+    end
+
+    # How the `*_time_series` lists are grouped: `day` for up to 14 days, `week` up to 90, `month` beyond. Measured
+    # from the first day with sessions in the range.
+    module AnalyticsRetrieveResponseGroupingMode
+      DAY = "day"
+      WEEK = "week"
+      MONTH = "month"
+
+      VALUES = [DAY, WEEK, MONTH].freeze
+    end
+
+    # Dashboard tab.
+    module AnalyticsRetrieveResponseScope
+      HOME = "home"
+      KYC = "kyc"
+      KYB = "kyb"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [HOME, KYC, KYB, TRANSACTIONS].freeze
+    end
+
+    class AnalyticsRetrieveResponse < Didit::Model
+      field :data_points, "data_points", [:array, "ApplicationAnalyticsDataPoint"]
+      field :request_breakdown, "request_breakdown", "ApplicationAnalyticsRequestBreakdown"
+      field :previous_data_points, "previous_data_points", [:array, "ApplicationAnalyticsDataPoint"]
+      field :previous_request_breakdown, "previous_request_breakdown", "ApplicationAnalyticsRequestBreakdown"
+      field :conversion_rate, "conversion_rate", :float
+      field :location_stats, "location_stats", "ApplicationAnalyticsLocationStats"
+      field :demographic_stats, "demographic_stats", "ApplicationAnalyticsDemographicStats"
+      field :device_details, "device_details", "ApplicationAnalyticsDeviceDetails"
+      field :workflow_funnel_stats, "workflow_funnel_stats", [:map, "ApplicationAnalyticsWorkflowFunnelValue"]
+      field :verification_time_stats, "verification_time_stats", "ApplicationAnalyticsVerificationTimeStats"
+      field :resubmission_stats, "resubmission_stats", "ApplicationAnalyticsResubmissionStats"
+      field :warning_stats, "warning_stats", [:map, "ApplicationAnalyticsWarningStatsValue"]
+      field :original_status_stats, "original_status_stats", "ApplicationAnalyticsOriginalStatusStats"
+      field :grouping_mode, "grouping_mode", :string
+      field :demographic_time_series, "demographic_time_series", [:array, "ApplicationAnalyticsDemographicPoint"]
+      field :device_time_series, "device_time_series", [:array, "ApplicationAnalyticsDevicePoint"]
+      field :verification_time_time_series, "verification_time_time_series", [:array, "ApplicationAnalyticsVerificationTimePoint"]
+      field :resubmission_time_series, "resubmission_time_series", [:array, "ApplicationAnalyticsResubmissionPoint"]
+      field :original_status_time_series, "original_status_time_series", [:array, "ApplicationAnalyticsOriginalStatusPoint"]
+      field :scope, "scope", :string
+      field :available_widget_keys, "available_widget_keys", [:array, :string]
+      field :requested_widget_keys, "requested_widget_keys", [:array, :string]
+      field :widgets, "widgets", [:map, "ApplicationAnalyticsWidget"]
+    end
+  end
+end

data/lib/didit/types/bank.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/billing.rb

@@ -0,0 +1,18 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    class BillingRetrieveBalanceResponse < Didit::Model
+      field :balance, "balance", :string
+      field :auto_refill_enabled, "auto_refill_enabled", :boolean
+      field :auto_refill_amount, "auto_refill_amount", :string
+      field :auto_refill_threshold, "auto_refill_threshold", :string
+    end
+
+    class BillingTopUpResponse < Didit::Model
+      field :checkout_session_id, "checkout_session_id", :string
+      field :checkout_session_url, "checkout_session_url", :string
+    end
+  end
+end

data/lib/didit/types/biometric_templates.rb

@@ -0,0 +1,292 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Only with `delete_all`.
+    module BiometricTemplatesBatchDeleteParamsSourceType
+      SESSION_DELETE = "session_delete"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+
+      VALUES = [SESSION_DELETE, AUTOMATIC_RETENTION, BACKFILL].freeze
+    end
+
+    # Only with `delete_all`.
+    module BiometricTemplatesBatchDeleteParamsStatus
+      PENDING = "pending"
+      ACTIVE = "active"
+      EXPIRED = "expired"
+      HELD_OUT_OF_USE = "held_out_of_use"
+      PURGE_PENDING = "purge_pending"
+      PURGE_FAILED = "purge_failed"
+
+      VALUES = [PENDING, ACTIVE, EXPIRED, HELD_OUT_OF_USE, PURGE_PENDING, PURGE_FAILED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesBatchDeleteResponseResultsOutcome
+      PURGED = "purged"
+      ALREADY_PURGED = "already_purged"
+
+      VALUES = [PURGED, ALREADY_PURGED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesCountParamsSourceType
+      SESSION_DELETE = "session_delete"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+
+      VALUES = [SESSION_DELETE, AUTOMATIC_RETENTION, BACKFILL].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesCountParamsStatus
+      PENDING = "pending"
+      ACTIVE = "active"
+      EXPIRED = "expired"
+      HELD_OUT_OF_USE = "held_out_of_use"
+      PURGE_PENDING = "purge_pending"
+      PURGE_FAILED = "purge_failed"
+
+      VALUES = [PENDING, ACTIVE, EXPIRED, HELD_OUT_OF_USE, PURGE_PENDING, PURGE_FAILED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesDeleteResponseOutcome
+      PURGED = "purged"
+      ALREADY_PURGED = "already_purged"
+
+      VALUES = [PURGED, ALREADY_PURGED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListParamsOrdering
+      RETAINED_AT = "retained_at"
+      RETAINED_AT_ = "-retained_at"
+      EXPIRES_AT = "expires_at"
+      EXPIRES_AT_ = "-expires_at"
+
+      VALUES = [RETAINED_AT, RETAINED_AT_, EXPIRES_AT, EXPIRES_AT_].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListParamsSourceType
+      SESSION_DELETE = "session_delete"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+
+      VALUES = [SESSION_DELETE, AUTOMATIC_RETENTION, BACKFILL].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListParamsStatus
+      PENDING = "pending"
+      ACTIVE = "active"
+      EXPIRED = "expired"
+      HELD_OUT_OF_USE = "held_out_of_use"
+      PURGE_PENDING = "purge_pending"
+      PURGE_FAILED = "purge_failed"
+
+      VALUES = [PENDING, ACTIVE, EXPIRED, HELD_OUT_OF_USE, PURGE_PENDING, PURGE_FAILED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListResponseResultsInstructionClass
+      OPERATIONAL_SESSION_DELETE = "operational_session_delete"
+      PRIVACY_ERASURE = "privacy_erasure"
+
+      VALUES = [OPERATIONAL_SESSION_DELETE, PRIVACY_ERASURE].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListResponseResultsInstructionSource
+      API = "api"
+      CONSOLE = "console"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+      PRIVACY_ERASURE = "privacy_erasure"
+      EXPLICIT_TEMPLATE_PURGE = "explicit_template_purge"
+      VENDOR_USER_DELETE = "vendor_user_delete"
+      EXPIRY = "expiry"
+      RECONCILIATION = "reconciliation"
+      MIGRATION = "migration"
+      SYSTEM = "system"
+
+      VALUES = [API, CONSOLE, AUTOMATIC_RETENTION, BACKFILL, PRIVACY_ERASURE, EXPLICIT_TEMPLATE_PURGE, VENDOR_USER_DELETE, EXPIRY, RECONCILIATION, MIGRATION, SYSTEM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesListResponseResultsRetainedByType
+      API_KEY = "API_KEY"
+      CONSOLE_USER = "CONSOLE_USER"
+      SYSTEM = "SYSTEM"
+
+      VALUES = [API_KEY, CONSOLE_USER, SYSTEM].freeze
+    end
+
+    # The application policy at retention time.
+    module BiometricTemplatesListResponseResultsRetentionPolicy
+      DELETE_WITH_SESSION = "delete_with_session"
+      RETAIN_UNTIL_USER_DELETED = "retain_until_user_deleted"
+
+      VALUES = [DELETE_WITH_SESSION, RETAIN_UNTIL_USER_DELETED].freeze
+    end
+
+    # How the template was created: a session deletion (API or Console), the application's automatic data-retention
+    # window, or a Didit-operated backfill you instructed.
+    module BiometricTemplatesListResponseResultsSourceType
+      SESSION_DELETE = "session_delete"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+
+      VALUES = [SESSION_DELETE, AUTOMATIC_RETENTION, BACKFILL].freeze
+    end
+
+    # Only `active` templates that are not held, not past `expires_at`, and whose User still exists take part in
+    # matching.
+    module BiometricTemplatesListResponseResultsStatus
+      PENDING = "pending"
+      ACTIVE = "active"
+      EXPIRED = "expired"
+      HELD_OUT_OF_USE = "held_out_of_use"
+      PURGE_PENDING = "purge_pending"
+      PURGE_FAILED = "purge_failed"
+      PURGED = "purged"
+
+      VALUES = [PENDING, ACTIVE, EXPIRED, HELD_OUT_OF_USE, PURGE_PENDING, PURGE_FAILED, PURGED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesRetrieveResponseInstructionClass
+      OPERATIONAL_SESSION_DELETE = "operational_session_delete"
+      PRIVACY_ERASURE = "privacy_erasure"
+
+      VALUES = [OPERATIONAL_SESSION_DELETE, PRIVACY_ERASURE].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesRetrieveResponseInstructionSource
+      API = "api"
+      CONSOLE = "console"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+      PRIVACY_ERASURE = "privacy_erasure"
+      EXPLICIT_TEMPLATE_PURGE = "explicit_template_purge"
+      VENDOR_USER_DELETE = "vendor_user_delete"
+      EXPIRY = "expiry"
+      RECONCILIATION = "reconciliation"
+      MIGRATION = "migration"
+      SYSTEM = "system"
+
+      VALUES = [API, CONSOLE, AUTOMATIC_RETENTION, BACKFILL, PRIVACY_ERASURE, EXPLICIT_TEMPLATE_PURGE, VENDOR_USER_DELETE, EXPIRY, RECONCILIATION, MIGRATION, SYSTEM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module BiometricTemplatesRetrieveResponseRetainedByType
+      API_KEY = "API_KEY"
+      CONSOLE_USER = "CONSOLE_USER"
+      SYSTEM = "SYSTEM"
+
+      VALUES = [API_KEY, CONSOLE_USER, SYSTEM].freeze
+    end
+
+    # The application policy at retention time.
+    module BiometricTemplatesRetrieveResponseRetentionPolicy
+      DELETE_WITH_SESSION = "delete_with_session"
+      RETAIN_UNTIL_USER_DELETED = "retain_until_user_deleted"
+
+      VALUES = [DELETE_WITH_SESSION, RETAIN_UNTIL_USER_DELETED].freeze
+    end
+
+    # How the template was created: a session deletion (API or Console), the application's automatic data-retention
+    # window, or a Didit-operated backfill you instructed.
+    module BiometricTemplatesRetrieveResponseSourceType
+      SESSION_DELETE = "session_delete"
+      AUTOMATIC_RETENTION = "automatic_retention"
+      BACKFILL = "backfill"
+
+      VALUES = [SESSION_DELETE, AUTOMATIC_RETENTION, BACKFILL].freeze
+    end
+
+    # Only `active` templates that are not held, not past `expires_at`, and whose User still exists take part in
+    # matching.
+    module BiometricTemplatesRetrieveResponseStatus
+      PENDING = "pending"
+      ACTIVE = "active"
+      EXPIRED = "expired"
+      HELD_OUT_OF_USE = "held_out_of_use"
+      PURGE_PENDING = "purge_pending"
+      PURGE_FAILED = "purge_failed"
+      PURGED = "purged"
+
+      VALUES = [PENDING, ACTIVE, EXPIRED, HELD_OUT_OF_USE, PURGE_PENDING, PURGE_FAILED, PURGED].freeze
+    end
+
+    class BiometricTemplatesBatchDeleteResponse < Didit::Model
+      field :results, "results", [:array, "BiometricTemplatesBatchDeleteResponseResults"]
+    end
+
+    class BiometricTemplatesBatchDeleteResponseResults < Didit::Model
+      field :uuid, "uuid", :string
+      field :outcome, "outcome", :string
+    end
+
+    class BiometricTemplatesCountResponse < Didit::Model
+      field :count, "count", :integer
+    end
+
+    class BiometricTemplatesDeleteResponse < Didit::Model
+      field :uuid, "uuid", :string
+      field :outcome, "outcome", :string
+    end
+
+    class BiometricTemplatesListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "BiometricTemplatesListResponseResults"]
+    end
+
+    class BiometricTemplatesListResponseResults < Didit::Model
+      field :uuid, "uuid", :string
+      field :vendor_user_uuid, "vendor_user_uuid", :string
+      field :vendor_data, "vendor_data", :string
+      field :source_type, "source_type", :string
+      field :provenance_reference, "provenance_reference", :string
+      field :retention_policy, "retention_policy", :string
+      field :retention_override, "retention_override", :boolean
+      field :retained_at, "retained_at", :datetime
+      field :expires_at, "expires_at", :datetime
+      field :retained_by, "retained_by", :string
+      field :retained_by_type, "retained_by_type", :string
+      field :instruction_class, "instruction_class", :string
+      field :instruction_source, "instruction_source", :string
+      field :instruction_id, "instruction_id", :string
+      field :held_out_of_use, "held_out_of_use", :boolean
+      field :status, "status", :string
+      field :purged_at, "purged_at", :datetime
+    end
+
+    class BiometricTemplatesRetrieveResponse < Didit::Model
+      field :uuid, "uuid", :string
+      field :vendor_user_uuid, "vendor_user_uuid", :string
+      field :vendor_data, "vendor_data", :string
+      field :source_type, "source_type", :string
+      field :provenance_reference, "provenance_reference", :string
+      field :retention_policy, "retention_policy", :string
+      field :retention_override, "retention_override", :boolean
+      field :retained_at, "retained_at", :datetime
+      field :expires_at, "expires_at", :datetime
+      field :retained_by, "retained_by", :string
+      field :retained_by_type, "retained_by_type", :string
+      field :instruction_class, "instruction_class", :string
+      field :instruction_source, "instruction_source", :string
+      field :instruction_id, "instruction_id", :string
+      field :held_out_of_use, "held_out_of_use", :boolean
+      field :status, "status", :string
+      field :purged_at, "purged_at", :datetime
+    end
+  end
+end

data/lib/didit/types/blocklist.rb

@@ -0,0 +1,31 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Known values of an open enum: the API may send others.
+    module BlocklistListParamsItemType
+      FACE = "face"
+      DOCUMENT = "document"
+      PHONE = "phone"
+      EMAIL = "email"
+
+      VALUES = [FACE, DOCUMENT, PHONE, EMAIL].freeze
+    end
+
+    class BlocklistAddResponse < Didit::Model
+      field :message, "message", :string
+    end
+
+    class BlocklistListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "BlocklistedItem"]
+    end
+
+    class BlocklistRemoveResponse < Didit::Model
+      field :message, "message", :string
+    end
+  end
+end