prelude-sdk 0.7.0 → 0.9.0

data/lib/prelude_sdk/models/watch_evaluate_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Watch#evaluate
+    class WatchEvaluateParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute flow_id
+      #   The flow to evaluate. A flow names the moment you are guarding and selects the
+      #   recipes that run.
+      #
+      #   @return [String]
+      required :flow_id, String
+
+      # @!attribute target
+      #   The identifier to score — a phone number or email address.
+      #
+      #   @return [PreludeSDK::Models::Target]
+      required :target, -> { PreludeSDK::Target }
+
+      # @!attribute attributes
+      #   Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      #   namespace a rule uses to reference them.
+      #
+      #   An attribute a recipe declares and this request omits is treated as missing
+      #   evidence, not as an empty value: the rules reading it report `NOT_EVALUATED`
+      #   rather than being scored as though the condition were false. A key no recipe in
+      #   the flow declares is ignored rather than rejected, so one payload can serve
+      #   flows that read different attributes.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :attributes, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute dispatch_id
+      #   The identifier of the dispatch that came from the front-end SDK. Signals it
+      #   carries fill in anything the request did not state; the request wins where both
+      #   supply a value.
+      #
+      #   @return [String, nil]
+      optional :dispatch_id, String
+
+      # @!attribute signals
+      #   The signals used for anti-fraud. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @return [PreludeSDK::Models::Signals, nil]
+      optional :signals, -> { PreludeSDK::Signals }
+
+      # @!method initialize(flow_id:, target:, attributes: nil, dispatch_id: nil, signals: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::WatchEvaluateParams} for more details.
+      #
+      #   @param flow_id [String] The flow to evaluate. A flow names the moment you are guarding and selects the r
+      #
+      #   @param target [PreludeSDK::Models::Target] The identifier to score — a phone number or email address.
+      #
+      #   @param attributes [Hash{Symbol=>String}] Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      #
+      #   @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK. Signals it carr
+      #
+      #   @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/prelude_sdk/models/watch_evaluate_response.rb

