prelude-sdk 0.2.0 → 0.4.0

data/lib/prelude_sdk/models/notify_send_params.rb

@@ -25,6 +25,13 @@ module PreludeSDK
       #   @return [String, nil]
       optional :callback_url, String
 
+      # @!attribute context
+      #   Context for replying to an inbound message. When provided, the message is sent
+      #   as a WhatsApp reply within the 24-hour conversation window.
+      #
+      #   @return [PreludeSDK::Models::NotifySendParams::Context, nil]
+      optional :context, -> { PreludeSDK::NotifySendParams::Context }
+
       # @!attribute correlation_id
       #   A user-defined identifier to correlate this message with your internal systems.
       #   It is returned in the response and any webhook events that refer to this
@@ -33,6 +40,21 @@ module PreludeSDK
       #   @return [String, nil]
       optional :correlation_id, String
 
+      # @!attribute document
+      #   A media attachment to include in the message header. Supported on WhatsApp
+      #   templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+      #   type is determined by the template's registered header format; send the matching
+      #   file type for each.
+      #
+      #   - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+      #     required and displayed to the recipient.
+      #   - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+      #     is ignored.
+      #   - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+      #
+      #   @return [PreludeSDK::Models::NotifySendParams::Document, nil]
+      optional :document, -> { PreludeSDK::NotifySendParams::Document }
+
       # @!attribute expires_at
       #   The message expiration date in RFC3339 format. The message will not be sent if
       #   this time is reached.
@@ -70,13 +92,21 @@ module PreludeSDK
       #   @return [Time, nil]
       optional :schedule_at, Time
 
+      # @!attribute text
+      #   The reply message body. Required when `context.reply_to` is provided. Used for
+      #   2-way WhatsApp messaging to send free-form text replies within a conversation
+      #   window.
+      #
+      #   @return [String, nil]
+      optional :text, String
+
       # @!attribute variables
       #   The variables to be replaced in the template.
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :variables, PreludeSDK::Internal::Type::HashOf[String]
 
-      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      # @!method initialize(template_id:, to:, callback_url: nil, context: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, text: nil, variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::NotifySendParams} for more details.
       #
@@ -86,8 +116,12 @@ module PreludeSDK
       #
       #   @param callback_url [String] The URL where webhooks will be sent for message delivery events.
       #
+      #   @param context [PreludeSDK::Models::NotifySendParams::Context] Context for replying to an inbound message. When provided, the message is sent a
+      #
       #   @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
       #
+      #   @param document [PreludeSDK::Models::NotifySendParams::Document] A media attachment to include in the message header. Supported on
+      #
       #   @param expires_at [Time] The message expiration date in RFC3339 format. The message will not be sent if t
       #
       #   @param from [String] The Sender ID. Must be approved for your account.
@@ -98,16 +132,73 @@ module PreludeSDK
       #
       #   @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
       #
+      #   @param text [String] The reply message body. Required when `context.reply_to` is provided. Used for 2
+      #
       #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+      class Context < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute reply_to
+        #   The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+        #   the `inbound.message.received` webhook event.
+        #
+        #   @return [String]
+        required :reply_to, String
+
+        # @!method initialize(reply_to:)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifySendParams::Context} for more details.
+        #
+        #   Context for replying to an inbound message. When provided, the message is sent
+        #   as a WhatsApp reply within the 24-hour conversation window.
+        #
+        #   @param reply_to [String] The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+      end
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute url
+        #   HTTPS URL of the media file. The file extension must match the template's
+        #   registered header format (PDF for DOCUMENT; PNG/JPG/JPEG/WEBP for IMAGE; MP4/3GP
+        #   for VIDEO).
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute filename
+        #   Filename displayed to the recipient. Required for templates with a `DOCUMENT`
+        #   header; ignored for `IMAGE` and `VIDEO` headers.
+        #
+        #   @return [String, nil]
+        optional :filename, String
+
+        # @!method initialize(url:, filename: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifySendParams::Document} for more details.
+        #
+        #   A media attachment to include in the message header. Supported on WhatsApp
+        #   templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        #   type is determined by the template's registered header format; send the matching
+        #   file type for each.
+        #
+        #   - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #     required and displayed to the recipient.
+        #   - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #     is ignored.
+        #   - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+        #
+        #   @param url [String] HTTPS URL of the media file. The file extension must match the template's regist
+        #
+        #   @param filename [String] Filename displayed to the recipient. Required for templates with a `DOCUMENT` he
+      end
+
       # The preferred channel to be used in priority for message delivery. If the
       # channel is unavailable, the system will fallback to other available channels.
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum
 
         SMS = :sms
