prelude-sdk 0.5.0 → 0.7.0

data/lib/prelude_sdk/resources/notify.rb

@@ -6,6 +6,8 @@ module PreludeSDK
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload get_subscription_config(config_id, request_options: {})
       #
       # @param config_id [String] The subscription configuration ID
@@ -27,6 +29,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.
+      #
       # @overload get_subscription_phone_number(phone_number, config_id:, request_options: {})
       #
       # @param phone_number [String] The phone number in E.164 format (e.g., +33612345678)
@@ -58,6 +62,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.
+      #
       # @overload list_subscription_configs(cursor: nil, limit: nil, request_options: {})
       #
       # @param cursor [String] Pagination cursor from the previous response
@@ -86,6 +92,8 @@ module PreludeSDK
       #
       # Events are ordered by timestamp in descending order (most recent first).
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload list_subscription_phone_number_events(phone_number, config_id:, cursor: nil, limit: nil, request_options: {})
       #
       # @param phone_number [String] Path param: The phone number in E.164 format (e.g., +33612345678)
@@ -126,6 +134,8 @@ module PreludeSDK
       #
       # You can optionally filter by subscription state (SUB or UNSUB).
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload list_subscription_phone_numbers(config_id, cursor: nil, limit: nil, state: nil, request_options: {})
       #
       # @param config_id [String] The subscription configuration ID
@@ -159,7 +169,7 @@ module PreludeSDK
       # Send transactional and marketing messages to your users via SMS, RCS and
       # WhatsApp with automatic compliance enforcement.
       #
-      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, max_auto_retries: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier configured by your Customer Success team.
       #
@@ -177,6 +187,8 @@ module PreludeSDK
       #
       # @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
       #
+      # @param max_auto_retries [Integer] Maximum number of automatic retry attempts across channels for this send, in add
+      #
       # @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendParams::PreferredChannel] The preferred channel to be used in priority for message delivery. If the channe
       #
       # @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
@@ -204,7 +216,7 @@ module PreludeSDK
       #
       # Send the same message to multiple recipients in a single request.
       #
-      # @overload send_batch(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      # @overload send_batch(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, max_auto_retries: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier configured by your Customer Success team.
       #
@@ -222,6 +234,8 @@ module PreludeSDK
       #
       # @param locale [String] A BCP-47 formatted locale string.
       #
+      # @param max_auto_retries [Integer] Maximum number of automatic retry attempts across channels for each send in the
+      #
       # @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendBatchParams::PreferredChannel] Preferred channel for delivery. If unavailable, automatic fallback applies.
       #
       # @param schedule_at [Time] Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply w

data/lib/prelude_sdk/resources/transactional.rb

@@ -12,7 +12,7 @@ module PreludeSDK
       # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
       # instead.
       #
-      # @overload send_(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: {})
+      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, max_auto_retries: nil, preferred_channel: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier.
       #
@@ -30,6 +30,8 @@ module PreludeSDK
       #
       # @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
       #
+      # @param max_auto_retries [Integer] Maximum number of automatic retry attempts across channels for this send, in add
+      #
       # @param preferred_channel [Symbol, PreludeSDK::Models::TransactionalSendParams::PreferredChannel] The preferred delivery channel for the message. When specified, the system will
       #
       # @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.

data/lib/prelude_sdk/resources/verification.rb

@@ -44,12 +44,14 @@ module PreludeSDK
       #
       # Check the validity of a verification code.
       #
-      # @overload check(code:, target:, request_options: {})
+      # @overload check(code:, target:, psd2: nil, request_options: {})
       #
       # @param code [String] The OTP code to validate.
       #
       # @param target [PreludeSDK::Models::VerificationCheckParams::Target] The verification target. Either a phone number or an email address. To use the e
       #
+      # @param psd2 [PreludeSDK::Models::VerificationCheckParams::Psd2] Required when checking a code issued under the `prelude:psd2` template. The subm
+      #
       # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [PreludeSDK::Models::VerificationCheckResponse]

data/lib/prelude_sdk/resources/watch.rb

@@ -7,11 +7,16 @@ module PreludeSDK
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::WatchPredictParams} for more details.
       #
-      # 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.
       #
       # @overload predict(target:, dispatch_id: nil, metadata: nil, signals: nil, request_options: {})
       #
-      # @param target [PreludeSDK::Models::WatchPredictParams::Target] The prediction target. Only supports phone numbers for now.
+      # @param target [PreludeSDK::Models::WatchPredictParams::Target] The signup identifier to score — a phone number or email address.
       #
       # @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
       #
@@ -38,8 +43,11 @@ module PreludeSDK
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::WatchSendEventsParams} for more details.
       #
-      # 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.
       #
       # @overload send_events(events:, request_options: {})
       #
@@ -64,8 +72,13 @@ module PreludeSDK
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::WatchSendFeedbacksParams} for more details.
       #
-      # 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.
       #
       # @overload send_feedbacks(feedbacks:, request_options: {})
       #

data/lib/prelude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PreludeSDK
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/rbi/prelude_sdk/models/notify_send_batch_params.rbi

@@ -78,6 +78,17 @@ module PreludeSDK
       sig { params(locale: String).void }
       attr_writer :locale
 
