context.dev 2.19.0 → 2.21.0

data/lib/context_dev/models/web_scrape_response.rb

@@ -19,6 +19,14 @@ module ContextDev
       #   @return [ContextDev::Models::WebScrapeResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::WebScrapeResponse::CacheMetadata }
 
+      # @!attribute highlights
+      #   Relevant Markdown excerpts for your question or topic, in page order. Headings
+      #   in square brackets supply necessary context; ellipses mark omitted portions.
+      #   Empty when the page has no text.
+      #
+      #   @return [ContextDev::Models::WebScrapeResponse::Highlights]
+      required :highlights, -> { ContextDev::Models::WebScrapeResponse::Highlights }
+
       # @!attribute html
       #   Rendered HTML after content filters.
       #
@@ -31,6 +39,12 @@ module ContextDev
       #   @return [ContextDev::Models::WebScrapeResponse::Images]
       required :images, -> { ContextDev::Models::WebScrapeResponse::Images }
 
+      # @!attribute json
+      #   Page data extracted using your schema.
+      #
+      #   @return [ContextDev::Models::WebScrapeResponse::Json]
+      required :json, -> { ContextDev::Models::WebScrapeResponse::Json }
+
       # @!attribute markdown
       #   Markdown after content filters.
       #
@@ -49,6 +63,12 @@ module ContextDev
       #   @return [ContextDev::Models::WebScrapeResponse::Parsed]
       required :parsed, -> { ContextDev::Models::WebScrapeResponse::Parsed }
 
+      # @!attribute product
+      #   Product details found on the page.
+      #
+      #   @return [ContextDev::Models::WebScrapeResponse::Product]
+      required :product, -> { ContextDev::Models::WebScrapeResponse::Product }
+
       # @!attribute request_id
       #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #   it when contacting support about a failed request.
@@ -69,8 +89,11 @@ module ContextDev
       required :url, String
 
       # @!attribute is_partial
-      #   Present when return-partial captures a page that is still loading or returns
-      #   images before image processing finishes. Partial responses are not cached.
+      #   Present when at least one requested output succeeds while another fails, or when
+      #   successful outputs come from a page that is still loading or images returned
+      #   before processing finished. Absent when every requested output fails. Check each
+      #   output's success field for its result. Valid captured pieces may be cached
+      #   independently; failed retrievals and incomplete captures are not cached.
       #
       #   @return [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial, nil]
       optional :is_partial, enum: -> { ContextDev::Models::WebScrapeResponse::IsPartial }, api_name: :isPartial
@@ -81,7 +104,7 @@ module ContextDev
       #   @return [ContextDev::Models::WebScrapeResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebScrapeResponse::KeyMetadata }
 
-      # @!method initialize(bytes:, cache_metadata:, html:, images:, markdown:, metadata:, parsed:, request_id:, screenshot:, url:, is_partial: nil, key_metadata: nil)
+      # @!method initialize(bytes:, cache_metadata:, highlights:, html:, images:, json:, markdown:, metadata:, parsed:, product:, request_id:, screenshot:, url:, is_partial: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScrapeResponse} for more details.
       #
@@ -89,23 +112,29 @@ module ContextDev
       #
       #   @param cache_metadata [ContextDev::Models::WebScrapeResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param highlights [ContextDev::Models::WebScrapeResponse::Highlights] Relevant Markdown excerpts for your question or topic, in page order. Headings i
+      #
       #   @param html [ContextDev::Models::WebScrapeResponse::HTML] Rendered HTML after content filters.
       #
       #   @param images [ContextDev::Models::WebScrapeResponse::Images] Images after content filters. Empty when none are found.
       #
+      #   @param json [ContextDev::Models::WebScrapeResponse::Json] Page data extracted using your schema.
+      #
       #   @param markdown [ContextDev::Models::WebScrapeResponse::Markdown] Markdown after content filters.
       #
       #   @param metadata [ContextDev::Models::WebScrapeResponse::Metadata] Page details, when available.
       #
       #   @param parsed [ContextDev::Models::WebScrapeResponse::Parsed] Fields produced by parseParams.rules, after shared content filters.
       #
+      #   @param product [ContextDev::Models::WebScrapeResponse::Product] Product details found on the page.
+      #
       #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
       #   @param screenshot [ContextDev::Models::WebScrapeResponse::Screenshot] An image data URL. Use directly as an image src.
       #
       #   @param url [String] Final URL after redirects and browser actions.
       #
-      #   @param is_partial [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial] Present when return-partial captures a page that is still loading or returns ima
+      #   @param is_partial [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial] Present when at least one requested output succeeds while another fails, or when
       #
       #   @param key_metadata [ContextDev::Models::WebScrapeResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
