Module: Telnyx::Models::WebSearchContentsParams::Format

Extended by:
Internal::Type::Enum
Defined in:
lib/telnyx/models/web_search_contents_params.rb,
sig/telnyx/models/web_search_contents_params.rbs

Constant Summary collapse

HTML =

Returns:

  • (:html) 
:html
MARKDOWN =

Returns:

  • (:markdown) 
:markdown
METADATA =

Returns:

  • (:metadata) 
:metadata

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#initialize(urls:, crawl_timeout: nil, formats: nil, max_age: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::WebSearchContentsParams for more details.

Parameters:

  • urls (Array<String>) —

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

  • crawl_timeout (Integer) (defaults to: nil) —

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

  • formats (Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>) (defaults to: nil) —

    Content formats to return. If omitted, html and metadata are returned by def

  • max_age (Integer, nil) (defaults to: nil) —

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

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


51
52
53
54
55
56
57
58
59
60
 
# File 'lib/telnyx/models/web_search_contents_params.rb', line 51

module Format
  extend Telnyx::Internal::Type::Enum

  HTML = :html
  MARKDOWN = :markdown
  METADATA = :metadata

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Telnyx::Models::WebSearchContentsParams::format_]

Returns:

  • (::Array[Telnyx::Models::WebSearchContentsParams::format_]) 


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

def self?.values: -> ::Array[Telnyx::Models::WebSearchContentsParams::format_]