context.dev 2.7.0 → 2.9.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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#search
+    class BrandSearchParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute query
+      #   Search term, matched against brand names and domains by prefix (e.g. 'nike',
+      #   'nike.com', 'nik').
+      #
+      #   @return [String]
+      required :query, String
+
+      # @!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
+      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(query:, tags: 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 tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_search_response.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#search
+    class BrandSearchResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute results
+      #   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,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandSearchResponse::Result] }
+
+      # @!attribute key_metadata
+      #   Metadata about the API key used for the request. Included in every response
+      #   whenever a valid API key is provided, even when the response status is not 200.
+      #
+      #   @return [ContextDev::Models::BrandSearchResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::BrandSearchResponse::KeyMetadata }
+
+      # @!method initialize(results:, key_metadata: nil)
+      #   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, 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
+
+      class Result < ContextDev::Internal::Type::BaseModel
+        # @!attribute domain
+        #   The brand's domain.
+        #
+        #   @return [String]
+        required :domain, String
+
+        # @!attribute logo
+        #   Logo link URL that serves the brand's logo, generated per request for the
+        #   calling organization.
+        #
+        #   @return [String]
+        required :logo, String
+
+        # @!attribute name
+        #   The brand's name. Empty string when unknown.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(domain:, logo:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandSearchResponse::Result} for more details.
+        #
+        #   @param domain [String] The brand's domain.
+        #
+        #   @param logo [String] Logo link URL that serves the brand's logo, generated per request for the callin
+        #
+        #   @param name [String] The brand's name. Empty string when unknown.
+      end
+
+      # @see ContextDev::Models::BrandSearchResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Metadata about the API key used for the request. Included in every response
+        #   whenever a valid API key is provided, even when the response status is not 200.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+    end
+  end
+end

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

data/lib/context_dev/models/parse_handle_params.rb

@@ -38,10 +38,11 @@ module ContextDev
       optional :include_links, union: -> { ContextDev::ParseHandleParams::IncludeLinks }
 
       # @!attribute ocr
-      #   When true for PDF inputs, detect and OCR images embedded in the selected pages,
-      #   inserting recognized text at each image's position in page reading order while
-      #   preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
-      #   When false, all OCR is disabled, including the automatic scanned-PDF fallback.
+      #   When true for PDF inputs, OCR the selected pages that have no usable text layer
+      #   (scans), replacing each recovered page's text with the OCR result while pages
+      #   with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
+      #   range. Billed at 1 credit per page OCR actually recovered, on top of the base
+      #   request cost. When false, no OCR runs.
       #
       #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr, nil]
       optional :ocr, union: -> { ContextDev::ParseHandleParams::Ocr }
@@ -95,7 +96,7 @@ module ContextDev
       #
       #   @param include_links [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks] Preserve hyperlinks in Markdown output
       #
-      #   @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] When true for PDF inputs, detect and OCR images embedded in the selected pages,
+      #   @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] When true for PDF inputs, OCR the selected pages that have no usable text layer
       #
       #   @param pdf [ContextDev::Models::ParseHandleParams::Pdf] PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
       #
@@ -239,10 +240,11 @@ module ContextDev
         # @!endgroup
       end
 
-      # When true for PDF inputs, detect and OCR images embedded in the selected pages,
-      # inserting recognized text at each image's position in page reading order while
-      # preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
-      # When false, all OCR is disabled, including the automatic scanned-PDF fallback.
+      # When true for PDF inputs, OCR the selected pages that have no usable text layer
+      # (scans), replacing each recovered page's text with the OCR result while pages
+      # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
+      # range. Billed at 1 credit per page OCR actually recovered, on top of the base
+      # request cost. When false, no OCR runs.
       module Ocr
         extend ContextDev::Internal::Type::Union
 

data/lib/context_dev/models/person_enrich_params.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::People#enrich
+    class PersonEnrichParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute company
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Company, nil]
+      optional :company, -> { ContextDev::PersonEnrichParams::Company }
+
+      # @!attribute education
+      #
+      #   @return [Array<ContextDev::Models::PersonEnrichParams::Education>, nil]
+      optional :education, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PersonEnrichParams::Education] }
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute location
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Location, nil]
+      optional :location, -> { ContextDev::PersonEnrichParams::Location }
+
+      # @!attribute name
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Name, nil]
+      optional :name, -> { ContextDev::PersonEnrichParams::Name }
+
+      # @!attribute social_urls
+      #
+      #   @return [Array<String>, nil]
+      optional :social_urls, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute timeout_ms
+      #   Optional timeout in milliseconds for the request. If the request takes longer
+      #   than this value, it will be aborted with a 408 status code. Maximum allowed
+      #   value is 300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::PersonEnrichParams} for more details.
+      #
+      #   @param company [ContextDev::Models::PersonEnrichParams::Company]
+      #
+      #   @param education [Array<ContextDev::Models::PersonEnrichParams::Education>]
+      #
+      #   @param email [String]
+      #
+      #   @param location [ContextDev::Models::PersonEnrichParams::Location]
+      #
+      #   @param name [ContextDev::Models::PersonEnrichParams::Name]
+      #
+      #   @param social_urls [Array<String>]
+      #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      class Company < ContextDev::Internal::Type::BaseModel
+        # @!attribute domain
+        #
+        #   @return [String, nil]
+        optional :domain, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(domain: nil, name: nil)
+        #   @param domain [String]
+        #   @param name [String]
+      end
+
+      class Education < ContextDev::Internal::Type::BaseModel
+        # @!attribute degree
+        #
+        #   @return [String, nil]
+        optional :degree, String
+
+        # @!attribute field_of_study
+        #
+        #   @return [String, nil]
+        optional :field_of_study, String
+
+        # @!attribute graduation_year
+        #
+        #   @return [Integer, nil]
+        optional :graduation_year, Integer
+
+        # @!attribute institution
+        #
+        #   @return [ContextDev::Models::PersonEnrichParams::Education::Institution, nil]
+        optional :institution, -> { ContextDev::PersonEnrichParams::Education::Institution }
+
+        # @!method initialize(degree: nil, field_of_study: nil, graduation_year: nil, institution: nil)
+        #   @param degree [String]
+        #   @param field_of_study [String]
+        #   @param graduation_year [Integer]
+        #   @param institution [ContextDev::Models::PersonEnrichParams::Education::Institution]
+
+        # @see ContextDev::Models::PersonEnrichParams::Education#institution
+        class Institution < ContextDev::Internal::Type::BaseModel
+          # @!attribute domain
+          #
+          #   @return [String, nil]
+          optional :domain, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(domain: nil, name: nil)
+          #   @param domain [String]
+          #   @param name [String]
+        end
+      end
+
+      class Location < ContextDev::Internal::Type::BaseModel
+        # @!attribute city
+        #
+        #   @return [String, nil]
+        optional :city, String
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute region
+        #
+        #   @return [String, nil]
+        optional :region, String
+
+        # @!method initialize(city: nil, country: nil, region: nil)
+        #   @param city [String]
+        #   @param country [String]
+        #   @param region [String]
+      end
+
+      class Name < ContextDev::Internal::Type::BaseModel
+        # @!attribute first
+        #
+        #   @return [String, nil]
+        optional :first, String
+
+        # @!attribute last
+        #
+        #   @return [String, nil]
+        optional :last, String
+
+        # @!method initialize(first: nil, last: nil)
+        #   @param first [String]
+        #   @param last [String]
+      end
+    end
+  end
+end