prelude-sdk 0.7.0 → 0.8.0

data/lib/prelude_sdk/models/signals.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    class Signals < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute app_version
+      #   The version of your application.
+      #
+      #   @return [String, nil]
+      optional :app_version, String
+
+      # @!attribute device_id
+      #   A unique ID for the user's device. You should ensure that each user device has a
+      #   unique `device_id` value. Ideally, for Android, this corresponds to the
+      #   `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
+      #
+      #   @return [String, nil]
+      optional :device_id, String
+
+      # @!attribute device_model
+      #   The model of the user's device.
+      #
+      #   @return [String, nil]
+      optional :device_model, String
+
+      # @!attribute device_platform
+      #   The type of the user's device.
+      #
+      #   @return [Symbol, PreludeSDK::Models::Signals::DevicePlatform, nil]
+      optional :device_platform, enum: -> { PreludeSDK::Signals::DevicePlatform }
+
+      # @!attribute existing_user
+      #   Whether the end-user already exists in your system, for example an existing
+      #   account signing in again rather than a first-time signup. Unlike
+      #   `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+      #   account as one additional anti-fraud signal. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @return [Boolean, nil]
+      optional :existing_user, PreludeSDK::Internal::Type::Boolean
+
+      # @!attribute ip
+      #   The public IP v4 or v6 address of the end-user's device. You should collect this
+      #   from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
+      #   `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
+      #   the actual public IP of the end-user's device.
+      #
+      #   @return [String, nil]
+      optional :ip, String
+
+      # @!attribute is_trusted_user
+      #   This signal should indicate a higher level of trust, explicitly stating that the
+      #   user is genuine. Contact us to discuss your use case. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @return [Boolean, nil]
+      optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
+
+      # @!attribute ja4_fingerprint
+      #   The JA4 fingerprint observed for the end-user's connection. Prelude will infer
+      #   it automatically when you use our Frontend SDKs (which use Prelude's edge
+      #   network), but you can also forward the value if you terminate TLS yourself.
+      #
+      #   @return [String, nil]
+      optional :ja4_fingerprint, String
+
+      # @!attribute os_version
+      #   The version of the user's device operating system.
+      #
+      #   @return [String, nil]
+      optional :os_version, String
+
+      # @!attribute user_agent
+      #   The user agent of the user's device. If the individual fields (os_version,
+      #   device_platform, device_model) are provided, we will prioritize those values
+      #   instead of parsing them from the user agent string.
+      #
+      #   @return [String, nil]
+      optional :user_agent, String
+
+      # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, existing_user: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::Signals} for more details.
+      #
+      #   The signals used for anti-fraud. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @param app_version [String] The version of your application.
+      #
+      #   @param device_id [String] A unique ID for the user's device. You should ensure that each user device has a
+      #
+      #   @param device_model [String] The model of the user's device.
+      #
+      #   @param device_platform [Symbol, PreludeSDK::Models::Signals::DevicePlatform] The type of the user's device.
+      #
+      #   @param existing_user [Boolean] Whether the end-user already exists in your system, for example an existing acco
+      #
+      #   @param ip [String] The public IP v4 or v6 address of the end-user's device. You should collect this
+      #
+      #   @param is_trusted_user [Boolean] This signal should indicate a higher level of trust, explicitly stating that the
+      #
+      #   @param ja4_fingerprint [String] The JA4 fingerprint observed for the end-user's connection. Prelude will infer i
+      #
+      #   @param os_version [String] The version of the user's device operating system.
+      #
+      #   @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
+
+      # The type of the user's device.
+      #
+      # @see PreludeSDK::Models::Signals#device_platform
+      module DevicePlatform
+        extend PreludeSDK::Internal::Type::Enum
+
+        ANDROID = :android
+        IOS = :ios
+        IPADOS = :ipados
+        TVOS = :tvos
+        WEB = :web
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/target.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    class Target < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute type
+      #   The type of the target. Either "phone_number" or "email_address".
+      #
+      #   @return [Symbol, PreludeSDK::Models::Target::Type]
+      required :type, enum: -> { PreludeSDK::Target::Type }
+
+      # @!attribute value
+      #   An E.164 formatted phone number or an email address.
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(type:, value:)
+      #   The operation target. Either a phone number or an email address.
+      #
+      #   @param type [Symbol, PreludeSDK::Models::Target::Type] The type of the target. Either "phone_number" or "email_address".
+      #
+      #   @param value [String] An E.164 formatted phone number or an email address.
+
+      # The type of the target. Either "phone_number" or "email_address".
+      #
+      # @see PreludeSDK::Models::Target#type
+      module Type
+        extend PreludeSDK::Internal::Type::Enum
+
+        PHONE_NUMBER = :phone_number
+        EMAIL_ADDRESS = :email_address
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification/phone/history_list_params.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        # @see PreludeSDK::Resources::Verification::Phone::History#list
+        class HistoryListParams < PreludeSDK::Internal::Type::BaseModel
+          extend PreludeSDK::Internal::Type::RequestParameters::Converter
+          include PreludeSDK::Internal::Type::RequestParameters
+
+          # @!attribute channels
+          #   Only verifications that could use one of these channels. Repeat the parameter
+          #   for several values.
+          #
+          #   @return [Array<Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Channel>, nil]
+          optional :channels,
+                   -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::Verification::Phone::HistoryListParams::Channel] }
+
+          # @!attribute cursor
+          #   Pagination cursor from the previous response.
+          #
+          #   @return [String, nil]
+          optional :cursor, String
+
+          # @!attribute device_platform
+          #   Only verifications created from this device platform.
+          #
+          #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::DevicePlatform, nil]
+          optional :device_platform, enum: -> { PreludeSDK::Verification::Phone::HistoryListParams::DevicePlatform }
+
+          # @!attribute from
+          #   Only verifications created at or after this RFC 3339 timestamp. Goes with `to`,
+          #   at most 6 months apart. Without them the whole history is searched.
+          #
+          #   @return [Time, nil]
+          optional :from, Time
+
+          # @!attribute limit
+          #   Maximum number of verifications to return per page.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute max_attempts
+          #   Only verifications that sent at most this many messages. `0` keeps the
+          #   verifications that never sent one.
+          #
+          #   @return [Integer, nil]
+          optional :max_attempts, Integer
+
+          # @!attribute min_attempts
+          #   Only verifications that sent at least this many messages.
+          #
+          #   @return [Integer, nil]
+          optional :min_attempts, Integer
+
+          # @!attribute phone_number
+          #   Only verifications targeting this E.164 phone number. The leading `+` may be
+          #   omitted.
+          #
+          #   @return [String, nil]
+          optional :phone_number, String
+
+          # @!attribute region
+          #   Only verifications of phone numbers from this region, as an ISO 3166-1 alpha-2
+          #   code.
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!attribute status
+          #   Only verifications in this status. `pending_check` cannot be filtered on.
+          #
+          #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Status, nil]
+          optional :status, enum: -> { PreludeSDK::Verification::Phone::HistoryListParams::Status }
+
+          # @!attribute template_id
+          #   Only verifications sent with this template, as returned in `template_id` by
+          #   [Get a phone verification](/verify/v2/api-reference/history/get-a-phone-verification).
+          #   Built-in templates (`prelude:*`) cannot be filtered on.
+          #
+          #   @return [String, nil]
+          optional :template_id, String
+
+          # @!attribute to
+          #   Only verifications created at or before this RFC 3339 timestamp. Goes with
+          #   `from`.
+          #
+          #   @return [Time, nil]
+          optional :to, Time
+
+          # @!method initialize(channels: nil, cursor: nil, device_platform: nil, from: nil, limit: nil, max_attempts: nil, min_attempts: nil, phone_number: nil, region: nil, status: nil, template_id: nil, to: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::Verification::Phone::HistoryListParams} for more details.
+          #
+          #   @param channels [Array<Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Channel>] Only verifications that could use one of these channels. Repeat the parameter fo
+          #
+          #   @param cursor [String] Pagination cursor from the previous response.
+          #
+          #   @param device_platform [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::DevicePlatform] Only verifications created from this device platform.
+          #
+          #   @param from [Time] Only verifications created at or after this RFC 3339 timestamp. Goes with `to`,
+          #
+          #   @param limit [Integer] Maximum number of verifications to return per page.
+          #
+          #   @param max_attempts [Integer] Only verifications that sent at most this many messages. `0` keeps the verificat
+          #
+          #   @param min_attempts [Integer] Only verifications that sent at least this many messages.
+          #
+          #   @param phone_number [String] Only verifications targeting this E.164 phone number. The leading `+` may be omi
+          #
+          #   @param region [String] Only verifications of phone numbers from this region, as an ISO 3166-1 alpha-2 c
+          #
+          #   @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListParams::Status] Only verifications in this status. `pending_check` cannot be filtered on.
+          #
+          #   @param template_id [String] Only verifications sent with this template, as returned in `template_id` by [Get
+          #
+          #   @param to [Time] Only verifications created at or before this RFC 3339 timestamp. Goes with `from
+          #
+          #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          module Channel
+            extend PreludeSDK::Internal::Type::Enum
+
+            SMS = :sms
+            RCS = :rcs
+            WHATSAPP = :whatsapp
+            VIBER = :viber
+            ZALO = :zalo
+            TELEGRAM = :telegram
+            VOICE = :voice
+            SILENT = :silent
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Only verifications created from this device platform.
+          module DevicePlatform
+            extend PreludeSDK::Internal::Type::Enum
+
+            ANDROID = :android
+            IOS = :ios
+            IPADOS = :ipados
+            TVOS = :tvos
+            WEB = :web
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Only verifications in this status. `pending_check` cannot be filtered on.
+          module Status
+            extend PreludeSDK::Internal::Type::Enum
+
+            CONVERTED = :converted
+            NOT_CONVERTED = :not_converted
+            PENDING_CHECK = :pending_check
+            SENT = :sent
+            CHALLENGED = :challenged
+            SUSPECTED_FRAUD = :suspected_fraud
+            IN_BLOCKLIST = :in_blocklist
+            INVALID_LINE = :invalid_line
+            INVALID_NUMBER = :invalid_number
+            RATE_LIMITED = :rate_limited
+            EXPIRED_SIGNALS = :expired_signals
+            SHADOWED = :shadowed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification/phone/history_list_response.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        # @see PreludeSDK::Resources::Verification::Phone::History#list
+        class HistoryListResponse < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute verifications
+          #   The page of verifications, most recent first.
+          #
+          #   @return [Array<PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification>]
+          required :verifications,
+                   -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification] }
+
+          # @!attribute next_cursor
+          #   Pagination cursor for the next page of results. Omitted if there are no more
+          #   pages.
+          #
+          #   @return [String, nil]
+          optional :next_cursor, String
+
+          # @!method initialize(verifications:, next_cursor: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::Verification::Phone::HistoryListResponse} for more details.
+          #
+          #   @param verifications [Array<PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification>] The page of verifications, most recent first.
+          #
+          #   @param next_cursor [String] Pagination cursor for the next page of results. Omitted if there are no more pag
+
+          class Verification < PreludeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   The verification identifier.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute channels
+            #   The channels the verification could use, and which one the end user converted
+            #   through. Empty when the verification used only channels this API does not list.
+            #
+            #   @return [Array<PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel>]
+            required :channels,
+                     -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel] }
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute delivered
+            #   Whether at least one message was reported delivered.
+            #
+            #   @return [Boolean]
+            required :delivered, PreludeSDK::Internal::Type::Boolean
+
+            # @!attribute phone_number
+            #   The E.164 phone number the verification targeted.
+            #
+            #   @return [String]
+            required :phone_number, String
+
+            # @!attribute status
+            #   The outcome of the verification.
+            #
+            #   - `converted` - The end user submitted a valid code.
+            #   - `not_converted` - The verification expired without a valid code.
+            #   - `pending_check` - A code was delivered and Prelude is still waiting for a
+            #     check.
+            #   - `sent` - A code was sent and the verification window is still open.
+            #   - `challenged` - The verification was restricted to non-SMS and non-voice
+            #     channels.
+            #   - `suspected_fraud` - The anti-fraud system blocked the verification.
+            #   - `in_blocklist` - The phone number is on the configured block list.
+            #   - `invalid_line` - The phone number is not a valid line type.
+            #   - `invalid_number` - The phone number is not a valid number.
+            #   - `rate_limited` - The verification was refused by a rate limit.
+            #   - `expired_signals` - The SDK signals were collected too long before the
+            #     request.
+            #   - `shadowed` - The anti-fraud system flagged the verification without blocking
+            #     it.
+            #
+            #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Status]
+            required :status,
+                     enum: -> { PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Status }
+
+            # @!attribute attempts
+            #   Number of messages sent for the verification, `0` when none was. Absent for
+            #   sandboxed phone numbers.
+            #
+            #   @return [Integer, nil]
+            optional :attempts, Integer
+
+            # @!attribute converted_at
+            #   When the end user submitted a valid code. Absent unless the verification
+            #   converted.
+            #
+            #   @return [Time, nil]
+            optional :converted_at, Time
+
+            # @!attribute cost
+            #   Total cost of the verification. Absent when nothing was billed.
+            #
+            #   @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil]
+            optional :cost, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney }
+
+            # @!attribute device_platform
+            #   Platform of the end-user device, when known.
+            #
+            #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::DevicePlatform, nil]
+            optional :device_platform,
+                     enum: -> { PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::DevicePlatform }
+
+            # @!attribute phone_number_condition
+            #   Whether the phone number was allow-listed, block-listed, or sandboxed at
+            #   verification time.
+            #
+            #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::PhoneNumberCondition, nil]
+            optional :phone_number_condition,
+                     enum: -> { PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::PhoneNumberCondition }
+
+            # @!attribute signals_hash_status
+            #   Whether the SDK signals integrity check passed.
+            #
+            #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::SignalsHashStatus, nil]
+            optional :signals_hash_status,
+                     enum: -> { PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::SignalsHashStatus }
+
+            # @!method initialize(id:, channels:, created_at:, delivered:, phone_number:, status:, attempts: nil, converted_at: nil, cost: nil, device_platform: nil, phone_number_condition: nil, signals_hash_status: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification} for
+            #   more details.
+            #
+            #   One entry of the verification history.
+            #   [Get a phone verification](/verify/v2/api-reference/history/get-a-phone-verification)
+            #   returns the full record.
+            #
+            #   @param id [String] The verification identifier.
+            #
+            #   @param channels [Array<PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel>] The channels the verification could use, and which one the end user converted th
+            #
+            #   @param created_at [Time]
+            #
+            #   @param delivered [Boolean] Whether at least one message was reported delivered.
+            #
+            #   @param phone_number [String] The E.164 phone number the verification targeted.
+            #
+            #   @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Status] The outcome of the verification.
+            #
+            #   @param attempts [Integer] Number of messages sent for the verification, `0` when none was. Absent for sand
+            #
+            #   @param converted_at [Time] When the end user submitted a valid code. Absent unless the verification convert
+            #
+            #   @param cost [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney] Total cost of the verification. Absent when nothing was billed.
+            #
+            #   @param device_platform [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::DevicePlatform] Platform of the end-user device, when known.
+            #
+            #   @param phone_number_condition [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::PhoneNumberCondition] Whether the phone number was allow-listed, block-listed, or sandboxed at verific
+            #
+            #   @param signals_hash_status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::SignalsHashStatus] Whether the SDK signals integrity check passed.
+
+            class Channel < PreludeSDK::Internal::Type::BaseModel
+              # @!attribute channel
+              #
+              #   @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel::Channel]
+              required :channel,
+                       enum: -> { PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel::Channel }
+
+              # @!attribute converted
+              #   Whether the end user submitted a valid code received through this channel.
+              #
+              #   @return [Boolean]
+              required :converted, PreludeSDK::Internal::Type::Boolean
+
+              # @!method initialize(channel:, converted:)
+              #   @param channel [Symbol, PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel::Channel]
+              #
+              #   @param converted [Boolean] Whether the end user submitted a valid code received through this channel.
+
+              # @see PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification::Channel#channel
+              module Channel
+                extend PreludeSDK::Internal::Type::Enum
+
+                SMS = :sms
+                RCS = :rcs
+                WHATSAPP = :whatsapp
+                VIBER = :viber
+                ZALO = :zalo
+                TELEGRAM = :telegram
+                VOICE = :voice
+                SILENT = :silent
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # The outcome of the verification.
+            #
+            # - `converted` - The end user submitted a valid code.
+            # - `not_converted` - The verification expired without a valid code.
+            # - `pending_check` - A code was delivered and Prelude is still waiting for a
+            #   check.
+            # - `sent` - A code was sent and the verification window is still open.
+            # - `challenged` - The verification was restricted to non-SMS and non-voice
+            #   channels.
+            # - `suspected_fraud` - The anti-fraud system blocked the verification.
+            # - `in_blocklist` - The phone number is on the configured block list.
+            # - `invalid_line` - The phone number is not a valid line type.
+            # - `invalid_number` - The phone number is not a valid number.
+            # - `rate_limited` - The verification was refused by a rate limit.
+            # - `expired_signals` - The SDK signals were collected too long before the
+            #   request.
+            # - `shadowed` - The anti-fraud system flagged the verification without blocking
+            #   it.
+            #
+            # @see PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification#status
+            module Status
+              extend PreludeSDK::Internal::Type::Enum
+
+              CONVERTED = :converted
+              NOT_CONVERTED = :not_converted
+              PENDING_CHECK = :pending_check
+              SENT = :sent
+              CHALLENGED = :challenged
+              SUSPECTED_FRAUD = :suspected_fraud
+              IN_BLOCKLIST = :in_blocklist
+              INVALID_LINE = :invalid_line
+              INVALID_NUMBER = :invalid_number
+              RATE_LIMITED = :rate_limited
+              EXPIRED_SIGNALS = :expired_signals
+              SHADOWED = :shadowed
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Platform of the end-user device, when known.
+            #
+            # @see PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification#device_platform
+            module DevicePlatform
+              extend PreludeSDK::Internal::Type::Enum
+
+              ANDROID = :android
+              IOS = :ios
+              IPADOS = :ipados
+              TVOS = :tvos
+              WEB = :web
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Whether the phone number was allow-listed, block-listed, or sandboxed at
+            # verification time.
+            #
+            # @see PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification#phone_number_condition
+            module PhoneNumberCondition
+              extend PreludeSDK::Internal::Type::Enum
+
+              ALLOW_LISTED = :allow_listed
+              BLOCK_LISTED = :block_listed
+              SANDBOXED = :sandboxed
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Whether the SDK signals integrity check passed.
+            #
+            # @see PreludeSDK::Models::Verification::Phone::HistoryListResponse::Verification#signals_hash_status
+            module SignalsHashStatus
+              extend PreludeSDK::Internal::Type::Enum
+
+              VALID = :valid
+              INVALID = :invalid
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification/phone/history_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        # @see PreludeSDK::Resources::Verification::Phone::History#retrieve
+        class HistoryRetrieveParams < PreludeSDK::Internal::Type::BaseModel
+          extend PreludeSDK::Internal::Type::RequestParameters::Converter
+          include PreludeSDK::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:, request_options: {})
+          #   @param id [String]
+          #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end