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

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -275,6 +275,24 @@ module PreludeSDK
         sig { params(custom_code: String).void }
         attr_writer :custom_code
 
+        # The integration that triggered the verification.
+        sig do
+          returns(
+            T.nilable(
+              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol
+            )
+          )
+        end
+        attr_reader :integration
+
+        sig do
+          params(
+            integration:
+              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol
+          ).void
+        end
+        attr_writer :integration
+
         # A BCP-47 formatted locale string with the language the text message will be sent
         # to. If there's no locale set, the language will be determined by the country
         # code of the phone number. If the language specified doesn't exist, it defaults
@@ -288,7 +306,10 @@ module PreludeSDK
         # The method used for verifying this phone number. The 'voice' option provides an
         # accessible alternative for visually impaired users by delivering the
         # verification code through a phone call rather than a text message. It also
-        # allows verification of landline numbers that cannot receive SMS messages.
+        # allows verification of landline numbers that cannot receive SMS messages. The
+        # 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
+        # skips silent verification, useful for scenarios requiring direct user
+        # interaction.
         sig do
           returns(
             T.nilable(
@@ -355,6 +376,8 @@ module PreludeSDK
             callback_url: String,
             code_size: Integer,
             custom_code: String,
+            integration:
+              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
             locale: String,
             verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
@@ -380,6 +403,8 @@ module PreludeSDK
           # contact us to enable it for your account. For more details, refer to
           # [Custom Code](/verify/v2/documentation/custom-codes).
           custom_code: nil,
+          # The integration that triggered the verification.
+          integration: nil,
           # A BCP-47 formatted locale string with the language the text message will be sent
           # to. If there's no locale set, the language will be determined by the country
           # code of the phone number. If the language specified doesn't exist, it defaults
@@ -388,7 +413,10 @@ module PreludeSDK
           # The method used for verifying this phone number. The 'voice' option provides an
           # accessible alternative for visually impaired users by delivering the
           # verification code through a phone call rather than a text message. It also
-          # allows verification of landline numbers that cannot receive SMS messages.
+          # allows verification of landline numbers that cannot receive SMS messages. The
+          # 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
+          # skips silent verification, useful for scenarios requiring direct user
+          # interaction.
           verification_method: nil,
           # The preferred channel to be used in priority for verification.
           preferred_channel: nil,
@@ -411,6 +439,8 @@ module PreludeSDK
               callback_url: String,
               code_size: Integer,
               custom_code: String,
+              integration:
+                PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
               locale: String,
               verification_method:
                 PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
@@ -443,7 +473,9 @@ module PreludeSDK
           end
           attr_accessor :platform
 
-          # The Android SMS Retriever API hash code that identifies your app.
+          # The Android SMS Retriever API hash code that identifies your app. For more
+          # information, see
+          # [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
           sig { returns(String) }
           attr_accessor :value
 
@@ -460,7 +492,9 @@ module PreludeSDK
             # The platform the SMS will be sent to. We are currently only supporting
             # "android".
             platform:,
-            # The Android SMS Retriever API hash code that identifies your app.
+            # The Android SMS Retriever API hash code that identifies your app. For more
+            # information, see
+            # [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
             value:
           )
           end
@@ -509,10 +543,48 @@ module PreludeSDK
           end
         end
 
+        # The integration that triggered the verification.
+        module Integration
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                PreludeSDK::VerificationCreateParams::Options::Integration
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTH0 =
+            T.let(
+              :auth0,
+              PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
+            )
+          SUPABASE =
+            T.let(
+              :supabase,
+              PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # The method used for verifying this phone number. The 'voice' option provides an
         # accessible alternative for visually impaired users by delivering the
         # verification code through a phone call rather than a text message. It also
-        # allows verification of landline numbers that cannot receive SMS messages.
+        # allows verification of landline numbers that cannot receive SMS messages. The
+        # 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
+        # skips silent verification, useful for scenarios requiring direct user
+        # interaction.
         module Method
           extend PreludeSDK::Internal::Type::Enum
 
@@ -535,6 +607,11 @@ module PreludeSDK
               :voice,
               PreludeSDK::VerificationCreateParams::Options::Method::TaggedSymbol
             )
+          MESSAGE =
+            T.let(
+              :message,
+              PreludeSDK::VerificationCreateParams::Options::Method::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -668,6 +745,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
@@ -695,6 +781,7 @@ module PreludeSDK
               PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
             ip: String,
             is_trusted_user: T::Boolean,
+            ja4_fingerprint: String,
             os_version: String,
             user_agent: String
           ).returns(T.attached_class)
@@ -715,6 +802,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,
@@ -734,6 +825,7 @@ module PreludeSDK
                 PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
               ip: String,
               is_trusted_user: T::Boolean,
+              ja4_fingerprint: String,
               os_version: String,
               user_agent: String
             }

data/rbi/prelude_sdk/models/verification_create_response.rbi

@@ -71,6 +71,19 @@ module PreludeSDK
 
       # The reason why the verification was blocked. Only present when status is
       # "blocked".
+      #
+      # - `expired_signature` - The signature of the SDK signals is expired. They should
+      #   be sent within the hour following their collection.
+      # - `in_block_list` - The phone number is part of the configured block list.
+      # - `invalid_phone_line` - The phone number is not a valid line number (e.g.
+      #   landline).
+      # - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
+      #   unallocated range).
+      # - `invalid_signature` - The signature of the SDK signals is invalid.
+      # - `repeated_attempts` - The phone number has made too many verification
+      #   attempts.
+      # - `suspicious` - The verification attempt was deemed suspicious by the
+      #   anti-fraud system.
       sig do
         returns(
           T.nilable(
@@ -141,6 +154,19 @@ module PreludeSDK
         metadata: nil,
         # The reason why the verification was blocked. Only present when status is
         # "blocked".
+        #
+        # - `expired_signature` - The signature of the SDK signals is expired. They should
+        #   be sent within the hour following their collection.
+        # - `in_block_list` - The phone number is part of the configured block list.
+        # - `invalid_phone_line` - The phone number is not a valid line number (e.g.
+        #   landline).
+        # - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
+        #   unallocated range).
+        # - `invalid_signature` - The signature of the SDK signals is invalid.
+        # - `repeated_attempts` - The phone number has made too many verification
+        #   attempts.
+        # - `suspicious` - The verification attempt was deemed suspicious by the
+        #   anti-fraud system.
         reason: nil,
         request_id: nil,
         # The silent verification specific properties.
@@ -353,6 +379,19 @@ module PreludeSDK
 
       # The reason why the verification was blocked. Only present when status is
       # "blocked".
+      #
+      # - `expired_signature` - The signature of the SDK signals is expired. They should
+      #   be sent within the hour following their collection.
+      # - `in_block_list` - The phone number is part of the configured block list.
+      # - `invalid_phone_line` - The phone number is not a valid line number (e.g.
+      #   landline).
+      # - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
+      #   unallocated range).
+      # - `invalid_signature` - The signature of the SDK signals is invalid.
+      # - `repeated_attempts` - The phone number has made too many verification
+      #   attempts.
+      # - `suspicious` - The verification attempt was deemed suspicious by the
+      #   anti-fraud system.
       module Reason
         extend PreludeSDK::Internal::Type::Enum
 

data/rbi/prelude_sdk/models/verification_management_delete_phone_number_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementDeletePhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationManagementDeletePhoneNumberParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # An E.164 formatted phone number to remove from 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 remove from 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::VerificationManagementDeletePhoneNumberParams::Action
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALLOW =
+          T.let(
+            :allow,
+            PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::TaggedSymbol
+          )
+        BLOCK =
+          T.let(
+            :block,
+            PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management_delete_phone_number_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationManagementDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationManagementDeletePhoneNumberResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The E.164 formatted phone number that was removed from 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 removed from 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_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