prelude-sdk 0.2.0 → 0.4.0

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: {}
       )
@@ -72,13 +74,6 @@ module PreludeSDK
         end
         attr_accessor :type
 
-        # The identifier of the dispatch that came from the front-end SDK.
-        sig { returns(T.nilable(String)) }
-        attr_reader :dispatch_id
-
-        sig { params(dispatch_id: String).void }
-        attr_writer :dispatch_id
-
         # The metadata for this feedback.
         sig do
           returns(
@@ -95,34 +90,14 @@ module PreludeSDK
         end
         attr_writer :metadata
 
-        # The signals used for anti-fraud. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig do
-          returns(
-            T.nilable(PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals)
-          )
-        end
-        attr_reader :signals
-
-        sig do
-          params(
-            signals:
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::OrHash
-          ).void
-        end
-        attr_writer :signals
-
         sig do
           params(
             target:
               PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::OrHash,
             type:
               PreludeSDK::WatchSendFeedbacksParams::Feedback::Type::OrSymbol,
-            dispatch_id: String,
             metadata:
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata::OrHash,
-            signals:
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::OrHash
+              PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -130,13 +105,8 @@ module PreludeSDK
           target:,
           # The type of feedback.
           type:,
-          # The identifier of the dispatch that came from the front-end SDK.
-          dispatch_id: nil,
           # The metadata for this feedback.
-          metadata: nil,
-          # The signals used for anti-fraud. For more details, refer to
-          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-          signals: nil
+          metadata: nil
         )
         end
 
@@ -146,10 +116,7 @@ module PreludeSDK
               target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
               type:
                 PreludeSDK::WatchSendFeedbacksParams::Feedback::Type::OrSymbol,
-              dispatch_id: String,
-              metadata:
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata,
-              signals: PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals
+              metadata: PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
             }
           )
         end
@@ -306,211 +273,6 @@ module PreludeSDK
           def to_hash
           end
         end
