prelude-sdk 0.3.0 → 0.4.0

data/rbi/prelude_sdk/models/verification_create_response.rbi

@@ -114,6 +114,51 @@ module PreludeSDK
       sig { params(request_id: String).void }
       attr_writer :request_id
 
+      # The risk factors that contributed to the verification being blocked. Only
+      # present when status is "blocked" and the anti-fraud system detected specific
+      # risk signals.
+      #
+      # - `behavioral_pattern` - The phone number past behavior during verification
+      #   flows exhibits suspicious patterns.
+      # - `device_attribute` - The device exhibits characteristics associated with
+      #   suspicious activity patterns.
+      # - `fraud_database` - The phone number has been flagged as suspicious in one or
+      #   more of our fraud databases.
+      # - `location_discrepancy` - The phone number prefix and IP address discrepancy
+      #   indicates potential fraud.
+      # - `network_fingerprint` - The network connection exhibits characteristics
+      #   associated with suspicious activity patterns.
+      # - `poor_conversion_history` - The phone number has a history of poorly
+      #   converting to a verified phone number.
+      # - `prefix_concentration` - The phone number is part of a range known to be
+      #   associated with suspicious activity patterns.
+      # - `suspected_request_tampering` - The SDK signature is invalid and the request
+      #   is considered to be tampered with.
+      # - `suspicious_ip_address` - The IP address is deemed to be associated with
+      #   suspicious activity patterns.
+      # - `temporary_phone_number` - The phone number is known to be a temporary or
+      #   disposable number.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :risk_factors
+
+      sig do
+        params(
+          risk_factors:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::RiskFactor::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :risk_factors
+
       # The silent verification specific properties.
       sig do
         returns(
@@ -145,6 +190,10 @@ module PreludeSDK
           reason:
             PreludeSDK::Models::VerificationCreateResponse::Reason::OrSymbol,
           request_id: String,
+          risk_factors:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::RiskFactor::OrSymbol
+            ],
           silent: PreludeSDK::Models::VerificationCreateResponse::Silent::OrHash
         ).returns(T.attached_class)
       end
@@ -183,6 +232,31 @@ module PreludeSDK
         #   anti-fraud system.
         reason: nil,
         request_id: nil,
+        # The risk factors that contributed to the verification being blocked. Only
+        # present when status is "blocked" and the anti-fraud system detected specific
+        # risk signals.
+        #
+        # - `behavioral_pattern` - The phone number past behavior during verification
+        #   flows exhibits suspicious patterns.
+        # - `device_attribute` - The device exhibits characteristics associated with
+        #   suspicious activity patterns.
+        # - `fraud_database` - The phone number has been flagged as suspicious in one or
+        #   more of our fraud databases.
+        # - `location_discrepancy` - The phone number prefix and IP address discrepancy
+        #   indicates potential fraud.
+        # - `network_fingerprint` - The network connection exhibits characteristics
+        #   associated with suspicious activity patterns.
+        # - `poor_conversion_history` - The phone number has a history of poorly
+        #   converting to a verified phone number.
+        # - `prefix_concentration` - The phone number is part of a range known to be
+        #   associated with suspicious activity patterns.
+        # - `suspected_request_tampering` - The SDK signature is invalid and the request
+        #   is considered to be tampered with.
+        # - `suspicious_ip_address` - The IP address is deemed to be associated with
+        #   suspicious activity patterns.
+        # - `temporary_phone_number` - The phone number is known to be a temporary or
+        #   disposable number.
+        risk_factors: nil,
         # The silent verification specific properties.
         silent: nil
       )
@@ -204,6 +278,10 @@ module PreludeSDK
             reason:
               PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol,
             request_id: String,
+            risk_factors:
+              T::Array[
+                PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+              ],
             silent: PreludeSDK::Models::VerificationCreateResponse::Silent
           }
         )
@@ -477,6 +555,80 @@ module PreludeSDK
         end
       end
 