+      # 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.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_auto_retries
+
+      sig { params(max_auto_retries: Integer).void }
+      attr_writer :max_auto_retries
+
       # Preferred channel for delivery. If unavailable, automatic fallback applies.
       sig do
         returns(
@@ -121,6 +132,7 @@ module PreludeSDK
           expires_at: Time,
           from: String,
           locale: String,
+          max_auto_retries: Integer,
           preferred_channel:
             PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
@@ -155,6 +167,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
@@ -177,6 +195,7 @@ module PreludeSDK
             expires_at: Time,
             from: String,
             locale: String,
+            max_auto_retries: Integer,
             preferred_channel:
               PreludeSDK::NotifySendBatchParams::PreferredChannel::OrSymbol,
             schedule_at: Time,

data/rbi/prelude_sdk/models/notify_send_params.rbi

@@ -78,6 +78,17 @@ module PreludeSDK
       sig { params(locale: String).void }
       attr_writer :locale
 
+      # 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.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_auto_retries
+
+      sig { params(max_auto_retries: Integer).void }
+      attr_writer :max_auto_retries
+
       # The preferred channel to be used in priority for message delivery. If the
       # channel is unavailable, the system will fallback to other available channels.
       sig do
@@ -121,6 +132,7 @@ module PreludeSDK
           expires_at: Time,
           from: String,
           locale: String,
+          max_auto_retries: Integer,
           preferred_channel:
             PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
@@ -160,6 +172,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,
@@ -184,6 +202,7 @@ module PreludeSDK
             expires_at: Time,
             from: String,
             locale: String,
+            max_auto_retries: Integer,
             preferred_channel:
               PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
             schedule_at: Time,

data/rbi/prelude_sdk/models/transactional_send_params.rbi

@@ -82,6 +82,15 @@ module PreludeSDK
       sig { params(locale: String).void }
       attr_writer :locale
 
+      # 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.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_auto_retries
+
+      sig { params(max_auto_retries: Integer).void }
+      attr_writer :max_auto_retries
+
       # 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.
@@ -125,6 +134,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],
@@ -162,6 +172,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.
@@ -189,6 +203,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],

data/rbi/prelude_sdk/models/verification_check_params.rbi

@@ -28,10 +28,23 @@ module PreludeSDK
       end
       attr_writer :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.
+      sig { returns(T.nilable(PreludeSDK::VerificationCheckParams::Psd2)) }
+      attr_reader :psd2
+
+      sig do
+        params(psd2: PreludeSDK::VerificationCheckParams::Psd2::OrHash).void
+      end
+      attr_writer :psd2
+
       sig do
         params(
           code: String,
           target: PreludeSDK::VerificationCheckParams::Target::OrHash,
+          psd2: PreludeSDK::VerificationCheckParams::Psd2::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -41,6 +54,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
@@ -50,6 +68,7 @@ module PreludeSDK
           {
             code: String,
             target: PreludeSDK::VerificationCheckParams::Target,
+            psd2: PreludeSDK::VerificationCheckParams::Psd2,
             request_options: PreludeSDK::RequestOptions
           }
         )
@@ -135,6 +154,55 @@ module PreludeSDK
           end
         end
       end
+
+      class Psd2 < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::VerificationCheckParams::Psd2,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # Decimal amount of the transaction.
+        sig { returns(String) }
+        attr_accessor :amount
+
+        # ISO 4217 currency code.
+        sig { returns(String) }
+        attr_accessor :currency
+
+        # Payee name displayed to the payer.
+        sig { returns(String) }
+        attr_accessor :recipient
+
+        # 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.
+        sig do
+          params(amount: String, currency: String, recipient: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Decimal amount of the transaction.
+          amount:,
+          # ISO 4217 currency code.
+          currency:,
+          # Payee name displayed to the payer.
+          recipient:
+        )
+        end
+
+        sig do
+          override.returns(
+            { amount: String, currency: String, recipient: String }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/prelude_sdk/models/verification_check_response.rbi

@@ -11,7 +11,9 @@ module PreludeSDK
           )
         end
 
-      # The status of the check.
+      # The status of the check. For `prelude:psd2` codes, `transaction_missing` is
+      # returned when the `psd2` block is omitted, and `transaction_mismatch` when the
+      # submitted variables differ from those provided at issuance.
       sig do
         returns(
           PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
@@ -59,7 +61,9 @@ module PreludeSDK
         ).returns(T.attached_class)
       end
       def self.new(
-        # The status of the check.
+        # The status of the check. For `prelude:psd2` codes, `transaction_missing` is
+        # returned when the `psd2` block is omitted, and `transaction_mismatch` when the
+        # submitted variables differ from those provided at issuance.
         status:,
         # The verification identifier.
         id: nil,
@@ -83,7 +87,9 @@ module PreludeSDK
       def to_hash
       end
 
-      # The status of the check.
+      # The status of the check. For `prelude:psd2` codes, `transaction_missing` is
+      # returned when the `psd2` block is omitted, and `transaction_mismatch` when the
+      # submitted variables differ from those provided at issuance.
       module Status
         extend PreludeSDK::Internal::Type::Enum
 
@@ -108,6 +114,16 @@ module PreludeSDK
             :expired_or_not_found,
             PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
           )
+        TRANSACTION_MISSING =
+          T.let(
+            :transaction_missing,
+            PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+          )
+        TRANSACTION_MISMATCH =
+          T.let(
+            :transaction_mismatch,
+            PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(