@@ -0,0 +1,318 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Watch#evaluate
+    class WatchEvaluateResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The evaluation identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute action
+      #   What the evaluation suggests you do, being the most severe action across the
+      #   recipes that ran. Advisory: enforcement is yours.
+      #
+      #   - `ALLOW` - Let the request through.
+      #   - `BLOCK` - Refuse the request.
+      #   - `CHALLENGE` - Let the request through behind an additional check.
+      #
+      #   @return [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Action]
+      required :action, enum: -> { PreludeSDK::Models::WatchEvaluateResponse::Action }
+
+      # @!attribute recipes
+      #   One result per recipe that ran. A recipe the flow names but that is not in
+      #   service is absent rather than reported as having passed.
+      #
+      #   @return [Array<PreludeSDK::Models::WatchEvaluateResponse::Recipe>]
+      required :recipes,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::WatchEvaluateResponse::Recipe] }
+
+      # @!attribute verdict
+      #   The evaluation-level verdict, being the most severe verdict across the recipes
+      #   that ran.
+      #
+      #   - `PASS` - No recipe flagged.
+      #   - `FLAG` - At least one recipe flagged.
+      #
+      #   @return [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Verdict]
+      required :verdict, enum: -> { PreludeSDK::Models::WatchEvaluateResponse::Verdict }
+
+      # @!method initialize(id:, action:, recipes:, verdict:)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::WatchEvaluateResponse} for more details.
+      #
+      #   @param id [String] The evaluation identifier.
+      #
+      #   @param action [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Action] What the evaluation suggests you do, being the most severe action across the rec
+      #
+      #   @param recipes [Array<PreludeSDK::Models::WatchEvaluateResponse::Recipe>] One result per recipe that ran. A recipe the flow names but that is not in servi
+      #
+      #   @param verdict [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Verdict] The evaluation-level verdict, being the most severe verdict across the recipes t
+
+      # What the evaluation suggests you do, being the most severe action across the
+      # recipes that ran. Advisory: enforcement is yours.
+      #
+      # - `ALLOW` - Let the request through.
+      # - `BLOCK` - Refuse the request.
+      # - `CHALLENGE` - Let the request through behind an additional check.
+      #
+      # @see PreludeSDK::Models::WatchEvaluateResponse#action
+      module Action
+        extend PreludeSDK::Internal::Type::Enum
+
+        ALLOW = :ALLOW
+        BLOCK = :BLOCK
+        CHALLENGE = :CHALLENGE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Recipe < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute partial_evidence
+        #   At least one rule could not be evaluated, so the score rests on less than the
+        #   whole recipe. The score is still returned — a partial verdict is more useful
+        #   than none — but it is labeled rather than passed off as whole.
+        #
+        #   @return [Boolean]
+        required :partial_evidence, PreludeSDK::Internal::Type::Boolean
+
+        # @!attribute recipe_id
+        #   The recipe that produced this result.
+        #
+        #   @return [String]
+        required :recipe_id, String
+
+        # @!attribute rules
+        #   One result per rule in the recipe, in membership order. Every rule runs — a
+        #   score is only meaningful when complete, so there is no short-circuit on the
+        #   first trigger. The exception is a recipe whose verdict a preempting rule has
+        #   already determined, where a rule that could no longer change it may report
+        #   `SKIPPED` instead.
+        #
+        #   @return [Array<PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule>]
+        required :rules,
+                 -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule] }
+
+        # @!attribute score
+        #   The sum of the weights of the rules that triggered, clamped to the range -100
+        #   to 100. Two scores at a bound are not comparable.
+        #
+        #   @return [Integer]
+        required :score, Integer
+
+        # @!attribute threshold
+        #   The score at or above which this recipe flags.
+        #
+        #   @return [Integer]
+        required :threshold, Integer
+
+        # @!attribute verdict
+        #   This recipe's own verdict. Normally the score against the threshold, unless a
+        #   preempting rule fired — see `determined_by`.
+        #
+        #   @return [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Verdict]
+        required :verdict, enum: -> { PreludeSDK::Models::WatchEvaluateResponse::Recipe::Verdict }
+
+        # @!attribute determined_by
+        #   The preempting rule that set `verdict`, present only when a rule rather than the
+        #   score decided it. Without it a recipe can report a score under its threshold and
+        #   still flag, with nothing in the payload accounting for the difference.
+        #
+        #   @return [String, nil]
+        optional :determined_by, String
+
+        # @!method initialize(partial_evidence:, recipe_id:, rules:, score:, threshold:, verdict:, determined_by: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::WatchEvaluateResponse::Recipe} for more details.
+        #
+        #   @param partial_evidence [Boolean] At least one rule could not be evaluated, so the score rests on less than the wh
+        #
+        #   @param recipe_id [String] The recipe that produced this result.
+        #
+        #   @param rules [Array<PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule>] One result per rule in the recipe, in membership order. Every rule runs — a scor
+        #
+        #   @param score [Integer] The sum of the weights of the rules that triggered, clamped to the range -100 to
+        #
+        #   @param threshold [Integer] The score at or above which this recipe flags.
+        #
+        #   @param verdict [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Verdict] This recipe's own verdict. Normally the score against the threshold, unless a pr
+        #
+        #   @param determined_by [String] The preempting rule that set `verdict`, present only when a rule rather than the
+
+        class Rule < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute outcome
+          #   What the rule concluded.
+          #
+          #   - `TRIGGERED` - The condition held; `weight` was added to the score.
+          #   - `NOT_TRIGGERED` - The condition did not hold.
+          #   - `NOT_EVALUATED` - The rule could not run, because something it reads never
+          #     arrived. This is not a quieter `NOT_TRIGGERED`: it contributed nothing either
+          #     way, and it is why `partial_evidence` is set on the recipe.
+          #   - `SKIPPED` - The rule was not run, because another rule had already determined
+          #     the recipe's verdict — see `determined_by`. Nothing was missing and nothing
+          #     failed, so `partial_evidence` is not set: `determined_by` is what accounts for
+          #     the recipe's score resting on fewer rules.
+          #
+          #   @return [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Outcome]
+          required :outcome, enum: -> { PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Outcome }
+
+          # @!attribute rule_id
+          #   The rule that produced this result. Present whatever the rule's visibility, so a
+          #   rule you cannot see the condition of is still one you can reweight, switch off,
+          #   or ask us about.
+          #
+          #   @return [String]
+          required :rule_id, String
+
+          # @!attribute type
+          #   Who authored the rule, which is what says how much of the rest of this result
+          #   you get.
+          #
+          #   - `MANAGED` - Prelude-owned, shared with customers: `name` and `version_id` are
+          #     omitted, and `blocked_by` reports only `missing_data`.
+          #   - `CUSTOM` - Yours: every field is returned.
+          #
+          #   @return [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Type]
+          required :type, enum: -> { PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Type }
+
+          # @!attribute weight
+          #   What this rule contributes to the recipe's score when it triggers.
+          #
+          #   @return [Integer]
+          required :weight, Integer
+
+          # @!attribute blocked_by
+          #   Why the rule could not run, set only when `outcome` is `NOT_EVALUATED`.
+          #
+          #   A rule you authored names the signal or attribute it waited on, since you wrote
+          #   the expression that reads it. A Prelude-managed rule reports `missing_data` and
+          #   nothing more: the signal it waited on is part of a condition that is not
+          #   disclosed.
+          #
+          #   @return [String, nil]
+          optional :blocked_by, String
+
+          # @!attribute name
+          #   The rule's name, present for a rule you authored and omitted for a
+          #   Prelude-managed one. A managed rule's name describes what it looks for, which is
+          #   as much of the condition as the expression is.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute unavailable
+          #   The rule could not run for a reason on our side rather than anything about your
+          #   request. `outcome` is `NOT_EVALUATED` and the failure is ours to fix.
+          #
+          #   @return [Boolean, nil]
+          optional :unavailable, PreludeSDK::Internal::Type::Boolean
+
+          # @!attribute version_id
+          #   The version of the rule that scored — the one this recipe is pinned to, or the
+          #   version current at evaluation time when it is not pinned. Present for a rule you
+          #   authored, and omitted for a Prelude-managed one.
+          #
+          #   @return [String, nil]
+          optional :version_id, String
+
+          # @!method initialize(outcome:, rule_id:, type:, weight:, blocked_by: nil, name: nil, unavailable: nil, version_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule} for more details.
+          #
+          #   @param outcome [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Outcome] What the rule concluded.
+          #
+          #   @param rule_id [String] The rule that produced this result. Present whatever the rule's visibility, so a
+          #
+          #   @param type [Symbol, PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule::Type] Who authored the rule, which is what says how much of the rest of this result yo
+          #
+          #   @param weight [Integer] What this rule contributes to the recipe's score when it triggers.
+          #
+          #   @param blocked_by [String] Why the rule could not run, set only when `outcome` is `NOT_EVALUATED`.
+          #
+          #   @param name [String] The rule's name, present for a rule you authored and omitted for a Prelude-manag
+          #
+          #   @param unavailable [Boolean] The rule could not run for a reason on our side rather than anything about your
+          #
+          #   @param version_id [String] The version of the rule that scored — the one this recipe is pinned to, or the v
+
+          # What the rule concluded.
+          #
+          # - `TRIGGERED` - The condition held; `weight` was added to the score.
+          # - `NOT_TRIGGERED` - The condition did not hold.
+          # - `NOT_EVALUATED` - The rule could not run, because something it reads never
+          #   arrived. This is not a quieter `NOT_TRIGGERED`: it contributed nothing either
+          #   way, and it is why `partial_evidence` is set on the recipe.
+          # - `SKIPPED` - The rule was not run, because another rule had already determined
+          #   the recipe's verdict — see `determined_by`. Nothing was missing and nothing
+          #   failed, so `partial_evidence` is not set: `determined_by` is what accounts for
+          #   the recipe's score resting on fewer rules.
+          #
+          # @see PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule#outcome
+          module Outcome
+            extend PreludeSDK::Internal::Type::Enum
+
+            TRIGGERED = :TRIGGERED
+            NOT_TRIGGERED = :NOT_TRIGGERED
+            NOT_EVALUATED = :NOT_EVALUATED
+            SKIPPED = :SKIPPED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Who authored the rule, which is what says how much of the rest of this result
+          # you get.
+          #
+          # - `MANAGED` - Prelude-owned, shared with customers: `name` and `version_id` are
+          #   omitted, and `blocked_by` reports only `missing_data`.
+          # - `CUSTOM` - Yours: every field is returned.
+          #
+          # @see PreludeSDK::Models::WatchEvaluateResponse::Recipe::Rule#type
+          module Type
+            extend PreludeSDK::Internal::Type::Enum
+
+            MANAGED = :MANAGED
+            CUSTOM = :CUSTOM
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # This recipe's own verdict. Normally the score against the threshold, unless a
+        # preempting rule fired — see `determined_by`.
+        #
+        # @see PreludeSDK::Models::WatchEvaluateResponse::Recipe#verdict
+        module Verdict
+          extend PreludeSDK::Internal::Type::Enum
+
+          PASS = :PASS
+          FLAG = :FLAG
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The evaluation-level verdict, being the most severe verdict across the recipes
+      # that ran.
+      #
+      # - `PASS` - No recipe flagged.
+      # - `FLAG` - At least one recipe flagged.
+      #
+      # @see PreludeSDK::Models::WatchEvaluateResponse#verdict
+      module Verdict
+        extend PreludeSDK::Internal::Type::Enum
+
+        PASS = :PASS
+        FLAG = :FLAG
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/watch_predict_params.rb

@@ -10,8 +10,8 @@ module PreludeSDK
       # @!attribute target
       #   The signup identifier to score — a phone number or email address.
       #
-      #   @return [PreludeSDK::Models::WatchPredictParams::Target]
-      required :target, -> { PreludeSDK::WatchPredictParams::Target }
+      #   @return [PreludeSDK::Models::Target]
+      required :target, -> { PreludeSDK::Target }
 
       # @!attribute dispatch_id
       #   The identifier of the dispatch that came from the front-end SDK.
@@ -29,57 +29,23 @@ module PreludeSDK
       #   The signals used for anti-fraud. For more details, refer to
       #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
       #
-      #   @return [PreludeSDK::Models::WatchPredictParams::Signals, nil]
-      optional :signals, -> { PreludeSDK::WatchPredictParams::Signals }
+      #   @return [PreludeSDK::Models::Signals, nil]
+      optional :signals, -> { PreludeSDK::Signals }
 
       # @!method initialize(target:, dispatch_id: nil, metadata: nil, signals: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::WatchPredictParams} for more details.
       #
-      #   @param target [PreludeSDK::Models::WatchPredictParams::Target] The signup identifier to score — a phone number or email address.
+      #   @param target [PreludeSDK::Models::Target] The signup identifier to score — a phone number or email address.
       #
       #   @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
       #
       #   @param metadata [PreludeSDK::Models::WatchPredictParams::Metadata] The metadata for this prediction.
       #
