prelude-sdk 0.1.0.pre.alpha.2 → 0.1.0

data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi

@@ -285,7 +285,8 @@ module PreludeSDK
               )
             end
 
-          # A user-defined identifier to correlate this feedback with.
+          # A user-defined identifier to correlate this feedback with. It is returned in the
+          # response and any webhook events that refer to this feedback.
           sig { returns(T.nilable(String)) }
           attr_reader :correlation_id
 
@@ -295,7 +296,8 @@ module PreludeSDK
           # The metadata for this feedback.
           sig { params(correlation_id: String).returns(T.attached_class) }
           def self.new(
-            # A user-defined identifier to correlate this feedback with.
+            # A user-defined identifier to correlate this feedback with. It is returned in the
+            # response and any webhook events that refer to this feedback.
             correlation_id: nil
           )
           end
@@ -370,6 +372,15 @@ module PreludeSDK
           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
@@ -397,6 +408,7 @@ module PreludeSDK
                 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)
@@ -417,6 +429,10 @@ module PreludeSDK
             # 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,
@@ -436,6 +452,7 @@ module PreludeSDK
                   PreludeSDK::WatchSendFeedbacksParams::Feedback::Signals::DevicePlatform::OrSymbol,
                 ip: String,
                 is_trusted_user: T::Boolean,
+                ja4_fingerprint: String,
                 os_version: String,
                 user_agent: String
               }

data/rbi/prelude_sdk/models.rbi

@@ -9,6 +9,21 @@ module PreludeSDK
 
   VerificationCreateParams = PreludeSDK::Models::VerificationCreateParams
 
+  VerificationManagementDeletePhoneNumberParams =
+    PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
+
+  VerificationManagementListPhoneNumbersParams =
+    PreludeSDK::Models::VerificationManagementListPhoneNumbersParams
+
+  VerificationManagementListSenderIDsParams =
+    PreludeSDK::Models::VerificationManagementListSenderIDsParams
+
+  VerificationManagementSetPhoneNumberParams =
+    PreludeSDK::Models::VerificationManagementSetPhoneNumberParams
+
+  VerificationManagementSubmitSenderIDParams =
+    PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
+
   WatchPredictParams = PreludeSDK::Models::WatchPredictParams
 
   WatchSendEventsParams = PreludeSDK::Models::WatchSendEventsParams

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -3,7 +3,8 @@
 module PreludeSDK
   module Resources
     class Transactional
