prelude-sdk 0.6.0 → 0.8.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,219 +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
-
-        # 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,
-            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,
-          # 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,
-              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,6 +32,9 @@ 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
@@ -97,6 +100,9 @@ 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
@@ -179,6 +185,11 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        ACCOUNT_RISK_PROFILE =
+          T.let(
+            :account_risk_profile,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
         BEHAVIORAL_PATTERN =
           T.let(
             :behavioral_pattern,

data/rbi/prelude_sdk/models/watch_send_events_params.rbi

@@ -74,14 +74,10 @@ module PreludeSDK
         attr_accessor :label
 
         # The event target. Only supports phone numbers for now.
-        sig { returns(PreludeSDK::WatchSendEventsParams::Event::Target) }
+        sig { returns(PreludeSDK::Target) }
         attr_reader :target
 
-        sig do
-          params(
-            target: PreludeSDK::WatchSendEventsParams::Event::Target::OrHash
-          ).void
-        end
+        sig { params(target: PreludeSDK::Target::OrHash).void }
         attr_writer :target
 
         sig do
@@ -89,7 +85,7 @@ module PreludeSDK
             confidence:
               PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol,
             label: String,
-            target: PreludeSDK::WatchSendEventsParams::Event::Target::OrHash
+            target: PreludeSDK::Target::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -116,7 +112,7 @@ module PreludeSDK
               confidence:
                 PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol,
               label: String,
-              target: PreludeSDK::WatchSendEventsParams::Event::Target
+              target: PreludeSDK::Target
             }
           )
         end
@@ -180,91 +176,6 @@ module PreludeSDK
           def self.values
           end
         end
-
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                PreludeSDK::WatchSendEventsParams::Event::Target,
-                PreludeSDK::Internal::AnyHash
-              )
-            end
-
-          # The type of the target. Either "phone_number" or "email_address".
-          sig do
-            returns(
-              PreludeSDK::WatchSendEventsParams::Event::Target::Type::OrSymbol
-            )
-          end
-          attr_accessor :type
-
-          # An E.164 formatted phone number or an email address.
-          sig { returns(String) }
-          attr_accessor :value
-
-          # The event target. Only supports phone numbers for now.
-          sig do
-            params(
-              type:
-                PreludeSDK::WatchSendEventsParams::Event::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::WatchSendEventsParams::Event::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::WatchSendEventsParams::Event::Target::Type
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            PHONE_NUMBER =
-              T.let(
-                :phone_number,
-                PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
-              )
-            EMAIL_ADDRESS =
-              T.let(
-                :email_address,
-                PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
       end
     end
   end

data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi

@@ -55,15 +55,10 @@ module PreludeSDK
           end
 
         # The feedback target. Only supports phone numbers for now.
-        sig { returns(PreludeSDK::WatchSendFeedbacksParams::Feedback::Target) }
+        sig { returns(PreludeSDK::Target) }
         attr_reader :target
 
-        sig do
-          params(
-            target:
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::OrHash
-          ).void
-        end
+        sig { params(target: PreludeSDK::Target::OrHash).void }
         attr_writer :target
 
         # The type of feedback.
@@ -92,8 +87,7 @@ module PreludeSDK
 
         sig do
           params(
-            target:
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::OrHash,
+            target: PreludeSDK::Target::OrHash,
             type:
               PreludeSDK::WatchSendFeedbacksParams::Feedback::Type::OrSymbol,
             metadata:
@@ -113,7 +107,7 @@ module PreludeSDK
         sig do
           override.returns(
             {
-              target: PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
+              target: PreludeSDK::Target,
               type:
                 PreludeSDK::WatchSendFeedbacksParams::Feedback::Type::OrSymbol,
               metadata: PreludeSDK::WatchSendFeedbacksParams::Feedback::Metadata
@@ -123,91 +117,6 @@ module PreludeSDK
         def to_hash
         end
 
-        class Target < PreludeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Target,
-                PreludeSDK::Internal::AnyHash
-              )
-            end
-
-          # The type of the target. Either "phone_number" or "email_address".
-          sig do
-            returns(
-              PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::Type::OrSymbol
-            )
-          end
-          attr_accessor :type
-
-          # An E.164 formatted phone number or an email address.
-          sig { returns(String) }
-          attr_accessor :value
-
-          # The feedback target. Only supports phone numbers for now.
-          sig do
-            params(
-              type:
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::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::WatchSendFeedbacksParams::Feedback::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::WatchSendFeedbacksParams::Feedback::Target::Type
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            PHONE_NUMBER =
-              T.let(
-                :phone_number,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::Type::TaggedSymbol
-              )
-            EMAIL_ADDRESS =
-              T.let(
-                :email_address,
-                PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::Type::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  PreludeSDK::WatchSendFeedbacksParams::Feedback::Target::Type::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
         # The type of feedback.
         module Type
           extend PreludeSDK::Internal::Type::Enum

data/rbi/prelude_sdk/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module PreludeSDK
+  Intel = PreludeSDK::Models::Intel
+
   LookupLookupParams = PreludeSDK::Models::LookupLookupParams
 
   NotifyGetSubscriptionConfigParams =
@@ -18,16 +20,26 @@ module PreludeSDK
   NotifyListSubscriptionPhoneNumbersParams =
     PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
 
+  NotifyReplyParams = PreludeSDK::Models::NotifyReplyParams
+
   NotifySendBatchParams = PreludeSDK::Models::NotifySendBatchParams
 
   NotifySendParams = PreludeSDK::Models::NotifySendParams
 
+  Signals = PreludeSDK::Models::Signals
+
+  Target = PreludeSDK::Models::Target
+
   TransactionalSendParams = PreludeSDK::Models::TransactionalSendParams
 
+  Verification = PreludeSDK::Models::Verification
+
   VerificationCheckParams = PreludeSDK::Models::VerificationCheckParams
 
   VerificationCreateParams = PreludeSDK::Models::VerificationCreateParams
 
+  VerificationManagement = PreludeSDK::Models::VerificationManagement
+
   VerificationManagementDeletePhoneNumberParams =
     PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
 
@@ -43,6 +55,8 @@ module PreludeSDK
   VerificationManagementSubmitSenderIDParams =
     PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
 
+  WatchEvaluateParams = PreludeSDK::Models::WatchEvaluateParams
+
   WatchPredictParams = PreludeSDK::Models::WatchPredictParams
 
   WatchSendEventsParams = PreludeSDK::Models::WatchSendEventsParams