+      module RiskFactor
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::Models::VerificationCreateResponse::RiskFactor
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BEHAVIORAL_PATTERN =
+          T.let(
+            :behavioral_pattern,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_ATTRIBUTE =
+          T.let(
+            :device_attribute,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        FRAUD_DATABASE =
+          T.let(
+            :fraud_database,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        LOCATION_DISCREPANCY =
+          T.let(
+            :location_discrepancy,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        NETWORK_FINGERPRINT =
+          T.let(
+            :network_fingerprint,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        POOR_CONVERSION_HISTORY =
+          T.let(
+            :poor_conversion_history,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        PREFIX_CONCENTRATION =
+          T.let(
+            :prefix_concentration,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        SUSPECTED_REQUEST_TAMPERING =
+          T.let(
+            :suspected_request_tampering,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        SUSPICIOUS_IP_ADDRESS =
+          T.let(
+            :suspicious_ip_address,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        TEMPORARY_PHONE_NUMBER =
+          T.let(
+            :temporary_phone_number,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Silent < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/prelude_sdk/models/watch_send_events_params.rbi

@@ -14,7 +14,8 @@ module PreludeSDK
           )
         end
 
-      # A list of events to dispatch.
+      # A list of events to dispatch. A maximum of 100 events can be sent in a single
+      # request.
       sig { returns(T::Array[PreludeSDK::WatchSendEventsParams::Event]) }
       attr_accessor :events
 
@@ -25,7 +26,8 @@ module PreludeSDK
         ).returns(T.attached_class)
       end
       def self.new(
-        # A list of events to dispatch.
+        # A list of events to dispatch. A maximum of 100 events can be sent in a single
+        # request.
         events:,
         request_options: {}
       )

data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi

@@ -14,7 +14,8 @@ module PreludeSDK
           )
         end
 
-      # A list of feedbacks to send.
+      # A list of feedbacks to send. A maximum of 100 feedbacks can be sent in a single
+      # request.
       sig { returns(T::Array[PreludeSDK::WatchSendFeedbacksParams::Feedback]) }
       attr_accessor :feedbacks
 
@@ -26,7 +27,8 @@ module PreludeSDK
         ).returns(T.attached_class)
       end
       def self.new(
-        # A list of feedbacks to send.
+        # A list of feedbacks to send. A maximum of 100 feedbacks can be sent in a single
+        # request.
         feedbacks:,
         request_options: {}
       )

data/rbi/prelude_sdk/resources/notify.rbi

@@ -114,13 +114,14 @@ module PreludeSDK
       )
       end
 
-      # Send transactional and marketing messages to your users via SMS and WhatsApp
-      # with automatic compliance enforcement.
+      # Send transactional and marketing messages to your users via SMS, RCS and
+      # WhatsApp with automatic compliance enforcement.
       sig do
         params(
           template_id: String,
           to: String,
           callback_url: String,
+          context: PreludeSDK::NotifySendParams::Context::OrHash,
           correlation_id: String,
           document: PreludeSDK::NotifySendParams::Document::OrHash,
           expires_at: Time,
@@ -129,6 +130,7 @@ module PreludeSDK
           preferred_channel:
             PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
+          text: String,
           variables: T::Hash[Symbol, String],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(PreludeSDK::Models::NotifySendResponse)
@@ -140,12 +142,23 @@ module PreludeSDK
         to:,
         # The URL where webhooks will be sent for message delivery events.
         callback_url: nil,
+        # Context for replying to an inbound message. When provided, the message is sent
+        # as a WhatsApp reply within the 24-hour conversation window.
+        context: nil,
         # A user-defined identifier to correlate this message with your internal systems.
         # It is returned in the response and any webhook events that refer to this
         # message.
         correlation_id: nil,
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # A media attachment to include in the message header. Supported on WhatsApp
+        # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        # type is determined by the template's registered header format; send the matching
+        # file type for each.
+        #
+        # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #   required and displayed to the recipient.
+        # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #   is ignored.
+        # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
         document: nil,
         # The message expiration date in RFC3339 format. The message will not be sent if
         # this time is reached.
@@ -164,6 +177,10 @@ module PreludeSDK
         # can be scheduled up to 90 days in advance and will be automatically adjusted for
         # compliance with local time window restrictions.
         schedule_at: nil,
+        # The reply message body. Required when `context.reply_to` is provided. Used for
+        # 2-way WhatsApp messaging to send free-form text replies within a conversation
+        # window.
+        text: nil,
         # The variables to be replaced in the template.
         variables: nil,
         request_options: {}
@@ -197,8 +214,16 @@ module PreludeSDK
         callback_url: nil,
         # A user-defined identifier to correlate this request with your internal systems.
         correlation_id: nil,
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # A media attachment to include in the message header. Supported on WhatsApp
+        # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        # type is determined by the template's registered header format; send the matching
+        # file type for each.
+        #
+        # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #   required and displayed to the recipient.
+        # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #   is ignored.
+        # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
         document: nil,
         # The message expiration date in RFC3339 format. Messages will not be sent after
         # this time.

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -33,8 +33,16 @@ module PreludeSDK
         # returned in the response and any webhook events that refer to this
         # transactionalmessage.
         correlation_id: nil,
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # A media attachment to include in the message header. Supported on WhatsApp
+        # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        # type is determined by the template's registered header format; send the matching
+        # file type for each.
+        #
+        # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #   required and displayed to the recipient.
+        # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #   is ignored.
+        # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
         document: nil,
         # The message expiration date.
         expires_at: nil,

data/rbi/prelude_sdk/resources/watch.rbi

@@ -37,7 +37,8 @@ module PreludeSDK
         ).returns(PreludeSDK::Models::WatchSendEventsResponse)
       end
       def send_events(
-        # A list of events to dispatch.
+        # A list of events to dispatch. A maximum of 100 events can be sent in a single
+        # request.
         events:,
         request_options: {}
       )
@@ -53,7 +54,8 @@ module PreludeSDK
         ).returns(PreludeSDK::Models::WatchSendFeedbacksResponse)
       end
       def send_feedbacks(
-        # A list of feedbacks to send.
+        # A list of feedbacks to send. A maximum of 100 feedbacks can be sent in a single
+        # request.
         feedbacks:,
         request_options: {}
       )

data/sig/prelude_sdk/internal/util.rbs

@@ -45,8 +45,12 @@ module PreludeSDK
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]

data/sig/prelude_sdk/models/notify_send_batch_params.rbs

@@ -94,24 +94,27 @@ module PreludeSDK
         request_options: PreludeSDK::RequestOptions
       }
 
-      type document = { filename: String, url: String }
+      type document = { url: String, filename: String }
 
       class Document < PreludeSDK::Internal::Type::BaseModel
-        attr_accessor filename: String
-
         attr_accessor url: String
 
-        def initialize: (filename: String, url: String) -> void
+        attr_reader filename: String?
+
+        def filename=: (String) -> String
+
+        def initialize: (url: String, ?filename: String) -> void
 
-        def to_hash: -> { filename: String, url: String }
+        def to_hash: -> { url: String, filename: String }
       end
 
-      type preferred_channel = :sms | :whatsapp
+      type preferred_channel = :sms | :rcs | :whatsapp
 
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum
 
         SMS: :sms
+        RCS: :rcs
         WHATSAPP: :whatsapp
 
         def self?.values: -> ::Array[PreludeSDK::Models::NotifySendBatchParams::preferred_channel]

data/sig/prelude_sdk/models/notify_send_params.rbs

@@ -5,6 +5,7 @@ module PreludeSDK
         template_id: String,
         to: String,
         callback_url: String,
+        context: PreludeSDK::NotifySendParams::Context,
         correlation_id: String,
         document: PreludeSDK::NotifySendParams::Document,
         expires_at: Time,
@@ -12,6 +13,7 @@ module PreludeSDK
         locale: String,
         preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         schedule_at: Time,
+        text: String,
         variables: ::Hash[Symbol, String]
       }
       & PreludeSDK::Internal::Type::request_parameters
@@ -28,6 +30,12 @@ module PreludeSDK
 
       def callback_url=: (String) -> String
 
+      attr_reader context: PreludeSDK::NotifySendParams::Context?
+
+      def context=: (
+        PreludeSDK::NotifySendParams::Context
+      ) -> PreludeSDK::NotifySendParams::Context
+
       attr_reader correlation_id: String?
 
       def correlation_id=: (String) -> String
@@ -60,6 +68,10 @@ module PreludeSDK
 
       def schedule_at=: (Time) -> Time
 
+      attr_reader text: String?
+
+      def text=: (String) -> String
+
       attr_reader variables: ::Hash[Symbol, String]?
 
       def variables=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
@@ -68,6 +80,7 @@ module PreludeSDK
         template_id: String,
         to: String,
         ?callback_url: String,
+        ?context: PreludeSDK::NotifySendParams::Context,
         ?correlation_id: String,
         ?document: PreludeSDK::NotifySendParams::Document,
         ?expires_at: Time,
@@ -75,6 +88,7 @@ module PreludeSDK
         ?locale: String,
         ?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         ?schedule_at: Time,
+        ?text: String,
         ?variables: ::Hash[Symbol, String],
         ?request_options: PreludeSDK::request_opts
       ) -> void