-
-        class Signals < PreludeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals,
-                PreludeSDK::Internal::AnyHash
-              )
-            end
-
-          # The version of your application.
-          sig { returns(T.nilable(String)) }
-          attr_reader :app_version
-
-          sig { params(app_version: String).void }
-          attr_writer :app_version
-
-          # The unique identifier for the user's device. For Android, this corresponds to
-          # the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-          sig { returns(T.nilable(String)) }
-          attr_reader :device_id
-
-          sig { params(device_id: String).void }
-          attr_writer :device_id
-
-          # The model of the user's device.
-          sig { returns(T.nilable(String)) }
-          attr_reader :device_model
-
-          sig { params(device_model: String).void }
-          attr_writer :device_model
-
-          # The type of the user's device.
-          sig do
-            returns(
-              T.nilable(
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::OrSymbol
-              )
-            )
-          end
-          attr_reader :device_platform
-
-          sig do
-            params(
-              device_platform:
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::OrSymbol
-            ).void
-          end
-          attr_writer :device_platform
-
-          # The IP address of the user's device.
-          sig { returns(T.nilable(String)) }
-          attr_reader :ip
-
-          sig { params(ip: String).void }
-          attr_writer :ip
-
-          # This signal should provide a higher level of trust, indicating that the user is
-          # genuine. Contact us to discuss your use case. For more details, refer to
-          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :is_trusted_user
-
-          sig { params(is_trusted_user: T::Boolean).void }
-          attr_writer :is_trusted_user
-
-          # The JA4 fingerprint observed for the connection. Prelude will infer it
-          # automatically when requests go through our client SDK (which uses Prelude's
-          # edge), but you can also provide it explicitly if you terminate TLS yourself.
-          sig { returns(T.nilable(String)) }
-          attr_reader :ja4_fingerprint
-
-          sig { params(ja4_fingerprint: String).void }
-          attr_writer :ja4_fingerprint
-
-          # The version of the user's device operating system.
-          sig { returns(T.nilable(String)) }
-          attr_reader :os_version
-
-          sig { params(os_version: String).void }
-          attr_writer :os_version
-
-          # The user agent of the user's device. If the individual fields (os_version,
-          # device_platform, device_model) are provided, we will prioritize those values
-          # instead of parsing them from the user agent string.
-          sig { returns(T.nilable(String)) }
-          attr_reader :user_agent
-
-          sig { params(user_agent: String).void }
-          attr_writer :user_agent
-
-          # The signals used for anti-fraud. For more details, refer to
-          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-          sig do
-            params(
-              app_version: String,
-              device_id: String,
-              device_model: String,
-              device_platform:
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::OrSymbol,
-              ip: String,
-              is_trusted_user: T::Boolean,
-              ja4_fingerprint: String,
-              os_version: String,
-              user_agent: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The version of your application.
-            app_version: nil,
-            # The unique identifier for the user's device. For Android, this corresponds to
-            # the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-            device_id: nil,
-            # The model of the user's device.
-            device_model: nil,
-            # The type of the user's device.
-            device_platform: nil,
-            # The IP address of the user's device.
-            ip: nil,
-            # This signal should provide a higher level of trust, indicating that the user is
-            # genuine. Contact us to discuss your use case. For more details, refer to
-            # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-            is_trusted_user: nil,
-            # The JA4 fingerprint observed for the connection. Prelude will infer it
-            # automatically when requests go through our client SDK (which uses Prelude's
-            # edge), but you can also provide it explicitly if you terminate TLS yourself.
-            ja4_fingerprint: nil,
-            # The version of the user's device operating system.
-            os_version: nil,
-            # The user agent of the user's device. If the individual fields (os_version,
-            # device_platform, device_model) are provided, we will prioritize those values
-            # instead of parsing them from the user agent string.
-            user_agent: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                app_version: String,
-                device_id: String,
-                device_model: String,
-                device_platform:
-                  PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::OrSymbol,
-                ip: String,
-                is_trusted_user: T::Boolean,
-                ja4_fingerprint: String,
-                os_version: String,
-                user_agent: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # The type of the user's device.
-          module DevicePlatform
-            extend PreludeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            ANDROID =
-              T.let(
-                :android,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-              )
-            IOS =
-              T.let(
-                :ios,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-              )
-            IPADOS =
-              T.let(
-                :ipados,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-              )
-            TVOS =
-              T.let(
-                :tvos,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-              )
-            WEB =
-              T.let(
-                :web,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
       end
     end
   end

data/rbi/prelude_sdk/resources/lookup.rbi

@@ -2,6 +2,8 @@
 
 module PreludeSDK
   module Resources
+    # Retrieve detailed information about a phone number including carrier data, line
+    # type, and portability status.
     class Lookup
       # Retrieve detailed information about a phone number including carrier data, line
       # type, and portability status.

data/rbi/prelude_sdk/resources/notify.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Send transactional and marketing messages with compliance enforcement.
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
       sig do
@@ -113,20 +114,23 @@ 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,
           from: String,
           locale: String,
           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)
@@ -138,10 +142,24 @@ 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 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.
         expires_at: nil,
@@ -159,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: {}
@@ -172,6 +194,7 @@ module PreludeSDK
           to: T::Array[String],
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::NotifySendBatchParams::Document::OrHash,
           expires_at: Time,
           from: String,
           locale: String,
@@ -191,6 +214,17 @@ module PreludeSDK
         callback_url: nil,
         # A user-defined identifier to correlate this request with your internal systems.
         correlation_id: nil,
+        # 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.
         expires_at: nil,

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Send transactional messages (deprecated - use Notify API instead).
     class Transactional
       # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
       # instead.
@@ -11,6 +12,7 @@ module PreludeSDK
           to: String,
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::TransactionalSendParams::Document::OrHash,
           expires_at: String,
           from: String,
           locale: String,
@@ -31,6 +33,17 @@ module PreludeSDK
         # returned in the response and any webhook events that refer to this
         # transactionalmessage.
         correlation_id: nil,
+        # 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,
         # The Sender ID.

data/rbi/prelude_sdk/resources/verification.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class Verification
       # Create a new verification for a specific phone number. If another non-expired
       # verification exists (the request is performed within the verification window),

data/rbi/prelude_sdk/resources/verification_management.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class VerificationManagement
       # Remove a phone number from the allow or block list.
       #

data/rbi/prelude_sdk/resources/watch.rbi

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
       # Predict the outcome of a verification based on Prelude’s anti-fraud system.
       sig do
@@ -36,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: {}
       )
@@ -52,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]]
@@ -106,6 +110,16 @@ module PreludeSDK
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/prelude_sdk/models/lookup_lookup_params.rbs

@@ -1,13 +1,18 @@
 module PreludeSDK
   module Models
     type lookup_lookup_params =