@@ -121,12 +150,21 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   Original HTTP response body. Waiting, actions, and content filters never change
         #   it.
         #
         #   @param data [ContextDev::Models::WebScrapeResponse::Bytes::Data, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
 
         # @see ContextDev::Models::WebScrapeResponse::Bytes#data
         class Data < ContextDev::Internal::Type::BaseModel
@@ -195,6 +233,36 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::WebScrapeResponse#highlights
+      class Highlights < ContextDev::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<String>, nil]
+        required :data, ContextDev::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute requested
+        #
+        #   @return [Boolean]
+        required :requested, ContextDev::Internal::Type::Boolean
+
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
+        #   Relevant Markdown excerpts for your question or topic, in page order. Headings
+        #   in square brackets supply necessary context; ellipses mark omitted portions.
+        #   Empty when the page has no text.
+        #
+        #   @param data [Array<String>, nil]
+        #
+        #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
+      end
+
       # @see ContextDev::Models::WebScrapeResponse#html
       class HTML < ContextDev::Internal::Type::BaseModel
         # @!attribute data
@@ -207,11 +275,20 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   Rendered HTML after content filters.
         #
         #   @param data [String, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
       end
 
       # @see ContextDev::Models::WebScrapeResponse#images
@@ -228,11 +305,20 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   Images after content filters. Empty when none are found.
         #
         #   @param data [Array<ContextDev::Models::WebScrapeResponse::Images::Data>, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
 
         class Data < ContextDev::Internal::Type::BaseModel
           # @!attribute alt
@@ -304,6 +390,34 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::WebScrapeResponse#json
+      class Json < ContextDev::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :data, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown], nil?: true
+
+        # @!attribute requested
+        #
+        #   @return [Boolean]
+        required :requested, ContextDev::Internal::Type::Boolean
+
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
+        #   Page data extracted using your schema.
+        #
+        #   @param data [Hash{Symbol=>Object}, nil]
+        #
+        #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
+      end
+
       # @see ContextDev::Models::WebScrapeResponse#markdown
       class Markdown < ContextDev::Internal::Type::BaseModel
         # @!attribute data
@@ -316,11 +430,20 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   Markdown after content filters.
         #
         #   @param data [String, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
       end
 
       # @see ContextDev::Models::WebScrapeResponse#metadata
@@ -594,11 +717,268 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   Fields produced by parseParams.rules, after shared content filters.
         #
         #   @param data [Hash{Symbol=>Object}, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
