Class: Telnyx::Models::WebSearchContentsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/web_search_contents_params.rb,
sig/telnyx/models/web_search_contents_params.rbs

Overview

See Also:

• Telnyx::Resources::WebSearch#contents

Defined Under Namespace

Modules: Format

Instance Attribute Summary

• #crawl_timeout ⇒ Integer^?

  Timeout for crawling each URL, in seconds (1-60).

• #formats ⇒ Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>^?

  Content formats to return.

• #max_age ⇒ Integer^?

  Maximum age of cached content in seconds.

• #urls ⇒ Array<String>

  List of URLs to retrieve content from (max 20 for public API).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/telnyx/models/web_search_contents_params.rbs', line 30

def initialize: (

Instance Attribute Details

#crawl_timeout ⇒ Integer^?

Timeout for crawling each URL, in seconds (1-60).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/web_search_contents_params.rb', line 20

optional :crawl_timeout, Integer

#formats ⇒ Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>^?

Content formats to return. If omitted, html and metadata are returned by default. Retrieval is best-effort per URL: a format field appears only when that content could be produced, and a freshly crawled page may also include html even when not requested.

Returns:

• (Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>, nil)

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

optional :formats, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::WebSearchContentsParams::Format] }

#max_age ⇒ Integer^?

Maximum age of cached content in seconds. null means no limit.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

optional :max_age, Integer, nil?: true

#urls ⇒ Array<String>

List of URLs to retrieve content from (max 20 for public API).

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

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

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/web_search_contents_params.rbs', line 38

def to_hash: -> {