prelude-sdk 0.5.0 → 0.6.0

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:

data/sig/prelude_sdk/models/notify_send_batch_params.rbs

@@ -10,6 +10,7 @@ module PreludeSDK
         expires_at: Time,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::NotifySendBatchParams::preferred_channel,
         schedule_at: Time,
         variables: ::Hash[Symbol, String]
@@ -50,6 +51,10 @@ module PreludeSDK
 
       def locale=: (String) -> String
 
+      attr_reader max_auto_retries: Integer?
+
+      def max_auto_retries=: (Integer) -> Integer
+
       attr_reader preferred_channel: PreludeSDK::Models::NotifySendBatchParams::preferred_channel?
 
       def preferred_channel=: (
@@ -73,6 +78,7 @@ module PreludeSDK
         ?expires_at: Time,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::NotifySendBatchParams::preferred_channel,
         ?schedule_at: Time,
         ?variables: ::Hash[Symbol, String],
@@ -88,6 +94,7 @@ module PreludeSDK
         expires_at: Time,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::NotifySendBatchParams::preferred_channel,
         schedule_at: Time,
         variables: ::Hash[Symbol, String],

data/sig/prelude_sdk/models/notify_send_params.rbs

@@ -10,6 +10,7 @@ module PreludeSDK
         expires_at: Time,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         schedule_at: Time,
         variables: ::Hash[Symbol, String]
@@ -50,6 +51,10 @@ module PreludeSDK
 
       def locale=: (String) -> String
 
+      attr_reader max_auto_retries: Integer?
+
+      def max_auto_retries=: (Integer) -> Integer
+
       attr_reader preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel?
 
       def preferred_channel=: (
@@ -73,6 +78,7 @@ module PreludeSDK
         ?expires_at: Time,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         ?schedule_at: Time,
         ?variables: ::Hash[Symbol, String],
@@ -88,6 +94,7 @@ module PreludeSDK
         expires_at: Time,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         schedule_at: Time,
         variables: ::Hash[Symbol, String],

data/sig/prelude_sdk/models/transactional_send_params.rbs

@@ -10,6 +10,7 @@ module PreludeSDK
         expires_at: String,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         variables: ::Hash[Symbol, String]
       }
@@ -49,6 +50,10 @@ module PreludeSDK
 
       def locale=: (String) -> String
 
+      attr_reader max_auto_retries: Integer?
+
+      def max_auto_retries=: (Integer) -> Integer
+
       attr_reader preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel?
 
       def preferred_channel=: (
@@ -68,6 +73,7 @@ module PreludeSDK
         ?expires_at: String,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         ?variables: ::Hash[Symbol, String],
         ?request_options: PreludeSDK::request_opts
@@ -82,6 +88,7 @@ module PreludeSDK
         expires_at: String,
         from: String,
         locale: String,
+        max_auto_retries: Integer,
         preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         variables: ::Hash[Symbol, String],
         request_options: PreludeSDK::RequestOptions

data/sig/prelude_sdk/models/verification_check_params.rbs

@@ -1,7 +1,11 @@
 module PreludeSDK
   module Models
     type verification_check_params =
-      { code: String, target: PreludeSDK::VerificationCheckParams::Target }
+      {
+        code: String,
+        target: PreludeSDK::VerificationCheckParams::Target,
+        :psd2 => PreludeSDK::VerificationCheckParams::Psd2
+      }
       & PreludeSDK::Internal::Type::request_parameters
 
     class VerificationCheckParams < PreludeSDK::Internal::Type::BaseModel
@@ -12,15 +16,23 @@ module PreludeSDK
 
       attr_accessor target: PreludeSDK::VerificationCheckParams::Target
 
+      attr_reader psd2: PreludeSDK::VerificationCheckParams::Psd2?
+
+      def psd2=: (
+        PreludeSDK::VerificationCheckParams::Psd2
+      ) -> PreludeSDK::VerificationCheckParams::Psd2
+
       def initialize: (
         code: String,
         target: PreludeSDK::VerificationCheckParams::Target,
+        ?psd2: PreludeSDK::VerificationCheckParams::Psd2,
         ?request_options: PreludeSDK::request_opts
       ) -> void
 
       def to_hash: -> {
         code: String,
         target: PreludeSDK::VerificationCheckParams::Target,
+        :psd2 => PreludeSDK::VerificationCheckParams::Psd2,
         request_options: PreludeSDK::RequestOptions
       }
 
@@ -56,6 +68,24 @@ module PreludeSDK
           def self?.values: -> ::Array[PreludeSDK::Models::VerificationCheckParams::Target::type_]
         end
       end
+
+      type psd2 = { amount: String, currency: String, recipient: String }
+
+      class Psd2 < PreludeSDK::Internal::Type::BaseModel
+        attr_accessor amount: String
+
+        attr_accessor currency: String
+
+        attr_accessor recipient: String
+
+        def initialize: (
+          amount: String,
+          currency: String,
+          recipient: String
+        ) -> void
+
+        def to_hash: -> { amount: String, currency: String, recipient: String }
+      end
     end
   end
 end

data/sig/prelude_sdk/models/verification_check_response.rbs

@@ -39,7 +39,12 @@ module PreludeSDK
         request_id: String
       }
 
-      type status = :success | :failure | :expired_or_not_found
+      type status =
+        :success
+        | :failure
+        | :expired_or_not_found
+        | :transaction_missing
+        | :transaction_mismatch
 
       module Status
         extend PreludeSDK::Internal::Type::Enum
@@ -47,6 +52,8 @@ module PreludeSDK
         SUCCESS: :success
         FAILURE: :failure
         EXPIRED_OR_NOT_FOUND: :expired_or_not_found
+        TRANSACTION_MISSING: :transaction_missing
+        TRANSACTION_MISMATCH: :transaction_mismatch
 
         def self?.values: -> ::Array[PreludeSDK::Models::VerificationCheckResponse::status]
       end

data/sig/prelude_sdk/models/verification_create_params.rbs

@@ -105,9 +105,12 @@ module PreludeSDK
         {
           app_realm: PreludeSDK::VerificationCreateParams::Options::AppRealm,
           callback_url: String,
+          channels: ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel],
           code_size: Integer,
           custom_code: String,
+          force_challenge: bool,
           locale: String,
+          max_auto_fallbacks: Integer,
           verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
@@ -126,6 +129,12 @@ module PreludeSDK
 
         def callback_url=: (String) -> String
 
+        attr_reader channels: ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel]?
+
+        def channels=: (
+          ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel]
+        ) -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel]
+
         attr_reader code_size: Integer?
 
         def code_size=: (Integer) -> Integer
