context.dev 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ed16d717d86dba3bde7aa2b1e5262ee7dc1e9dc522daee067dcc82c8551942
-  data.tar.gz: 5e80361d8778dc08fb2ba658f1c00e84db050a2675e8465242d25d3af5ddbedf
+  metadata.gz: 84cc2c8157b82ddbf49757ced0e0f6bbc55fb1cf67ffe3db1725bdbf7db89c46
+  data.tar.gz: a1783d6a9fb36f14a61d4c201066e25986249ca36d64f4bfa06e3acfb400ab33
 SHA512:
-  metadata.gz: f709379d128f514ac2ade54ee59c6f1a322f57e763a488d7071fd53e2a651216ab1fa00b1949b6209223a06b2916f1a1bc64976e45dad5e6ed65b826af364e59
-  data.tar.gz: 5dea40e6f474fb5bd0159677850b363dff7c547b02e471f98f85c461d148e158c6305d5df8d2394b4e2019ba1534109f9ffeffbfe8162ec8ac09336011f5965f
+  metadata.gz: c76dc1a666b1765f26e679707344ef82ffc004850e0fa8d1fa9565571a0784a2cfb408c110c3463f4dcd75a2df86d7036178694cd17c39e1d0c93f41a6db2cfa
+  data.tar.gz: 7babec26bd5a654a9c10e2da55ebf39835c2078c8e06ce0f54fd3d1022adb6f65008b7a007594d8ba8547292dc75597bf184a1d499b175936a6f50df1245db0a

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.15.0 (2026-05-06)
+
+Full Changelog: [v1.14.0...v1.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.14.0...v1.15.0)
+
+### Features
+
+* **api:** api update ([42c8282](https://github.com/context-dot-dev/context-ruby-sdk/commit/42c8282f18c421ca317b51c640ea42cc04c61230))
+
+## 1.14.0 (2026-05-06)
+
+Full Changelog: [v1.13.0...v1.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.13.0...v1.14.0)
+
+### Features
+
+* **api:** api update ([58cb73a](https://github.com/context-dot-dev/context-ruby-sdk/commit/58cb73a109e20f296f6a5f256a94d690b1203f70))
+
 ## 1.13.0 (2026-05-05)
 
 Full Changelog: [v1.12.0...v1.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.12.0...v1.13.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 1.13.0"
+gem "context.dev", "~> 1.15.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/models/brand_retrieve_by_email_params.rb

@@ -21,6 +21,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveByEmailParams::ForceLanguage, nil]
       optional :force_language, enum: -> { ContextDev::BrandRetrieveByEmailParams::ForceLanguage }
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute max_speed
       #   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
@@ -37,7 +46,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveByEmailParams} for more details.
       #
@@ -45,6 +54,8 @@ module ContextDev
       #
       #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th

data/lib/context_dev/models/brand_retrieve_by_isin_params.rb

@@ -21,6 +21,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveByIsinParams::ForceLanguage, nil]
       optional :force_language, enum: -> { ContextDev::BrandRetrieveByIsinParams::ForceLanguage }
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute max_speed
       #   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
@@ -37,7 +46,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveByIsinParams} for more details.
       #
@@ -45,6 +54,8 @@ module ContextDev
       #
       #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th

data/lib/context_dev/models/brand_retrieve_by_name_params.rb

@@ -27,6 +27,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveByNameParams::ForceLanguage, nil]
       optional :force_language, enum: -> { ContextDev::BrandRetrieveByNameParams::ForceLanguage }
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute max_speed
       #   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
@@ -43,7 +52,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(name:, country_gl: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveByNameParams} for more details.
       #
@@ -53,6 +62,8 @@ module ContextDev
       #
       #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th

data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb

@@ -20,6 +20,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage, nil]
       optional :force_language, enum: -> { ContextDev::BrandRetrieveByTickerParams::ForceLanguage }
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute max_speed
       #   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
@@ -42,7 +51,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveByTickerParams} for more details.
       #
@@ -50,6 +59,8 @@ module ContextDev
       #
       #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param ticker_exchange [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.

data/lib/context_dev/models/brand_retrieve_params.rb

@@ -20,6 +20,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage, nil]
       optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::ForceLanguage }
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute max_speed
       #   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
@@ -36,7 +45,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveParams} for more details.
       #
@@ -44,6 +53,8 @@ module ContextDev
       #
       #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th

data/lib/context_dev/models/brand_retrieve_simplified_params.rb

@@ -13,6 +13,15 @@ module ContextDev
       #   @return [String]
       required :domain, String
 
+      # @!attribute max_age_ms
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
       # @!attribute timeout_ms
       #   Optional timeout in milliseconds for the request. If the request takes longer
       #   than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -21,12 +30,14 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(domain:, timeout_ms: nil, request_options: {})