-      { type: ::Array[PreludeSDK::Models::LookupLookupParams::type_] }
+      {
+        phone_number: String,
+        type: ::Array[PreludeSDK::Models::LookupLookupParams::type_]
+      }
       & PreludeSDK::Internal::Type::request_parameters
 
     class LookupLookupParams < PreludeSDK::Internal::Type::BaseModel
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      attr_accessor phone_number: String
+
       attr_reader type: ::Array[PreludeSDK::Models::LookupLookupParams::type_]?
 
       def type=: (
@@ -15,11 +20,13 @@ module PreludeSDK
       ) -> ::Array[PreludeSDK::Models::LookupLookupParams::type_]
 
       def initialize: (
+        phone_number: String,
         ?type: ::Array[PreludeSDK::Models::LookupLookupParams::type_],
         ?request_options: PreludeSDK::request_opts
       ) -> void
 
       def to_hash: -> {
+        phone_number: String,
         type: ::Array[PreludeSDK::Models::LookupLookupParams::type_],
         request_options: PreludeSDK::RequestOptions
       }

data/sig/prelude_sdk/models/notify_get_subscription_config_params.rbs

@@ -1,15 +1,23 @@
 module PreludeSDK
   module Models
     type notify_get_subscription_config_params =
-      {  } & PreludeSDK::Internal::Type::request_parameters
+      { config_id: String } & PreludeSDK::Internal::Type::request_parameters
 
     class NotifyGetSubscriptionConfigParams < PreludeSDK::Internal::Type::BaseModel
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: PreludeSDK::request_opts) -> void
+      attr_accessor config_id: String
 
-      def to_hash: -> { request_options: PreludeSDK::RequestOptions }
+      def initialize: (
+        config_id: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        config_id: String,
+        request_options: PreludeSDK::RequestOptions
+      }
     end
   end
 end

data/sig/prelude_sdk/models/notify_get_subscription_phone_number_params.rbs

@@ -1,7 +1,8 @@
 module PreludeSDK
   module Models
     type notify_get_subscription_phone_number_params =
-      { config_id: String } & PreludeSDK::Internal::Type::request_parameters
+      { config_id: String, phone_number: String }
+      & PreludeSDK::Internal::Type::request_parameters
 
     class NotifyGetSubscriptionPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,17 @@ module PreludeSDK
 
       attr_accessor config_id: String
 
+      attr_accessor phone_number: String
+
       def initialize: (
         config_id: String,
+        phone_number: String,
         ?request_options: PreludeSDK::request_opts
       ) -> void
 
       def to_hash: -> {
         config_id: String,
+        phone_number: String,
         request_options: PreludeSDK::RequestOptions
       }
     end

data/sig/prelude_sdk/models/notify_list_subscription_phone_number_events_params.rbs

@@ -1,7 +1,12 @@
 module PreludeSDK
   module Models
     type notify_list_subscription_phone_number_events_params =
-      { config_id: String, cursor: String, limit: Integer }
+      {
+        config_id: String,
+        phone_number: String,
+        cursor: String,
+        limit: Integer
+      }
       & PreludeSDK::Internal::Type::request_parameters
 
     class NotifyListSubscriptionPhoneNumberEventsParams < PreludeSDK::Internal::Type::BaseModel
@@ -10,6 +15,8 @@ module PreludeSDK
 
       attr_accessor config_id: String
 
+      attr_accessor phone_number: String
+
       attr_reader cursor: String?
 
       def cursor=: (String) -> String
@@ -20,6 +27,7 @@ module PreludeSDK
 
       def initialize: (
         config_id: String,
+        phone_number: String,
         ?cursor: String,
         ?limit: Integer,
         ?request_options: PreludeSDK::request_opts
@@ -27,6 +35,7 @@ module PreludeSDK
 
       def to_hash: -> {
         config_id: String,
+        phone_number: String,
         cursor: String,
         limit: Integer,
         request_options: PreludeSDK::RequestOptions

data/sig/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rbs

@@ -2,6 +2,7 @@ module PreludeSDK
   module Models
     type notify_list_subscription_phone_numbers_params =
       {
+        config_id: String,
         cursor: String,
         limit: Integer,
         state: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::state
@@ -12,6 +13,8 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      attr_accessor config_id: String
+
       attr_reader cursor: String?
 
       def cursor=: (String) -> String
@@ -27,6 +30,7 @@ module PreludeSDK
       ) -> PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::state
 
       def initialize: (
+        config_id: String,
         ?cursor: String,
         ?limit: Integer,
         ?state: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::state,
@@ -34,6 +38,7 @@ module PreludeSDK
       ) -> void
 
       def to_hash: -> {
+        config_id: String,
         cursor: String,
         limit: Integer,
         state: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::state,