context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/web_screenshot_params.rbi

@@ -38,8 +38,7 @@ module ContextDev
       end
       attr_writer :color_scheme
 
-      # Fetch the target page through a residential proxy in this country (ISO 3166-1
-      # alpha-2).
+      # Fetch from this country (ISO 3166-1 alpha-2).
       sig do
         returns(T.nilable(ContextDev::WebScreenshotParams::Country::OrSymbol))
       end
@@ -136,17 +135,14 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :scroll_offset
 
-      # 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 { returns(T.nilable(ContextDev::WebScreenshotParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
@@ -174,11 +170,8 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :wait_for_ms
 
-      # 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 { returns(T.nilable(ContextDev::WebScreenshotParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -217,8 +210,7 @@ module ContextDev
         # Optional parameter to choose the site's visual theme in the screenshot. Use
         # 'light' or 'dark' when the site offers both appearances.
         color_scheme: nil,
-        # Fetch the target page through a residential proxy in this country (ISO 3166-1
-        # alpha-2).
+        # Fetch from this country (ISO 3166-1 alpha-2).
         country: nil,
         # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
         # 'https://example.com/pricing'). When provided, the screenshot is taken of this
@@ -261,12 +253,9 @@ module ContextDev
         # top to bottom). The final slice may be shorter than the viewport height. Takes
         # precedence over fullScreenshot. Max: 100000.
         scroll_offset: 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,
         # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
         viewport: nil,
@@ -276,11 +265,8 @@ module ContextDev
         # least waitForMs + 10000 ms; a shorter deadline is rejected with 400
         # TIMEOUT_TOO_SHORT_FOR_WAIT.
         wait_for_ms: 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: {}
       )
@@ -345,8 +331,7 @@ module ContextDev
         end
       end
 
-      # Fetch the target page through a residential proxy in this country (ISO 3166-1
-      # alpha-2).
+      # Fetch from this country (ISO 3166-1 alpha-2).
       module Country
         extend ContextDev::Internal::Type::Enum
 
@@ -650,15 +635,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(
@@ -676,9 +658,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,
@@ -687,13 +667,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
@@ -710,11 +687,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
 
@@ -790,11 +764,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_screenshot_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 { returns(ContextDev::Models::WebScreenshotResponse::CacheMetadata) }
       attr_reader :cache_metadata
 
@@ -25,8 +23,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
 
@@ -44,11 +42,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(
@@ -73,7 +68,7 @@ module ContextDev
       sig { params(height: Integer).void }
       attr_writer :height
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(
           T.nilable(ContextDev::Models::WebScreenshotResponse::KeyMetadata)
@@ -115,7 +110,7 @@ module ContextDev
       end
       attr_writer :screenshot_type
 
-      # Status of the response, e.g., 'ok'
+      # Always `ok` on success.
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -149,33 +144,28 @@ 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,
         # Height in pixels of the returned screenshot image
         height: nil,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil,
         # Public image URL for standard requests, or an in-memory data URL when ZDR or
         # non-empty custom headers are supplied.
         screenshot: nil,
         # Type of screenshot that was captured
         screenshot_type: nil,
-        # Status of the response, e.g., 'ok'
+        # Always `ok` on success.
         status: nil,
         # Width in pixels of the returned screenshot image
         width: nil
@@ -228,9 +218,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,
@@ -301,11 +289,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
 
@@ -349,7 +334,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -357,14 +342,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: