prelude-sdk 0.7.0 → 0.9.0

data/rbi/prelude_sdk/models/watch_predict_params.rbi

@@ -12,12 +12,10 @@ module PreludeSDK
         end
 
       # The signup identifier to score — a phone number or email address.
-      sig { returns(PreludeSDK::WatchPredictParams::Target) }
+      sig { returns(PreludeSDK::Target) }
       attr_reader :target
 
-      sig do
-        params(target: PreludeSDK::WatchPredictParams::Target::OrHash).void
-      end
+      sig { params(target: PreludeSDK::Target::OrHash).void }
       attr_writer :target
 
       # The identifier of the dispatch that came from the front-end SDK.
@@ -38,20 +36,18 @@ module PreludeSDK
 
       # The signals used for anti-fraud. For more details, refer to
       # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-      sig { returns(T.nilable(PreludeSDK::WatchPredictParams::Signals)) }
+      sig { returns(T.nilable(PreludeSDK::Signals)) }
       attr_reader :signals
 
-      sig do
-        params(signals: PreludeSDK::WatchPredictParams::Signals::OrHash).void
-      end
+      sig { params(signals: PreludeSDK::Signals::OrHash).void }
       attr_writer :signals
 
       sig do
         params(
-          target: PreludeSDK::WatchPredictParams::Target::OrHash,
+          target: PreludeSDK::Target::OrHash,
           dispatch_id: String,
           metadata: PreludeSDK::WatchPredictParams::Metadata::OrHash,
-          signals: PreludeSDK::WatchPredictParams::Signals::OrHash,
+          signals: PreludeSDK::Signals::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -72,10 +68,10 @@ module PreludeSDK
       sig do
         override.returns(
           {
-            target: PreludeSDK::WatchPredictParams::Target,
+            target: PreludeSDK::Target,
             dispatch_id: String,
             metadata: PreludeSDK::WatchPredictParams::Metadata,
-            signals: PreludeSDK::WatchPredictParams::Signals,
+            signals: PreludeSDK::Signals,
             request_options: PreludeSDK::RequestOptions
           }
         )
@@ -83,82 +79,6 @@ module PreludeSDK
       def to_hash
       end
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              PreludeSDK::WatchPredictParams::Target,
-              PreludeSDK::Internal::AnyHash
-            )
-          end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        sig { returns(PreludeSDK::WatchPredictParams::Target::Type::OrSymbol) }
-        attr_accessor :type
-
-        # An E.164 formatted phone number or an email address.
-        sig { returns(String) }
-        attr_accessor :value
-
-        # The signup identifier to score — a phone number or email address.
-        sig do
-          params(
-            type: PreludeSDK::WatchPredictParams::Target::Type::OrSymbol,
-            value: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The type of the target. Either "phone_number" or "email_address".
-          type:,
-          # An E.164 formatted phone number or an email address.
-          value:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              type: PreludeSDK::WatchPredictParams::Target::Type::OrSymbol,
-              value: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, PreludeSDK::WatchPredictParams::Target::Type)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          PHONE_NUMBER =
-            T.let(
-              :phone_number,
-              PreludeSDK::WatchPredictParams::Target::Type::TaggedSymbol
-            )
-          EMAIL_ADDRESS =
-            T.let(
-              :email_address,
-              PreludeSDK::WatchPredictParams::Target::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::WatchPredictParams::Target::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -189,238 +109,6 @@ module PreludeSDK
         def to_hash
         end
       end
-
-      class Signals < PreludeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              PreludeSDK::WatchPredictParams::Signals,
-              PreludeSDK::Internal::AnyHash
-            )
-          end
-
-        # The version of your application.
-        sig { returns(T.nilable(String)) }
-        attr_reader :app_version
-
-        sig { params(app_version: String).void }
-        attr_writer :app_version
-
-        # A unique ID for the user's device. You should ensure that each user device has a
-        # unique `device_id` value. Ideally, for Android, this corresponds to the
-        # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :device_id
-
-        sig { params(device_id: String).void }
-        attr_writer :device_id
-
-        # The model of the user's device.
-        sig { returns(T.nilable(String)) }
-        attr_reader :device_model
-
-        sig { params(device_model: String).void }
-        attr_writer :device_model
-
-        # The type of the user's device.
-        sig do
-          returns(
-            T.nilable(
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol
-            )
-          )
-        end
-        attr_reader :device_platform
-
-        sig do
-          params(
-            device_platform:
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol
-          ).void
-        end
-        attr_writer :device_platform
-
-        # Whether the end-user already exists in your system, for example an existing
-        # account signing in again rather than a first-time signup. Unlike
-        # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
-        # account as one additional anti-fraud signal. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :existing_user
-
-        sig { params(existing_user: T::Boolean).void }
-        attr_writer :existing_user
-
-        # The public IP v4 or v6 address of the end-user's device. You should collect this
-        # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
-        # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
-        # the actual public IP of the end-user's device.
-        sig { returns(T.nilable(String)) }
-        attr_reader :ip
-
-        sig { params(ip: String).void }
-        attr_writer :ip
-
-        # This signal should indicate a higher level of trust, explicitly stating that the
-        # user is genuine. Contact us to discuss your use case. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_trusted_user
-
-        sig { params(is_trusted_user: T::Boolean).void }
-        attr_writer :is_trusted_user
-
-        # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
-        # it automatically when you use our Frontend SDKs (which use Prelude's edge
-        # network), but you can also forward the value 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
-
-        sig { params(os_version: String).void }
-        attr_writer :os_version
-
-        # The user agent of the user's device. If the individual fields (os_version,
-        # device_platform, device_model) are provided, we will prioritize those values
-        # instead of parsing them from the user agent string.
-        sig { returns(T.nilable(String)) }
-        attr_reader :user_agent
-
-        sig { params(user_agent: String).void }
-        attr_writer :user_agent
-
-        # The signals used for anti-fraud. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig do
-          params(
-            app_version: String,
-            device_id: String,
-            device_model: String,
-            device_platform:
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
-            existing_user: T::Boolean,
-            ip: String,
-            is_trusted_user: T::Boolean,
-            ja4_fingerprint: String,
-            os_version: String,
-            user_agent: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The version of your application.
-          app_version: nil,
-          # A unique ID for the user's device. You should ensure that each user device has a
-          # unique `device_id` value. Ideally, for Android, this corresponds to the
-          # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-          device_id: nil,
-          # The model of the user's device.
-          device_model: nil,
-          # The type of the user's device.
-          device_platform: nil,
-          # Whether the end-user already exists in your system, for example an existing
-          # account signing in again rather than a first-time signup. Unlike
-          # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
-          # account as one additional anti-fraud signal. For more details, refer to
-          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-          existing_user: nil,
-          # The public IP v4 or v6 address of the end-user's device. You should collect this
-          # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
-          # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
-          # the actual public IP of the end-user's device.
-          ip: nil,
-          # This signal should indicate a higher level of trust, explicitly stating that the
-          # user is 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 end-user's connection. Prelude will infer
-          # it automatically when you use our Frontend SDKs (which use Prelude's edge
-          # network), but you can also forward the value 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,
-          # device_platform, device_model) are provided, we will prioritize those values
-          # instead of parsing them from the user agent string.
-          user_agent: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              app_version: String,
-              device_id: String,
-              device_model: String,
-              device_platform:
-                PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
-              existing_user: T::Boolean,
-              ip: String,
-              is_trusted_user: T::Boolean,
-              ja4_fingerprint: String,
-              os_version: String,
-              user_agent: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The type of the user's device.
-        module DevicePlatform
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                PreludeSDK::WatchPredictParams::Signals::DevicePlatform
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ANDROID =
-            T.let(
-              :android,
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          IOS =
-            T.let(
-              :ios,
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          IPADOS =
-            T.let(
-              :ipados,
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          TVOS =
-            T.let(
-              :tvos,
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          WEB =
-            T.let(
-              :web,
-              PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::WatchPredictParams::Signals::DevicePlatform::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end

data/rbi/prelude_sdk/models/watch_predict_response.rbi

@@ -32,29 +32,43 @@ module PreludeSDK
       # when prediction is "suspicious" and the anti-fraud system detected specific risk
       # signals.
       #
-      # - `account_risk_profile` - The target matches a risk profile derived from the
-      #   outcomes reported on your own account, rather than from a signal shared across
-      #   accounts.
-      # - `behavioral_pattern` - The phone number past behavior during verification
-      #   flows exhibits suspicious patterns.
-      # - `device_attribute` - The device exhibits characteristics associated with
-      #   suspicious activity patterns.
-      # - `fraud_database` - The phone number has been flagged as suspicious in one or
-      #   more of our fraud databases.
-      # - `location_discrepancy` - The phone number prefix and IP address discrepancy
-      #   indicates potential fraud.
-      # - `network_fingerprint` - The network connection exhibits characteristics
-      #   associated with suspicious activity patterns.
-      # - `poor_conversion_history` - The phone number has a history of poorly
-      #   converting to a verified phone number.
-      # - `prefix_concentration` - The phone number is part of a range known to be
-      #   associated with suspicious activity patterns.
-      # - `suspected_request_tampering` - The SDK signature is invalid and the request
-      #   is considered to be tampered with.
-      # - `suspicious_ip_address` - The IP address is deemed to be associated with
-      #   suspicious activity patterns.
-      # - `temporary_phone_number` - The phone number is known to be a temporary or
-      #   disposable number.
+      # - `account_risk_profile` - The request matches a risk profile derived from the
+      #   outcomes reported on your own account.
+      # - `automation_signature` - The request appears to come from an automated client
+      #   rather than a person.
+      # - `carrier_not_permitted` - The destination carrier is one this account does not
+      #   accept traffic for.
+      # - `client_fingerprint_mismatch` - The client does not appear to be the platform
+      #   it identifies itself as.
+      # - `custom_policy` - A rule configured for your account matched this request.
+      # - `device_emulator` - The request appears to come from an emulator rather than a
+      #   physical device.
+      # - `device_not_permitted` - The device platform is one your account blocks.
+      # - `device_reuse` - One device is driving verifications for an unusual number of
+      #   phone numbers.
+      # - `expired_signals` - The SDK signals were collected too long before the request
+      #   to still attest to it.
+      # - `fraud_database` - The phone number is flagged in one or more of the fraud
+      #   databases Prelude consults.
+      # - `invalid_signature` - The SDK signature did not verify, so the request cannot
+      #   be attributed to the device it claims to come from.
+      # - `ip_concentration` - The request shares its origin with an unusual volume of
+      #   other verifications.
+      # - `ip_reputation` - The originating IP address is not trusted.
+      # - `location_mismatch` - The network location and the phone number's country are
+      #   inconsistent.
+      # - `missing_signals` - The verification expected Prelude SDK signals and none
+      #   arrived.
+      # - `number_range_abuse` - The phone number belongs to a range currently
+      #   associated with abuse.
+      # - `poor_conversion_history` - Traffic resembling this request rarely completes a
+      #   verification.
+      # - `proxy_network` - The request did not arrive over the subscriber's own access
+      #   network.
+      # - `repeated_attempts` - The phone number exceeded the allowed number of
+      #   verification attempts in a short period.
+      # - `temporary_phone_number` - The phone number belongs to a disposable or
+      #   short-lived numbering service.
       sig do
         returns(
           T.nilable(
@@ -100,29 +114,43 @@ module PreludeSDK
         # when prediction is "suspicious" and the anti-fraud system detected specific risk
         # signals.
         #
-        # - `account_risk_profile` - The target matches a risk profile derived from the
-        #   outcomes reported on your own account, rather than from a signal shared across
-        #   accounts.
-        # - `behavioral_pattern` - The phone number past behavior during verification
-        #   flows exhibits suspicious patterns.
-        # - `device_attribute` - The device exhibits characteristics associated with
-        #   suspicious activity patterns.
-        # - `fraud_database` - The phone number has been flagged as suspicious in one or
-        #   more of our fraud databases.
-        # - `location_discrepancy` - The phone number prefix and IP address discrepancy
-        #   indicates potential fraud.
-        # - `network_fingerprint` - The network connection exhibits characteristics
-        #   associated with suspicious activity patterns.
-        # - `poor_conversion_history` - The phone number has a history of poorly
-        #   converting to a verified phone number.
-        # - `prefix_concentration` - The phone number is part of a range known to be
-        #   associated with suspicious activity patterns.
-        # - `suspected_request_tampering` - The SDK signature is invalid and the request
-        #   is considered to be tampered with.
-        # - `suspicious_ip_address` - The IP address is deemed to be associated with
-        #   suspicious activity patterns.
-        # - `temporary_phone_number` - The phone number is known to be a temporary or
-        #   disposable number.
+        # - `account_risk_profile` - The request matches a risk profile derived from the
+        #   outcomes reported on your own account.
+        # - `automation_signature` - The request appears to come from an automated client
+        #   rather than a person.
+        # - `carrier_not_permitted` - The destination carrier is one this account does not
+        #   accept traffic for.
+        # - `client_fingerprint_mismatch` - The client does not appear to be the platform
+        #   it identifies itself as.
+        # - `custom_policy` - A rule configured for your account matched this request.
+        # - `device_emulator` - The request appears to come from an emulator rather than a
+        #   physical device.
+        # - `device_not_permitted` - The device platform is one your account blocks.
+        # - `device_reuse` - One device is driving verifications for an unusual number of
+        #   phone numbers.
+        # - `expired_signals` - The SDK signals were collected too long before the request
+        #   to still attest to it.
+        # - `fraud_database` - The phone number is flagged in one or more of the fraud
+        #   databases Prelude consults.
+        # - `invalid_signature` - The SDK signature did not verify, so the request cannot
+        #   be attributed to the device it claims to come from.
+        # - `ip_concentration` - The request shares its origin with an unusual volume of
+        #   other verifications.
+        # - `ip_reputation` - The originating IP address is not trusted.
+        # - `location_mismatch` - The network location and the phone number's country are
+        #   inconsistent.
+        # - `missing_signals` - The verification expected Prelude SDK signals and none
+        #   arrived.
+        # - `number_range_abuse` - The phone number belongs to a range currently
+        #   associated with abuse.
+        # - `poor_conversion_history` - Traffic resembling this request rarely completes a
+        #   verification.
+        # - `proxy_network` - The request did not arrive over the subscriber's own access
+        #   network.
+        # - `repeated_attempts` - The phone number exceeded the allowed number of
+        #   verification attempts in a short period.
+        # - `temporary_phone_number` - The phone number belongs to a disposable or
+        #   short-lived numbering service.
         risk_factors: nil
       )
       end
@@ -190,14 +218,44 @@ module PreludeSDK
             :account_risk_profile,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        BEHAVIORAL_PATTERN =
+        AUTOMATION_SIGNATURE =
           T.let(
-            :behavioral_pattern,
+            :automation_signature,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        DEVICE_ATTRIBUTE =
+        CARRIER_NOT_PERMITTED =
           T.let(
-            :device_attribute,
+            :carrier_not_permitted,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        CLIENT_FINGERPRINT_MISMATCH =
+          T.let(
+            :client_fingerprint_mismatch,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        CUSTOM_POLICY =
+          T.let(
+            :custom_policy,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_EMULATOR =
+          T.let(
+            :device_emulator,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_NOT_PERMITTED =
+          T.let(
+            :device_not_permitted,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_REUSE =
+          T.let(
+            :device_reuse,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        EXPIRED_SIGNALS =
+          T.let(
+            :expired_signals,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
         FRAUD_DATABASE =
@@ -205,34 +263,49 @@ module PreludeSDK
             :fraud_database,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        LOCATION_DISCREPANCY =
+        INVALID_SIGNATURE =
           T.let(
-            :location_discrepancy,
+            :invalid_signature,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        NETWORK_FINGERPRINT =
+        IP_CONCENTRATION =
           T.let(
-            :network_fingerprint,
+            :ip_concentration,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        POOR_CONVERSION_HISTORY =
+        IP_REPUTATION =
           T.let(
-            :poor_conversion_history,
+            :ip_reputation,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        PREFIX_CONCENTRATION =
+        LOCATION_MISMATCH =
           T.let(
-            :prefix_concentration,
+            :location_mismatch,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        MISSING_SIGNALS =
+          T.let(
+            :missing_signals,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        NUMBER_RANGE_ABUSE =
+          T.let(
+            :number_range_abuse,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
+        POOR_CONVERSION_HISTORY =
+          T.let(
+            :poor_conversion_history,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        SUSPECTED_REQUEST_TAMPERING =
+        PROXY_NETWORK =
           T.let(
-            :suspected_request_tampering,
+            :proxy_network,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
-        SUSPICIOUS_IP_ADDRESS =
+        REPEATED_ATTEMPTS =
           T.let(
-            :suspicious_ip_address,
+            :repeated_attempts,
             PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
           )
         TEMPORARY_PHONE_NUMBER =