+        RCS = :rcs
         WHATSAPP = :whatsapp
 
         # @!method self.values

data/lib/prelude_sdk/models/notify_send_response.rb

@@ -52,6 +52,22 @@ module PreludeSDK
       #   @return [String, nil]
       optional :correlation_id, String
 
+      # @!attribute encoding
+      #   The SMS encoding type based on message content. GSM-7 supports standard
+      #   characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      #   emoji (up to 70 chars per segment). Only present for SMS messages.
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifySendResponse::Encoding, nil]
+      optional :encoding, enum: -> { PreludeSDK::Models::NotifySendResponse::Encoding }
+
+      # @!attribute estimated_segment_count
+      #   The estimated number of SMS segments for this message. This value is not
+      #   contractual; the actual segment count will be determined after the SMS is sent
+      #   by the provider. Only present for SMS messages.
+      #
+      #   @return [Integer, nil]
+      optional :estimated_segment_count, Integer
+
       # @!attribute from
       #   The Sender ID used for this message.
       #
@@ -66,7 +82,7 @@ module PreludeSDK
       #   @return [Time, nil]
       optional :schedule_at, Time
 
-      # @!method initialize(id:, created_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, from: nil, schedule_at: nil)
+      # @!method initialize(id:, created_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, encoding: nil, estimated_segment_count: nil, from: nil, schedule_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::NotifySendResponse} for more details.
       #
@@ -86,9 +102,28 @@ module PreludeSDK
       #
       #   @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
       #
+      #   @param encoding [Symbol, PreludeSDK::Models::NotifySendResponse::Encoding] The SMS encoding type based on message content. GSM-7 supports standard characte
+      #
+      #   @param estimated_segment_count [Integer] The estimated number of SMS segments for this message. This value is not contrac
+      #
       #   @param from [String] The Sender ID used for this message.
       #
       #   @param schedule_at [Time] When the message will actually be sent in RFC3339 format with timezone offset. F
+
+      # The SMS encoding type based on message content. GSM-7 supports standard
+      # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      # emoji (up to 70 chars per segment). Only present for SMS messages.
+      #
+      # @see PreludeSDK::Models::NotifySendResponse#encoding
+      module Encoding
+        extend PreludeSDK::Internal::Type::Enum
+
+        GSM_7 = :"GSM-7"
+        UCS_2 = :"UCS-2"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -33,6 +33,21 @@ module PreludeSDK
       #   @return [String, nil]
       optional :correlation_id, String
 
+      # @!attribute document
+      #   A media attachment to include in the message header. Supported on WhatsApp
+      #   templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+      #   type is determined by the template's registered header format; send the matching
+      #   file type for each.
+      #
+      #   - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+      #     required and displayed to the recipient.
+      #   - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+      #     is ignored.
+      #   - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+      #
+      #   @return [PreludeSDK::Models::TransactionalSendParams::Document, nil]
+      optional :document, -> { PreludeSDK::TransactionalSendParams::Document }
+
       # @!attribute expires_at
       #   The message expiration date.
       #
@@ -74,7 +89,7 @@ module PreludeSDK
       #   @return [Hash{Symbol=>String}, nil]
       optional :variables, PreludeSDK::Internal::Type::HashOf[String]
 
-      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::TransactionalSendParams} for more details.
       #
@@ -86,6 +101,8 @@ module PreludeSDK
       #
       #   @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
+      #   @param document [PreludeSDK::Models::TransactionalSendParams::Document] A media attachment to include in the message header. Supported on
+      #
       #   @param expires_at [String] The message expiration date.
       #
       #   @param from [String] The Sender ID.
@@ -98,6 +115,42 @@ module PreludeSDK
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute url
+        #   HTTPS URL of the media file. The file extension must match the template's
+        #   registered header format (PDF for DOCUMENT; PNG/JPG/JPEG/WEBP for IMAGE; MP4/3GP
+        #   for VIDEO).
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute filename
+        #   Filename displayed to the recipient. Required for templates with a `DOCUMENT`
+        #   header; ignored for `IMAGE` and `VIDEO` headers.
+        #
+        #   @return [String, nil]
+        optional :filename, String
+
+        # @!method initialize(url:, filename: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::TransactionalSendParams::Document} for more details.
+        #
+        #   A media attachment to include in the message header. Supported on WhatsApp
+        #   templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        #   type is determined by the template's registered header format; send the matching
+        #   file type for each.
+        #
+        #   - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #     required and displayed to the recipient.
+        #   - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #     is ignored.
+        #   - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+        #
+        #   @param url [String] HTTPS URL of the media file. The file extension must match the template's regist
+        #
+        #   @param filename [String] Filename displayed to the recipient. Required for templates with a `DOCUMENT` he
+      end
+
       # The preferred delivery channel for the message. When specified, the system will
       # prioritize sending via the requested channel if the template is configured for
       # it.

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -111,8 +111,8 @@ module PreludeSDK
 
       class Options < PreludeSDK::Internal::Type::BaseModel
         # @!attribute app_realm