+      end
+
+      # @see ContextDev::Models::WebScrapeResponse#product
+      class Product < ContextDev::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [ContextDev::Models::WebScrapeResponse::Product::Data, nil]
+        required :data, -> { ContextDev::Models::WebScrapeResponse::Product::Data }, nil?: true
+
+        # @!attribute requested
+        #
+        #   @return [Boolean]
+        required :requested, ContextDev::Internal::Type::Boolean
+
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
+        #   Product details found on the page.
+        #
+        #   @param data [ContextDev::Models::WebScrapeResponse::Product::Data, nil]
+        #
+        #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
+
+        # @see ContextDev::Models::WebScrapeResponse::Product#data
+        class Data < ContextDev::Internal::Type::BaseModel
+          # @!attribute is_product_page
+          #   Whether the page is a product detail page.
+          #
+          #   @return [Boolean]
+          required :is_product_page, ContextDev::Internal::Type::Boolean, api_name: :isProductPage
+
+          # @!attribute product
+          #   The extracted product, or null when the page is not a product detail page.
+          #
+          #   @return [ContextDev::Models::WebScrapeResponse::Product::Data::Product, nil]
+          required :product, -> { ContextDev::Models::WebScrapeResponse::Product::Data::Product }, nil?: true
+
+          # @!method initialize(is_product_page:, product:)
+          #   @param is_product_page [Boolean] Whether the page is a product detail page.
+          #
+          #   @param product [ContextDev::Models::WebScrapeResponse::Product::Data::Product, nil] The extracted product, or null when the page is not a product detail page.
+
+          # @see ContextDev::Models::WebScrapeResponse::Product::Data#product
+          class Product < ContextDev::Internal::Type::BaseModel
+            # @!attribute availability
+            #   Stock or ordering availability.
+            #
+            #   @return [Symbol, ContextDev::Models::WebScrapeResponse::Product::Data::Product::Availability, nil]
+            required :availability,
+                     enum: -> { ContextDev::Models::WebScrapeResponse::Product::Data::Product::Availability },
+                     nil?: true
+
+            # @!attribute brand
+            #   Brand or vendor.
+            #
+            #   @return [String, nil]
+            required :brand, String, nil?: true
+
+            # @!attribute category
+            #   Product category.
+            #
+            #   @return [String, nil]
+            required :category, String, nil?: true
+
+            # @!attribute currency
+            #   ISO 4217 currency code.
+            #
+            #   @return [String, nil]
+            required :currency, String, nil?: true
+
+            # @!attribute description
+            #   Product description.
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute dimensions
+            #   Product dimensions as shown on the page.
+            #
+            #   @return [Array<String>]
+            required :dimensions, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!attribute features
+            #   Key features and specifications.
+            #
+            #   @return [Array<String>]
+            required :features, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!attribute images
+            #   Product image URLs, main image first.
+            #
+            #   @return [Array<String>]
+            required :images, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!attribute image_url
+            #   Main product image URL.
+            #
+            #   @return [String, nil]
+            required :image_url, String, api_name: :imageUrl, nil?: true
+
+            # @!attribute name
+            #   Product name.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute price
+            #   Current price.
+            #
+            #   @return [Float, nil]
+            required :price, Float, nil?: true
+
+            # @!attribute regular_price
+            #   List price before any discount.
+            #
+            #   @return [Float, nil]
+            required :regular_price, Float, api_name: :regularPrice, nil?: true
+
+            # @!attribute sku
+            #   Product identifier such as a SKU or model number.
+            #
+            #   @return [String, nil]
+            required :sku, String, nil?: true
+
+            # @!attribute tags
+            #   Product tags.
+            #
+            #   @return [Array<String>]
+            required :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!attribute target_audience
+            #   Intended audience.
+            #
+            #   @return [Array<String>]
+            required :target_audience, ContextDev::Internal::Type::ArrayOf[String], api_name: :targetAudience
+
+            # @!attribute variants
+            #   Product variations, such as different colors or sizes, with their attributes and
+            #   images. Empty if none are found. May not include every variation offered by the
+            #   store.
+            #
+            #   @return [Array<ContextDev::Models::WebScrapeResponse::Product::Data::Product::Variant>]
+            required :variants,
+                     -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebScrapeResponse::Product::Data::Product::Variant] }
+
+            # @!method initialize(availability:, brand:, category:, currency:, description:, dimensions:, features:, images:, image_url:, name:, price:, regular_price:, sku:, tags:, target_audience:, variants:)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::WebScrapeResponse::Product::Data::Product} for more
+            #   details.
+            #
+            #   The extracted product, or null when the page is not a product detail page.
+            #
+            #   @param availability [Symbol, ContextDev::Models::WebScrapeResponse::Product::Data::Product::Availability, nil] Stock or ordering availability.
+            #
+            #   @param brand [String, nil] Brand or vendor.
+            #
+            #   @param category [String, nil] Product category.
+            #
+            #   @param currency [String, nil] ISO 4217 currency code.
+            #
+            #   @param description [String, nil] Product description.
+            #
+            #   @param dimensions [Array<String>] Product dimensions as shown on the page.
+            #
+            #   @param features [Array<String>] Key features and specifications.
+            #
+            #   @param images [Array<String>] Product image URLs, main image first.
+            #
+            #   @param image_url [String, nil] Main product image URL.
+            #
+            #   @param name [String] Product name.
+            #
+            #   @param price [Float, nil] Current price.
+            #
+            #   @param regular_price [Float, nil] List price before any discount.
+            #
+            #   @param sku [String, nil] Product identifier such as a SKU or model number.
+            #
+            #   @param tags [Array<String>] Product tags.
+            #
+            #   @param target_audience [Array<String>] Intended audience.
+            #
+            #   @param variants [Array<ContextDev::Models::WebScrapeResponse::Product::Data::Product::Variant>] Product variations, such as different colors or sizes, with their attributes and
+
+            # Stock or ordering availability.
+            #
+            # @see ContextDev::Models::WebScrapeResponse::Product::Data::Product#availability
+            module Availability
+              extend ContextDev::Internal::Type::Enum
+
+              IN_STOCK = :in_stock
+              OUT_OF_STOCK = :out_of_stock
+              LIMITED_AVAILABILITY = :limited_availability
+              PREORDER = :preorder
+              BACKORDER = :backorder
+              MADE_TO_ORDER = :made_to_order
+              DISCONTINUED = :discontinued
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            class Variant < ContextDev::Internal::Type::BaseModel
+              # @!attribute attributes
+              #   Explicit variant attributes such as color, size, material, pattern and
+              #   properties declared by page.
+              #
+              #   @return [Hash{Symbol=>String}]
+              required :attributes, ContextDev::Internal::Type::HashOf[String]
+
+              # @!attribute images
+              #   Original source image URLs explicitly attached to this variant.
+              #
+              #   @return [Array<String>]
+              required :images, ContextDev::Internal::Type::ArrayOf[String]
+
+              # @!attribute sku
+              #
+              #   @return [String, nil]
+              required :sku, String, nil?: true
+
+              # @!attribute url
+              #   Variant or offer URL when provided by the source. May be shared by variants.
+              #
+              #   @return [String, nil]
+              required :url, String, nil?: true
+
+              # @!method initialize(attributes:, images:, sku:, url:)
+              #   Some parameter documentations has been truncated, see
+              #   {ContextDev::Models::WebScrapeResponse::Product::Data::Product::Variant} for
+              #   more details.
+              #
+              #   @param attributes [Hash{Symbol=>String}] Explicit variant attributes such as color, size, material, pattern and propertie
+              #
+              #   @param images [Array<String>] Original source image URLs explicitly attached to this variant.
+              #
+              #   @param sku [String, nil]
+              #
+              #   @param url [String, nil] Variant or offer URL when provided by the source. May be shared by variants.
+            end
+          end
+        end
       end
 
       # @see ContextDev::Models::WebScrapeResponse#screenshot
