Class: Telnyx::Models::WebSearchContentsResponse::Data::Result

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

Defined Under Namespace

Classes: Metadata

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(url:, html: nil, markdown: nil, metadata: nil, title: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::WebSearchContentsResponse::Data::Result for more details.

Parameters:

  • url (String) —

    The source URL.

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

    Cleaned HTML content (if html format requested; may also be present on freshly

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

    Markdown content (if markdown format requested).

  • metadata (Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata) (defaults to: nil) —

    Page metadata (if metadata format requested).

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

    Page title (if available).



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 26

class Result < Telnyx::Internal::Type::BaseModel
  # @!attribute url
  #   The source URL.
  #
  #   @return [String]
  required :url, String

  # @!attribute html
  #   Cleaned HTML content (if `html` format requested; may also be present on freshly
  #   crawled pages).
  #
  #   @return [String, nil]
  optional :html, String

  # @!attribute markdown
  #   Markdown content (if `markdown` format requested).
  #
  #   @return [String, nil]
  optional :markdown, String

  # @!attribute metadata
  #   Page metadata (if `metadata` format requested).
  #
  #   @return [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata, nil]
  optional :metadata, -> { Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata }

  # @!attribute title
  #   Page title (if available).
  #
  #   @return [String, nil]
  optional :title, String

  # @!method initialize(url:, html: nil, markdown: nil, metadata: nil, title: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::WebSearchContentsResponse::Data::Result} for more details.
  #
  #   @param url [String] The source URL.
  #
  #   @param html [String] Cleaned HTML content (if `html` format requested; may also be present on freshly
  #
  #   @param markdown [String] Markdown content (if `markdown` format requested).
  #
  #   @param metadata [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata] Page metadata (if `metadata` format requested).
  #
  #   @param title [String] Page title (if available).

  # @see Telnyx::Models::WebSearchContentsResponse::Data::Result#metadata
  class Metadata < Telnyx::Internal::Type::BaseModel
    # @!attribute favicon_url
    #   Favicon URL (if available).
    #
    #   @return [String, nil]
    optional :favicon_url, String

    # @!attribute site_name
    #   Site name. Often empty.
    #
    #   @return [String, nil]
    optional :site_name, String

    # @!method initialize(favicon_url: nil, site_name: nil)
    #   Page metadata (if `metadata` format requested).
    #
    #   @param favicon_url [String] Favicon URL (if available).
    #
    #   @param site_name [String] Site name. Often empty.
  end
end

Instance Attribute Details

#html ⇒ String?

Cleaned HTML content (if html format requested; may also be present on freshly crawled pages).

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 38

optional :html, String

#markdown ⇒ String?

Markdown content (if markdown format requested).

Parameters:

  • (String)

Returns:

  • (String, nil) 


44
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 44

optional :markdown, String

#metadata ⇒ Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata?

Page metadata (if metadata format requested).

Returns:



50
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 50

optional :metadata, -> { Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata }

#title ⇒ String?

Page title (if available).

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 56

optional :title, String

#url ⇒ String

The source URL.

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/telnyx/models/web_search_contents_response.rb', line 31

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/telnyx/models/web_search_contents_response.rbs', line 77

def to_hash: -> {