didit-sdk 1.0.0

data/lib/didit/types/lists.rb

@@ -0,0 +1,111 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What the list holds: `face`, `document` (document number), `phone`, `email`, `ip_address` (IP address or CIDR
+    # range), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` or
+    # `business` (your `vendor_data`), or `key` (any string). It decides how entry values are validated and matched.
+    # Cannot be changed later.
+    module ListsCreateParamsEntryType
+      FACE = "face"
+      DOCUMENT = "document"
+      PHONE = "phone"
+      EMAIL = "email"
+      IP_ADDRESS = "ip_address"
+      DEVICE_FINGERPRINT = "device_fingerprint"
+      WALLET_ADDRESS = "wallet_address"
+      BANK_ACCOUNT = "bank_account"
+      COUNTRY = "country"
+      USER = "user"
+      BUSINESS = "business"
+      KEY = "key"
+
+      VALUES = [FACE, DOCUMENT, PHONE, EMAIL, IP_ADDRESS, DEVICE_FINGERPRINT, WALLET_ADDRESS, BANK_ACCOUNT, COUNTRY, USER, BUSINESS, KEY].freeze
+    end
+
+    # `allowlist` or `custom`. `blocklist` is refused with `400`.
+    module ListsCreateParamsListType
+      ALLOWLIST = "allowlist"
+      CUSTOM = "custom"
+
+      VALUES = [ALLOWLIST, CUSTOM].freeze
+    end
+
+    # Face lists with `reference_session_id`: which of the session's images the face is taken from. `liveness`
+    # (default) is the liveness selfie. `front_image_camera_front` and `back_image_camera_front` are the selfies the
+    # front camera took while the user photographed the front or back of their document: accepted only on the system
+    # face blocklist, with `reference_session_id` and an empty `value`. Each selfie can be added once and must show
+    # one clear face.
+    module ListsEntriesCreateParamsFaceImageSource
+      LIVENESS = "liveness"
+      FRONT_IMAGE_CAMERA_FRONT = "front_image_camera_front"
+      BACK_IMAGE_CAMERA_FRONT = "back_image_camera_front"
+
+      VALUES = [LIVENESS, FRONT_IMAGE_CAMERA_FRONT, BACK_IMAGE_CAMERA_FRONT].freeze
+    end
+
+    # What `reference_object_uuid` points to.
+    module ListsEntriesCreateParamsMetadataReferenceType
+      TRANSACTION = "transaction"
+      VENDOR_USER = "vendor_user"
+      VENDOR_BUSINESS = "vendor_business"
+
+      VALUES = [TRANSACTION, VENDOR_USER, VENDOR_BUSINESS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module ListsListParamsEntryType
+      FACE = "face"
+      DOCUMENT = "document"
+      PHONE = "phone"
+      EMAIL = "email"
+      IP_ADDRESS = "ip_address"
+      DEVICE_FINGERPRINT = "device_fingerprint"
+      WALLET_ADDRESS = "wallet_address"
+      BANK_ACCOUNT = "bank_account"
+      COUNTRY = "country"
+      USER = "user"
+      BUSINESS = "business"
+      KEY = "key"
+
+      VALUES = [FACE, DOCUMENT, PHONE, EMAIL, IP_ADDRESS, DEVICE_FINGERPRINT, WALLET_ADDRESS, BANK_ACCOUNT, COUNTRY, USER, BUSINESS, KEY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module ListsListParamsListType
+      BLOCKLIST = "blocklist"
+      ALLOWLIST = "allowlist"
+      CUSTOM = "custom"
+
+      VALUES = [BLOCKLIST, ALLOWLIST, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module ListsListParamsOrdering
+      CREATED_AT = "-created_at"
+      CREATED_AT_ = "created_at"
+
+      VALUES = [CREATED_AT, CREATED_AT_].freeze
+    end
+
+    class ListsEntriesListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "ComplianceListEntry"]
+    end
+
+    class ListsListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "ComplianceList"]
+    end
+
+    class ListsUpdateResponse < Didit::Model
+      field :name, "name", :string
+      field :description, "description", :string
+    end
+  end
+end

data/lib/didit/types/monitoring_events.rb

@@ -0,0 +1,235 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # `accepted`: stored and evaluated. `replayed`: already stored with the same content. `rejected`: not stored; see
+    # `errors`.
+    module MonitoringEventsCreateBatchResponseResultsOutcome
+      ACCEPTED = "accepted"
+      REPLAYED = "replayed"
+      REJECTED = "rejected"
+
+      VALUES = [ACCEPTED, REPLAYED, REJECTED].freeze
+    end
+
+    # Accepted and replayed items only.
+    module MonitoringEventsCreateBatchResponseResultsRetentionClass
+      LOW_VALUE = "low_value"
+      STANDARD = "standard"
+      RISK_RELEVANT = "risk_relevant"
+      MONETARY_OR_COMPLIANCE = "monetary_or_compliance"
+
+      VALUES = [LOW_VALUE, STANDARD, RISK_RELEVANT, MONETARY_OR_COMPLIANCE].freeze
+    end
+
+    # `TEST` rules record the match but apply no actions.
+    module MonitoringEventsCreateBatchResponseResultsRuleMatchesMode
+      ACTIVE = "ACTIVE"
+      TEST = "TEST"
+
+      VALUES = [ACTIVE, TEST].freeze
+    end
+
+    # Accepted and replayed items only.
+    module MonitoringEventsCreateBatchResponseResultsStatus
+      ACCEPTED = "ACCEPTED"
+      APPROVED = "APPROVED"
+      IN_REVIEW = "IN_REVIEW"
+      DECLINED = "DECLINED"
+
+      VALUES = [ACCEPTED, APPROVED, IN_REVIEW, DECLINED].freeze
+    end
+
+    # Event category.
+    module MonitoringEventsCreateParamsEventCategory
+      AUTH = "auth"
+      SESSION = "session"
+      GAMEPLAY = "gameplay"
+      BONUS = "bonus"
+      AFFILIATE = "affiliate"
+      PAYMENT = "payment"
+      DISPUTE = "dispute"
+      SECURITY = "security"
+      RESPONSIBLE_GAMBLING = "responsible_gambling"
+      CUSTOM = "custom"
+
+      VALUES = [AUTH, SESSION, GAMEPLAY, BONUS, AFFILIATE, PAYMENT, DISPUTE, SECURITY, RESPONSIBLE_GAMBLING, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsCreateSdkTokenParamsAllowedEventCategories
+      AUTH = "auth"
+      SESSION = "session"
+      GAMEPLAY = "gameplay"
+      BONUS = "bonus"
+      AFFILIATE = "affiliate"
+      PAYMENT = "payment"
+      DISPUTE = "dispute"
+      SECURITY = "security"
+      RESPONSIBLE_GAMBLING = "responsible_gambling"
+      CUSTOM = "custom"
+
+      VALUES = [AUTH, SESSION, GAMEPLAY, BONUS, AFFILIATE, PAYMENT, DISPUTE, SECURITY, RESPONSIBLE_GAMBLING, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsCreateSdkTokenResponseAllowedEventCategories
+      AUTH = "auth"
+      SESSION = "session"
+      GAMEPLAY = "gameplay"
+      BONUS = "bonus"
+      AFFILIATE = "affiliate"
+      PAYMENT = "payment"
+      DISPUTE = "dispute"
+      SECURITY = "security"
+      RESPONSIBLE_GAMBLING = "responsible_gambling"
+      CUSTOM = "custom"
+
+      VALUES = [AUTH, SESSION, GAMEPLAY, BONUS, AFFILIATE, PAYMENT, DISPUTE, SECURITY, RESPONSIBLE_GAMBLING, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsListParamsEventCategory
+      AUTH = "auth"
+      SESSION = "session"
+      GAMEPLAY = "gameplay"
+      BONUS = "bonus"
+      AFFILIATE = "affiliate"
+      PAYMENT = "payment"
+      DISPUTE = "dispute"
+      SECURITY = "security"
+      RESPONSIBLE_GAMBLING = "responsible_gambling"
+      CUSTOM = "custom"
+
+      VALUES = [AUTH, SESSION, GAMEPLAY, BONUS, AFFILIATE, PAYMENT, DISPUTE, SECURITY, RESPONSIBLE_GAMBLING, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsListParamsRetentionClass
+      LOW_VALUE = "low_value"
+      STANDARD = "standard"
+      RISK_RELEVANT = "risk_relevant"
+      MONETARY_OR_COMPLIANCE = "monetary_or_compliance"
+
+      VALUES = [LOW_VALUE, STANDARD, RISK_RELEVANT, MONETARY_OR_COMPLIANCE].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsListParamsStatus
+      ACCEPTED = "ACCEPTED"
+      APPROVED = "APPROVED"
+      IN_REVIEW = "IN_REVIEW"
+      DECLINED = "DECLINED"
+
+      VALUES = [ACCEPTED, APPROVED, IN_REVIEW, DECLINED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsListParamsSubjectEntityType
+      INDIVIDUAL = "individual"
+      COMPANY = "company"
+
+      VALUES = [INDIVIDUAL, COMPANY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsRetrieveSubjectTimelineParamsEntityType
+      INDIVIDUAL = "individual"
+      COMPANY = "company"
+
+      VALUES = [INDIVIDUAL, COMPANY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsRetrieveSubjectTimelineParamsEventCategory
+      AUTH = "auth"
+      SESSION = "session"
+      GAMEPLAY = "gameplay"
+      BONUS = "bonus"
+      AFFILIATE = "affiliate"
+      PAYMENT = "payment"
+      DISPUTE = "dispute"
+      SECURITY = "security"
+      RESPONSIBLE_GAMBLING = "responsible_gambling"
+      CUSTOM = "custom"
+
+      VALUES = [AUTH, SESSION, GAMEPLAY, BONUS, AFFILIATE, PAYMENT, DISPUTE, SECURITY, RESPONSIBLE_GAMBLING, CUSTOM].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsRetrieveSubjectTimelineParamsRetentionClass
+      LOW_VALUE = "low_value"
+      STANDARD = "standard"
+      RISK_RELEVANT = "risk_relevant"
+      MONETARY_OR_COMPLIANCE = "monetary_or_compliance"
+
+      VALUES = [LOW_VALUE, STANDARD, RISK_RELEVANT, MONETARY_OR_COMPLIANCE].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module MonitoringEventsRetrieveSubjectTimelineParamsStatus
+      ACCEPTED = "ACCEPTED"
+      APPROVED = "APPROVED"
+      IN_REVIEW = "IN_REVIEW"
+      DECLINED = "DECLINED"
+
+      VALUES = [ACCEPTED, APPROVED, IN_REVIEW, DECLINED].freeze
+    end
+
+    class MonitoringEventsCreateBatchResponse < Didit::Model
+      field :accepted_count, "accepted_count", :integer
+      field :replayed_count, "replayed_count", :integer
+      field :rejected_count, "rejected_count", :integer
+      field :results, "results", [:array, "MonitoringEventsCreateBatchResponseResults"]
+    end
+
+    # Outcome of one item. Accepted and replayed items also carry every field of `MonitoringEventIngestResult`;
+    # rejected items carry `event_id` and `errors` instead.
+    class MonitoringEventsCreateBatchResponseResults < Didit::Model
+      field :index, "index", :integer
+      field :outcome, "outcome", :string
+      field :event_id, "event_id", :string
+      field :errors, "errors", :any
+      field :event_uuid, "event_uuid", :string
+      field :status, "status", :string
+      field :score, "score", :integer
+      field :rules_evaluated_count, "rules_evaluated_count", :integer
+      field :rules_matched_count, "rules_matched_count", :integer
+      field :correlation_pending, "correlation_pending", :boolean
+      field :retention_class, "retention_class", :string
+      field :expires_at, "expires_at", :datetime
+      field :idempotent_replay, "idempotent_replay", :boolean
+      field :rule_matches, "rule_matches", [:array, "MonitoringEventsCreateBatchResponseResultsRuleMatches"]
+    end
+
+    class MonitoringEventsCreateBatchResponseResultsRuleMatches < Didit::Model
+      field :rule_id, "rule_id", :string
+      field :library_key, "library_key", :string
+      field :mode, "mode", :string
+      field :is_async, "is_async", :boolean
+    end
+
+    class MonitoringEventsCreateSdkTokenResponse < Didit::Model
+      field :monitoring_token, "monitoring_token", :string
+      field :expires_at, "expires_at", :datetime
+      field :allowed_event_categories, "allowed_event_categories", [:array, :string]
+      field :max_uses, "max_uses", :integer
+      field :bind_to_origin, "bind_to_origin", :string
+    end
+
+    class MonitoringEventsRetrieveEnrichmentMetricsResponse < Didit::Model
+      field :events_ingested, "events_ingested", :integer
+      field :events_rejected, "events_rejected", :integer
+      field :enrichment_lookups, "enrichment_lookups", :integer
+      field :enrichment_cache_hits, "enrichment_cache_hits", :integer
+      field :enrichment_provider_calls, "enrichment_provider_calls", :integer
+      field :enrichment_skipped_low_value, "enrichment_skipped_low_value", :integer
+      field :unique_ips_seen, "unique_ips_seen", :integer
+      field :period_days, "period_days", :integer
+      field :cache_hit_rate, "cache_hit_rate", :float
+      field :unique_ip_ratio, "unique_ip_ratio", :float
+      field :provider_calls_per_1k_events, "provider_calls_per_1k_events", :float
+    end
+  end
+end

data/lib/didit/types/networks.rb

@@ -0,0 +1,120 @@
+# 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 NetworksListParamsScope
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Why cross-organization signals do not apply, checked in this order. `plan`: the organization's plan does not
+    # include the cross-organization fraud network (it needs the Enterprise plan), whatever the sharing mode.
+    # `sharing_mode`: the plan includes it, but the sharing mode is `private` or `off`. Null when
+    # `cross_org_available` is `true`.
+    module NetworksListResponseCrossOrgUnavailableReason
+      PLAN = "plan"
+      SHARING_MODE = "sharing_mode"
+
+      VALUES = [PLAN, SHARING_MODE].freeze
+    end
+
+    # The organization's cross-organization sharing mode. Only `global` compares networks across organizations;
+    # `private` and `off` keep them to the organization's own history.
+    module NetworksListResponseSharingMode
+      OFF = "off"
+      PRIVATE = "private"
+      GLOBAL = "global"
+
+      VALUES = [OFF, PRIVATE, GLOBAL].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module NetworksRetrieveGraphParamsDepth
+      V_1 = "1"
+      V_2 = "2"
+      V_3 = "3"
+      ALL = "all"
+
+      VALUES = [V_1, V_2, V_3, ALL].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module NetworksRetrieveGraphParamsFocusKind
+      VENDOR_USER = "vendor_user"
+      VENDOR_BUSINESS = "vendor_business"
+      TRANSACTION_PARTY = "transaction_party"
+
+      VALUES = [VENDOR_USER, VENDOR_BUSINESS, TRANSACTION_PARTY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module NetworksRetrieveTimelineParamsContract
+      V_2 = "2"
+
+      VALUES = [V_2].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module NetworksRetrieveTimelineParamsEventType
+      NETWORK_DETECTED = "network_detected"
+      SIGNAL_OBSERVED = "signal_observed"
+      NETWORK_ACTIVE = "network_active"
+      NETWORK_IN_REVIEW = "network_in_review"
+      NETWORK_RESOLVED = "network_resolved"
+      NETWORK_DISMISSED = "network_dismissed"
+      VERIFICATION_ATTEMPT = "verification_attempt"
+      TRANSACTION = "transaction"
+      LOGIN = "login"
+      RULE_HIT = "rule_hit"
+      CASE_LINKED = "case_linked"
+      NOTE_ADDED = "note_added"
+
+      VALUES = [NETWORK_DETECTED, SIGNAL_OBSERVED, NETWORK_ACTIVE, NETWORK_IN_REVIEW, NETWORK_RESOLVED, NETWORK_DISMISSED, VERIFICATION_ATTEMPT, TRANSACTION, LOGIN, RULE_HIT, CASE_LINKED, NOTE_ADDED].freeze
+    end
+
+    class NetworksListMembersResponse < Didit::Model
+      field :results, "results", [:array, "NetworkMember"]
+    end
+
+    class NetworksListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :integer
+      field :previous, "previous", :integer
+      field :results, "results", [:array, "NetworkListItem"]
+      field :kpis, "kpis", "NetworksListResponseKpis"
+      field :counts, "counts", "NetworkListCounts"
+      field :sharing_mode, "sharing_mode", :string
+      field :cross_org_available, "cross_org_available", :boolean
+      field :cross_org_unavailable_reason, "cross_org_unavailable_reason", :string
+    end
+
+    # Each key is {value, delta} over the results matching the current filters. Omitted when `summary=false`.
+    class NetworksListResponseKpis < Didit::Model
+      field :active, "active", :any
+      field :in_review, "in_review", :any
+      field :applicants_involved, "applicants_involved", :any
+      field :detected_this_period, "detected_this_period", :any
+      field :false_positive_rate, "false_positive_rate", :any
+    end
+
+    class NetworksListSignalsResponse < Didit::Model
+      field :results, "results", [:array, "NetworkSignal"]
+    end
+
+    class NetworksNotesListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "NetworkNote"]
+    end
+
+    class NetworksRetrieveTimelineResponse < Didit::Model
+      field :results, "results", [:array, "NetworkTimelineEvent"]
+      field :next_cursor, "next_cursor", :string
+    end
+  end
+end

data/lib/didit/types/passive_liveness.rb

@@ -0,0 +1,95 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Always `PASSIVE` for this endpoint.
+    module PassiveLivenessCheckResponseLivenessMethod
+      PASSIVE = "PASSIVE"
+
+      VALUES = [PASSIVE].freeze
+    end
+
+    # `Declined` when at least one `error`-severity warning fired (no face, low score, presentation attack, or a
+    # blocklist hit); `Approved` otherwise. `warning`/`information` entries (multiple faces, duplicates) never decline
+    # on their own.
+    module PassiveLivenessCheckResponseLivenessStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, DECLINED].freeze
+    end
+
+    # Feature that raised the warning. Always `LIVENESS` on this endpoint.
+    module PassiveLivenessCheckResponseLivenessWarningsFeature
+      LIVENESS = "LIVENESS"
+
+      VALUES = [LIVENESS].freeze
+    end
+
+    # Severity. `error` warnings drive `status` to `Declined`; `warning` and `information` entries are advisory and
+    # never decline on their own.
+    module PassiveLivenessCheckResponseLivenessWarningsLogType
+      ERROR = "error"
+      WARNING = "warning"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, WARNING, INFORMATION].freeze
+    end
+
+    # Machine-readable risk code.
+    module PassiveLivenessCheckResponseLivenessWarningsRisk
+      NO_FACE_DETECTED = "NO_FACE_DETECTED"
+      LOW_LIVENESS_SCORE = "LOW_LIVENESS_SCORE"
+      LIVENESS_FACE_ATTACK = "LIVENESS_FACE_ATTACK"
+      MULTIPLE_FACES_DETECTED = "MULTIPLE_FACES_DETECTED"
+      FACE_IN_BLOCKLIST = "FACE_IN_BLOCKLIST"
+      POSSIBLE_FACE_IN_BLOCKLIST = "POSSIBLE_FACE_IN_BLOCKLIST"
+      DUPLICATED_FACE = "DUPLICATED_FACE"
+      POSSIBLE_DUPLICATED_FACE = "POSSIBLE_DUPLICATED_FACE"
+
+      VALUES = [NO_FACE_DETECTED, LOW_LIVENESS_SCORE, LIVENESS_FACE_ATTACK, MULTIPLE_FACES_DETECTED, FACE_IN_BLOCKLIST, POSSIBLE_FACE_IN_BLOCKLIST, DUPLICATED_FACE, POSSIBLE_DUPLICATED_FACE].freeze
+    end
+
+    class PassiveLivenessCheckResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :liveness, "liveness", "PassiveLivenessCheckResponseLiveness"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class PassiveLivenessCheckResponseLiveness < Didit::Model
+      field :status, "status", :string
+      field :method_, "method", :string
+      field :score, "score", :float
+      field :user_image, "user_image", "PassiveLivenessCheckResponseLivenessUserImage"
+      field :warnings, "warnings", [:array, "PassiveLivenessCheckResponseLivenessWarnings"]
+      field :face_quality, "face_quality", :float
+      field :face_luminance, "face_luminance", :float
+    end
+
+    # Face-detection results for the submitted image.
+    class PassiveLivenessCheckResponseLivenessUserImage < Didit::Model
+      field :entities, "entities", [:array, "PassiveLivenessCheckResponseLivenessUserImageEntities"]
+      field :best_angle, "best_angle", :integer
+    end
+
+    class PassiveLivenessCheckResponseLivenessUserImageEntities < Didit::Model
+      field :bbox, "bbox", [:array, :integer]
+      field :confidence, "confidence", :float
+      field :age, "age", :float
+      field :gender, "gender", :string
+      field :race, "race", :string
+    end
+
+    class PassiveLivenessCheckResponseLivenessWarnings < 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

data/lib/didit/types/phone.rb

@@ -0,0 +1,69 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What to do when the carrier lookup flags the number as a temporary/burner line (`phone.is_disposable`).
+    # `DECLINE` flips the final `status` to `Declined`; `NO_ACTION` records the risk in `phone.warnings`.
+    module PhoneCheckCodeParamsDisposableNumberAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when the same number was already used by a different user (different `vendor_data`) of your
+    # application. `DECLINE` flips the final `status` to `Declined`; `NO_ACTION` records the risk in `phone.warnings`
+    # and fills `phone.matches`.
+    module PhoneCheckCodeParamsDuplicatedPhoneNumberAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # Action when the social footprint check finds the number registered on none of the platforms it covers. Only
+    # NO_ACTION and DECLINE are accepted on this endpoint; REVIEW is available on the workflow configuration key of
+    # the same name.
+    module PhoneCheckCodeParamsPhoneNoSocialPresenceAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when the carrier lookup reports a virtual line type - `voip`, `isp`, or `vpn` (`phone.is_virtual`).
+    # `DECLINE` flips the final `status` to `Declined`; `NO_ACTION` records the risk in `phone.warnings`.
+    module PhoneCheckCodeParamsVoipNumberAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # Preferred delivery channel. If the channel is unavailable for the destination country or number, the message
+    # automatically falls back to SMS - the send still reports `Success`.
+    module PhoneSendCodeParamsOptionsPreferredChannel
+      WHATSAPP = "whatsapp"
+      SMS = "sms"
+      TELEGRAM = "telegram"
+      VOICE = "voice"
+      RCS = "rcs"
+      VIBER = "viber"
+      ZALO = "zalo"
+
+      VALUES = [WHATSAPP, SMS, TELEGRAM, VOICE, RCS, VIBER, ZALO].freeze
+    end
+
+    # Platform of the end user's device.
+    module PhoneSendCodeParamsSignalsDevicePlatform
+      ANDROID = "android"
+      IOS = "ios"
+      IPADOS = "ipados"
+      TVOS = "tvos"
+      WEB = "web"
+
+      VALUES = [ANDROID, IOS, IPADOS, TVOS, WEB].freeze
+    end
+  end
+end