context.dev 2.7.0 → 2.9.0

data/rbi/context_dev/models/brand_retrieve_response.rbi

@@ -179,6 +179,24 @@ module ContextDev
         sig { params(email: String).void }
         attr_writer :email
 
+        # Employee headcount information for the brand (will be null if unknown)
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::BrandRetrieveResponse::Brand::Employees
+            )
+          )
+        end
+        attr_reader :employees
+
+        sig do
+          params(
+            employees:
+              ContextDev::Models::BrandRetrieveResponse::Brand::Employees::OrHash
+          ).void
+        end
+        attr_writer :employees
+
         # Industry classification information for the brand
         sig do
           returns(
@@ -324,6 +342,8 @@ module ContextDev
             description: String,
             domain: String,
             email: String,
+            employees:
+              ContextDev::Models::BrandRetrieveResponse::Brand::Employees::OrHash,
             industries:
               ContextDev::Models::BrandRetrieveResponse::Brand::Industries::OrHash,
             is_nsfw: T::Boolean,
@@ -361,6 +381,8 @@ module ContextDev
           domain: nil,
           # Company email address
           email: nil,
+          # Employee headcount information for the brand (will be null if unknown)
+          employees: nil,
           # Industry classification information for the brand
           industries: nil,
           # Indicates whether the brand content is not safe for work (NSFW)
@@ -401,6 +423,8 @@ module ContextDev
               description: String,
               domain: String,
               email: String,
+              employees:
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees,
               industries:
                 ContextDev::Models::BrandRetrieveResponse::Brand::Industries,
               is_nsfw: T::Boolean,
@@ -757,6 +781,134 @@ module ContextDev
           end
         end
 
+        class Employees < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Exact employee count when a precise headcount is known
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :exact
+
+          sig { params(exact: Integer).void }
+          attr_writer :exact
+
+          # Employee count range for the brand (e.g. '11 to 50')
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :range
+
+          sig do
+            params(
+              range:
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::OrSymbol
+            ).void
+          end
+          attr_writer :range
+
+          # Employee headcount information for the brand (will be null if unknown)
+          sig do
+            params(
+              exact: Integer,
+              range:
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Exact employee count when a precise headcount is known
+            exact: nil,
+            # Employee count range for the brand (e.g. '11 to 50')
+            range: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                exact: Integer,
+                range:
+                  ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Employee count range for the brand (e.g. '11 to 50')
+          module Range
+            extend ContextDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            RANGE_1_TO_10 =
+              T.let(
+                :"1 to 10",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_11_TO_50 =
+              T.let(
+                :"11 to 50",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_51_TO_200 =
+              T.let(
+                :"51 to 200",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_201_TO_500 =
+              T.let(
+                :"201 to 500",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_501_TO_1000 =
+              T.let(
+                :"501 to 1000",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_1001_TO_5000 =
+              T.let(
+                :"1001 to 5000",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_5001_TO_10000 =
+              T.let(
+                :"5001 to 10000",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+            RANGE_10001 =
+              T.let(
+                :"10001+",
+                ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::BrandRetrieveResponse::Brand::Employees::Range::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class Industries < ContextDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/context_dev/models/brand_search_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandSearchParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::BrandSearchParams, ContextDev::Internal::AnyHash)
+        end
+
+      # Search term, matched against brand names and domains by prefix (e.g. 'nike',
+      # 'nike.com', 'nik').
+      sig { returns(String) }
+      attr_accessor :query
+
+      # 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.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
+      sig do
+        params(
+          query: String,
+          tags: T::Array[String],
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Search term, matched against brand names and domains by prefix (e.g. 'nike',
+        # 'nike.com', 'nik').
+        query:,
+        # 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.
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            query: String,
+            tags: T::Array[String],
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/context_dev/models/brand_search_response.rbi

@@ -0,0 +1,148 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandSearchResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::BrandSearchResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Up to 10 matching brands, name matches first, then domain matches, most popular
+      # first within each group. Empty when nothing matches.
+      sig { returns(T::Array[ContextDev::Models::BrandSearchResponse::Result]) }
+      attr_accessor :results
+
+      # 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.
+      sig do
+        returns(T.nilable(ContextDev::Models::BrandSearchResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::BrandSearchResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          results:
+            T::Array[ContextDev::Models::BrandSearchResponse::Result::OrHash],
+          key_metadata:
+            ContextDev::Models::BrandSearchResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Up to 10 matching brands, name matches first, then domain matches, most popular
+        # first within each group. Empty when nothing matches.
+        results:,
+        # 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.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            results: T::Array[ContextDev::Models::BrandSearchResponse::Result],
+            key_metadata: ContextDev::Models::BrandSearchResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Result < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandSearchResponse::Result,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The brand's domain.
+        sig { returns(String) }
+        attr_accessor :domain
+
+        # Logo link URL that serves the brand's logo, generated per request for the
+        # calling organization.
+        sig { returns(String) }
+        attr_accessor :logo
+
+        # The brand's name. Empty string when unknown.
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(domain: String, logo: String, name: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The brand's domain.
+          domain:,
+          # Logo link URL that serves the brand's logo, generated per request for the
+          # calling organization.
+          logo:,
+          # The brand's name. Empty string when unknown.
+          name:
+        )
+        end
+
+        sig { override.returns({ domain: String, logo: String, name: String }) }
+        def to_hash
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandSearchResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :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.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/crawl_controls.rbi

@@ -39,8 +39,8 @@ module ContextDev
           max_pages: Integer,
           source:
             T.any(
-              ContextDev::CrawlControls::Source::UnionMember0::OrHash,
-              ContextDev::CrawlControls::Source::UnionMember1::OrHash
+              ContextDev::CrawlControls::Source::StartURL::OrHash,
+              ContextDev::CrawlControls::Source::Sitemap::OrHash
             ),
           url_pattern: T.nilable(String)
         ).returns(T.attached_class)
@@ -82,23 +82,23 @@ module ContextDev
         Variants =
           T.type_alias do
             T.any(
-              ContextDev::CrawlControls::Source::UnionMember0,
-              ContextDev::CrawlControls::Source::UnionMember1
+              ContextDev::CrawlControls::Source::StartURL,
+              ContextDev::CrawlControls::Source::Sitemap
             )
           end
 
-        class UnionMember0 < ContextDev::Internal::Type::BaseModel
+        class StartURL < ContextDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                ContextDev::CrawlControls::Source::UnionMember0,
+                ContextDev::CrawlControls::Source::StartURL,
                 ContextDev::Internal::AnyHash
               )
             end
 
           sig do
             returns(
-              ContextDev::CrawlControls::Source::UnionMember0::Type::TaggedSymbol
+              ContextDev::CrawlControls::Source::StartURL::Type::TaggedSymbol
             )
           end
           attr_accessor :type
@@ -107,10 +107,10 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
+          # The crawl discovered pages by following links from one URL.
           sig do
             params(
-              type:
-                ContextDev::CrawlControls::Source::UnionMember0::Type::OrSymbol,
+              type: ContextDev::CrawlControls::Source::StartURL::Type::OrSymbol,
               url: String
             ).returns(T.attached_class)
           end
@@ -125,7 +125,7 @@ module ContextDev
             override.returns(
               {
                 type:
-                  ContextDev::CrawlControls::Source::UnionMember0::Type::TaggedSymbol,
+                  ContextDev::CrawlControls::Source::StartURL::Type::TaggedSymbol,
                 url: String
               }
             )
@@ -138,23 +138,20 @@ module ContextDev
 
             TaggedSymbol =
               T.type_alias do
-                T.all(
-                  Symbol,
-                  ContextDev::CrawlControls::Source::UnionMember0::Type
-                )
+                T.all(Symbol, ContextDev::CrawlControls::Source::StartURL::Type)
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             START_URL =
               T.let(
                 :start_url,
-                ContextDev::CrawlControls::Source::UnionMember0::Type::TaggedSymbol
+                ContextDev::CrawlControls::Source::StartURL::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  ContextDev::CrawlControls::Source::UnionMember0::Type::TaggedSymbol
+                  ContextDev::CrawlControls::Source::StartURL::Type::TaggedSymbol
                 ]
               )
             end
@@ -163,11 +160,11 @@ module ContextDev
           end
         end
 
-        class UnionMember1 < ContextDev::Internal::Type::BaseModel
+        class Sitemap < ContextDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                ContextDev::CrawlControls::Source::UnionMember1,
+                ContextDev::CrawlControls::Source::Sitemap,
                 ContextDev::Internal::AnyHash
               )
             end
@@ -178,16 +175,16 @@ module ContextDev
 
           sig do
             returns(
-              ContextDev::CrawlControls::Source::UnionMember1::Type::TaggedSymbol
+              ContextDev::CrawlControls::Source::Sitemap::Type::TaggedSymbol
             )
           end
           attr_accessor :type
 
+          # The crawl scraped the pages listed in the domain's sitemap.
           sig do
             params(
               domain: String,
-              type:
-                ContextDev::CrawlControls::Source::UnionMember1::Type::OrSymbol
+              type: ContextDev::CrawlControls::Source::Sitemap::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -202,7 +199,7 @@ module ContextDev
               {
                 domain: String,
                 type:
-                  ContextDev::CrawlControls::Source::UnionMember1::Type::TaggedSymbol
+                  ContextDev::CrawlControls::Source::Sitemap::Type::TaggedSymbol
               }
             )
           end
@@ -214,23 +211,20 @@ module ContextDev
 
             TaggedSymbol =
               T.type_alias do
-                T.all(
-                  Symbol,
-                  ContextDev::CrawlControls::Source::UnionMember1::Type
-                )
+                T.all(Symbol, ContextDev::CrawlControls::Source::Sitemap::Type)
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             SITEMAP =
               T.let(
                 :sitemap,
-                ContextDev::CrawlControls::Source::UnionMember1::Type::TaggedSymbol
+                ContextDev::CrawlControls::Source::Sitemap::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  ContextDev::CrawlControls::Source::UnionMember1::Type::TaggedSymbol
+                  ContextDev::CrawlControls::Source::Sitemap::Type::TaggedSymbol
                 ]
               )
             end

data/rbi/context_dev/models/parse_handle_params.rbi

@@ -83,10 +83,11 @@ module ContextDev
       end
       attr_writer :include_links
 
-      # 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.
       sig do
         returns(
           T.nilable(
@@ -220,10 +221,11 @@ module ContextDev
         include_images: nil,
         # Preserve hyperlinks in Markdown output
         include_links: nil,
-        # 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.
         ocr: nil,
         # PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
         pdf: nil,
@@ -516,10 +518,11 @@ module ContextDev
           )
       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