+      # @!method initialize(domain:, max_age_ms: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
       #
       #   @param domain [String] Domain name to retrieve simplified brand data for
       #
+      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]

data/lib/context_dev/models/web_web_scrape_images_params.rb

@@ -8,15 +8,78 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute url
-      #   Full URL to scrape images from (must include http:// or https:// protocol)
+      #   Page URL to inspect. Must include http:// or https://.
       #
       #   @return [String]
       required :url, String
 
-      # @!method initialize(url:, request_options: {})
-      #   @param url [String] Full URL to scrape images from (must include http:// or https:// protocol)
+      # @!attribute enrichment
+      #   Optional per-image processing, sent as deep-object query params such as
+      #   enrichment[resolution]=true.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeImagesParams::Enrichment, nil]
+      optional :enrichment, -> { ContextDev::WebWebScrapeImagesParams::Enrichment }
+
+      # @!attribute max_age_ms
+      #   Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
+      #   day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
+      #
+      #   @return [Integer, nil]
+      optional :max_age_ms, Integer
+
+      # @!method initialize(url:, enrichment: nil, max_age_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeImagesParams} for more details.
+      #
+      #   @param url [String] Page URL to inspect. Must include http:// or https://.
+      #
+      #   @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme
+      #
+      #   @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}]
+
+      class Enrichment < ContextDev::Internal::Type::BaseModel
+        # @!attribute classification
+        #   Classify each image by visual asset type.
+        #
+        #   @return [Boolean, nil]
+        optional :classification, ContextDev::Internal::Type::Boolean
+
+        # @!attribute hosted_url
+        #   Host materializable images on the Brand.dev CDN and return their URL and MIME
+        #   type.
+        #
+        #   @return [Boolean, nil]
+        optional :hosted_url, ContextDev::Internal::Type::Boolean, api_name: :hostedUrl
+
+        # @!attribute max_time_per_ms
+        #   Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
+        #
+        #   @return [Integer, nil]
+        optional :max_time_per_ms, Integer, api_name: :maxTimePerMs
+
+        # @!attribute resolution
+        #   Measure image width and height when possible.
+        #
+        #   @return [Boolean, nil]
+        optional :resolution, ContextDev::Internal::Type::Boolean
+
+        # @!method initialize(classification: nil, hosted_url: nil, max_time_per_ms: nil, resolution: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeImagesParams::Enrichment} for more details.
+        #
+        #   Optional per-image processing, sent as deep-object query params such as
+        #   enrichment[resolution]=true.
+        #
+        #   @param classification [Boolean] Classify each image by visual asset type.
+        #
+        #   @param hosted_url [Boolean] Host materializable images on the Brand.dev CDN and return their URL and MIME ty
+        #
+        #   @param max_time_per_ms [Integer] Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
+        #
+        #   @param resolution [Boolean] Measure image width and height when possible.
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_images_response.rb

@@ -5,66 +5,74 @@ module ContextDev
     # @see ContextDev::Resources::Web#web_scrape_images
     class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel
       # @!attribute images
-      #   Array of scraped images
+      #   Images found on the page.
       #
       #   @return [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>]
       required :images,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] }
 
       # @!attribute success
-      #   Indicates success
+      #   Always true on success.
       #
       #   @return [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success]
       required :success, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Success }
 
       # @!attribute url
-      #   The URL that was scraped
+      #   Page URL that was scraped.
       #
       #   @return [String]
       required :url, String
 
       # @!method initialize(images:, success:, url:)
-      #   @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Array of scraped images
+      #   @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images found on the page.
       #
-      #   @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Indicates success
+      #   @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
       #
-      #   @param url [String] The URL that was scraped
+      #   @param url [String] Page URL that was scraped.
 
       class Image < ContextDev::Internal::Type::BaseModel
         # @!attribute alt
-        #   Alt text of the image, or null if not present
+        #   Image alt text, or null when unavailable.
         #
         #   @return [String, nil]
         required :alt, String, nil?: true
 
         # @!attribute element
-        #   The HTML element the image was found in
+        #   Where the image was found.
         #
         #   @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element]
         required :element, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Element }
 
         # @!attribute src
-        #   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.
         #
         #   @return [String]
         required :src, String
 
         # @!attribute type
-        #   The type/format of the src value
+        #   Format of src.
         #
         #   @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type]
         required :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Type }
 
-        # @!method initialize(alt:, element:, src:, type:)
-        #   @param alt [String, nil] Alt text of the image, or null if not present
+        # @!attribute enrichment
+        #   Requested metadata for images that could be processed.
         #
