context.dev 2.17.1 → 2.19.0

data/rbi/context_dev/models/web_screenshot_params.rbi

@@ -95,6 +95,19 @@ module ContextDev
       sig { params(handle_cookie_popup: T::Boolean).void }
       attr_writer :handle_cookie_popup
 
+      # Optional outbound HTTP headers, using the same JSON object or deep-object query
+      # format as other scrape endpoints (for example headers[Authorization]=Bearer
+      # token). Headers are scoped to the target origin during capture. For domain/page
+      # requests, discovery receives no custom headers and only pages on the resolved
+      # origin are eligible. Non-empty headers bypass screenshot caching and return an
+      # in-memory data URL; no screenshot is uploaded. Empty objects behave like omitted
+      # headers.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :headers
+
+      sig { params(headers: T::Hash[Symbol, String]).void }
+      attr_writer :headers
+
       # Return a cached screenshot if a prior screenshot for the same parameters exists
       # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
       # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
@@ -162,9 +175,10 @@ module ContextDev
       attr_accessor :wait_for_ms
 
       # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. 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.
+      # 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.
       sig { returns(T.nilable(ContextDev::WebScreenshotParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -181,6 +195,7 @@ module ContextDev
           full_screenshot:
             ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol,
           handle_cookie_popup: T::Boolean,
+          headers: T::Hash[Symbol, String],
           max_age_ms: T.nilable(Integer),
           page: ContextDev::WebScreenshotParams::Page::OrSymbol,
           scroll_offset: T.nilable(Integer),
@@ -221,6 +236,14 @@ module ContextDev
         # dismiss cookie banner before capture. If 'false' or not provided, captures the
         # page without that step.
         handle_cookie_popup: nil,
+        # Optional outbound HTTP headers, using the same JSON object or deep-object query
+        # format as other scrape endpoints (for example headers[Authorization]=Bearer
+        # token). Headers are scoped to the target origin during capture. For domain/page
+        # requests, discovery receives no custom headers and only pages on the resolved
+        # origin are eligible. Non-empty headers bypass screenshot caching and return an
+        # in-memory data URL; no screenshot is uploaded. Empty objects behave like omitted
+        # headers.
+        headers: nil,
         # Return a cached screenshot if a prior screenshot for the same parameters exists
         # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
         # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
@@ -254,9 +277,10 @@ module ContextDev
         # 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. 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.
+        # 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.
         zdr: nil,
         request_options: {}
       )
@@ -274,6 +298,7 @@ module ContextDev
             full_screenshot:
               ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol,
             handle_cookie_popup: T::Boolean,
+            headers: T::Hash[Symbol, String],
             max_age_ms: T.nilable(Integer),
             page: ContextDev::WebScreenshotParams::Page::OrSymbol,
             scroll_offset: T.nilable(Integer),
@@ -633,7 +658,7 @@ module ContextDev
         # 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 15000.
+        # least 5000.
         sig do
           returns(
             T.nilable(
@@ -668,7 +693,7 @@ module ContextDev
           # 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 15000.
+          # least 5000.
           behavior: nil
         )
         end
@@ -689,7 +714,7 @@ module ContextDev
         # 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 15000.
+        # least 5000.
         module Behavior
           extend ContextDev::Internal::Type::Enum
 
@@ -766,9 +791,10 @@ module ContextDev
       end
 
       # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. 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.
+      # 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.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/web_screenshot_response.rbi

@@ -89,8 +89,8 @@ module ContextDev
       end
       attr_writer :key_metadata
 
-      # Public image URL for standard requests, or an in-memory data URL when ZDR is
-      # enabled.
+      # Public image URL for standard requests, or an in-memory data URL when ZDR or
+      # non-empty custom headers are supplied.
       sig { returns(T.nilable(String)) }
       attr_reader :screenshot
 
@@ -170,8 +170,8 @@ module ContextDev
         height: nil,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
-        # Public image URL for standard requests, or an in-memory data URL when ZDR is
-        # enabled.
+        # 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,

data/rbi/context_dev/models/web_search_params.rbi

@@ -98,6 +98,17 @@ 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.
+      sig { returns(T.nilable(ContextDev::WebSearchParams::Zdr::OrSymbol)) }
+      attr_reader :zdr
+
+      sig { params(zdr: ContextDev::WebSearchParams::Zdr::OrSymbol).void }
+      attr_writer :zdr
+
       sig do
         params(
           query: String,
@@ -111,6 +122,7 @@ module ContextDev
           query_fanout: T::Boolean,
           tags: T::Array[String],
           timeout_opts: ContextDev::WebSearchParams::TimeoutOpts::OrHash,
+          zdr: ContextDev::WebSearchParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -141,6 +153,12 @@ module ContextDev
         # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
         # timeoutOpts object.
         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.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -158,6 +176,7 @@ module ContextDev
             query_fanout: T::Boolean,
             tags: T::Array[String],
             timeout_opts: ContextDev::WebSearchParams::TimeoutOpts,
+            zdr: ContextDev::WebSearchParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -699,7 +718,7 @@ module ContextDev
           # 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 15000.
+          # least 5000.
           sig do
             returns(
               T.nilable(
@@ -734,7 +753,7 @@ module ContextDev
             # 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 15000.
+            # least 5000.
             behavior: nil
           )
           end
@@ -755,7 +774,7 @@ module ContextDev
           # 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 15000.
+          # least 5000.
           module Behavior
             extend ContextDev::Internal::Type::Enum
 
@@ -894,6 +913,32 @@ module ContextDev
           end
         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.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebSearchParams::Zdr) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENABLED =
+          T.let(:enabled, ContextDev::WebSearchParams::Zdr::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, ContextDev::WebSearchParams::Zdr::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebSearchParams::Zdr::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models.rbi

@@ -1,10 +1,6 @@
 # typed: strong
 
 module ContextDev
-  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
-
-  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
-
   BatchCancelParams = ContextDev::Models::BatchCancelParams
 
   BatchDeleteParams = ContextDev::Models::BatchDeleteParams
@@ -19,9 +15,6 @@ module ContextDev
 
   BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
 
-  BrandRetrieveSimplifiedParams =
-    ContextDev::Models::BrandRetrieveSimplifiedParams
-
   BrandSearchParams = ContextDev::Models::BrandSearchParams
 
   CrawlControls = ContextDev::Models::CrawlControls
@@ -62,6 +55,11 @@ module ContextDev
 
   MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
 
+  MonitorRetrieveRunParams = ContextDev::Models::MonitorRetrieveRunParams
+
+  MonitorRotateWebhookSecretParams =
+    ContextDev::Models::MonitorRotateWebhookSecretParams
+
   MonitorRunParams = ContextDev::Models::MonitorRunParams
 
   MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
@@ -82,29 +80,19 @@ module ContextDev
 
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
 
-  WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
-
-  WebExtractParams = ContextDev::Models::WebExtractParams
-
   WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams
 
   WebhookDelivery = ContextDev::Models::WebhookDelivery
 
   Webhooks = ContextDev::Models::Webhooks
 
+  WebMapURLsParams = ContextDev::Models::WebMapURLsParams
+
+  WebScrapeParams = ContextDev::Models::WebScrapeParams
+
   WebScreenshotParams = ContextDev::Models::WebScreenshotParams
 
   WebSearchParams = ContextDev::Models::WebSearchParams
 
   WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
-
-  WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
-
-  WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
-
-  WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams
-
-  WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams
-
-  WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams
 end

data/rbi/context_dev/resources/brand.rbi

@@ -29,41 +29,6 @@ module ContextDev
       )
       end
 
-      # Returns a simplified version of brand data containing only essential
-      # information: domain, title, colors, logos, and backdrops. Optimized for faster
-      # responses and reduced data transfer.
-      sig do
-        params(
-          domain: String,
-          max_age_ms: T.nilable(Integer),
-          tags: T::Array[String],
-          theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
-          timeout_opts:
-            ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::OrHash,
-          request_options: ContextDev::RequestOptions::OrHash
-        ).returns(ContextDev::Models::BrandRetrieveSimplifiedResponse)
-      end
-      def retrieve_simplified(
-        # Domain name to retrieve simplified brand data for
-        domain:,
-        # Maximum age in milliseconds for cached brand data before the API performs a hard
-        # refresh. Defaults to 3 months (7776000000 ms). 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.
-        max_age_ms: nil,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
-        tags: nil,
-        # Optional theme preference used when selecting brand assets.
-        theme: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
-        timeout_opts: nil,
-        request_options: {}
-      )
-      end
-
       # Search indexed brands by name or domain
       sig do
         params(

data/rbi/context_dev/resources/industry.rbi

@@ -12,6 +12,7 @@ module ContextDev
           tags: T::Array[String],
           timeout_opts:
             ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::OrHash,
+          zdr: ContextDev::IndustryRetrieveNaicsParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::IndustryRetrieveNaicsResponse)
       end
@@ -32,6 +33,12 @@ module ContextDev
         # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
         # timeoutOpts object.
         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.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -48,6 +55,7 @@ module ContextDev
           timeout_opts:
             ContextDev::IndustryRetrieveSicParams::TimeoutOpts::OrHash,
           type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
+          zdr: ContextDev::IndustryRetrieveSicParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::IndustryRetrieveSicResponse)
       end
@@ -71,6 +79,12 @@ module ContextDev
         # Industrial Classification system; `latest_sec` uses the current SIC list as
         # published by the SEC. Defaults to `original_sic`.
         type: 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.
+        zdr: nil,
         request_options: {}
       )
       end

data/rbi/context_dev/resources/monitors.rbi

@@ -311,6 +311,30 @@ module ContextDev
       def retrieve_change(change_id, request_options: {})
       end
 
+      # Fetches one run for a monitor, including lifecycle status, timing, credits
+      # charged, and any detected change.
+      sig do
+        params(
+          run_id: String,
+          monitor_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::MonitorRetrieveRunResponse)
+      end
+      def retrieve_run(run_id, monitor_id:, request_options: {})
+      end
+
+      # Generates a new signing secret for the monitor's webhook and returns the updated
+      # monitor (including the new `webhook.secret`). The previous secret stops signing
+      # deliveries immediately, so update your endpoint before rotating.
+      sig do
+        params(
+          monitor_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::MonitorRotateWebhookSecretResponse)
+      end
+      def rotate_webhook_secret(monitor_id, request_options: {})
+      end
+
       # Triggers an immediate run of the monitor outside its normal schedule. The run is
       # queued and processed asynchronously.
       sig do

data/rbi/context_dev/resources/parse.rbi

@@ -50,10 +50,10 @@ module ContextDev
         # Query param: Extract only the main content from HTML-like inputs
         use_main_content_only: nil,
         # Query param: Set to enabled to bypass shared caches and omit request and
-        # response content from retained usage logs. 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.
+        # 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.
         zdr: nil,
         request_options: {}
       )

data/rbi/context_dev/resources/people.rbi

@@ -18,6 +18,7 @@ module ContextDev
           social_urls: T::Array[String],
           tags: T::Array[String],
           timeout_opts: ContextDev::PersonEnrichParams::TimeoutOpts::OrHash,
+          zdr: ContextDev::PersonEnrichParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::PersonEnrichResponse)
       end
@@ -34,6 +35,12 @@ module ContextDev
         # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
         # timeoutOpts object.
         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.
+        zdr: nil,
         request_options: {}
       )
       end