-        #   This allows you to automatically retrieve and fill the OTP code on mobile apps.
-        #   Currently only Android devices are supported.
+        #   This allows automatic OTP retrieval on mobile apps and web browsers. Supported
+        #   platforms are Android (SMS Retriever API) and Web (WebOTP API).
         #
         #   @return [PreludeSDK::Models::VerificationCreateParams::Options::AppRealm, nil]
         optional :app_realm, -> { PreludeSDK::VerificationCreateParams::Options::AppRealm }
@@ -140,12 +140,6 @@ module PreludeSDK
         #   @return [String, nil]
         optional :custom_code, String
 
-        # @!attribute integration
-        #   The integration that triggered the verification.
-        #
-        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Integration, nil]
-        optional :integration, enum: -> { PreludeSDK::VerificationCreateParams::Options::Integration }
-
         # @!attribute locale
         #   A BCP-47 formatted locale string with the language the text message will be sent
         #   to. If there's no locale set, the language will be determined by the country
@@ -195,13 +189,13 @@ module PreludeSDK
         #   @return [Hash{Symbol=>String}, nil]
         optional :variables, PreludeSDK::Internal::Type::HashOf[String]
 
-        # @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, integration: nil, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
+        # @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
         #   Some parameter documentations has been truncated, see
         #   {PreludeSDK::Models::VerificationCreateParams::Options} for more details.
         #
         #   Verification options
         #
-        #   @param app_realm [PreludeSDK::Models::VerificationCreateParams::Options::AppRealm] This allows you to automatically retrieve and fill the OTP code on mobile apps.
+        #   @param app_realm [PreludeSDK::Models::VerificationCreateParams::Options::AppRealm] This allows automatic OTP retrieval on mobile apps and web browsers. Supported p
         #
         #   @param callback_url [String] The URL where webhooks will be sent when verification events occur, including ve
         #
@@ -209,8 +203,6 @@ module PreludeSDK
         #
         #   @param custom_code [String] The custom code to use for OTP verification. To use the custom code feature, con
         #
-        #   @param integration [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Integration] The integration that triggered the verification.
-        #
         #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
         #
         #   @param verification_method [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
@@ -226,16 +218,19 @@ module PreludeSDK
         # @see PreludeSDK::Models::VerificationCreateParams::Options#app_realm
         class AppRealm < PreludeSDK::Internal::Type::BaseModel
           # @!attribute platform
-          #   The platform the SMS will be sent to. We are currently only supporting
-          #   "android".
+          #   The platform for automatic OTP retrieval. Use "android" for the SMS Retriever
+          #   API or "web" for the WebOTP API.
           #
           #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform]
           required :platform, enum: -> { PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform }
 
           # @!attribute value
-          #   The Android SMS Retriever API hash code that identifies your app. For more
-          #   information, see
-          #   [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+          #   The value depends on the platform:
+          #
+          #   - For Android: The SMS Retriever API hash code (11 characters). See
+          #     [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+          #   - For Web: The origin domain (e.g., "example.com" or "www.example.com"). See
+          #     [WebOTP API documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebOTP_API).
           #
           #   @return [String]
           required :value, String
@@ -245,40 +240,28 @@ module PreludeSDK
           #   {PreludeSDK::Models::VerificationCreateParams::Options::AppRealm} for more
           #   details.
           #
-          #   This allows you to automatically retrieve and fill the OTP code on mobile apps.
-          #   Currently only Android devices are supported.
+          #   This allows automatic OTP retrieval on mobile apps and web browsers. Supported
+          #   platforms are Android (SMS Retriever API) and Web (WebOTP API).
           #
-          #   @param platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform] The platform the SMS will be sent to. We are currently only supporting "android"
+          #   @param platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform] The platform for automatic OTP retrieval. Use "android" for the SMS Retriever AP
           #
-          #   @param value [String] The Android SMS Retriever API hash code that identifies your app.
+          #   @param value [String] The value depends on the platform:
 
