context.dev 2.14.0 → 2.16.0

data/lib/context_dev/models/web_extract_response.rb

@@ -23,6 +23,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebExtractResponse::Metadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute status
       #   Status of the response, e.g., 'ok'
       #
@@ -42,13 +49,12 @@ module ContextDev
       required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
+      # @!method initialize(cache_metadata:, data:, metadata:, request_id:, status:, url:, urls_analyzed:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractResponse} for more details.
       #
@@ -58,13 +64,15 @@ module ContextDev
       #
       #   @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param url [String] The starting URL that was analyzed
       #
       #   @param urls_analyzed [Array<String>] List of URLs whose Markdown was used for extraction
       #
-      #   @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebExtractResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -247,24 +255,23 @@ module ContextDev
       # @see ContextDev::Models::WebExtractResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_extract_styleguide_params.rb

@@ -41,9 +41,8 @@ module ContextDev
       optional :max_age_ms, Integer, nil?: true
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -68,7 +67,7 @@ module ContextDev
       #
       #   @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_extract_styleguide_response.rb

@@ -12,6 +12,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute code
       #   HTTP status code
       #
@@ -25,8 +32,7 @@ module ContextDev
       optional :domain, String
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata }
@@ -43,17 +49,19 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil]
       optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }
 
-      # @!method initialize(cache_metadata:, code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
+      # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractStyleguideResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param code [Integer] HTTP status code
       #
       #   @param domain [String] The normalized domain that was processed
       #
-      #   @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
@@ -106,24 +114,23 @@ module ContextDev
       # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
 
       # @see ContextDev::Models::WebExtractStyleguideResponse#styleguide

data/lib/context_dev/models/web_screenshot_params.rb

@@ -93,9 +93,8 @@ module ContextDev
       optional :scroll_offset, Integer, nil?: true
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -117,7 +116,8 @@ module ContextDev
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load before taking
       #   the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
-      #   omitted.
+      #   omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
+      #   10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       #
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, nil?: true
@@ -155,7 +155,7 @@ module ContextDev
       #
       #   @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_screenshot_response.rb

@@ -12,6 +12,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebScreenshotResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute code
       #   HTTP status code
       #
@@ -31,8 +38,7 @@ module ContextDev
       optional :height, Integer
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebScreenshotResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
@@ -64,19 +70,21 @@ module ContextDev
       #   @return [Integer, nil]
       optional :width, Integer
 
-      # @!method initialize(cache_metadata:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
+      # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScreenshotResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param code [Integer] HTTP status code
       #
       #   @param domain [String] The normalized domain that was processed
       #
       #   @param height [Integer] Height in pixels of the returned screenshot image
       #
-      #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR is ena
       #
@@ -132,24 +140,23 @@ module ContextDev
       # @see ContextDev::Models::WebScreenshotResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
 
       # Type of screenshot that was captured

data/lib/context_dev/models/web_search_response.rb

@@ -18,6 +18,13 @@ module ContextDev
       #   @return [String]
       required :query, String
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute results
       #
       #   @return [Array<ContextDev::Models::WebSearchResponse::Result>]
@@ -25,13 +32,12 @@ module ContextDev
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result] }
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, query:, results:, key_metadata: nil)
+      # @!method initialize(cache_metadata:, query:, request_id:, results:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebSearchResponse} for more details.
       #
@@ -39,9 +45,11 @@ module ContextDev
       #
       #   @param query [String] Echo of the original query (useful when fanout was enabled).
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
       #
-      #   @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebSearchResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -189,24 +197,23 @@ module ContextDev
       # @see ContextDev::Models::WebSearchResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_web_crawl_md_response.rb

@@ -17,6 +17,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::Metadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute results
       #
       #   @return [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
@@ -24,13 +31,12 @@ module ContextDev
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result] }
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, metadata:, results:, key_metadata: nil)
+      # @!method initialize(cache_metadata:, metadata:, request_id:, results:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdResponse} for more details.
       #
@@ -38,9 +44,11 @@ module ContextDev
       #
       #   @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
       #
-      #   @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebCrawlMdResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -460,24 +468,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebCrawlMdResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_web_scrape_html_params.rb

@@ -84,9 +84,8 @@ module ContextDev
       optional :settle_animations, ContextDev::Internal::Type::Boolean
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -108,7 +107,9 @@ module ContextDev
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
-      #   30000 (30 seconds).
+      #   30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
+      #   waitForMs + 10000 ms; a shorter deadline is rejected with 400
+      #   TIMEOUT_TOO_SHORT_FOR_WAIT.
       #
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, nil?: true
@@ -146,7 +147,7 @@ module ContextDev
       #
       #   @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_web_scrape_html_response.rb

@@ -26,6 +26,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::Metadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Indicates success
       #
@@ -63,13 +70,12 @@ module ContextDev
       optional :actions_html_stale, ContextDev::Internal::Type::Boolean, api_name: :actionsHtmlStale
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
+      # @!method initialize(cache_metadata:, html:, metadata:, request_id:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
       #
@@ -79,6 +85,8 @@ module ContextDev
       #
       #   @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeHTMLResponse::Success] Indicates success
       #
       #   @param type [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa
@@ -89,7 +97,7 @@ module ContextDev
       #
       #   @param actions_html_stale [Boolean] True when an action was applied but the returned content could not be refreshed
       #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebScrapeHTMLResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -526,24 +534,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebScrapeHTMLResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_web_scrape_images_params.rb

@@ -57,9 +57,8 @@ module ContextDev
       optional :max_age_ms, Integer, nil?: true
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -74,7 +73,9 @@ module ContextDev
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load before
-      #   collecting images. Min: 0. Max: 30000 (30 seconds).
+      #   collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
+      #   timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
+      #   is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       #
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, nil?: true
@@ -95,7 +96,7 @@ module ContextDev
       #
       #   @param max_age_ms [Integer, nil] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_web_scrape_images_response.rb

@@ -19,6 +19,13 @@ module ContextDev
       required :images,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Always true on success.
       #
@@ -40,13 +47,12 @@ module ContextDev
                api_name: :actionsApplied
 
       # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, images:, success:, url:, actions_applied: nil, key_metadata: nil)
+      # @!method initialize(cache_metadata:, images:, request_id:, success:, url:, actions_applied: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
       #
@@ -54,13 +60,15 @@ module ContextDev
       #
       #   @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images 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 success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
       #
       #   @param url [String] Page URL that was scraped.
       #
       #   @param actions_applied [Array<ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
       #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebScrapeImagesResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -337,24 +345,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end