context.dev 1.13.0 → 1.15.0

data/lib/context_dev/resources/web.rb

@@ -183,13 +183,21 @@ module ContextDev
         )
       end
 
-      # Scrapes all images from the given URL. Extracts images from img, svg,
-      # picture/source, link, and video elements including inline SVGs, base64 data
-      # URIs, and standard URLs.
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::WebWebScrapeImagesParams} for more details.
+      #
+      # Extract image assets from a web page, including standard URLs, inline SVGs, data
+      # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and
+      # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned
+      # image.
+      #
+      # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, request_options: {})
+      #
+      # @param url [String] Page URL to inspect. Must include http:// or https://.
       #
-      # @overload web_scrape_images(url:, request_options: {})
+      # @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme
       #
-      # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol)
+      # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -202,7 +210,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "web/scrape/images",
-          query: query,
+          query: query.transform_keys(max_age_ms: "maxAgeMs"),
           model: ContextDev::Models::WebWebScrapeImagesResponse,
           options: options
         )

data/lib/context_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextDev
-  VERSION = "1.13.0"
+  VERSION = "1.15.0"
 end

data/rbi/context_dev/models/brand_retrieve_by_email_params.rbi

@@ -38,6 +38,16 @@ module ContextDev
       end
       attr_writer :force_language
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data.
@@ -61,6 +71,7 @@ module ContextDev
           email: String,
           force_language:
             ContextDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
+          max_age_ms: Integer,
           max_speed: T::Boolean,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
@@ -73,6 +84,11 @@ module ContextDev
         email:,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -91,6 +107,7 @@ module ContextDev
             email: String,
             force_language:
               ContextDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
+            max_age_ms: Integer,
             max_speed: T::Boolean,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi

@@ -38,6 +38,16 @@ module ContextDev
       end
       attr_writer :force_language
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data.
@@ -61,6 +71,7 @@ module ContextDev
           isin: String,
           force_language:
             ContextDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol,
+          max_age_ms: Integer,
           max_speed: T::Boolean,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
@@ -73,6 +84,11 @@ module ContextDev
         isin:,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -91,6 +107,7 @@ module ContextDev
             isin: String,
             force_language:
               ContextDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol,
+            max_age_ms: Integer,
             max_speed: T::Boolean,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi

@@ -53,6 +53,16 @@ module ContextDev
       end
       attr_writer :force_language
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data.
@@ -78,6 +88,7 @@ module ContextDev
             ContextDev::BrandRetrieveByNameParams::CountryGl::OrSymbol,
           force_language:
             ContextDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol,
+          max_age_ms: Integer,
           max_speed: T::Boolean,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
@@ -92,6 +103,11 @@ module ContextDev
         country_gl: nil,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -112,6 +128,7 @@ module ContextDev
               ContextDev::BrandRetrieveByNameParams::CountryGl::OrSymbol,
             force_language:
               ContextDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol,
+            max_age_ms: Integer,
             max_speed: T::Boolean,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi

@@ -37,6 +37,16 @@ module ContextDev
       end
       attr_writer :force_language
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data.
@@ -78,6 +88,7 @@ module ContextDev
           ticker: String,
           force_language:
             ContextDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol,
+          max_age_ms: Integer,
           max_speed: T::Boolean,
           ticker_exchange:
             ContextDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol,
@@ -91,6 +102,11 @@ module ContextDev
         ticker:,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -111,6 +127,7 @@ module ContextDev
             ticker: String,
             force_language:
               ContextDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol,
+            max_age_ms: Integer,
             max_speed: T::Boolean,
             ticker_exchange:
               ContextDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol,

data/rbi/context_dev/models/brand_retrieve_params.rbi

@@ -32,6 +32,16 @@ module ContextDev
       end
       attr_writer :force_language
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data. Works with all three lookup methods.
@@ -55,6 +65,7 @@ module ContextDev
           domain: String,
           force_language:
             ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          max_age_ms: Integer,
           max_speed: T::Boolean,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
