prelude-sdk 0.3.0 → 0.5.0

data/rbi/prelude_sdk/resources/notify.rbi

@@ -114,8 +114,8 @@ 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,
@@ -144,8 +144,16 @@ module PreludeSDK
         # 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.
@@ -197,8 +205,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

@@ -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::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
       }
 
@@ -82,7 +91,7 @@ module PreludeSDK
         def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::method_]
       end
 
-      type status = :success | :retry | :challenged | :blocked
+      type status = :success | :retry | :challenged | :blocked | :shadow_blocked
 
       module Status
         extend PreludeSDK::Internal::Type::Enum
@@ -91,6 +100,7 @@ module PreludeSDK
         RETRY: :retry
         CHALLENGED: :challenged
         BLOCKED: :blocked
+        SHADOW_BLOCKED: :shadow_blocked
 
         def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::status]
       end
@@ -148,6 +158,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

metadata

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