Class: PreludeSDK::Models::WatchEvaluateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/prelude_sdk/models/watch_evaluate_params.rb,
sig/prelude_sdk/models/watch_evaluate_params.rbs

Overview

See Also:

  • PreludeSDK::Resources::Watch#evaluate

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PreludeSDK

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(flow_id:, target:, attributes: nil, dispatch_id: nil, signals: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::WatchEvaluateParams for more details.

Parameters:

  • flow_id (String) —

    The flow to evaluate. A flow names the moment you are guarding and selects the r

  • target (PreludeSDK::Models::Target) —

    The identifier to score — a phone number or email address.

  • attributes (Hash{Symbol=>String}) (defaults to: nil) —

    Values for the attributes the flow's recipes declare, keyed without the attr.

  • dispatch_id (String) (defaults to: nil) —

    The identifier of the dispatch that came from the front-end SDK. Signals it carr

  • signals (PreludeSDK::Models::Signals) (defaults to: nil) —

    The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2

  • request_options (PreludeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 51

Instance Attribute Details

#attributes ⇒ Hash{Symbol=>String}?

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.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


34
 
# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 34

optional :attributes, PreludeSDK::Internal::Type::HashOf[String]

#dispatch_id ⇒ String?

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.

Parameters:

  • (String)

Returns:

  • (String, nil) 


42
 
# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 42

optional :dispatch_id, String

#flow_id ⇒ String

The flow to evaluate. A flow names the moment you are guarding and selects the recipes that run.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 15

required :flow_id, String

#signals ⇒ PreludeSDK::Models::Signals?

The signals used for anti-fraud. For more details, refer to Signals.

Parameters:

Returns:



49
 
# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 49

optional :signals, -> { PreludeSDK::Signals }

#target ⇒ PreludeSDK::Models::Target

The identifier to score — a phone number or email address.

Parameters:

Returns:



21
 
# File 'lib/prelude_sdk/models/watch_evaluate_params.rb', line 21

required :target, -> { PreludeSDK::Target }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


42
 
# File 'sig/prelude_sdk/models/watch_evaluate_params.rbs', line 42

def to_hash: -> {