prelude-sdk 0.5.0 → 0.7.0

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -258,6 +258,37 @@ module PreludeSDK
         sig { params(callback_url: String).void }
         attr_writer :callback_url
 
+        # The channels this verification may use, in the order they are tried. Channels
+        # you omit are never used, including on retries. This option can only be set when
+        # the verification is created. The list is recorded on the verification and
+        # applies for its whole lifecycle, so `channels` sent while retrying an existing
+        # verification is ignored — unlike `preferred_channel`, which is honored on every
+        # retry. Every channel you list must be enabled on your account and active in the
+        # destination country, otherwise the request fails with
+        # `channel_not_enabled_in_region`. Prelude still picks the best provider within
+        # each channel. Cannot be combined with `preferred_channel`. Voice is requested
+        # through `method` instead. Disabled by default — contact support to enable it.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                PreludeSDK::VerificationCreateParams::Options::Channel::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :channels
+
+        sig do
+          params(
+            channels:
+              T::Array[
+                PreludeSDK::VerificationCreateParams::Options::Channel::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :channels
+
         # The size of the code generated. It should be between 4 and 8. Defaults to the
         # code size specified from the Dashboard.
         sig { returns(T.nilable(Integer)) }
@@ -275,6 +306,19 @@ module PreludeSDK
         sig { params(custom_code: String).void }
         attr_writer :custom_code
 
+        # When `true`, the verification is routed through challenge-safe channels
+        # (non-SMS/Voice) regardless of country eligibility or any antispam outcome. The
+        # resulting verification has `status: "challenged"`. Use this when you have your
+        # own signal that the request is suspicious and want stricter routing — the
+        # verification is **not** classified as fraud and does not contribute to
+        # anti-fraud counters or risk factors. This feature is disabled by default —
+        # contact Prelude support to enable it on your account.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :force_challenge
+
+        sig { params(force_challenge: T::Boolean).void }
+        attr_writer :force_challenge
+
         # 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
         # code of the phone number. If the language specified doesn't exist, it defaults
@@ -285,6 +329,27 @@ module PreludeSDK
         sig { params(locale: String).void }
         attr_writer :locale
 
+        # Maximum number of delivery attempts Prelude may add on its own after the one you
+        # requested. `0` means a single attempt: if it cannot be delivered, Prelude
+        # neither tries another provider nor another channel, and does not retry
+        # automatically. `1` allows one additional attempt, and so on — a value larger
+        # than the number of routes available for the destination simply behaves like the
+        # default. When omitted, Prelude retries as your account is configured, across as
+        # many channels as the route offers.
+        #
+        # This option can only be set when the verification is created. The value is
+        # recorded on the verification and applies for its whole lifecycle, so a
+        # `max_auto_fallbacks` sent while retrying an existing verification is ignored —
+        # the limit cannot be raised or lowered after the fact. A retry you ask for is not
+        # an automatic attempt, so it gets a fresh allowance of the same limit. This
+        # option is disabled by default — contact Prelude support to enable it on your
+        # account.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_auto_fallbacks
+
+        sig { params(max_auto_fallbacks: Integer).void }
+        attr_writer :max_auto_fallbacks
+
         # 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
@@ -309,7 +374,12 @@ module PreludeSDK
         end
         attr_writer :verification_method
 
-        # The preferred channel to be used in priority for verification.
+        # The channel to prioritize when delivering the verification. Prelude prioritizes
+        # this channel on the first attempt and continues to prefer it on retries while an
+        # untried route on that channel remains; once those are exhausted, retries fall
+        # back to the next best available route. If the channel is unavailable (for
+        # example, when a verification is challenged), Prelude uses the best available
+        # route instead. Cannot be combined with `channels`.
         sig do
           returns(
             T.nilable(
@@ -356,9 +426,15 @@ module PreludeSDK
             app_realm:
               PreludeSDK::VerificationCreateParams::Options::AppRealm::OrHash,
             callback_url: String,
+            channels:
+              T::Array[
+                PreludeSDK::VerificationCreateParams::Options::Channel::OrSymbol
+              ],
             code_size: Integer,
             custom_code: String,
+            force_challenge: T::Boolean,
             locale: String,
+            max_auto_fallbacks: Integer,
             verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
             preferred_channel:
@@ -376,6 +452,17 @@ module PreludeSDK
           # verification creation, attempt creation, and delivery status changes. For more
           # details, refer to [Webhook](/verify/v2/documentation/webhook).
           callback_url: nil,
+          # The channels this verification may use, in the order they are tried. Channels
+          # you omit are never used, including on retries. This option can only be set when
+          # the verification is created. The list is recorded on the verification and
+          # applies for its whole lifecycle, so `channels` sent while retrying an existing
+          # verification is ignored — unlike `preferred_channel`, which is honored on every
+          # retry. Every channel you list must be enabled on your account and active in the
+          # destination country, otherwise the request fails with
+          # `channel_not_enabled_in_region`. Prelude still picks the best provider within
+          # each channel. Cannot be combined with `preferred_channel`. Voice is requested
+          # through `method` instead. Disabled by default — contact support to enable it.
+          channels: nil,
           # The size of the code generated. It should be between 4 and 8. Defaults to the
           # code size specified from the Dashboard.
           code_size: nil,
@@ -383,11 +470,35 @@ module PreludeSDK
           # contact us to enable it for your account. For more details, refer to
           # [Custom Code](/verify/v2/documentation/custom-codes).
           custom_code: nil,
+          # When `true`, the verification is routed through challenge-safe channels
+          # (non-SMS/Voice) regardless of country eligibility or any antispam outcome. The
+          # resulting verification has `status: "challenged"`. Use this when you have your
+          # own signal that the request is suspicious and want stricter routing — the
+          # verification is **not** classified as fraud and does not contribute to
+          # anti-fraud counters or risk factors. This feature is disabled by default —
+          # contact Prelude support to enable it on your account.
+          force_challenge: nil,
           # 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
           # code of the phone number. If the language specified doesn't exist, it defaults
           # to US English.
           locale: nil,
+          # Maximum number of delivery attempts Prelude may add on its own after the one you
+          # requested. `0` means a single attempt: if it cannot be delivered, Prelude
+          # neither tries another provider nor another channel, and does not retry
+          # automatically. `1` allows one additional attempt, and so on — a value larger
+          # than the number of routes available for the destination simply behaves like the
+          # default. When omitted, Prelude retries as your account is configured, across as
+          # many channels as the route offers.
+          #
+          # This option can only be set when the verification is created. The value is
+          # recorded on the verification and applies for its whole lifecycle, so a
+          # `max_auto_fallbacks` sent while retrying an existing verification is ignored —
+          # the limit cannot be raised or lowered after the fact. A retry you ask for is not
+          # an automatic attempt, so it gets a fresh allowance of the same limit. This
+          # option is disabled by default — contact Prelude support to enable it on your
+          # account.
+          max_auto_fallbacks: nil,
           # 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
@@ -396,7 +507,12 @@ module PreludeSDK
           # skips silent verification, useful for scenarios requiring direct user
           # interaction.
           verification_method: nil,
-          # The preferred channel to be used in priority for verification.
+          # The channel to prioritize when delivering the verification. Prelude prioritizes
+          # this channel on the first attempt and continues to prefer it on retries while an
+          # untried route on that channel remains; once those are exhausted, retries fall
+          # back to the next best available route. If the channel is unavailable (for
+          # example, when a verification is challenged), Prelude uses the best available
+          # route instead. Cannot be combined with `channels`.
           preferred_channel: nil,
           # The Sender ID to use for this message. The Sender ID needs to be enabled by
           # Prelude.
@@ -415,9 +531,15 @@ module PreludeSDK
               app_realm:
                 PreludeSDK::VerificationCreateParams::Options::AppRealm,
               callback_url: String,
+              channels:
+                T::Array[
+                  PreludeSDK::VerificationCreateParams::Options::Channel::OrSymbol
+                ],
               code_size: Integer,
               custom_code: String,
+              force_challenge: T::Boolean,
               locale: String,
+              max_auto_fallbacks: Integer,
               verification_method:
                 PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
               preferred_channel:
@@ -530,6 +652,60 @@ module PreludeSDK
           end
         end
 
+        module Channel
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                PreludeSDK::VerificationCreateParams::Options::Channel
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SMS =
+            T.let(
+              :sms,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+          RCS =
+            T.let(
+              :rcs,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+          WHATSAPP =
+            T.let(
+              :whatsapp,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+          VIBER =
+            T.let(
+              :viber,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+          ZALO =
+            T.let(
+              :zalo,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+          TELEGRAM =
+            T.let(
+              :telegram,
+              PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::VerificationCreateParams::Options::Channel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        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
@@ -576,7 +752,12 @@ module PreludeSDK
           end
         end
 
-        # The preferred channel to be used in priority for verification.
+        # The channel to prioritize when delivering the verification. Prelude prioritizes
+        # this channel on the first attempt and continues to prefer it on retries while an
+        # untried route on that channel remains; once those are exhausted, retries fall
+        # back to the next best available route. If the channel is unavailable (for
+        # example, when a verification is challenged), Prelude uses the best available
+        # route instead. Cannot be combined with `channels`.
         module PreferredChannel
           extend PreludeSDK::Internal::Type::Enum
 
@@ -682,6 +863,17 @@ module PreludeSDK
         end
         attr_writer :device_platform
 
+        # 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).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :existing_user
+
+        sig { params(existing_user: T::Boolean).void }
+        attr_writer :existing_user
+
         # 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
@@ -735,6 +927,7 @@ module PreludeSDK
             device_model: String,
             device_platform:
               PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
+            existing_user: T::Boolean,
             ip: String,
             is_trusted_user: T::Boolean,
             ja4_fingerprint: String,
@@ -753,6 +946,12 @@ module PreludeSDK
           device_model: nil,
           # The type of the user's device.
           device_platform: nil,
+          # 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).
+          existing_user: nil,
           # 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
@@ -783,6 +982,7 @@ module PreludeSDK
               device_model: String,
               device_platform:
                 PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
+              existing_user: T::Boolean,
               ip: String,
               is_trusted_user: T::Boolean,
               ja4_fingerprint: String,

data/rbi/prelude_sdk/models/watch_predict_params.rbi

@@ -11,7 +11,7 @@ module PreludeSDK
           T.any(PreludeSDK::WatchPredictParams, PreludeSDK::Internal::AnyHash)
         end
 
-      # The prediction target. Only supports phone numbers for now.
+      # The signup identifier to score — a phone number or email address.
       sig { returns(PreludeSDK::WatchPredictParams::Target) }
       attr_reader :target
 
@@ -56,7 +56,7 @@ module PreludeSDK
         ).returns(T.attached_class)
       end
       def self.new(
-        # The prediction target. Only supports phone numbers for now.
+        # The signup identifier to score — a phone number or email address.
         target:,
         # The identifier of the dispatch that came from the front-end SDK.
         dispatch_id: nil,
@@ -100,7 +100,7 @@ module PreludeSDK
         sig { returns(String) }
         attr_accessor :value
 
-        # The prediction target. Only supports phone numbers for now.
+        # The signup identifier to score — a phone number or email address.
         sig do
           params(
             type: PreludeSDK::WatchPredictParams::Target::Type::OrSymbol,
@@ -240,6 +240,17 @@ module PreludeSDK
         end
         attr_writer :device_platform
 
+        # 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).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :existing_user
+
+        sig { params(existing_user: T::Boolean).void }
+        attr_writer :existing_user
+
         # 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
@@ -293,6 +304,7 @@ module PreludeSDK
             device_model: String,
             device_platform:
               PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
+            existing_user: T::Boolean,
             ip: String,
             is_trusted_user: T::Boolean,
             ja4_fingerprint: String,
@@ -311,6 +323,12 @@ module PreludeSDK
           device_model: nil,
           # The type of the user's device.
           device_platform: nil,
+          # 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).
+          existing_user: nil,
           # 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
@@ -341,6 +359,7 @@ module PreludeSDK
               device_model: String,
               device_platform:
                 PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
+              existing_user: T::Boolean,
               ip: String,
               is_trusted_user: T::Boolean,
               ja4_fingerprint: String,

data/rbi/prelude_sdk/models/watch_predict_response.rbi

@@ -32,6 +32,9 @@ module PreludeSDK
       # when prediction is "suspicious" and the anti-fraud system detected specific risk
       # signals.
       #
+      # - `account_risk_profile` - The target matches a risk profile derived from the
+      #   outcomes reported on your own account, rather than from a signal shared across
+      #   accounts.
       # - `behavioral_pattern` - The phone number past behavior during verification
       #   flows exhibits suspicious patterns.
       # - `device_attribute` - The device exhibits characteristics associated with
@@ -97,6 +100,9 @@ module PreludeSDK
         # when prediction is "suspicious" and the anti-fraud system detected specific risk
         # signals.
         #
+        # - `account_risk_profile` - The target matches a risk profile derived from the
+        #   outcomes reported on your own account, rather than from a signal shared across
+        #   accounts.
         # - `behavioral_pattern` - The phone number past behavior during verification
         #   flows exhibits suspicious patterns.
         # - `device_attribute` - The device exhibits characteristics associated with
@@ -179,6 +185,11 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        ACCOUNT_RISK_PROFILE =
+          T.let(
+            :account_risk_profile,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
         BEHAVIORAL_PATTERN =
           T.let(
             :behavioral_pattern,

data/rbi/prelude_sdk/models/watch_send_events_params.rbi

@@ -53,7 +53,15 @@ module PreludeSDK
             )
           end
 
-        # A confidence level you want to assign to the event.
+        # How much this event tells us to trust the end-user's legitimacy — not how
+        # certain you are that the event occurred. In increasing order of trust:
+        # `minimum`, `low`, `neutral`, `high`, `maximum`.
+        #
+        # Use `minimum` for an event tied to a user you trust the least to be legitimate
+        # (e.g. a `payment.chargeback`), and `maximum` for an event tied to a highly
+        # trustworthy user (e.g. a confirmed 3DS payment). Prelude weights these signals
+        # when scoring traffic: it filters out users tied to low-confidence events while
+        # preserving the experience for users tied to high-confidence ones.
         sig do
           returns(
             PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol
@@ -85,7 +93,15 @@ module PreludeSDK
           ).returns(T.attached_class)
         end
         def self.new(
-          # A confidence level you want to assign to the event.
+          # How much this event tells us to trust the end-user's legitimacy — not how
+          # certain you are that the event occurred. In increasing order of trust:
+          # `minimum`, `low`, `neutral`, `high`, `maximum`.
+          #
+          # Use `minimum` for an event tied to a user you trust the least to be legitimate
+          # (e.g. a `payment.chargeback`), and `maximum` for an event tied to a highly
+          # trustworthy user (e.g. a confirmed 3DS payment). Prelude weights these signals
+          # when scoring traffic: it filters out users tied to low-confidence events while
+          # preserving the experience for users tied to high-confidence ones.
           confidence:,
           # A label to describe what the event refers to.
           label:,
@@ -107,7 +123,15 @@ module PreludeSDK
         def to_hash
         end
 
-        # A confidence level you want to assign to the event.
+        # How much this event tells us to trust the end-user's legitimacy — not how
+        # certain you are that the event occurred. In increasing order of trust:
+        # `minimum`, `low`, `neutral`, `high`, `maximum`.
+        #
+        # Use `minimum` for an event tied to a user you trust the least to be legitimate
+        # (e.g. a `payment.chargeback`), and `maximum` for an event tied to a highly
+        # trustworthy user (e.g. a confirmed 3DS payment). Prelude weights these signals
+        # when scoring traffic: it filters out users tied to low-confidence events while
+        # preserving the experience for users tied to high-confidence ones.
         module Confidence
           extend PreludeSDK::Internal::Type::Enum
 

data/rbi/prelude_sdk/resources/notify.rbi

@@ -5,6 +5,8 @@ module PreludeSDK
     # Send transactional and marketing messages with compliance enforcement.
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           config_id: String,
@@ -20,6 +22,8 @@ module PreludeSDK
 
       # Retrieve the current subscription status for a specific phone number within a
       # subscription configuration.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           phone_number: String,
@@ -41,6 +45,8 @@ module PreludeSDK
       #
       # Each configuration represents a subscription management setup with phone numbers
       # for receiving opt-out/opt-in requests and a callback URL for webhook events.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           cursor: String,
@@ -61,6 +67,8 @@ module PreludeSDK
       # phone number within a subscription configuration.
       #
       # Events are ordered by timestamp in descending order (most recent first).
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           phone_number: String,
@@ -89,6 +97,8 @@ module PreludeSDK
       # specific subscription configuration.
       #
       # You can optionally filter by subscription state (SUB or UNSUB).
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           config_id: String,
@@ -126,6 +136,7 @@ module PreludeSDK
           expires_at: Time,
           from: String,
           locale: String,
+          max_auto_retries: Integer,
           preferred_channel:
             PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
@@ -165,6 +176,12 @@ module PreludeSDK
         # code of the phone number. If the language specified doesn't exist, the default
         # set on the template will be used.
         locale: nil,
+        # Maximum number of automatic retry attempts across channels for this send, in
+        # addition to the first attempt. For example, `2` allows up to 3 total delivery
+        # attempts. Lower values reduce delivery cost on hard-to-reach numbers at the
+        # expense of deliverability. When omitted, your account's configured default
+        # applies.
+        max_auto_retries: nil,
         # The preferred channel to be used in priority for message delivery. If the
         # channel is unavailable, the system will fallback to other available channels.
         preferred_channel: nil,
@@ -189,6 +206,7 @@ module PreludeSDK
           expires_at: Time,
           from: String,
           locale: String,
+          max_auto_retries: Integer,
           preferred_channel:
             PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
@@ -223,6 +241,12 @@ module PreludeSDK
         from: nil,
         # A BCP-47 formatted locale string.
         locale: nil,
+        # Maximum number of automatic retry attempts across channels for each send in the
+        # batch, in addition to the first attempt. For example, `2` allows up to 3 total
+        # delivery attempts per recipient. Lower values reduce delivery cost on
+        # hard-to-reach numbers at the expense of deliverability. When omitted, your
+        # account's configured default applies.
+        max_auto_retries: nil,
         # Preferred channel for delivery. If unavailable, automatic fallback applies.
         preferred_channel: nil,
         # Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -16,6 +16,7 @@ module PreludeSDK
           expires_at: String,
           from: String,
           locale: String,
+          max_auto_retries: Integer,
           preferred_channel:
             PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
           variables: T::Hash[Symbol, String],
@@ -53,6 +54,10 @@ module PreludeSDK
         # code of the phone number. If the language specified doesn't exist, the default
         # set on the template will be used.
         locale: nil,
+        # Maximum number of automatic retry attempts across channels for this send, in
+        # addition to the first attempt. For example, `2` allows up to 3 total delivery
+        # attempts. When omitted, your account's configured default applies.
+        max_auto_retries: nil,
         # 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/rbi/prelude_sdk/resources/verification.rbi

@@ -40,6 +40,7 @@ module PreludeSDK
         params(
           code: String,
           target: PreludeSDK::VerificationCheckParams::Target::OrHash,
+          psd2: PreludeSDK::VerificationCheckParams::Psd2::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(PreludeSDK::Models::VerificationCheckResponse)
       end
@@ -49,6 +50,11 @@ module PreludeSDK
         # The verification target. Either a phone number or an email address. To use the
         # email verification feature contact us to discuss your use case.
         target:,
+        # Required when checking a code issued under the `prelude:psd2` template. The
+        # submitted variables must match those provided at issuance; any mismatch
+        # invalidates the code (PSD2 SCA RTS Article 5 dynamic linking). Ignored on
+        # non-PSD2 verifications.
+        psd2: nil,
         request_options: {}
       )
       end

data/rbi/prelude_sdk/resources/watch.rbi

@@ -4,7 +4,12 @@ module PreludeSDK
   module Resources
     # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
-      # Predict the outcome of a verification based on Prelude’s anti-fraud system.
+      # At signup, score the user's phone number or email address (target) as legitimate
+      # or suspicious. Scoring-only — does not update counters by itself. When using
+      # Feedback, call predict before verification.started on the same target (and
+      # correlation_id when used) so feedback can warm Watch auth-start counters. Use
+      # Events for product fraud labels; use Feedback only if you run your own phone
+      # verification funnel outside Prelude Verify.
       sig do
         params(
           target: PreludeSDK::WatchPredictParams::Target::OrHash,
@@ -15,7 +20,7 @@ module PreludeSDK
         ).returns(PreludeSDK::Models::WatchPredictResponse)
       end
       def predict(
-        # The prediction target. Only supports phone numbers for now.
+        # The signup identifier to score — a phone number or email address.
         target:,
         # The identifier of the dispatch that came from the front-end SDK.
         dispatch_id: nil,
@@ -28,8 +33,11 @@ module PreludeSDK
       )
       end
 
-      # Send real-time event data from end-user interactions within your application.
-      # Events will be analyzed for proactive fraud prevention and risk scoring.
+      # Send custom fraud signals from your application (labels and confidence levels).
+      # Events capture product-specific risk patterns and are weighted when scoring
+      # traffic. Use without Predict or Feedback if you only need to report product-side
+      # abuse (for example account.banned). Feedback is a separate, optional endpoint
+      # for self-hosted phone verification funnels.
       sig do
         params(
           events: T::Array[PreludeSDK::WatchSendEventsParams::Event::OrHash],
@@ -44,8 +52,13 @@ module PreludeSDK
       )
       end
 
-      # Send feedback regarding your end-users verification funnel. Events will be
-      # analyzed for proactive fraud prevention and risk scoring.
+      # Optional. Report verification-funnel steps (verification.started,
+      # verification.completed) when you run phone verification outside Prelude Verify.
+      # Feeds Watch abuse-rate counters for your own flow. Call Predict on the same
+      # target before verification.started and reuse metadata.correlation_id so
+      # auth-start counters receive predict signals; without a linked predict, only
+      # attempt-rate counters update on started. Not required if you only use Events
+      # and/or Predict, or if Verify already handles verification for that traffic.
       sig do
         params(
           feedbacks: