prelude-sdk 0.7.0 → 0.9.0

data/rbi/prelude_sdk/models/verification_create_response.rbi

@@ -89,9 +89,10 @@ module PreludeSDK
       #   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.
+      # - `invalid_signature` - The SDK signature did not verify, so the request cannot
+      #   be attributed to the device it claims to come from.
+      # - `repeated_attempts` - The phone number exceeded the allowed number of
+      #   verification attempts in a short period.
       # - `suspicious` - The verification attempt was deemed suspicious by the
       #   anti-fraud system.
       sig do
@@ -121,26 +122,41 @@ module PreludeSDK
       # present when status is "blocked" or "shadow_blocked" and the anti-fraud system
       # detected specific risk signals.
       #
-      # - `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.
+      # - `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(
@@ -231,9 +247,10 @@ module PreludeSDK
         #   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.
+        # - `invalid_signature` - The SDK signature did not verify, so the request cannot
+        #   be attributed to the device it claims to come from.
+        # - `repeated_attempts` - The phone number exceeded the allowed number of
+        #   verification attempts in a short period.
         # - `suspicious` - The verification attempt was deemed suspicious by the
         #   anti-fraud system.
         reason: nil,
@@ -242,26 +259,41 @@ module PreludeSDK
         # present when status is "blocked" or "shadow_blocked" and the anti-fraud system
         # detected specific risk signals.
         #
-        # - `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.
+        # - `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,
         # The silent verification specific properties.
         silent: nil
@@ -505,9 +537,10 @@ module PreludeSDK
       #   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.
+      # - `invalid_signature` - The SDK signature did not verify, so the request cannot
+      #   be attributed to the device it claims to come from.
+      # - `repeated_attempts` - The phone number exceeded the allowed number of
+      #   verification attempts in a short period.
       # - `suspicious` - The verification attempt was deemed suspicious by the
       #   anti-fraud system.
       module Reason
@@ -581,14 +614,44 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        BEHAVIORAL_PATTERN =
+        AUTOMATION_SIGNATURE =
           T.let(
-            :behavioral_pattern,
+            :automation_signature,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        DEVICE_ATTRIBUTE =
+        CARRIER_NOT_PERMITTED =
           T.let(
-            :device_attribute,
+            :carrier_not_permitted,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        CLIENT_FINGERPRINT_MISMATCH =
+          T.let(
+            :client_fingerprint_mismatch,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        CUSTOM_POLICY =
+          T.let(
+            :custom_policy,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_EMULATOR =
+          T.let(
+            :device_emulator,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_NOT_PERMITTED =
+          T.let(
+            :device_not_permitted,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        DEVICE_REUSE =
+          T.let(
+            :device_reuse,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        EXPIRED_SIGNALS =
+          T.let(
+            :expired_signals,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
         FRAUD_DATABASE =
@@ -596,34 +659,49 @@ module PreludeSDK
             :fraud_database,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        LOCATION_DISCREPANCY =
+        INVALID_SIGNATURE =
           T.let(
-            :location_discrepancy,
+            :invalid_signature,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        NETWORK_FINGERPRINT =
+        IP_CONCENTRATION =
           T.let(
-            :network_fingerprint,
+            :ip_concentration,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        POOR_CONVERSION_HISTORY =
+        IP_REPUTATION =
           T.let(
-            :poor_conversion_history,
+            :ip_reputation,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        PREFIX_CONCENTRATION =
+        LOCATION_MISMATCH =
           T.let(
-            :prefix_concentration,
+            :location_mismatch,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        SUSPECTED_REQUEST_TAMPERING =
+        MISSING_SIGNALS =
           T.let(
-            :suspected_request_tampering,
+            :missing_signals,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
-        SUSPICIOUS_IP_ADDRESS =
+        NUMBER_RANGE_ABUSE =
           T.let(
-            :suspicious_ip_address,
+            :number_range_abuse,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        POOR_CONVERSION_HISTORY =
+          T.let(
+            :poor_conversion_history,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        PROXY_NETWORK =
+          T.let(
+            :proxy_network,
+            PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
+          )
+        REPEATED_ATTEMPTS =
+          T.let(
+            :repeated_attempts,
             PreludeSDK::Models::VerificationCreateResponse::RiskFactor::TaggedSymbol
           )
         TEMPORARY_PHONE_NUMBER =

data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxAddPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::VerificationManagement::SandboxAddPhoneNumberParams,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The fixed attempt code that will validate verification attempts for this phone
+        # number.
+        sig { returns(String) }
+        attr_accessor :attempt_code
+
+        # An E.164 formatted phone number to add to the sandbox list.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig do
+          params(
+            attempt_code: String,
+            phone_number: String,
+            request_options: PreludeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The fixed attempt code that will validate verification attempts for this phone
+          # number.
+          attempt_code:,
+          # An E.164 formatted phone number to add to the sandbox list.
+          phone_number:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              attempt_code: String,
+              phone_number: String,
+              request_options: PreludeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rbi

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

data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxDeletePhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::VerificationManagement::SandboxDeletePhoneNumberParams,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        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(phone_number:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              phone_number: String,
+              request_options: PreludeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberResponse,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The E.164 formatted phone number that was removed from the sandbox 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 sandbox list.
+          phone_number:
+        )
+        end
+
+        sig { override.returns({ phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rbi

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

data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rbi

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