Class: ContextDev::Models::WebExtractCompetitorsResponse::Competitor

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/web_extract_competitors_response.rb

Defined Under Namespace

Modules: Confidence

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(confidence:, description:, domain:, name:, source_urls:, url:) ⇒ Object

Parameters:

  • confidence (Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence) —

    Confidence that this company is a direct competitor.

  • description (String) —

    Short description of the competitor.

  • domain (String) —

    Competitor’s normalized official domain.

  • name (String) —

    Competitor company or product name.

  • source_urls (Array<String>) —

    Search result URLs used as evidence for this competitor.

  • url (String) —

    Competitor website URL.



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
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 41

class Competitor < ContextDev::Internal::Type::BaseModel
  # @!attribute confidence
  #   Confidence that this company is a direct competitor.
  #
  #   @return [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence]
  required :confidence,
           enum: -> { ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence }

  # @!attribute description
  #   Short description of the competitor.
  #
  #   @return [String]
  required :description, String

  # @!attribute domain
  #   Competitor's normalized official domain.
  #
  #   @return [String]
  required :domain, String

  # @!attribute name
  #   Competitor company or product name.
  #
  #   @return [String]
  required :name, String

  # @!attribute source_urls
  #   Search result URLs used as evidence for this competitor.
  #
  #   @return [Array<String>]
  required :source_urls, ContextDev::Internal::Type::ArrayOf[String], api_name: :sourceUrls

  # @!attribute url
  #   Competitor website URL.
  #
  #   @return [String]
  required :url, String

  # @!method initialize(confidence:, description:, domain:, name:, source_urls:, url:)
  #   @param confidence [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence] Confidence that this company is a direct competitor.
  #
  #   @param description [String] Short description of the competitor.
  #
  #   @param domain [String] Competitor's normalized official domain.
  #
  #   @param name [String] Competitor company or product name.
  #
  #   @param source_urls [Array<String>] Search result URLs used as evidence for this competitor.
  #
  #   @param url [String] Competitor website URL.

  # Confidence that this company is a direct competitor.
  #
  # @see ContextDev::Models::WebExtractCompetitorsResponse::Competitor#confidence
  module Confidence
    extend ContextDev::Internal::Type::Enum

    HIGH = :high
    MEDIUM = :medium

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

Instance Attribute Details

#confidence ⇒ Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence

Confidence that this company is a direct competitor.

Returns:



46
47
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 46

required :confidence,
enum: -> { ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence }

#description ⇒ String

Short description of the competitor.

Returns:

  • (String) 


53
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 53

required :description, String

#domain ⇒ String

Competitor’s normalized official domain.

Returns:

  • (String) 


59
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 59

required :domain, String

#name ⇒ String

Competitor company or product name.

Returns:

  • (String) 


65
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 65

required :name, String

#source_urls ⇒ Array<String>

Search result URLs used as evidence for this competitor.

Returns:

  • (Array<String>) 


71
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 71

required :source_urls, ContextDev::Internal::Type::ArrayOf[String], api_name: :sourceUrls

#url ⇒ String

Competitor website URL.

Returns:

  • (String) 


77
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 77

required :url, String