-          # The platform the SMS will be sent to. We are currently only supporting
-          # "android".
+          # The platform for automatic OTP retrieval. Use "android" for the SMS Retriever
+          # API or "web" for the WebOTP API.
           #
           # @see PreludeSDK::Models::VerificationCreateParams::Options::AppRealm#platform
           module Platform
             extend PreludeSDK::Internal::Type::Enum
 
             ANDROID = :android
+            WEB = :web
 
             # @!method self.values
             #   @return [Array<Symbol>]
           end
         end
 
-        # The integration that triggered the verification.
-        #
-        # @see PreludeSDK::Models::VerificationCreateParams::Options#integration
-        module Integration
-          extend PreludeSDK::Internal::Type::Enum
-
-          AUTH0 = :auth0
-          SUPABASE = :supabase
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # The method used for verifying this phone number. The 'voice' option provides an
         # accessible alternative for visually impaired users by delivering the
         # verification code through a phone call rather than a text message. It also
@@ -325,8 +308,9 @@ module PreludeSDK
         optional :app_version, String
 
         # @!attribute device_id
-        #   The unique identifier for the user's device. For Android, this corresponds to
-        #   the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
+        #   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
@@ -344,23 +328,26 @@ module PreludeSDK
         optional :device_platform, enum: -> { PreludeSDK::VerificationCreateParams::Signals::DevicePlatform }
 
         # @!attribute ip
-        #   The IP address of the user's device.
+        #   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 provide a higher level of trust, indicating that the user is
-        #   genuine. Contact us to discuss your use case. For more details, refer to
+        #   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 connection. Prelude will infer it
-        #   automatically when requests go through our client SDK (which uses Prelude's
-        #   edge), but you can also provide it explicitly if you terminate TLS yourself.
+        #   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
@@ -388,17 +375,17 @@ module PreludeSDK
         #
         #   @param app_version [String] The version of your application.
         #
-        #   @param device_id [String] The unique identifier for the user's device. For Android, this corresponds to th
+        #   @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::VerificationCreateParams::Signals::DevicePlatform] The type of the user's device.
         #
-        #   @param ip [String] The IP address of the user's device.
+        #   @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 provide a higher level of trust, indicating that the user is
+        #   @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 connection. Prelude will infer it automatic
+        #   @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.
         #

data/lib/prelude_sdk/models/verification_create_response.rb

@@ -21,6 +21,13 @@ module PreludeSDK
       # @!attribute status
       #   The status of the verification.
       #
+      #   - `success` - A new verification window was created.
+      #   - `retry` - A new attempt was created for an existing verification window.
+      #   - `challenged` - The verification is suspicious and is restricted to non-SMS and
+      #     non-voice channels only. This mode must be enabled for your customer account
+      #     by Prelude support.
+      #   - `blocked` - The verification was blocked.
+      #
       #   @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Status]
       required :status, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Status }
 
@@ -62,13 +69,43 @@ module PreludeSDK
       #   @return [String, nil]
       optional :request_id, String
 
+      # @!attribute risk_factors
+      #   The risk factors that contributed to the verification being blocked. Only
+      #   present when status is "blocked" and the anti-fraud system detected specific
+      #   risk signals.
+      #
+      #   - `behavioral_pattern` - The phone number past behavior during verification
+      #     flows exhibits suspicious patterns.
+      #   - `device_attribute` - The device exhibits characteristics associated with
+      #     suspicious activity patterns.
+      #   - `fraud_database` - The phone number has been flagged as suspicious in one or
+      #     more of our fraud databases.
+      #   - `location_discrepancy` - The phone number prefix and IP address discrepancy
+      #     indicates potential fraud.
+      #   - `network_fingerprint` - The network connection exhibits characteristics
+      #     associated with suspicious activity patterns.
+      #   - `poor_conversion_history` - The phone number has a history of poorly
+      #     converting to a verified phone number.
+      #   - `prefix_concentration` - The phone number is part of a range known to be
+      #     associated with suspicious activity patterns.
+      #   - `suspected_request_tampering` - The SDK signature is invalid and the request
+      #     is considered to be tampered with.
+      #   - `suspicious_ip_address` - The IP address is deemed to be associated with
+      #     suspicious activity patterns.
+      #   - `temporary_phone_number` - The phone number is known to be a temporary or
+      #     disposable number.
+      #
+      #   @return [Array<Symbol, PreludeSDK::Models::VerificationCreateResponse::RiskFactor>, nil]
+      optional :risk_factors,
+               -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::Models::VerificationCreateResponse::RiskFactor] }
+
       # @!attribute silent
       #   The silent verification specific properties.
       #
       #   @return [PreludeSDK::Models::VerificationCreateResponse::Silent, nil]
       optional :silent, -> { PreludeSDK::Models::VerificationCreateResponse::Silent }
 
