context.dev 2.8.0 → 2.10.0

data/lib/context_dev/models/brand_retrieve_response.rb

@@ -81,6 +81,12 @@ module ContextDev
         #   @return [String, nil]
         optional :email, String
 
+        # @!attribute employees
+        #   Employee headcount information for the brand (will be null if unknown)
+        #
+        #   @return [ContextDev::Models::BrandRetrieveResponse::Brand::Employees, nil]
+        optional :employees, -> { ContextDev::Models::BrandRetrieveResponse::Brand::Employees }
+
         # @!attribute industries
         #   Industry classification information for the brand
         #
@@ -146,7 +152,7 @@ module ContextDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, employees: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::BrandRetrieveResponse::Brand} for more details.
         #
@@ -164,6 +170,8 @@ module ContextDev
         #
         #   @param email [String] Company email address
         #
+        #   @param employees [ContextDev::Models::BrandRetrieveResponse::Brand::Employees] Employee headcount information for the brand (will be null if unknown)
+        #
         #   @param industries [ContextDev::Models::BrandRetrieveResponse::Brand::Industries] Industry classification information for the brand
         #
         #   @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
@@ -342,6 +350,47 @@ module ContextDev
           #   @param name [String] Name of the color
         end
 
+        # @see ContextDev::Models::BrandRetrieveResponse::Brand#employees
+        class Employees < ContextDev::Internal::Type::BaseModel
+          # @!attribute exact
+          #   Exact employee count when a precise headcount is known
+          #
+          #   @return [Integer, nil]
+          optional :exact, Integer
+
+          # @!attribute range
+          #   Employee count range for the brand (e.g. '11 to 50')
+          #
+          #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range, nil]
+          optional :range, enum: -> { ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range }
+
+          # @!method initialize(exact: nil, range: nil)
+          #   Employee headcount information for the brand (will be null if unknown)
+          #
+          #   @param exact [Integer] Exact employee count when a precise headcount is known
+          #
+          #   @param range [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range] Employee count range for the brand (e.g. '11 to 50')
+
+          # Employee count range for the brand (e.g. '11 to 50')
+          #
+          # @see ContextDev::Models::BrandRetrieveResponse::Brand::Employees#range
+          module Range
+            extend ContextDev::Internal::Type::Enum
+
+            RANGE_1_TO_10 = :"1 to 10"
+            RANGE_11_TO_50 = :"11 to 50"
+            RANGE_51_TO_200 = :"51 to 200"
+            RANGE_201_TO_500 = :"201 to 500"
+            RANGE_501_TO_1000 = :"501 to 1000"
+            RANGE_1001_TO_5000 = :"1001 to 5000"
+            RANGE_5001_TO_10000 = :"5001 to 10000"
+            RANGE_10001 = :"10001+"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @see ContextDev::Models::BrandRetrieveResponse::Brand#industries
         class Industries < ContextDev::Internal::Type::BaseModel
           # @!attribute eic

data/lib/context_dev/models/brand_search_params.rb

@@ -8,12 +8,27 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute query
-      #   Search term, matched against brand names and domains by prefix (e.g. 'nike',
+      #   Search term, matched against the fields selected by queryBy (e.g. 'nike',
       #   'nike.com', 'nik').
       #
       #   @return [String]
       required :query, String
 
+      # @!attribute autocomplete
+      #   Whether the search term matches by prefix, so partial words match as they are
+      #   typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
+      #
+      #   @return [Boolean, nil]
+      optional :autocomplete, ContextDev::Internal::Type::Boolean
+
+      # @!attribute query_by
+      #   Fields to match the search term against, as a comma-separated list or repeated
+      #   parameter: 'name', 'domain', or both. Defaults to both.
+      #
+      #   @return [Array<Symbol, ContextDev::Models::BrandSearchParams::QueryBy>, nil]
+      optional :query_by,
+               -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::BrandSearchParams::QueryBy] }
+
       # @!attribute tags
       #   Optional comma-separated caller-defined tags for tracking this request. Tags are
       #   recorded on the request's usage log and can be used to filter usage on the
@@ -22,15 +37,38 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(query:, tags: nil, request_options: {})
+      # @!attribute typo_tolerance
+      #   Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
+      #   typo tolerance).
+      #
+      #   @return [Integer, nil]
+      optional :typo_tolerance, Integer
+
+      # @!method initialize(query:, autocomplete: nil, query_by: nil, tags: nil, typo_tolerance: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandSearchParams} for more details.
       #
-      #   @param query [String] Search term, matched against brand names and domains by prefix (e.g. 'nike', 'ni
+      #   @param query [String] Search term, matched against the fields selected by queryBy (e.g. 'nike', 'nike.
+      #
+      #   @param autocomplete [Boolean] Whether the search term matches by prefix, so partial words match as they are ty
+      #
+      #   @param query_by [Array<Symbol, ContextDev::Models::BrandSearchParams::QueryBy>] Fields to match the search term against, as a comma-separated list or repeated p
       #
       #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
       #
+      #   @param typo_tolerance [Integer] Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
+      #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      module QueryBy
+        extend ContextDev::Internal::Type::Enum
+
+        NAME = :name
+        DOMAIN = :domain
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/context_dev/models/brand_search_response.rb

@@ -5,7 +5,8 @@ module ContextDev
     # @see ContextDev::Resources::Brand#search
     class BrandSearchResponse < ContextDev::Internal::Type::BaseModel
       # @!attribute results
