prelude-sdk 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e471ff14576be4e30d555ac095637659799c089243d85e8eb0b1e107d5f72a4d
-  data.tar.gz: b7429bca67dc1516c3deaccf43ca63535b4b2ec8e07d36889635893b940cb1ee
+  metadata.gz: cc907faf5181de68a78b810ea7e8f112b9487a1509787ade20ee24a89ebb1e47
+  data.tar.gz: 72ee64f891262d8b42dbf743563acf09d649090ac5b0e5b4a651ab3250228952
 SHA512:
-  metadata.gz: ad313a26fcd1936dc0b3e66224f7fdf4488c392c85ac3828ee18ff93463791e07ff0113296d5145ef492a3189787601c8481a8ee83fd735af42b985a52cbb148
-  data.tar.gz: 2be45dd24a4db7b69cc636e1db2703d69a88721034ebb50bff9f3f79c1b6df2179b4a1f4a08f9681bd6498c7f50f380034e9ff1e6ee895a437433932bbd9d212
+  metadata.gz: 92d9f3a4bc299dc75db670d6be40eeeadd34e2ee1d19c82197ea7217f05e3fed75f279a3e13f209dbfd129d190794d9a53f6cef584e32fa90e97fd30abfe06ee
+  data.tar.gz: 360197b7fafbed000c76dc07e8b21dc81c8f46e869c193298da0ad51b71930ad6bb1ea5585f1d0570a1c3d2fd88c0a68984f54cacf6630a1c78a656465b632d5

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 0.6.0 (2026-08-07)
+
+Full Changelog: [v0.5.0...v0.6.0](https://github.com/prelude-so/ruby-sdk/compare/v0.5.0...v0.6.0)
+
+### Features
+
+* **api:** api update ([f50fa71](https://github.com/prelude-so/ruby-sdk/commit/f50fa71d8df49b0787d7db47a5510f44151f9e8d))
+* **api:** api update ([05e7092](https://github.com/prelude-so/ruby-sdk/commit/05e7092347c6b2b2c8824c3912843b751ee5139b))
+* **api:** api update ([9354ab4](https://github.com/prelude-so/ruby-sdk/commit/9354ab444b7f24f01f953071f76088c05d7b60e0))
+* **api:** api update ([8617519](https://github.com/prelude-so/ruby-sdk/commit/8617519ff89a67501d6a68a48e228f8f90c1acc5))
+* **api:** api update ([714bb99](https://github.com/prelude-so/ruby-sdk/commit/714bb99f625935f8e7320ff56fe30db697015bc6))
+* **api:** api update ([36cef75](https://github.com/prelude-so/ruby-sdk/commit/36cef7585d0e0217ef205a0de19a74cab7088ed6))
+* **api:** api update ([4f9e5d5](https://github.com/prelude-so/ruby-sdk/commit/4f9e5d5fed8221c84514419e8fc55b4fe9695bb4))
+* **api:** api update ([3a7d02a](https://github.com/prelude-so/ruby-sdk/commit/3a7d02aaff30f5db464a6669134125b645faccdb))
+* **api:** api update ([b481c73](https://github.com/prelude-so/ruby-sdk/commit/b481c73a09d3cea498b5449612e8f36ffd134b68))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([066b5f2](https://github.com/prelude-so/ruby-sdk/commit/066b5f29b4bf551e90d782fc5216a62669c7c415))
+
+
+### Bug Fixes
+
+* **client:** elide content type header on requests without body ([3b5e81c](https://github.com/prelude-so/ruby-sdk/commit/3b5e81cec044555fb0b3aecead5ae056eedb3373))
+* **client:** send content-type header for requests with an omitted optional body ([513ece3](https://github.com/prelude-so/ruby-sdk/commit/513ece3bc7f8c0282b8825bb7a817c3a27e5c795))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([8370b94](https://github.com/prelude-so/ruby-sdk/commit/8370b948890fbb6e4a981e63e4be6c0ee1fb0b1e))
+
 ## 0.5.0 (2026-05-07)
 
 Full Changelog: [v0.4.0...v0.5.0](https://github.com/prelude-so/ruby-sdk/compare/v0.4.0...v0.5.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "prelude-sdk", "~> 0.5.0"
+gem "prelude-sdk", "~> 0.6.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/prelude_sdk/internal/transport/base_client.rb

@@ -306,6 +306,11 @@ module PreludeSDK
               PreludeSDK::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = PreludeSDK::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/prelude_sdk/models/notify_send_batch_params.rb

@@ -65,6 +65,16 @@ module PreludeSDK
       #   @return [String, nil]
       optional :locale, String
 
+      # @!attribute max_auto_retries
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_auto_retries, Integer
+
       # @!attribute preferred_channel
       #   Preferred channel for delivery. If unavailable, automatic fallback applies.
       #
@@ -84,7 +94,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, document: 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, 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: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::NotifySendBatchParams} for more details.
       #
@@ -104,6 +114,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/models/notify_send_params.rb

@@ -70,6 +70,16 @@ module PreludeSDK
       #   @return [String, nil]
       optional :locale, String
 
+      # @!attribute max_auto_retries
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_auto_retries, Integer
+
       # @!attribute preferred_channel
       #   The preferred channel to be used in priority for message delivery. If the
       #   channel is unavailable, the system will fallback to other available channels.
@@ -91,7 +101,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, document: 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, 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: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::NotifySendParams} for more details.
       #
@@ -111,6 +121,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

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -69,6 +69,14 @@ module PreludeSDK
       #   @return [String, nil]
       optional :locale, String
 
+      # @!attribute max_auto_retries
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_auto_retries, Integer
+
       # @!attribute preferred_channel
       #   The preferred delivery channel for the message. When specified, the system will
       #   prioritize sending via the requested channel if the template is configured for
@@ -89,7 +97,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, document: 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, max_auto_retries: nil, preferred_channel: nil, variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::TransactionalSendParams} for more details.
       #
@@ -109,6 +117,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/models/verification_check_params.rb

@@ -20,7 +20,16 @@ module PreludeSDK
       #   @return [PreludeSDK::Models::VerificationCheckParams::Target]
       required :target, -> { PreludeSDK::VerificationCheckParams::Target }
 
-      # @!method initialize(code:, target:, request_options: {})
+      # @!attribute psd2
+      #   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.
+      #
+      #   @return [PreludeSDK::Models::VerificationCheckParams::Psd2, nil]
+      optional :psd2, -> { PreludeSDK::VerificationCheckParams::Psd2 }
+
+      # @!method initialize(code:, target:, psd2: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::VerificationCheckParams} for more details.
       #
@@ -28,6 +37,8 @@ module PreludeSDK
       #
       #   @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}]
 
       class Target < PreludeSDK::Internal::Type::BaseModel
@@ -64,6 +75,38 @@ module PreludeSDK
           #   @return [Array<Symbol>]
         end
       end
+
+      class Psd2 < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute amount
+        #   Decimal amount of the transaction.
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute currency
+        #   ISO 4217 currency code.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute recipient
+        #   Payee name displayed to the payer.
+        #
+        #   @return [String]
+        required :recipient, String
+
+        # @!method initialize(amount:, currency:, 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.
+        #
+        #   @param amount [String] Decimal amount of the transaction.
+        #
+        #   @param currency [String] ISO 4217 currency code.
+        #
+        #   @param recipient [String] Payee name displayed to the payer.
+      end
     end
   end
 end

data/lib/prelude_sdk/models/verification_check_response.rb

@@ -5,7 +5,9 @@ module PreludeSDK
     # @see PreludeSDK::Resources::Verification#check
     class VerificationCheckResponse < PreludeSDK::Internal::Type::BaseModel
       # @!attribute status
-      #   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.
       #
       #   @return [Symbol, PreludeSDK::Models::VerificationCheckResponse::Status]
       required :status, enum: -> { PreludeSDK::Models::VerificationCheckResponse::Status }
@@ -28,7 +30,10 @@ module PreludeSDK
       optional :request_id, String
 
       # @!method initialize(status:, id: nil, metadata: nil, request_id: nil)
-      #   @param status [Symbol, PreludeSDK::Models::VerificationCheckResponse::Status] The status of the check.
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::VerificationCheckResponse} for more details.
+      #
+      #   @param status [Symbol, PreludeSDK::Models::VerificationCheckResponse::Status] The status of the check. For `prelude:psd2` codes, `transaction_missing` is retu
       #
       #   @param id [String] The verification identifier.
       #
@@ -36,7 +41,9 @@ module PreludeSDK
       #
       #   @param request_id [String]
 
-      # 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.
       #
       # @see PreludeSDK::Models::VerificationCheckResponse#status
       module Status
@@ -45,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
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -125,6 +125,22 @@ module PreludeSDK
         #   @return [String, nil]
         optional :callback_url, String
 
+        # @!attribute channels
+        #   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.
+        #
+        #   @return [Array<Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Channel>, nil]
+        optional :channels,
+                 -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::VerificationCreateParams::Options::Channel] }
+
         # @!attribute code_size
         #   The size of the code generated. It should be between 4 and 8. Defaults to the
         #   code size specified from the Dashboard.
@@ -140,6 +156,18 @@ module PreludeSDK
         #   @return [String, nil]
         optional :custom_code, String
 
+        # @!attribute force_challenge
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :force_challenge, PreludeSDK::Internal::Type::Boolean
+
         # @!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
@@ -149,6 +177,26 @@ module PreludeSDK
         #   @return [String, nil]
         optional :locale, String
 
+        # @!attribute max_auto_fallbacks
+        #   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.
+        #
+        #   @return [Integer, nil]
+        optional :max_auto_fallbacks, Integer
+
         # @!attribute verification_method
         #   The method used for verifying this phone number. The 'voice' option provides an
         #   accessible alternative for visually impaired users by delivering the
@@ -164,7 +212,12 @@ module PreludeSDK
                  api_name: :method
 
         # @!attribute preferred_channel
-        #   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`.
         #
         #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel, nil]
         optional :preferred_channel, enum: -> { PreludeSDK::VerificationCreateParams::Options::PreferredChannel }
@@ -189,7 +242,7 @@ 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, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
+        # @!method initialize(app_realm: nil, callback_url: nil, channels: nil, code_size: nil, custom_code: nil, force_challenge: nil, locale: nil, max_auto_fallbacks: 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.
         #
@@ -199,15 +252,21 @@ module PreludeSDK
         #
         #   @param callback_url [String] The URL where webhooks will be sent when verification events occur, including ve
         #
+        #   @param channels [Array<Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Channel>] The channels this verification may use, in the order they are tried. Channels yo
+        #
         #   @param code_size [Integer] The size of the code generated. It should be between 4 and 8. Defaults to the co
         #
         #   @param custom_code [String] The custom code to use for OTP verification. To use the custom code feature, con
         #
+        #   @param force_challenge [Boolean] When `true`, the verification is routed through challenge-safe channels (non-SMS
+        #
         #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
         #
+        #   @param max_auto_fallbacks [Integer] Maximum number of delivery attempts Prelude may add on its own after the one you
+        #
         #   @param verification_method [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
         #
-        #   @param preferred_channel [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel] The preferred channel to be used in priority for verification.
+        #   @param preferred_channel [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel] The channel to prioritize when delivering the verification. Prelude prioritizes
         #
         #   @param sender_id [String] The Sender ID to use for this message. The Sender ID needs to be enabled by Prel
         #
@@ -262,6 +321,20 @@ module PreludeSDK
           end
         end
 
+        module Channel
+          extend PreludeSDK::Internal::Type::Enum
+
+          SMS = :sms
+          RCS = :rcs
+          WHATSAPP = :whatsapp
+          VIBER = :viber
+          ZALO = :zalo
+          TELEGRAM = :telegram
+
+          # @!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
@@ -282,7 +355,12 @@ module PreludeSDK
           #   @return [Array<Symbol>]
         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`.
         #
         # @see PreludeSDK::Models::VerificationCreateParams::Options#preferred_channel
         module PreferredChannel

data/lib/prelude_sdk/models/watch_predict_params.rb

@@ -8,7 +8,7 @@ module PreludeSDK
       include PreludeSDK::Internal::Type::RequestParameters
 
       # @!attribute target
-      #   The prediction target. Only supports phone numbers for now.
+      #   The signup identifier to score — a phone number or email address.
       #
       #   @return [PreludeSDK::Models::WatchPredictParams::Target]
       required :target, -> { PreludeSDK::WatchPredictParams::Target }
@@ -36,7 +36,7 @@ module PreludeSDK
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::WatchPredictParams} for more details.
       #
-      #   @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.
       #
@@ -60,7 +60,7 @@ module PreludeSDK
         required :value, String
 
         # @!method initialize(type:, value:)
-        #   The prediction target. Only supports phone numbers for now.
+        #   The signup identifier to score — a phone number or email address.
         #
         #   @param type [Symbol, PreludeSDK::Models::WatchPredictParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
         #

data/lib/prelude_sdk/models/watch_send_events_params.rb

@@ -24,7 +24,15 @@ module PreludeSDK
 
       class Event < PreludeSDK::Internal::Type::BaseModel
         # @!attribute confidence
-        #   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.
         #
         #   @return [Symbol, PreludeSDK::Models::WatchSendEventsParams::Event::Confidence]
         required :confidence, enum: -> { PreludeSDK::WatchSendEventsParams::Event::Confidence }
@@ -42,13 +50,24 @@ module PreludeSDK
         required :target, -> { PreludeSDK::WatchSendEventsParams::Event::Target }
 
         # @!method initialize(confidence:, label:, target:)
-        #   @param confidence [Symbol, PreludeSDK::Models::WatchSendEventsParams::Event::Confidence] A confidence level you want to assign to the event.
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::WatchSendEventsParams::Event} for more details.
+        #
+        #   @param confidence [Symbol, PreludeSDK::Models::WatchSendEventsParams::Event::Confidence] How much this event tells us to trust the end-user's legitimacy — not how certai
         #
         #   @param label [String] A label to describe what the event refers to.
         #
         #   @param target [PreludeSDK::Models::WatchSendEventsParams::Event::Target] The event target. Only supports phone numbers for now.
 
-        # 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.
         #
         # @see PreludeSDK::Models::WatchSendEventsParams::Event#confidence
         module Confidence

data/lib/prelude_sdk/resources/notify.rb

@@ -159,7 +159,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 +177,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 +206,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 +224,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.6.0"
 end