Class: Inttegro::MessageTemplate::SafetyResult

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/message_template/safety_result.rb

Overview

Result of the email safety scan.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#content_hash ⇒ String (readonly)

Value of the content_hash field in the Inttegro API payload.

Required in the API payload. Wire name: content_hash.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#links ⇒ Array<Inttegro::MessageTemplate::ScannedLink>? (readonly)

Value of the links field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: links.

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#normalized_text ⇒ String (readonly)

Value of the normalized_text field in the Inttegro API payload.

Required in the API payload. Wire name: normalized_text.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#quarantine_notes ⇒ String? (readonly)

Value of the quarantine_notes field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: quarantine_notes.

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#reason_codes ⇒ Array<String>? (readonly)

Value of the reason_codes field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: reason_codes.

Returns:

  • (Array<String>, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#sanitized_html ⇒ String? (readonly)

Value of the sanitized_html field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: sanitized_html.

Returns:

  • (String, nil) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#scanner ⇒ String (readonly)

Value of the scanner field in the Inttegro API payload.

Required in the API payload. Wire name: scanner.

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end

#status ⇒ Inttegro::Shared::ContentSafetyStatus (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/inttegro/message_template/safety_result.rb', line 67

class SafetyResult < T::Struct
  const :content_hash, String
  const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
  const :normalized_text, String
  const :quarantine_notes, T.nilable(String), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :scanner, String
  const :status, Inttegro::Shared::ContentSafetyStatus
end