-      #   Up to 10 matching brands, most popular first. Empty when nothing matches.
+      #   Up to 10 matching brands, name matches first, then domain matches, most popular
+      #   first within each group. Empty when nothing matches.
       #
       #   @return [Array<ContextDev::Models::BrandSearchResponse::Result>]
       required :results,
@@ -22,7 +23,7 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandSearchResponse} for more details.
       #
-      #   @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, most popular first. Empty when nothing matches.
+      #   @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, name matches first, then domain matches, most popular
       #
       #   @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 

data/lib/context_dev/models/crawl_controls.rb

@@ -26,7 +26,7 @@ module ContextDev
       # @!attribute source
       #   Where the crawl started.
       #
-      #   @return [ContextDev::Models::CrawlControls::Source::UnionMember0, ContextDev::Models::CrawlControls::Source::UnionMember1]
+      #   @return [ContextDev::Models::CrawlControls::Source::StartURL, ContextDev::Models::CrawlControls::Source::Sitemap]
       required :source, union: -> { ContextDev::CrawlControls::Source }
 
       # @!attribute url_pattern
@@ -48,7 +48,7 @@ module ContextDev
       #
       #   @param max_pages [Integer] The `maxUrls` submitted with the crawl. A sitemap crawl scrapes only the URLs it
       #
-      #   @param source [ContextDev::Models::CrawlControls::Source::UnionMember0, ContextDev::Models::CrawlControls::Source::UnionMember1] Where the crawl started.
+      #   @param source [ContextDev::Models::CrawlControls::Source::StartURL, ContextDev::Models::CrawlControls::Source::Sitemap] Where the crawl started.
       #
       #   @param url_pattern [String, nil] RE2 pattern URLs had to match to be crawled. Null when the crawl set none.
 
@@ -58,15 +58,17 @@ module ContextDev
       module Source
         extend ContextDev::Internal::Type::Union
 
-        variant -> { ContextDev::CrawlControls::Source::UnionMember0 }
+        # The crawl discovered pages by following links from one URL.
+        variant -> { ContextDev::CrawlControls::Source::StartURL }
 
-        variant -> { ContextDev::CrawlControls::Source::UnionMember1 }
+        # The crawl scraped the pages listed in the domain's sitemap.
+        variant -> { ContextDev::CrawlControls::Source::Sitemap }
 
-        class UnionMember0 < ContextDev::Internal::Type::BaseModel
+        class StartURL < ContextDev::Internal::Type::BaseModel
           # @!attribute type
           #
-          #   @return [Symbol, ContextDev::Models::CrawlControls::Source::UnionMember0::Type]
-          required :type, enum: -> { ContextDev::CrawlControls::Source::UnionMember0::Type }
+          #   @return [Symbol, ContextDev::Models::CrawlControls::Source::StartURL::Type]
+          required :type, enum: -> { ContextDev::CrawlControls::Source::StartURL::Type }
 
           # @!attribute url
           #   Page the crawl started from.
@@ -75,11 +77,13 @@ module ContextDev
           required :url, String
 
           # @!method initialize(type:, url:)
-          #   @param type [Symbol, ContextDev::Models::CrawlControls::Source::UnionMember0::Type]
+          #   The crawl discovered pages by following links from one URL.
+          #
+          #   @param type [Symbol, ContextDev::Models::CrawlControls::Source::StartURL::Type]
           #
           #   @param url [String] Page the crawl started from.
 
-          # @see ContextDev::Models::CrawlControls::Source::UnionMember0#type
+          # @see ContextDev::Models::CrawlControls::Source::StartURL#type
           module Type
             extend ContextDev::Internal::Type::Enum
 
@@ -90,7 +94,7 @@ module ContextDev
           end
         end
 
-        class UnionMember1 < ContextDev::Internal::Type::BaseModel
+        class Sitemap < ContextDev::Internal::Type::BaseModel
           # @!attribute domain
           #   Domain whose sitemap supplied the pages.
           #
@@ -99,15 +103,17 @@ module ContextDev
 
           # @!attribute type
           #
-          #   @return [Symbol, ContextDev::Models::CrawlControls::Source::UnionMember1::Type]
-          required :type, enum: -> { ContextDev::CrawlControls::Source::UnionMember1::Type }
+          #   @return [Symbol, ContextDev::Models::CrawlControls::Source::Sitemap::Type]
+          required :type, enum: -> { ContextDev::CrawlControls::Source::Sitemap::Type }
 
           # @!method initialize(domain:, type:)
+          #   The crawl scraped the pages listed in the domain's sitemap.
+          #
           #   @param domain [String] Domain whose sitemap supplied the pages.
           #
-          #   @param type [Symbol, ContextDev::Models::CrawlControls::Source::UnionMember1::Type]
+          #   @param type [Symbol, ContextDev::Models::CrawlControls::Source::Sitemap::Type]
 
-          # @see ContextDev::Models::CrawlControls::Source::UnionMember1#type
+          # @see ContextDev::Models::CrawlControls::Source::Sitemap#type
           module Type
             extend ContextDev::Internal::Type::Enum
 
@@ -119,7 +125,7 @@ module ContextDev
         end
 
         # @!method self.variants
-        #   @return [Array(ContextDev::Models::CrawlControls::Source::UnionMember0, ContextDev::Models::CrawlControls::Source::UnionMember1)]
+        #   @return [Array(ContextDev::Models::CrawlControls::Source::StartURL, ContextDev::Models::CrawlControls::Source::Sitemap)]
       end
     end
   end