@@ -83,6 +97,7 @@ module PreludeSDK
         template_id: String,
         to: String,
         callback_url: String,
+        context: PreludeSDK::NotifySendParams::Context,
         correlation_id: String,
         document: PreludeSDK::NotifySendParams::Document,
         expires_at: Time,
@@ -90,28 +105,42 @@ module PreludeSDK
         locale: String,
         preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         schedule_at: Time,
+        text: String,
         variables: ::Hash[Symbol, String],
         request_options: PreludeSDK::RequestOptions
       }
 
-      type document = { filename: String, url: String }
+      type context = { reply_to: String }
 
-      class Document < PreludeSDK::Internal::Type::BaseModel
-        attr_accessor filename: String
+      class Context < PreludeSDK::Internal::Type::BaseModel
+        attr_accessor reply_to: String
+
+        def initialize: (reply_to: String) -> void
 
+        def to_hash: -> { reply_to: String }
+      end
+
+      type document = { url: String, filename: String }
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
         attr_accessor url: String
 
-        def initialize: (filename: String, url: String) -> void
+        attr_reader filename: String?
+
+        def filename=: (String) -> String
+
+        def initialize: (url: String, ?filename: String) -> void
 
-        def to_hash: -> { filename: String, url: String }
+        def to_hash: -> { url: String, filename: String }
       end
 
