context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/web_extract_competitors_response.rbi

@@ -25,8 +25,8 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :domain
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
@@ -50,7 +50,7 @@ module ContextDev
       end
       attr_writer :target
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(
           T.nilable(
@@ -98,14 +98,14 @@ module ContextDev
         competitors:,
         # Normalized input domain.
         domain:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
         # Status of the response.
         status:,
         # Target company profile inferred from the landing page.
         target:,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil,
         # True when the timeout ended processing and this response contains only usable
         # results completed so far. Unfinished results are omitted.
@@ -349,7 +349,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -357,14 +357,14 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # Credits used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining:

data/rbi/context_dev/models/web_extract_styleguide_params.rbi

@@ -33,10 +33,7 @@ module ContextDev
       end
       attr_writer :color_scheme
 
-      # A specific URL to fetch the styleguide from directly, bypassing domain
-      # resolution (e.g., 'https://example.com/design-system'). When provided, the
-      # styleguide is extracted from this exact URL. You must provide either 'domain' or
-      # 'directUrl', but not both.
+      # Exact URL to inspect. Provide either `domain` or `directUrl`, not both.
       sig { returns(T.nilable(String)) }
       attr_reader :direct_url
 
@@ -52,24 +49,19 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # Maximum age in milliseconds for cached brand data before the API performs a hard
-      # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
-      # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
-      # are clamped to 1 year.
+      # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
+      # year. `0` refreshes.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
-      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      # characters.
+      # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # Optional request deadline and behavior on timeout. For GET requests, use
-      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      # timeoutOpts object.
+      # Request deadline and what to return when it passes.
       sig do
         returns(T.nilable(ContextDev::WebExtractStyleguideParams::TimeoutOpts))
       end
@@ -83,11 +75,8 @@ module ContextDev
       end
       attr_writer :timeout_opts
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       sig do
         returns(
           T.nilable(ContextDev::WebExtractStyleguideParams::Zdr::OrSymbol)
@@ -118,32 +107,21 @@ module ContextDev
         # Optional browser color scheme to emulate for websites that respond to
         # prefers-color-scheme. This value is part of the styleguide cache key.
         color_scheme: nil,
-        # A specific URL to fetch the styleguide from directly, bypassing domain
-        # resolution (e.g., 'https://example.com/design-system'). When provided, the
-        # styleguide is extracted from this exact URL. You must provide either 'domain' or
-        # 'directUrl', but not both.
+        # Exact URL to inspect. Provide either `domain` or `directUrl`, not both.
         direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated. You must provide either
         # 'domain' or 'directUrl', but not both.
         domain: nil,
-        # Maximum age in milliseconds for cached brand data before the API performs a hard
-        # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
-        # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
-        # are clamped to 1 year.
+        # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
+        # year. `0` refreshes.
         max_age_ms: nil,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         timeout_opts: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )
@@ -209,15 +187,12 @@ module ContextDev
             )
           end
 
-        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        # Deadline in milliseconds.
         sig { returns(Integer) }
         attr_accessor :milliseconds
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
         sig do
           returns(
             T.nilable(
@@ -235,9 +210,7 @@ module ContextDev
         end
         attr_writer :behavior
 
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         sig do
           params(
             milliseconds: Integer,
@@ -246,13 +219,10 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          # Deadline in milliseconds.
           milliseconds:,
-          # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-          # credits. "return-partial" returns usable results collected so far; if none are
-          # available, the request still fails without charging credits. Partial results are
-          # not cached as complete results. "return-partial" requires milliseconds of at
-          # least 5000.
+          # "fail" returns 408 at the deadline. "return-partial" returns available results;
+          # inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
           behavior: nil
         )
         end
@@ -269,11 +239,8 @@ module ContextDev
         def to_hash
         end
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
         module Behavior
           extend ContextDev::Internal::Type::Enum
 
@@ -309,11 +276,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/web_extract_styleguide_response.rbi

@@ -11,9 +11,7 @@ module ContextDev
           )
         end
 
-      # Cache outcome for this response. Composite responses are hits only when every
-      # cache-controlled fetch contributing to the output was a hit; age_ms is the
-      # oldest contributing hit.
+      # Whether this response came from cache.
       sig do
         returns(ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata)
       end
@@ -27,8 +25,8 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
@@ -46,11 +44,8 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
+      # `loaded`, or `still-loading` when capture ended before the page finished
+      # loading.
       sig do
         returns(
           T.nilable(
@@ -68,7 +63,7 @@ module ContextDev
       end
       attr_writer :final_dom_state
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(
           T.nilable(
@@ -86,7 +81,7 @@ module ContextDev
       end
       attr_writer :key_metadata
 
-      # Status of the response, e.g., 'ok'
+      # Always `ok` on success.
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -128,26 +123,21 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
+        # Whether this response came from cache.
         cache_metadata:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
         # HTTP status code
         code: nil,
         # The normalized domain that was processed
         domain: nil,
-        # How complete the returned content is. `loaded` means the page finished the waits
-        # the request asked for. `still-loading` only occurs with
-        # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-        # reached first, so the content reflects the DOM at that moment and late-rendering
-        # parts may be missing. Partial results are billed at the base request cost.
+        # `loaded`, or `still-loading` when capture ended before the page finished
+        # loading.
         final_dom_state: nil,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil,
-        # Status of the response, e.g., 'ok'
+        # Always `ok` on success.
         status: nil,
         # Comprehensive styleguide data extracted from the website
         styleguide: nil
@@ -197,9 +187,7 @@ module ContextDev
         end
         attr_accessor :status
 
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
+        # Whether this response came from cache.
         sig do
           params(
             age_ms: Integer,
@@ -270,11 +258,8 @@ module ContextDev
         end
       end
 
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
+      # `loaded`, or `still-loading` when capture ended before the page finished
+      # loading.
       module FinalDomState
         extend ContextDev::Internal::Type::Enum
 
@@ -318,7 +303,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -326,14 +311,14 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # Credits used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining:
@@ -782,7 +767,7 @@ module ContextDev
               sig { returns(String) }
               attr_accessor :min_height
 
-              # Sampled minimum width of the button box (typically px)
+              # Minimum width (usually px).
               sig { returns(String) }
               attr_accessor :min_width
 
@@ -851,7 +836,7 @@ module ContextDev
                 font_weight:,
                 # Sampled minimum height of the button box (typically px)
                 min_height:,
-                # Sampled minimum width of the button box (typically px)
+                # Minimum width (usually px).
                 min_width:,
                 padding:,
                 text_decoration:,
@@ -938,7 +923,7 @@ module ContextDev
               sig { returns(String) }
               attr_accessor :min_height
 
-              # Sampled minimum width of the button box (typically px)
+              # Minimum width (usually px).
               sig { returns(String) }
               attr_accessor :min_width
 
@@ -1007,7 +992,7 @@ module ContextDev
                 font_weight:,
                 # Sampled minimum height of the button box (typically px)
                 min_height:,
-                # Sampled minimum width of the button box (typically px)
+                # Minimum width (usually px).
                 min_width:,
                 padding:,
                 text_decoration:,
@@ -1094,7 +1079,7 @@ module ContextDev
               sig { returns(String) }
               attr_accessor :min_height
 
-              # Sampled minimum width of the button box (typically px)
+              # Minimum width (usually px).
               sig { returns(String) }
               attr_accessor :min_width
 
@@ -1163,7 +1148,7 @@ module ContextDev
                 font_weight:,
                 # Sampled minimum height of the button box (typically px)
                 min_height:,
-                # Sampled minimum width of the button box (typically px)
+                # Minimum width (usually px).
                 min_width:,
                 padding:,
                 text_decoration:,
@@ -1725,7 +1710,7 @@ module ContextDev
               sig { returns(T::Array[String]) }
               attr_accessor :font_fallbacks
 
-              # Primary face (first family in the computed stack)
+              # First font in the stack.
               sig { returns(String) }
               attr_accessor :font_family
 
@@ -1754,7 +1739,7 @@ module ContextDev
               def self.new(
                 # Full ordered font list from resolved computed font-family
                 font_fallbacks:,
-                # Primary face (first family in the computed stack)
+                # First font in the stack.
                 font_family:,
                 font_size:,
                 font_weight:,
@@ -1792,7 +1777,7 @@ module ContextDev
               sig { returns(T::Array[String]) }
               attr_accessor :font_fallbacks
 
-              # Primary face (first family in the computed stack)
+              # First font in the stack.
               sig { returns(String) }
               attr_accessor :font_family
 
@@ -1821,7 +1806,7 @@ module ContextDev
               def self.new(
                 # Full ordered font list from resolved computed font-family
                 font_fallbacks:,
-                # Primary face (first family in the computed stack)
+                # First font in the stack.
                 font_family:,
                 font_size:,
                 font_weight:,
@@ -1859,7 +1844,7 @@ module ContextDev
               sig { returns(T::Array[String]) }
               attr_accessor :font_fallbacks
 
-              # Primary face (first family in the computed stack)
+              # First font in the stack.
               sig { returns(String) }
               attr_accessor :font_family
 
@@ -1888,7 +1873,7 @@ module ContextDev
               def self.new(
                 # Full ordered font list from resolved computed font-family
                 font_fallbacks:,
-                # Primary face (first family in the computed stack)
+                # First font in the stack.
                 font_family:,
                 font_size:,
                 font_weight:,
@@ -1926,7 +1911,7 @@ module ContextDev
               sig { returns(T::Array[String]) }
               attr_accessor :font_fallbacks
 
-              # Primary face (first family in the computed stack)
+              # First font in the stack.
               sig { returns(String) }
               attr_accessor :font_family
 
@@ -1955,7 +1940,7 @@ module ContextDev
               def self.new(
                 # Full ordered font list from resolved computed font-family
                 font_fallbacks:,
-                # Primary face (first family in the computed stack)
+                # First font in the stack.
                 font_family:,
                 font_size:,
                 font_weight:,
@@ -1994,7 +1979,7 @@ module ContextDev
             sig { returns(T::Array[String]) }
             attr_accessor :font_fallbacks
 
-            # Primary face (first family in the computed stack)
+            # First font in the stack.
             sig { returns(String) }
             attr_accessor :font_family
 
@@ -2023,7 +2008,7 @@ module ContextDev
             def self.new(
               # Full ordered font list from resolved computed font-family
               font_fallbacks:,
-              # Primary face (first family in the computed stack)
+              # First font in the stack.
               font_family:,
               font_size:,
               font_weight:,