context.dev 1.13.0 → 1.15.0

data/rbi/context_dev/models/web_web_scrape_images_response.rbi

@@ -11,13 +11,13 @@ module ContextDev
           )
         end
 
-      # Array of scraped images
+      # Images found on the page.
       sig do
         returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image])
       end
       attr_accessor :images
 
-      # Indicates success
+      # Always true on success.
       sig do
         returns(
           ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean
@@ -25,7 +25,7 @@ module ContextDev
       end
       attr_accessor :success
 
-      # The URL that was scraped
+      # Page URL that was scraped.
       sig { returns(String) }
       attr_accessor :url
 
@@ -41,11 +41,11 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # Array of scraped images
+        # Images found on the page.
         images:,
-        # Indicates success
+        # Always true on success.
         success:,
-        # The URL that was scraped
+        # Page URL that was scraped.
         url:
       )
       end
@@ -73,11 +73,11 @@ module ContextDev
             )
           end
 
-        # Alt text of the image, or null if not present
+        # Image alt text, or null when unavailable.
         sig { returns(T.nilable(String)) }
         attr_accessor :alt
 
-        # The HTML element the image was found in
+        # Where the image was found.
         sig do
           returns(
             ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
@@ -85,11 +85,11 @@ module ContextDev
         end
         attr_accessor :element
 
-        # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        # Original image value: URL, inline SVG or HTML, or base64 data URI.
         sig { returns(String) }
         attr_accessor :src
 
-        # The type/format of the src value
+        # Format of src.
         sig do
           returns(
             ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
@@ -97,6 +97,24 @@ module ContextDev
         end
         attr_accessor :type
 
+        # Requested metadata for images that could be processed.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment
+            )
+          )
+        end
+        attr_reader :enrichment
+
+        sig do
+          params(
+            enrichment:
+              ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash
+          ).void
+        end
+        attr_writer :enrichment
+
         sig do
           params(
             alt: T.nilable(String),
@@ -104,18 +122,22 @@ module ContextDev
               ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::OrSymbol,
             src: String,
             type:
-              ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol
+              ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol,
+            enrichment:
+              ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # Alt text of the image, or null if not present
+          # Image alt text, or null when unavailable.
           alt:,
-          # The HTML element the image was found in
+          # Where the image was found.
           element:,
-          # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+          # Original image value: URL, inline SVG or HTML, or base64 data URI.
           src:,
-          # The type/format of the src value
-          type:
+          # Format of src.
+          type:,
+          # Requested metadata for images that could be processed.
+          enrichment: nil
         )
         end
 
@@ -127,14 +149,16 @@ module ContextDev
                 ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol,
               src: String,
               type:
-                ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol,
+              enrichment:
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment
             }
           )
         end
         def to_hash
         end
 
-        # The HTML element the image was found in
+        # Where the image was found.
         module Element
           extend ContextDev::Internal::Type::Enum
 
@@ -204,7 +228,7 @@ module ContextDev
           end
         end
 
-        # The type/format of the src value
+        # Format of src.
         module Type
           extend ContextDev::Internal::Type::Enum
 
@@ -243,9 +267,170 @@ module ContextDev
           def self.values
           end
         end
+
+        class Enrichment < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Image height in pixels, when measured.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :height
+
+          sig { params(height: Integer).void }
+          attr_writer :height
+
+          # Detected MIME type, when hosted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :mimetype
+
+          sig { params(mimetype: String).void }
+          attr_writer :mimetype
+
+          # Visual asset category, when classified.
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          # Brand.dev CDN URL, when hosted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          # Image width in pixels, when measured.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :width
+
+          sig { params(width: Integer).void }
+          attr_writer :width
+
+          # Requested metadata for images that could be processed.
+          sig do
+            params(
+              height: Integer,
+              mimetype: String,
+              type:
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol,
+              url: String,
+              width: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Image height in pixels, when measured.
+            height: nil,
+            # Detected MIME type, when hosted.
+            mimetype: nil,
+            # Visual asset category, when classified.
+            type: nil,
+            # Brand.dev CDN URL, when hosted.
+            url: nil,
+            # Image width in pixels, when measured.
+            width: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                height: Integer,
+                mimetype: String,
+                type:
+                  ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol,
+                url: String,
+                width: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Visual asset category, when classified.
+          module Type
+            extend ContextDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PHOTOGRAPHY =
+              T.let(
+                :photography,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            ILLUSTRATION =
+              T.let(
+                :illustration,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            LOGO =
+              T.let(
+                :logo,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            WORDMARK =
+              T.let(
+                :wordmark,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            ICON =
+              T.let(
+                :icon,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            PATTERN =
+              T.let(
+                :pattern,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            GRAPHIC =
+              T.let(
+                :graphic,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+            OTHER =
+              T.let(
+                :other,
+                ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
-      # Indicates success
+      # Always true on success.
       module Success
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/resources/brand.rbi

@@ -10,6 +10,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
@@ -21,6 +22,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.
@@ -89,6 +95,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
@@ -101,6 +108,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.
@@ -120,6 +132,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
@@ -132,6 +145,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.
@@ -152,6 +170,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
@@ -166,6 +185,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.
@@ -184,6 +208,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,
@@ -197,6 +222,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.
@@ -217,6 +247,7 @@ module ContextDev
       sig do
         params(
           domain: String,
+          max_age_ms: Integer,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::BrandRetrieveSimplifiedResponse)
@@ -224,6 +255,11 @@ module ContextDev
       def retrieve_simplified(
         # 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).

data/rbi/context_dev/resources/web.rbi

@@ -180,18 +180,27 @@ 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.
+      # 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.
       sig do
         params(
           url: String,
+          enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash,
+          max_age_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::WebWebScrapeImagesResponse)
       end
       def web_scrape_images(
-        # 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

data/sig/context_dev/models/brand_retrieve_by_email_params.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         email: String,
         force_language: ContextDev::Models::BrandRetrieveByEmailParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer
       }
@@ -21,6 +22,10 @@ module ContextDev
         ContextDev::Models::BrandRetrieveByEmailParams::force_language
       ) -> ContextDev::Models::BrandRetrieveByEmailParams::force_language
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -32,6 +37,7 @@ module ContextDev
       def initialize: (
         email: String,
         ?force_language: ContextDev::Models::BrandRetrieveByEmailParams::force_language,
+        ?max_age_ms: Integer,
         ?max_speed: bool,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
@@ -40,6 +46,7 @@ module ContextDev
       def to_hash: -> {
         email: String,
         force_language: ContextDev::Models::BrandRetrieveByEmailParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions

data/sig/context_dev/models/brand_retrieve_by_isin_params.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         isin: String,
         force_language: ContextDev::Models::BrandRetrieveByIsinParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer
       }
@@ -21,6 +22,10 @@ module ContextDev
         ContextDev::Models::BrandRetrieveByIsinParams::force_language
       ) -> ContextDev::Models::BrandRetrieveByIsinParams::force_language
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -32,6 +37,7 @@ module ContextDev
       def initialize: (
         isin: String,
         ?force_language: ContextDev::Models::BrandRetrieveByIsinParams::force_language,
+        ?max_age_ms: Integer,
         ?max_speed: bool,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
@@ -40,6 +46,7 @@ module ContextDev
       def to_hash: -> {
         isin: String,
         force_language: ContextDev::Models::BrandRetrieveByIsinParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions

data/sig/context_dev/models/brand_retrieve_by_name_params.rbs

@@ -5,6 +5,7 @@ module ContextDev
         name: String,
         country_gl: ContextDev::Models::BrandRetrieveByNameParams::country_gl,
         force_language: ContextDev::Models::BrandRetrieveByNameParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer
       }
@@ -28,6 +29,10 @@ module ContextDev
         ContextDev::Models::BrandRetrieveByNameParams::force_language
       ) -> ContextDev::Models::BrandRetrieveByNameParams::force_language
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -40,6 +45,7 @@ module ContextDev
         name: String,
         ?country_gl: ContextDev::Models::BrandRetrieveByNameParams::country_gl,
         ?force_language: ContextDev::Models::BrandRetrieveByNameParams::force_language,
+        ?max_age_ms: Integer,
         ?max_speed: bool,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
@@ -49,6 +55,7 @@ module ContextDev
         name: String,
         country_gl: ContextDev::Models::BrandRetrieveByNameParams::country_gl,
         force_language: ContextDev::Models::BrandRetrieveByNameParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions

data/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         ticker: String,
         force_language: ContextDev::Models::BrandRetrieveByTickerParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         ticker_exchange: ContextDev::Models::BrandRetrieveByTickerParams::ticker_exchange,
         timeout_ms: Integer
@@ -22,6 +23,10 @@ module ContextDev
         ContextDev::Models::BrandRetrieveByTickerParams::force_language
       ) -> ContextDev::Models::BrandRetrieveByTickerParams::force_language
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -39,6 +44,7 @@ module ContextDev
       def initialize: (
         ticker: String,
         ?force_language: ContextDev::Models::BrandRetrieveByTickerParams::force_language,
+        ?max_age_ms: Integer,
         ?max_speed: bool,
         ?ticker_exchange: ContextDev::Models::BrandRetrieveByTickerParams::ticker_exchange,
         ?timeout_ms: Integer,
@@ -48,6 +54,7 @@ module ContextDev
       def to_hash: -> {
         ticker: String,
         force_language: ContextDev::Models::BrandRetrieveByTickerParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         ticker_exchange: ContextDev::Models::BrandRetrieveByTickerParams::ticker_exchange,
         timeout_ms: Integer,

data/sig/context_dev/models/brand_retrieve_params.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         domain: String,
         force_language: ContextDev::Models::BrandRetrieveParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer
       }
@@ -21,6 +22,10 @@ module ContextDev
         ContextDev::Models::BrandRetrieveParams::force_language
       ) -> ContextDev::Models::BrandRetrieveParams::force_language
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -32,6 +37,7 @@ module ContextDev
       def initialize: (
         domain: String,
         ?force_language: ContextDev::Models::BrandRetrieveParams::force_language,
+        ?max_age_ms: Integer,
         ?max_speed: bool,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
@@ -40,6 +46,7 @@ module ContextDev
       def to_hash: -> {
         domain: String,
         force_language: ContextDev::Models::BrandRetrieveParams::force_language,
+        max_age_ms: Integer,
         max_speed: bool,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions

data/sig/context_dev/models/brand_retrieve_simplified_params.rbs

@@ -1,7 +1,7 @@
 module ContextDev
   module Models
     type brand_retrieve_simplified_params =
-      { domain: String, timeout_ms: Integer }
+      { domain: String, max_age_ms: Integer, timeout_ms: Integer }
       & ContextDev::Internal::Type::request_parameters
 
     class BrandRetrieveSimplifiedParams < ContextDev::Internal::Type::BaseModel
@@ -10,18 +10,24 @@ module ContextDev
 
       attr_accessor domain: String
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader timeout_ms: Integer?
 
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
         domain: String,
+        ?max_age_ms: Integer,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
       ) -> void
 
       def to_hash: -> {
         domain: String,
+        max_age_ms: Integer,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions
       }