-        #   @param element [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] The HTML element the image was found in
+        #   @return [ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment, nil]
+        optional :enrichment, -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment }
+
+        # @!method initialize(alt:, element:, src:, type:, enrichment: nil)
+        #   @param alt [String, nil] Image alt text, or null when unavailable.
+        #
+        #   @param element [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] Where the image was found.
+        #
+        #   @param src [String] Original image value: URL, inline SVG or HTML, or base64 data URI.
         #
-        #   @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        #   @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] Format of src.
         #
-        #   @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] The type/format of the src value
+        #   @param enrichment [ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment] Requested metadata for images that could be processed.
 
-        # The HTML element the image was found in
+        # Where the image was found.
         #
         # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#element
         module Element
@@ -84,7 +92,7 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
 
-        # The type/format of the src value
+        # Format of src.
         #
         # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#type
         module Type
@@ -97,9 +105,74 @@ module ContextDev
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#enrichment
+        class Enrichment < ContextDev::Internal::Type::BaseModel
+          # @!attribute height
+          #   Image height in pixels, when measured.
+          #
+          #   @return [Integer, nil]
+          optional :height, Integer
+
+          # @!attribute mimetype
+          #   Detected MIME type, when hosted.
+          #
+          #   @return [String, nil]
+          optional :mimetype, String
+
+          # @!attribute type
+          #   Visual asset category, when classified.
+          #
+          #   @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type, nil]
+          optional :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type }
+
+          # @!attribute url
+          #   Brand.dev CDN URL, when hosted.
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!attribute width
+          #   Image width in pixels, when measured.
+          #
+          #   @return [Integer, nil]
+          optional :width, Integer
+
+          # @!method initialize(height: nil, mimetype: nil, type: nil, url: nil, width: nil)
+          #   Requested metadata for images that could be processed.
+          #
+          #   @param height [Integer] Image height in pixels, when measured.
+          #
+          #   @param mimetype [String] Detected MIME type, when hosted.
+          #
+          #   @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type] Visual asset category, when classified.
+          #
+          #   @param url [String] Brand.dev CDN URL, when hosted.
+          #
+          #   @param width [Integer] Image width in pixels, when measured.
+
+          # Visual asset category, when classified.
+          #
+          # @see ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment#type
+          module Type
+            extend ContextDev::Internal::Type::Enum
+
+            PHOTOGRAPHY = :photography
+            ILLUSTRATION = :illustration
+            LOGO = :logo
+            WORDMARK = :wordmark
+            ICON = :icon
+            PATTERN = :pattern
+            GRAPHIC = :graphic
+            OTHER = :other
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
 
-      # Indicates success
+      # Always true on success.
       #
       # @see ContextDev::Models::WebWebScrapeImagesResponse#success
       module Success

data/lib/context_dev/resources/brand.rb

@@ -9,12 +9,14 @@ module ContextDev
       # Retrieve logos, backdrops, colors, industry, description, and more from any
       # domain
       #
-      # @overload retrieve(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
       #
       # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -30,7 +32,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve",
-          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveResponse,
           options: options
         )
@@ -86,12 +88,14 @@ module ContextDev
       # free email addresses. Disposable and free email addresses (like gmail.com,
       # yahoo.com) will throw a 422 error.
       #
-      # @overload retrieve_by_email(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_by_email(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #
       # @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
       #
       # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -107,7 +111,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-by-email",
-          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveByEmailResponse,
           options: options
         )
@@ -119,12 +123,14 @@ module ContextDev
       # Retrieve brand information using an ISIN (International Securities
       # Identification Number).
       #
-      # @overload retrieve_by_isin(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_by_isin(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #
       # @param isin [String] ISIN (International Securities Identification Number) to retrieve brand data for
       #
       # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -140,7 +146,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-by-isin",
-          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveByIsinResponse,
           options: options
         )
@@ -151,7 +157,7 @@ module ContextDev
       #
       # Retrieve brand information using a company name.
       #
-      # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #
       # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
       #
@@ -159,6 +165,8 @@ module ContextDev
       #
       # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -174,7 +182,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-by-name",
-          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveByNameResponse,
           options: options
         )
@@ -185,12 +193,14 @@ module ContextDev
       #
       # Retrieve brand information using a stock ticker symbol.
       #
-      # @overload retrieve_by_ticker(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_by_ticker(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
       #
       # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
       #
       # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param ticker_exchange [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
@@ -208,7 +218,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-by-ticker",
-          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveByTickerResponse,
           options: options
         )
@@ -221,10 +231,12 @@ module ContextDev
       # information: domain, title, colors, logos, and backdrops. Optimized for faster
       # responses and reduced data transfer.
       #
-      # @overload retrieve_simplified(domain:, timeout_ms: nil, request_options: {})
+      # @overload retrieve_simplified(domain:, max_age_ms: nil, timeout_ms: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve simplified brand data for
       #
+      # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -238,7 +250,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-simplified",
-          query: query.transform_keys(timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"),
           model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
           options: options
         )