Class: Telnyx::Models::WebSearchResult

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/web_search_result.rb,
sig/telnyx/models/web_search_result.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(description:, snippets:, title:, url:, favicon_url: nil, thumbnail_url: nil) ⇒ Object

Parameters:

  • description (String) —

    Short description or excerpt.

  • snippets (Array<String>) —

    Relevant text snippets from the page.

  • title (String) —

    Result title.

  • url (String) —

    Result URL.

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

    Favicon URL (if available).

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

    Thumbnail image URL (if available).




# File 'lib/telnyx/models/web_search_result.rb', line 42

Instance Attribute Details

#description ⇒ String

Short description or excerpt.

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/telnyx/models/web_search_result.rb', line 10

required :description, String

#favicon_url ⇒ String?

Favicon URL (if available).

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/web_search_result.rb', line 34

optional :favicon_url, String

#snippets ⇒ Array<String>

Relevant text snippets from the page.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


16
 
# File 'lib/telnyx/models/web_search_result.rb', line 16

required :snippets, Telnyx::Internal::Type::ArrayOf[String]

#thumbnail_url ⇒ String?

Thumbnail image URL (if available).

Parameters:

  • (String)

Returns:

  • (String, nil) 


40
 
# File 'lib/telnyx/models/web_search_result.rb', line 40

optional :thumbnail_url, String

#title ⇒ String

Result title.

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/telnyx/models/web_search_result.rb', line 22

required :title, String

#url ⇒ String

Result URL.

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/telnyx/models/web_search_result.rb', line 28

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/telnyx/models/web_search_result.rbs', line 39

def to_hash: -> {