-      # Send a transactional message to your user.
+      # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
+      # instead.
       sig do
         params(
           template_id: String,
@@ -13,6 +14,8 @@ module PreludeSDK
           expires_at: String,
           from: String,
           locale: String,
+          preferred_channel:
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
           variables: T::Hash[Symbol, String],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(PreludeSDK::Models::TransactionalSendResponse)
@@ -24,7 +27,9 @@ module PreludeSDK
         to:,
         # The callback URL.
         callback_url: nil,
-        # A unique, user-defined identifier that will be included in webhook events.
+        # A user-defined identifier to correlate this transactional message with. It is
+        # returned in the response and any webhook events that refer to this
+        # transactionalmessage.
         correlation_id: nil,
         # The message expiration date.
         expires_at: nil,
@@ -35,6 +40,16 @@ module PreludeSDK
         # code of the phone number. If the language specified doesn't exist, the default
         # set on the template will be used.
         locale: nil,
+        # The preferred delivery channel for the message. When specified, the system will
+        # prioritize sending via the requested channel if the template is configured for
+        # it.
+        #
+        # If not specified and the template is configured for WhatsApp, the message will
+        # be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+        # is unavailable.
+        #
+        # Supported channels: `sms`, `rcs`, `whatsapp`.
+        preferred_channel: nil,
         # The variables to be replaced in the template.
         variables: nil,
         request_options: {}

data/rbi/prelude_sdk/resources/verification_management.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class VerificationManagement
+      # Remove a phone number from the allow or block list.
+      #
+      # This operation is idempotent - re-deleting the same phone number will not result
+      # in errors. If the phone number does not exist in the specified list, the
+      # operation will succeed without making any changes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::OrSymbol,
+          phone_number: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementDeletePhoneNumberResponse
+        )
+      end
+      def delete_phone_number(
+        # The action type - either "allow" or "block"
+        action,
+        # An E.164 formatted phone number to remove from the list.
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      # Retrieve the list of phone numbers in the allow or block list.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementListPhoneNumbersParams::Action::OrSymbol,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse
+        )
+      end
+      def list_phone_numbers(
+        # The action type - either "allow" or "block"
+        action,
+        request_options: {}
+      )
+      end
+
+      # Retrieve sender IDs list.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+          PreludeSDK::Models::VerificationManagementListSenderIDsResponse
+        )
+      end
+      def list_sender_ids(request_options: {})
+      end
+
+      # Add a phone number to the allow or block list.
+      #
+      # This operation is idempotent - re-adding the same phone number will not result
+      # in duplicate entries or errors. If the phone number already exists in the
+      # specified list, the operation will succeed without making any changes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(
+          action:
+            PreludeSDK::VerificationManagementSetPhoneNumberParams::Action::OrSymbol,
+          phone_number: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementSetPhoneNumberResponse
+        )
+      end
+      def set_phone_number(
+        # The action type - either "allow" or "block"
+        action,
+        # An E.164 formatted phone number to add to the list.
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      # This endpoint allows you to submit a new sender ID for verification purposes.
+      #
+      # In order to get access to this endpoint, contact our support team.
+      sig do
+        params(
+          sender_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(
+          PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse
+        )
+      end
+      def submit_sender_id(
+        # The sender ID to add.
+        sender_id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/prelude_sdk/client.rbs

@@ -16,6 +16,8 @@ module PreludeSDK
 
     attr_reader verification: PreludeSDK::Resources::Verification
 
+    attr_reader verification_management: PreludeSDK::Resources::VerificationManagement
+
     attr_reader watch: PreludeSDK::Resources::Watch
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/prelude_sdk/errors.rbs

@@ -21,11 +21,14 @@ module PreludeSDK
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module PreludeSDK
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module PreludeSDK
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

data/sig/prelude_sdk/file_part.rbs

@@ -14,7 +14,7 @@ module PreludeSDK
 
     def initialize: (
       Pathname | StringIO | IO | String content,
-      ?filename: String?,
+      ?filename: (Pathname | String)?,
       ?content_type: String?
     ) -> void
   end

data/sig/prelude_sdk/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module PreludeSDK
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (
@@ -99,7 +101,7 @@ module PreludeSDK
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           PreludeSDK::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/prelude_sdk/internal/transport/pooled_net_requester.rbs

@@ -17,7 +17,10 @@ module PreludeSDK
 
         DEFAULT_MAX_CONNECTIONS: Integer
 
-        def self.connect: (URI::Generic url) -> top
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
 
         def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
 

data/sig/prelude_sdk/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module PreludeSDK
           | PreludeSDK::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            union: ^-> PreludeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            union: ^-> PreludeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> PreludeSDK::Internal::Type::Converter::coerce_state

data/sig/prelude_sdk/internal/type/union.rbs

@@ -5,9 +5,9 @@ module PreludeSDK
         include PreludeSDK::Internal::Type::Converter
         include PreludeSDK::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> PreludeSDK::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> PreludeSDK::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]
 

data/sig/prelude_sdk/models/transactional_send_params.rbs

@@ -9,6 +9,7 @@ module PreludeSDK
         expires_at: String,
         from: String,
         locale: String,
+        preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         variables: ::Hash[Symbol, String]
       }
       & PreludeSDK::Internal::Type::request_parameters
@@ -41,6 +42,12 @@ module PreludeSDK
 
       def locale=: (String) -> String
 
+      attr_reader preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel?
+
+      def preferred_channel=: (
+        PreludeSDK::Models::TransactionalSendParams::preferred_channel
+      ) -> PreludeSDK::Models::TransactionalSendParams::preferred_channel
+
       attr_reader variables: ::Hash[Symbol, String]?
 
       def variables=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
@@ -53,6 +60,7 @@ module PreludeSDK
         ?expires_at: String,
         ?from: String,
         ?locale: String,
+        ?preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         ?variables: ::Hash[Symbol, String],
         ?request_options: PreludeSDK::request_opts
       ) -> void
@@ -65,9 +73,22 @@ module PreludeSDK
         expires_at: String,
         from: String,
         locale: String,
+        preferred_channel: PreludeSDK::Models::TransactionalSendParams::preferred_channel,
         variables: ::Hash[Symbol, String],
         request_options: PreludeSDK::RequestOptions
       }
