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

data/rbi/prelude_sdk/models/verification_management_list_phone_numbers_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementListPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationManagementListPhoneNumbersParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: PreludeSDK::RequestOptions }) }
+      def to_hash
+      end
+
+      module Action
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::VerificationManagementListPhoneNumbersParams::Action
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALLOW =
+          T.let(
+            :allow,
+            PreludeSDK::VerificationManagementListPhoneNumbersParams::Action::TaggedSymbol
+          )
+        BLOCK =
+          T.let(
+            :block,
+            PreludeSDK::VerificationManagementListPhoneNumbersParams::Action::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::VerificationManagementListPhoneNumbersParams::Action::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_list_phone_numbers_response.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementListPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # A list of phone numbers in the allow or block list.
+      sig do
+        returns(
+          T::Array[
+            PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber
+          ]
+        )
+      end
+      attr_accessor :phone_numbers
+
+      sig do
+        params(
+          phone_numbers:
+            T::Array[
+              PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of phone numbers in the allow or block list.
+        phone_numbers:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            phone_numbers:
+              T::Array[
+                PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The date and time when the phone number was added to the list.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # An E.164 formatted phone number.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig do
+          params(created_at: Time, phone_number: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The date and time when the phone number was added to the list.
+          created_at:,
+          # An E.164 formatted phone number.
+          phone_number:
+        )
+        end
+
+        sig { override.returns({ created_at: Time, phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_list_sender_ids_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementListSenderIDsParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationManagementListSenderIDsParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: PreludeSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -168,7 +168,8 @@ module PreludeSDK
             )
           end
 
-        # A user-defined identifier to correlate this prediction with.
+        # A user-defined identifier to correlate this prediction with. It is returned in
+        # the response and any webhook events that refer to this prediction.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -178,7 +179,8 @@ module PreludeSDK
         # The metadata for this prediction.
         sig { params(correlation_id: String).returns(T.attached_class) }
         def self.new(
-          # A user-defined identifier to correlate this prediction with.
+          # A user-defined identifier to correlate this prediction with. It is returned in
+          # the response and any webhook events that refer to this prediction.
           correlation_id: nil
         )
         end
@@ -253,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
@@ -280,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)
@@ -300,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,
@@ -319,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
             }