-      # @!method initialize(id:, verification_method:, status:, channels: nil, metadata: nil, reason: nil, request_id: nil, silent: nil)
+      # @!method initialize(id:, verification_method:, status:, channels: nil, metadata: nil, reason: nil, request_id: nil, risk_factors: nil, silent: nil)
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::VerificationCreateResponse} for more details.
       #
@@ -86,6 +123,8 @@ module PreludeSDK
       #
       #   @param request_id [String]
       #
+      #   @param risk_factors [Array<Symbol, PreludeSDK::Models::VerificationCreateResponse::RiskFactor>] The risk factors that contributed to the verification being blocked. Only presen
+      #
       #   @param silent [PreludeSDK::Models::VerificationCreateResponse::Silent] The silent verification specific properties.
 
       # The method used for verifying this phone number.
@@ -105,12 +144,20 @@ module PreludeSDK
 
       # The status of the verification.
       #
+      # - `success` - A new verification window was created.
+      # - `retry` - A new attempt was created for an existing verification window.
+      # - `challenged` - The verification is suspicious and is restricted to non-SMS and
+      #   non-voice channels only. This mode must be enabled for your customer account
+      #   by Prelude support.
+      # - `blocked` - The verification was blocked.
+      #
       # @see PreludeSDK::Models::VerificationCreateResponse#status
       module Status
         extend PreludeSDK::Internal::Type::Enum
 
         SUCCESS = :success
         RETRY = :retry
+        CHALLENGED = :challenged
         BLOCKED = :blocked
 
         # @!method self.values
@@ -183,6 +230,24 @@ module PreludeSDK
         #   @return [Array<Symbol>]
       end
 
+      module RiskFactor
+        extend PreludeSDK::Internal::Type::Enum
+
+        BEHAVIORAL_PATTERN = :behavioral_pattern
+        DEVICE_ATTRIBUTE = :device_attribute
+        FRAUD_DATABASE = :fraud_database
+        LOCATION_DISCREPANCY = :location_discrepancy
+        NETWORK_FINGERPRINT = :network_fingerprint
+        POOR_CONVERSION_HISTORY = :poor_conversion_history
+        PREFIX_CONCENTRATION = :prefix_concentration
+        SUSPECTED_REQUEST_TAMPERING = :suspected_request_tampering
+        SUSPICIOUS_IP_ADDRESS = :suspicious_ip_address
+        TEMPORARY_PHONE_NUMBER = :temporary_phone_number
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see PreludeSDK::Models::VerificationCreateResponse#silent
       class Silent < PreludeSDK::Internal::Type::BaseModel
         # @!attribute request_url

data/lib/prelude_sdk/models/verification_management_delete_phone_number_params.rb

@@ -7,13 +7,20 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      # @!attribute action
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams::Action]
+      required :action, enum: -> { PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action }
+
       # @!attribute phone_number
       #   An E.164 formatted phone number to remove from the list.
       #
       #   @return [String]
       required :phone_number, String
 
-      # @!method initialize(phone_number:, request_options: {})
+      # @!method initialize(action:, phone_number:, request_options: {})
+      #   @param action [Symbol, PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams::Action]
+      #
       #   @param phone_number [String] An E.164 formatted phone number to remove from the list.
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]

data/lib/prelude_sdk/models/verification_management_list_phone_numbers_params.rb

@@ -7,7 +7,13 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute action
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationManagementListPhoneNumbersParams::Action]
+      required :action, enum: -> { PreludeSDK::VerificationManagementListPhoneNumbersParams::Action }
+
+      # @!method initialize(action:, request_options: {})
+      #   @param action [Symbol, PreludeSDK::Models::VerificationManagementListPhoneNumbersParams::Action]
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
       module Action

data/lib/prelude_sdk/models/verification_management_set_phone_number_params.rb

@@ -7,13 +7,20 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      # @!attribute action
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationManagementSetPhoneNumberParams::Action]
+      required :action, enum: -> { PreludeSDK::VerificationManagementSetPhoneNumberParams::Action }
+
       # @!attribute phone_number
       #   An E.164 formatted phone number to add to the list.
       #
       #   @return [String]
       required :phone_number, String
 
-      # @!method initialize(phone_number:, request_options: {})
+      # @!method initialize(action:, phone_number:, request_options: {})
+      #   @param action [Symbol, PreludeSDK::Models::VerificationManagementSetPhoneNumberParams::Action]
+      #
       #   @param phone_number [String] An E.164 formatted phone number to add to the list.
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]