-      type preferred_channel = :sms | :whatsapp
+      type preferred_channel = :sms | :rcs | :whatsapp
 
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum
 
         SMS: :sms
+        RCS: :rcs
         WHATSAPP: :whatsapp
 
         def self?.values: -> ::Array[PreludeSDK::Models::NotifySendParams::preferred_channel]

data/sig/prelude_sdk/models/transactional_send_params.rbs

@@ -87,16 +87,18 @@ module PreludeSDK
         request_options: PreludeSDK::RequestOptions
       }
 
-      type document = { filename: String, url: String }
+      type document = { url: String, filename: String }
 
       class Document < PreludeSDK::Internal::Type::BaseModel
-        attr_accessor filename: String
-
         attr_accessor url: String
 
-        def initialize: (filename: String, url: String) -> void
+        attr_reader filename: String?
+
+        def filename=: (String) -> String
+
+        def initialize: (url: String, ?filename: String) -> void
 
-        def to_hash: -> { filename: String, url: String }
+        def to_hash: -> { url: String, filename: String }
       end
 
       type preferred_channel = :sms | :rcs | :whatsapp

data/sig/prelude_sdk/models/verification_create_response.rbs

@@ -9,6 +9,7 @@ module PreludeSDK
         metadata: PreludeSDK::Models::VerificationCreateResponse::Metadata,
         reason: PreludeSDK::Models::VerificationCreateResponse::reason,
         request_id: String,