@@ -134,10 +143,18 @@ module PreludeSDK
 
         def custom_code=: (String) -> String
 
+        attr_reader force_challenge: bool?
+
+        def force_challenge=: (bool) -> bool
+
         attr_reader locale: String?
 
         def locale=: (String) -> String
 
+        attr_reader max_auto_fallbacks: Integer?
+
+        def max_auto_fallbacks=: (Integer) -> Integer
+
         attr_reader verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_?
 
         def verification_method=: (
@@ -165,9 +182,12 @@ module PreludeSDK
         def initialize: (
           ?app_realm: PreludeSDK::VerificationCreateParams::Options::AppRealm,
           ?callback_url: String,
+          ?channels: ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel],
           ?code_size: Integer,
           ?custom_code: String,
+          ?force_challenge: bool,
           ?locale: String,
+          ?max_auto_fallbacks: Integer,
           ?verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           ?preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           ?sender_id: String,
@@ -178,9 +198,12 @@ module PreludeSDK
         def to_hash: -> {
           app_realm: PreludeSDK::VerificationCreateParams::Options::AppRealm,
           callback_url: String,
+          channels: ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel],
           code_size: Integer,
           custom_code: String,
+          force_challenge: bool,
           locale: String,
+          max_auto_fallbacks: Integer,
           verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
@@ -221,6 +244,21 @@ module PreludeSDK
           end
         end
 
+        type channel = :sms | :rcs | :whatsapp | :viber | :zalo | :telegram
+
+        module Channel
+          extend PreludeSDK::Internal::Type::Enum
+
+          SMS: :sms
+          RCS: :rcs
+          WHATSAPP: :whatsapp
+          VIBER: :viber
+          ZALO: :zalo
+          TELEGRAM: :telegram
+
+          def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::channel]
+        end
+
         type method_ = :auto | :voice | :message
 
         module Method

data/sig/prelude_sdk/resources/notify.rbs

@@ -43,6 +43,7 @@ module PreludeSDK
         ?expires_at: Time,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         ?schedule_at: Time,
         ?variables: ::Hash[Symbol, String],
@@ -58,6 +59,7 @@ module PreludeSDK
         ?expires_at: Time,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::NotifySendBatchParams::preferred_channel,
         ?schedule_at: Time,
         ?variables: ::Hash[Symbol, String],

data/sig/prelude_sdk/resources/transactional.rbs

@@ -10,6 +10,7 @@ module PreludeSDK
         ?expires_at: String,
         ?from: String,
         ?locale: String,
+        ?max_auto_retries: Integer,
         ?preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         ?variables: ::Hash[Symbol, String],
         ?request_options: PreludeSDK::request_opts

data/sig/prelude_sdk/resources/verification.rbs

@@ -13,6 +13,7 @@ module PreludeSDK
       def check: (
         code: String,
         target: PreludeSDK::VerificationCheckParams::Target,
+        ?psd2: PreludeSDK::VerificationCheckParams::Psd2,
         ?request_options: PreludeSDK::request_opts
       ) -> PreludeSDK::Models::VerificationCheckResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prelude-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Prelude
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-07 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi