Class: Telnyx::Models::ReputationData

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::ReputationData

Defined in:

lib/telnyx/models/reputation_data.rb

Defined Under Namespace

Modules: SpamRisk

Instance Attribute Summary

• #connection_score ⇒ Integer^?
• #engagement_score ⇒ Integer^?
• #last_refreshed_at ⇒ Time^?
• #maturity_score ⇒ Integer^?
• #sentiment_score ⇒ Integer^?
• #spam_category ⇒ String^?

  Category label from the reputation feed when the number is flagged.

• #spam_risk ⇒ Symbol, ...

  Overall spam-risk classification.

Instance Method Summary

• #initialize(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil) ⇒ Object constructor

  Reputation snapshot for a phone number.

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(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil) ⇒ Object

Reputation snapshot for a phone number. Each metric is a 0–100 score; ‘spam_risk` is a coarse bucket. Field set may grow over time - read by key.

Parameters:

• connection_score (Integer, nil) (defaults to: nil)
• engagement_score (Integer, nil) (defaults to: nil)
• last_refreshed_at (Time, nil) (defaults to: nil)
• maturity_score (Integer, nil) (defaults to: nil)
• sentiment_score (Integer, nil) (defaults to: nil)
• spam_category (String, nil) (defaults to: nil) —

  Category label from the reputation feed when the number is flagged.

• spam_risk (Symbol, Telnyx::Models::ReputationData::SpamRisk, nil) (defaults to: nil) —

  Overall spam-risk classification.

# File 'lib/telnyx/models/reputation_data.rb', line 43

Instance Attribute Details

#connection_score ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 9

optional :connection_score, Integer, nil?: true

#engagement_score ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 14

optional :engagement_score, Integer, nil?: true

#last_refreshed_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 19

optional :last_refreshed_at, Time, nil?: true

#maturity_score ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 24

optional :maturity_score, Integer, nil?: true

#sentiment_score ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 29

optional :sentiment_score, Integer, nil?: true

#spam_category ⇒ String^?

Category label from the reputation feed when the number is flagged.

Returns:

• (String, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 35

optional :spam_category, String, nil?: true

#spam_risk ⇒ Symbol, ...

Overall spam-risk classification.

Returns:

• (Symbol, Telnyx::Models::ReputationData::SpamRisk, nil)

# File 'lib/telnyx/models/reputation_data.rb', line 41

optional :spam_risk, enum: -> { Telnyx::ReputationData::SpamRisk }, nil?: true