Class: Telnyx::Models::WebSearch::ResearchCitation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::WebSearch::ResearchCitation

Defined in:

lib/telnyx/models/web_search/research_citation.rb,
sig/telnyx/models/web_search/research_citation.rbs

Instance Attribute Summary

• #snippet ⇒ String^?

  Relevant excerpt from the source (if available).

• #title ⇒ String

  Title of the source page.

• #url ⇒ String

  Source URL.

Instance Method Summary

• #initialize(title:, url:, snippet: nil) ⇒ ResearchCitation constructor

  A new instance of ResearchCitation.

• #to_hash ⇒ { title: String, url: String, snippet: String }

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(title:, url:, snippet: nil) ⇒ ResearchCitation

Returns a new instance of ResearchCitation.

Parameters:

• title (String) —

  Title of the source page.

• url (String) —

  Source URL.

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

  Relevant excerpt from the source (if available).

• title: (String)
• url: (String)
• snippet: (String) (defaults to: nil)

# File 'lib/telnyx/models/web_search/research_citation.rb', line 25

Instance Attribute Details

#snippet ⇒ String^?

Relevant excerpt from the source (if available).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/web_search/research_citation.rb', line 23

optional :snippet, String

#title ⇒ String

Title of the source page.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/web_search/research_citation.rb', line 11

required :title, String

#url ⇒ String

Source URL.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/web_search/research_citation.rb', line 17

required :url, String

Instance Method Details

#to_hash ⇒ { title: String, url: String, snippet: String }

Returns:

• ({ title: String, url: String, snippet: String })

# File 'sig/telnyx/models/web_search/research_citation.rbs', line 17

def to_hash: -> { title: String, url: String, snippet: String }