-      #   @param signals [PreludeSDK::Models::WatchPredictParams::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #   @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        # @!attribute type
-        #   The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @return [Symbol, PreludeSDK::Models::WatchPredictParams::Target::Type]
-        required :type, enum: -> { PreludeSDK::WatchPredictParams::Target::Type }
-
-        # @!attribute value
-        #   An E.164 formatted phone number or an email address.
-        #
-        #   @return [String]
-        required :value, String
-
-        # @!method initialize(type:, value:)
-        #   The signup identifier to score — a phone number or email address.
-        #
-        #   @param type [Symbol, PreludeSDK::Models::WatchPredictParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @param value [String] An E.164 formatted phone number or an email address.
-
-        # The type of the target. Either "phone_number" or "email_address".
-        #
-        # @see PreludeSDK::Models::WatchPredictParams::Target#type
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          PHONE_NUMBER = :phone_number
-          EMAIL_ADDRESS = :email_address
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
         #   A user-defined identifier to correlate this prediction with. It is returned in
@@ -96,126 +62,6 @@ module PreludeSDK
         #
         #   @param correlation_id [String] A user-defined identifier to correlate this prediction with. It is returned in t
       end
-
-      class Signals < PreludeSDK::Internal::Type::BaseModel
-        # @!attribute app_version
-        #   The version of your application.
-        #
-        #   @return [String, nil]
-        optional :app_version, String
-
-        # @!attribute device_id
-        #   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`.
-        #
-        #   @return [String, nil]
-        optional :device_id, String
-
-        # @!attribute device_model
-        #   The model of the user's device.
-        #
-        #   @return [String, nil]
-        optional :device_model, String
-
-        # @!attribute device_platform
-        #   The type of the user's device.
-        #
-        #   @return [Symbol, PreludeSDK::Models::WatchPredictParams::Signals::DevicePlatform, nil]
-        optional :device_platform, enum: -> { PreludeSDK::WatchPredictParams::Signals::DevicePlatform }
-
-        # @!attribute existing_user
-        #   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).
-        #
-        #   @return [Boolean, nil]
-        optional :existing_user, PreludeSDK::Internal::Type::Boolean
-
-        # @!attribute ip
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :ip, String
-
-        # @!attribute is_trusted_user
-        #   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).
-        #
-        #   @return [Boolean, nil]
-        optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
-
-        # @!attribute ja4_fingerprint
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :ja4_fingerprint, String
-
-        # @!attribute os_version
-        #   The version of the user's device operating system.
-        #
-        #   @return [String, nil]
-        optional :os_version, String
-
-        # @!attribute user_agent
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :user_agent, String
-
-        # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, existing_user: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {PreludeSDK::Models::WatchPredictParams::Signals} for more details.
-        #
-        #   The signals used for anti-fraud. For more details, refer to
-        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        #
-        #   @param app_version [String] The version of your application.
-        #
-        #   @param device_id [String] A unique ID for the user's device. You should ensure that each user device has a
-        #
-        #   @param device_model [String] The model of the user's device.
-        #
-        #   @param device_platform [Symbol, PreludeSDK::Models::WatchPredictParams::Signals::DevicePlatform] The type of the user's device.
-        #
-        #   @param existing_user [Boolean] Whether the end-user already exists in your system, for example an existing acco
-        #
-        #   @param ip [String] The public IP v4 or v6 address of the end-user's device. You should collect this
-        #
-        #   @param is_trusted_user [Boolean] This signal should indicate a higher level of trust, explicitly stating that the
-        #
-        #   @param ja4_fingerprint [String] The JA4 fingerprint observed for the end-user's connection. Prelude will infer i
-        #
-        #   @param os_version [String] The version of the user's device operating system.
-        #
-        #   @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
-
-        # The type of the user's device.
-        #
-        # @see PreludeSDK::Models::WatchPredictParams::Signals#device_platform
-        module DevicePlatform
-          extend PreludeSDK::Internal::Type::Enum
-
-          ANDROID = :android
-          IOS = :ios
-          IPADOS = :ipados
-          TVOS = :tvos
-          WEB = :web
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end