context.dev 2.18.0 → 2.20.0

data/lib/context_dev/models/web_screenshot_params.rb

@@ -63,6 +63,18 @@ module ContextDev
       #   @return [Boolean, nil]
       optional :handle_cookie_popup, ContextDev::Internal::Type::Boolean
 
+      # @!attribute headers
+      #   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.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, ContextDev::Internal::Type::HashOf[String]
+
       # @!attribute max_age_ms
       #   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
@@ -133,7 +145,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebScreenshotParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }
 
-      # @!method initialize(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @!method initialize(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, headers: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScreenshotParams} for more details.
       #
@@ -151,6 +163,8 @@ module ContextDev
       #
       #   @param handle_cookie_popup [Boolean] Optional parameter to control cookie/consent popup handling. If 'true', we dismi
       #
+      #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers, using the same JSON object or deep-object query
+      #
       #   @param max_age_ms [Integer, nil] Return a cached screenshot if a prior screenshot for the same parameters exists
       #
       #   @param page [Symbol, ContextDev::Models::WebScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy

data/lib/context_dev/models/web_screenshot_response.rb

@@ -56,8 +56,8 @@ module ContextDev
       optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
 
       # @!attribute screenshot
-      #   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.
       #
       #   @return [String, nil]
       optional :screenshot, String
@@ -100,7 +100,7 @@ module ContextDev
       #
       #   @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
+      #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR or non
       #
       #   @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
       #

data/lib/context_dev/models.rb

@@ -39,10 +39,6 @@ module ContextDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
-
-  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
-
   BatchCancelParams = ContextDev::Models::BatchCancelParams
 
   BatchDeleteParams = ContextDev::Models::BatchDeleteParams
@@ -57,8 +53,6 @@ module ContextDev
 
   BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
 
-  BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
-
   BrandSearchParams = ContextDev::Models::BrandSearchParams
 
   CrawlControls = ContextDev::Models::CrawlControls
@@ -97,6 +91,10 @@ module ContextDev
 
   MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
 
+  MonitorRetrieveRunParams = ContextDev::Models::MonitorRetrieveRunParams
+
+  MonitorRotateWebhookSecretParams = ContextDev::Models::MonitorRotateWebhookSecretParams
+
   MonitorRunParams = ContextDev::Models::MonitorRunParams
 
   MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
@@ -117,31 +115,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
-
-  WebWebScrapeScreenshotParams = ContextDev::Models::WebWebScrapeScreenshotParams
-
-  WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams
 end

data/lib/context_dev/resources/brand.rb

@@ -29,42 +29,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
-      #
-      # 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.
-      #
-      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
-      #
-      # @param domain [String] Domain name to retrieve simplified brand data for
-      #
-      # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
-      #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
-      #
-      # @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
-      #
-      # @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandRetrieveSimplifiedResponse]
-      #
-      # @see ContextDev::Models::BrandRetrieveSimplifiedParams
-      def retrieve_simplified(params)
-        parsed, options = ContextDev::BrandRetrieveSimplifiedParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/retrieve-simplified",
-          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_opts: "timeoutOpts"),
-          model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandSearchParams} for more details.
       #

data/lib/context_dev/resources/monitors.rb

@@ -360,6 +360,53 @@ module ContextDev
         )
       end
 
+      # Fetches one run for a monitor, including lifecycle status, timing, credits
+      # charged, and any detected change.
+      #
+      # @overload retrieve_run(run_id, monitor_id:, request_options: {})
+      #
+      # @param run_id [String]
+      # @param monitor_id [String]
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::MonitorRetrieveRunResponse]
+      #
+      # @see ContextDev::Models::MonitorRetrieveRunParams
+      def retrieve_run(run_id, params)
+        parsed, options = ContextDev::MonitorRetrieveRunParams.dump_request(params)
+        monitor_id =
+          parsed.delete(:monitor_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["monitors/%1$s/runs/%2$s", monitor_id, run_id],
+          model: ContextDev::Models::MonitorRetrieveRunResponse,
+          options: 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.
+      #
+      # @overload rotate_webhook_secret(monitor_id, request_options: {})
+      #
+      # @param monitor_id [String]
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::MonitorRotateWebhookSecretResponse]
+      #
+      # @see ContextDev::Models::MonitorRotateWebhookSecretParams
+      def rotate_webhook_secret(monitor_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["monitors/%1$s/webhook/rotate-secret", monitor_id],
+          model: ContextDev::Models::MonitorRotateWebhookSecretResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Triggers an immediate run of the monitor outside its normal schedule. The run is
       # queued and processed asynchronously.
       #