+        risk_factors: ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor],
         silent: PreludeSDK::Models::VerificationCreateResponse::Silent
       }
 
@@ -41,6 +42,12 @@ module PreludeSDK
 
       def request_id=: (String) -> String
 
+      attr_reader risk_factors: ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor]?
+
+      def risk_factors=: (
+        ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor]
+      ) -> ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor]
+
       attr_reader silent: PreludeSDK::Models::VerificationCreateResponse::Silent?
 
       def silent=: (
@@ -55,6 +62,7 @@ module PreludeSDK
         ?metadata: PreludeSDK::Models::VerificationCreateResponse::Metadata,
         ?reason: PreludeSDK::Models::VerificationCreateResponse::reason,
         ?request_id: String,
+        ?risk_factors: ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor],
         ?silent: PreludeSDK::Models::VerificationCreateResponse::Silent
       ) -> void
 
@@ -66,6 +74,7 @@ module PreludeSDK
         metadata: PreludeSDK::Models::VerificationCreateResponse::Metadata,
         reason: PreludeSDK::Models::VerificationCreateResponse::reason,
         request_id: String,
+        risk_factors: ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor],
         silent: PreludeSDK::Models::VerificationCreateResponse::Silent
       }
 
@@ -148,6 +157,35 @@ module PreludeSDK
         def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::reason]
       end
 
+      type risk_factor =
+        :behavioral_pattern
+        | :device_attribute
+        | :fraud_database
+        | :location_discrepancy
+        | :network_fingerprint
+        | :poor_conversion_history
+        | :prefix_concentration
+        | :suspected_request_tampering
+        | :suspicious_ip_address
+        | :temporary_phone_number
+
+      module RiskFactor
+        extend PreludeSDK::Internal::Type::Enum
+
+        BEHAVIORAL_PATTERN: :behavioral_pattern
+        DEVICE_ATTRIBUTE: :device_attribute
+        FRAUD_DATABASE: :fraud_database
+        LOCATION_DISCREPANCY: :location_discrepancy
+        NETWORK_FINGERPRINT: :network_fingerprint
+        POOR_CONVERSION_HISTORY: :poor_conversion_history
+        PREFIX_CONCENTRATION: :prefix_concentration
+        SUSPECTED_REQUEST_TAMPERING: :suspected_request_tampering
+        SUSPICIOUS_IP_ADDRESS: :suspicious_ip_address
+        TEMPORARY_PHONE_NUMBER: :temporary_phone_number
+
+        def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::risk_factor]
+      end
+
       type silent = { request_url: String }
 
       class Silent < PreludeSDK::Internal::Type::BaseModel

data/sig/prelude_sdk/resources/notify.rbs

@@ -38,6 +38,7 @@ module PreludeSDK
         template_id: String,
         to: String,
         ?callback_url: String,
+        ?context: PreludeSDK::NotifySendParams::Context,
         ?correlation_id: String,
         ?document: PreludeSDK::NotifySendParams::Document,
         ?expires_at: Time,
@@ -45,6 +46,7 @@ module PreludeSDK
         ?locale: String,
         ?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
         ?schedule_at: Time,
+        ?text: String,
         ?variables: ::Hash[Symbol, String],
         ?request_options: PreludeSDK::request_opts
       ) -> PreludeSDK::Models::NotifySendResponse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prelude-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Prelude
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-23 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi