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

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -200,7 +200,8 @@ module PreludeSDK
             )
           end
 
-        # A user-defined identifier to correlate this verification with.
+        # A user-defined identifier to correlate this verification with. It is returned in
+        # the response and any webhook events that refer to this verification.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -211,7 +212,8 @@ module PreludeSDK
         # response or webhook sent that refers to this verification.
         sig { params(correlation_id: String).returns(T.attached_class) }
         def self.new(
-          # A user-defined identifier to correlate this verification with.
+          # A user-defined identifier to correlate this verification with. It is returned in
+          # the response and any webhook events that refer to this verification.
           correlation_id: nil
         )
         end
@@ -273,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
@@ -286,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(
@@ -294,15 +317,15 @@ module PreludeSDK
             )
           )
         end
-        attr_reader :method_
+        attr_reader :verification_method
 
         sig do
           params(
-            method_:
+            verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol
           ).void
         end
-        attr_writer :method_
+        attr_writer :verification_method
 
         # The preferred channel to be used in priority for verification.
         sig do
@@ -353,8 +376,10 @@ module PreludeSDK
             callback_url: String,
             code_size: Integer,
             custom_code: String,
+            integration:
+              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
             locale: String,
-            method_:
+            verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
             preferred_channel:
               PreludeSDK::VerificationCreateParams::Options::PreferredChannel::OrSymbol,
@@ -378,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
@@ -386,8 +413,11 @@ 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.
-          method_: nil,
+          # 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,
           # The Sender ID to use for this message. The Sender ID needs to be enabled by
@@ -409,8 +439,10 @@ module PreludeSDK
               callback_url: String,
               code_size: Integer,
               custom_code: String,
+              integration:
+                PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
               locale: String,
-              method_:
+              verification_method:
                 PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
               preferred_channel:
                 PreludeSDK::VerificationCreateParams::Options::PreferredChannel::OrSymbol,
@@ -441,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
 
@@ -458,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
@@ -507,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
 
@@ -533,6 +607,11 @@ module PreludeSDK
               :voice,
               PreludeSDK::VerificationCreateParams::Options::Method::TaggedSymbol
             )
+          MESSAGE =
+            T.let(
+              :message,
+              PreludeSDK::VerificationCreateParams::Options::Method::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -588,16 +667,6 @@ module PreludeSDK
               :telegram,
               PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
             )
-          SILENT =
-            T.let(
-              :silent,
-              PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
-            )
-          VOICE =
-            T.let(
-              :voice,
-              PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
-            )
 
           sig do
             override.returns(
@@ -676,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
@@ -703,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)
@@ -723,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,
@@ -742,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

@@ -21,7 +21,7 @@ module PreludeSDK
           PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol
         )
       end
-      attr_accessor :method_
+      attr_accessor :verification_method
 
       # The status of the verification.
       sig do
@@ -32,10 +32,25 @@ module PreludeSDK
       attr_accessor :status
 
       # The ordered sequence of channels to be used for verification
-      sig { returns(T.nilable(T::Array[String])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+            ]
+          )
+        )
+      end
       attr_reader :channels
 
-      sig { params(channels: T::Array[String]).void }
+      sig do
+        params(
+          channels:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::OrSymbol
+            ]
+        ).void
+      end
       attr_writer :channels
 
       # The metadata for this verification.
@@ -56,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(
@@ -97,11 +125,14 @@ module PreludeSDK
       sig do
         params(
           id: String,
-          method_:
+          verification_method:
             PreludeSDK::Models::VerificationCreateResponse::Method::OrSymbol,
           status:
             PreludeSDK::Models::VerificationCreateResponse::Status::OrSymbol,
-          channels: T::Array[String],
+          channels:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::OrSymbol
+            ],
           metadata:
             PreludeSDK::Models::VerificationCreateResponse::Metadata::OrHash,
           reason:
@@ -114,7 +145,7 @@ module PreludeSDK
         # The verification identifier.
         id:,
         # The method used for verifying this phone number.
-        method_:,
+        verification_method:,
         # The status of the verification.
         status:,
         # The ordered sequence of channels to be used for verification
@@ -123,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.
@@ -134,11 +178,14 @@ module PreludeSDK
         override.returns(
           {
             id: String,
-            method_:
+            verification_method:
               PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol,
             status:
               PreludeSDK::Models::VerificationCreateResponse::Status::TaggedSymbol,
-            channels: T::Array[String],
+            channels:
+              T::Array[
+                PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+              ],
             metadata: PreludeSDK::Models::VerificationCreateResponse::Metadata,
             reason:
               PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol,
@@ -163,6 +210,11 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        EMAIL =
+          T.let(
+            :email,
+            PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol
+          )
         MESSAGE =
           T.let(
             :message,
@@ -230,6 +282,70 @@ module PreludeSDK
         end
       end
 
+      module Channel
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::Models::VerificationCreateResponse::Channel
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        SILENT =
+          T.let(
+            :silent,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        TELEGRAM =
+          T.let(
+            :telegram,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        VIBER =
+          T.let(
+            :viber,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        VOICE =
+          T.let(
+            :voice,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        ZALO =
+          T.let(
+            :zalo,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -239,6 +355,8 @@ module PreludeSDK
             )
           end
 
+        # A user-defined identifier to correlate this verification with. It is returned in
+        # the response and any webhook events that refer to this verification.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -247,7 +365,11 @@ module PreludeSDK
 
         # The metadata for this verification.
         sig { params(correlation_id: String).returns(T.attached_class) }
-        def self.new(correlation_id: nil)
+        def self.new(
+          # A user-defined identifier to correlate this verification with. It is returned in
+          # the response and any webhook events that refer to this verification.
+          correlation_id: nil
+        )
         end
 
         sig { override.returns({ correlation_id: String }) }
@@ -257,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
 
@@ -269,14 +404,14 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        SUSPICIOUS =
+        EXPIRED_SIGNATURE =
           T.let(
-            :suspicious,
+            :expired_signature,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
-        REPEATED_ATTEMPTS =
+        IN_BLOCK_LIST =
           T.let(
-            :repeated_attempts,
+            :in_block_list,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
         INVALID_PHONE_LINE =
@@ -289,9 +424,19 @@ module PreludeSDK
             :invalid_phone_number,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
-        IN_BLOCK_LIST =
+        INVALID_SIGNATURE =
           T.let(
-            :in_block_list,
+            :invalid_signature,
+            PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
+          )
+        REPEATED_ATTEMPTS =
+          T.let(
+            :repeated_attempts,
+            PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
+          )
+        SUSPICIOUS =
+          T.let(
+            :suspicious,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
 

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