+
+      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::TransactionalSendParams::preferred_channel]
+      end
     end
   end
 end

data/sig/prelude_sdk/models/verification_create_params.rbs

@@ -107,8 +107,9 @@ module PreludeSDK
           callback_url: String,
           code_size: Integer,
           custom_code: String,
+          integration: PreludeSDK::Models::VerificationCreateParams::Options::integration,
           locale: String,
-          method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
           template_id: String,
@@ -134,13 +135,19 @@ module PreludeSDK
 
         def custom_code=: (String) -> String
 
+        attr_reader integration: PreludeSDK::Models::VerificationCreateParams::Options::integration?
+
+        def integration=: (
+          PreludeSDK::Models::VerificationCreateParams::Options::integration
+        ) -> PreludeSDK::Models::VerificationCreateParams::Options::integration
+
         attr_reader locale: String?
 
         def locale=: (String) -> String
 
-        attr_reader method_: PreludeSDK::Models::VerificationCreateParams::Options::method_?
+        attr_reader verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_?
 
-        def method_=: (
+        def verification_method=: (
           PreludeSDK::Models::VerificationCreateParams::Options::method_
         ) -> PreludeSDK::Models::VerificationCreateParams::Options::method_
 
@@ -167,8 +174,9 @@ module PreludeSDK
           ?callback_url: String,
           ?code_size: Integer,
           ?custom_code: String,
+          ?integration: PreludeSDK::Models::VerificationCreateParams::Options::integration,
           ?locale: String,
-          ?method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          ?verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           ?preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           ?sender_id: String,
           ?template_id: String,
@@ -180,8 +188,9 @@ module PreludeSDK
           callback_url: String,
           code_size: Integer,
           custom_code: String,
+          integration: PreludeSDK::Models::VerificationCreateParams::Options::integration,
           locale: String,
-          method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
           template_id: String,
@@ -220,26 +229,31 @@ module PreludeSDK
           end
         end
 
-        type method_ = :auto | :voice
+        type integration = :auth0 | :supabase
+
+        module Integration
+          extend PreludeSDK::Internal::Type::Enum
+
+          AUTH0: :auth0
+          SUPABASE: :supabase
+
+          def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::integration]
+        end
+
+        type method_ = :auto | :voice | :message
 
         module Method
           extend PreludeSDK::Internal::Type::Enum
 
           AUTO: :auto
           VOICE: :voice
+          MESSAGE: :message
 
           def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::method_]
         end
 
         type preferred_channel =
-          :sms
-          | :rcs
-          | :whatsapp
-          | :viber
-          | :zalo
-          | :telegram
-          | :silent
-          | :voice
+          :sms | :rcs | :whatsapp | :viber | :zalo | :telegram
 
         module PreferredChannel
           extend PreludeSDK::Internal::Type::Enum
@@ -250,8 +264,6 @@ module PreludeSDK
           VIBER: :viber
           ZALO: :zalo
           TELEGRAM: :telegram
-          SILENT: :silent
-          VOICE: :voice
 
           def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel]
         end
@@ -265,6 +277,7 @@ module PreludeSDK
           device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
           ip: String,
           is_trusted_user: bool,
+          :ja4_fingerprint => String,
           os_version: String,
           user_agent: String
         }
@@ -296,6 +309,10 @@ module PreludeSDK
 
         def is_trusted_user=: (bool) -> bool
 
+        attr_reader ja4_fingerprint: String?
+
+        def ja4_fingerprint=: (String) -> String
+
         attr_reader os_version: String?
 
         def os_version=: (String) -> String
@@ -311,6 +328,7 @@ module PreludeSDK
           ?device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
           ?ip: String,
           ?is_trusted_user: bool,
+          ?ja4_fingerprint: String,
           ?os_version: String,
           ?user_agent: String
         ) -> void
@@ -322,6 +340,7 @@ module PreludeSDK
           device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
           ip: String,
           is_trusted_user: bool,
+          :ja4_fingerprint => String,
           os_version: String,
           user_agent: String
         }