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

data/rbi/prelude_sdk/models/verification_management_list_sender_ids_response.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementListSenderIDsResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationManagementListSenderIDsResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID
+            ]
+          )
+        )
+      end
+      attr_reader :sender_ids
+
+      sig do
+        params(
+          sender_ids:
+            T::Array[
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::OrHash
+            ]
+        ).void
+      end
+      attr_writer :sender_ids
+
+      # A list of Sender ID.
+      sig do
+        params(
+          sender_ids:
+            T::Array[
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(sender_ids: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            sender_ids:
+              T::Array[
+                PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class SenderID < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # Value that will be presented as Sender ID
+        sig { returns(T.nilable(String)) }
+        attr_reader :sender_id
+
+        sig { params(sender_id: String).void }
+        attr_writer :sender_id
+
+        # It indicates the status of the Sender ID. Possible values are:
+        #
+        # - `approved` - The Sender ID is approved.
+        # - `pending` - The Sender ID is pending.
+        # - `rejected` - The Sender ID is rejected.
+        sig do
+          returns(
+            T.nilable(
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            sender_id: String,
+            status:
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Value that will be presented as Sender ID
+          sender_id: nil,
+          # It indicates the status of the Sender ID. Possible values are:
+          #
+          # - `approved` - The Sender ID is approved.
+          # - `pending` - The Sender ID is pending.
+          # - `rejected` - The Sender ID is rejected.
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              sender_id: String,
+              status:
+                PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # It indicates the status of the Sender ID. Possible values are:
+        #
+        # - `approved` - The Sender ID is approved.
+        # - `pending` - The Sender ID is pending.
+        # - `rejected` - The Sender ID is rejected.
+        module Status
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APPROVED =
+            T.let(
+              :approved,
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+            )
+          PENDING =
+            T.let(
+              :pending,
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_set_phone_number_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementSetPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationManagementSetPhoneNumberParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # An E.164 formatted phone number to add to the list.
+      sig { returns(String) }
+      attr_accessor :phone_number
+
+      sig do
+        params(
+          phone_number: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # An E.164 formatted phone number to add to the list.
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { phone_number: String, request_options: PreludeSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+
+      module Action
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::VerificationManagementSetPhoneNumberParams::Action
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALLOW =
+          T.let(
+            :allow,
+            PreludeSDK::VerificationManagementSetPhoneNumberParams::Action::TaggedSymbol
+          )
+        BLOCK =
+          T.let(
+            :block,
+            PreludeSDK::VerificationManagementSetPhoneNumberParams::Action::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::VerificationManagementSetPhoneNumberParams::Action::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_set_phone_number_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementSetPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationManagementSetPhoneNumberResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The E.164 formatted phone number that was added to the list.
+      sig { returns(String) }
+      attr_accessor :phone_number
+
+      sig { params(phone_number: String).returns(T.attached_class) }
+      def self.new(
+        # The E.164 formatted phone number that was added to the list.
+        phone_number:
+      )
+      end
+
+      sig { override.returns({ phone_number: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_submit_sender_id_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementSubmitSenderIDParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationManagementSubmitSenderIDParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The sender ID to add.
+      sig { returns(String) }
+      attr_accessor :sender_id
+
+      sig do
+        params(
+          sender_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The sender ID to add.
+        sender_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { sender_id: String, request_options: PreludeSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_submit_sender_id_response.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementSubmitSenderIDResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The sender ID that was added.
+      sig { returns(String) }
+      attr_accessor :sender_id
+
+      # It indicates the status of the sender ID. Possible values are:
+      #
+      # - `approved` - The sender ID is approved.
+      # - `pending` - The sender ID is pending.
+      # - `rejected` - The sender ID is rejected.
+      sig do
+        returns(
+          PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The reason why the sender ID was rejected.
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      sig do
+        params(
+          sender_id: String,
+          status:
+            PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::OrSymbol,
+          reason: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The sender ID that was added.
+        sender_id:,
+        # It indicates the status of the sender ID. Possible values are:
+        #
+        # - `approved` - The sender ID is approved.
+        # - `pending` - The sender ID is pending.
+        # - `rejected` - The sender ID is rejected.
+        status:,
+        # The reason why the sender ID was rejected.
+        reason: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            sender_id: String,
+            status:
+              PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol,
+            reason: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # It indicates the status of the sender ID. Possible values are:
+      #
+      # - `approved` - The sender ID is approved.
+      # - `pending` - The sender ID is pending.
+      # - `rejected` - The sender ID is rejected.
+      module Status
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        APPROVED =
+          T.let(
+            :approved,
+            PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/watch_predict_params.rbi

@@ -255,6 +255,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
@@ -282,6 +291,7 @@ module PreludeSDK
               PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
             ip: String,
             is_trusted_user: T::Boolean,
+            ja4_fingerprint: String,
             os_version: String,
             user_agent: String
           ).returns(T.attached_class)
@@ -302,6 +312,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,
@@ -321,6 +335,7 @@ module PreludeSDK
                 PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
               ip: String,
               is_trusted_user: T::Boolean,
+              ja4_fingerprint: String,
               os_version: String,
               user_agent: String
             }

data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi

@@ -372,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
@@ -399,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)
@@ -419,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,
@@ -438,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)
@@ -37,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