@@ -66,6 +77,11 @@ module ContextDev
         domain:,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data. Works with all three lookup methods.
@@ -84,6 +100,7 @@ module ContextDev
             domain: String,
             force_language:
               ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+            max_age_ms: Integer,
             max_speed: T::Boolean,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi

@@ -18,6 +18,16 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :domain
 
+      # Maximum age in milliseconds for cached brand data before the API performs a hard
+      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+      # year.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_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).
@@ -30,6 +40,7 @@ module ContextDev
       sig do
         params(
           domain: String,
+          max_age_ms: Integer,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -37,6 +48,11 @@ module ContextDev
       def self.new(
         # Domain name to retrieve simplified brand data for
         domain:,
+        # Maximum age in milliseconds for cached brand data before the API performs a hard
+        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
+        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
+        # year.
+        max_age_ms: nil,
         # 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).
@@ -49,6 +65,7 @@ module ContextDev
         override.returns(
           {
             domain: String,
+            max_age_ms: Integer,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }

data/rbi/context_dev/models/web_web_scrape_images_params.rbi

@@ -14,30 +14,140 @@ module ContextDev
           )
         end
 
-      # Full URL to scrape images from (must include http:// or https:// protocol)
+      # Page URL to inspect. Must include http:// or https://.
       sig { returns(String) }
       attr_accessor :url
 
+      # Optional per-image processing, sent as deep-object query params such as
+      # enrichment[resolution]=true.
+      sig do
+        returns(T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment))
+      end
+      attr_reader :enrichment
+
+      sig do
+        params(
+          enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash
+        ).void
+      end
+      attr_writer :enrichment
+
+      # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
+      # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_age_ms
+
+      sig { params(max_age_ms: Integer).void }
+      attr_writer :max_age_ms
+
       sig do
         params(
           url: String,
+          enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash,
+          max_age_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Full URL to scrape images from (must include http:// or https:// protocol)
+        # Page URL to inspect. Must include http:// or https://.
         url:,
+        # Optional per-image processing, sent as deep-object query params such as
+        # enrichment[resolution]=true.
+        enrichment: nil,
+        # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
+        # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
+        max_age_ms: nil,
         request_options: {}
       )
       end
 
       sig do
         override.returns(
-          { url: String, request_options: ContextDev::RequestOptions }
+          {
+            url: String,
+            enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment,
+            max_age_ms: Integer,
+            request_options: ContextDev::RequestOptions
+          }
         )
       end
       def to_hash
       end
+
+      class Enrichment < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebScrapeImagesParams::Enrichment,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Classify each image by visual asset type.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :classification
+
+        sig { params(classification: T::Boolean).void }
+        attr_writer :classification
+
+        # Host materializable images on the Brand.dev CDN and return their URL and MIME
+        # type.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :hosted_url
+
+        sig { params(hosted_url: T::Boolean).void }
+        attr_writer :hosted_url
+
+        # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_time_per_ms
+
+        sig { params(max_time_per_ms: Integer).void }
+        attr_writer :max_time_per_ms
+
+        # Measure image width and height when possible.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :resolution
+
+        sig { params(resolution: T::Boolean).void }
+        attr_writer :resolution
+
+        # Optional per-image processing, sent as deep-object query params such as
+        # enrichment[resolution]=true.
+        sig do
+          params(
+            classification: T::Boolean,
+            hosted_url: T::Boolean,
+            max_time_per_ms: Integer,
+            resolution: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Classify each image by visual asset type.
+          classification: nil,
+          # Host materializable images on the Brand.dev CDN and return their URL and MIME
+          # type.
+          hosted_url: nil,
+          # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
+          max_time_per_ms: nil,
+          # Measure image width and height when possible.
+          resolution: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              classification: T::Boolean,
+              hosted_url: T::Boolean,
+              max_time_per_ms: Integer,
+              resolution: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end