@@ -613,15 +993,27 @@ module ContextDev
         #   @return [Boolean]
         required :requested, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(data:, requested:)
+        # @!attribute success
+        #   True when retrieved, false when retrieval failed, and null when not requested.
+        #
+        #   @return [Boolean, nil]
+        required :success, ContextDev::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(data:, requested:, success:)
         #   An image data URL. Use directly as an image src.
         #
         #   @param data [String, nil]
+        #
         #   @param requested [Boolean]
+        #
+        #   @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
       end
 
-      # Present when return-partial captures a page that is still loading or returns
-      # images before image processing finishes. Partial responses are not cached.
+      # Present when at least one requested output succeeds while another fails, or when
+      # successful outputs come from a page that is still loading or images returned
+      # before processing finished. Absent when every requested output fails. Check each
+      # output's success field for its result. Valid captured pieces may be cached
+      # independently; failed retrievals and incomplete captures are not cached.
       #
       # @see ContextDev::Models::WebScrapeResponse#is_partial
       module IsPartial

data/lib/context_dev/models.rb

@@ -59,6 +59,8 @@ module ContextDev
 
   Failure = ContextDev::Models::Failure
 
+  FeedbackSubmitParams = ContextDev::Models::FeedbackSubmitParams
+
   IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
   IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams

data/lib/context_dev/resources/feedback.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
+    # cost no credits and use a separate rate limit.
+    class Feedback
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::FeedbackSubmitParams} for more details.
+      #
+      # Report a problem with a Context.dev API call, docs page, SDK, or CLI. Include
+      # request_id, url, or both.
+      #
+      # @overload submit(category:, note:, request_id: nil, tags: nil, url: nil, request_options: {})
+      #
+      # @param category [Symbol, ContextDev::Models::FeedbackSubmitParams::Category] Kind of issue.
+      #
+      # @param note [String] What went wrong and what you expected instead.
+      #
+      # @param request_id [String] The request_id of the API call the feedback is about, from its response body or
+      #
+      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      # @param url [String] The page the feedback is about, such as one page of a crawl or a docs page.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::FeedbackSubmitResponse]
+      #
+      # @see ContextDev::Models::FeedbackSubmitParams
+      def submit(params)
+        parsed, options = ContextDev::FeedbackSubmitParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "feedback",
+          body: parsed,
+          model: ContextDev::Models::FeedbackSubmitResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/news.rb

@@ -4,11 +4,15 @@ module ContextDev
   module Resources
     # Search live first-party RSS and free historical news data by company identity.
     class News
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::NewsSearchParams} for more details.
+      #
       # Searches live and historical company news for one company, identified in
       # searchBy by name, domain, ticker (optionally disambiguated by exchange), or
-      # ISIN. Results can be filtered by publisher domain, publisher country, article
-      # language, article type, and published-at date, and include stable story IDs,
-      # source metadata, verified entity relevance, and cursor pagination.
+      # ISIN. Results can be filtered by one of publisher domain, publisher country,
+      # article language, or article type, optionally combined with a published-at date
+      # range, and include stable story IDs, source metadata, verified entity relevance,
+      # and cursor pagination.
       #
       # @overload search(search_by:, cursor: nil, filter_by: nil, limit: nil, sort_by: nil, tags: nil, request_options: {})
       #
@@ -16,7 +20,7 @@ module ContextDev
       #
       # @param cursor [String, nil] Opaque next_cursor from the previous response, or null for the first page.
       #
-      # @param filter_by [ContextDev::Models::NewsSearchParams::FilterBy] Optional result filters.
+      # @param filter_by [ContextDev::Models::NewsSearchParams::FilterBy] Optional result filters. Use at most one of sourceDomain, sourceCountry, article
       #
       # @param limit [Integer] Maximum results to return. Defaults to 10.
       #