context.dev 2.8.0 → 2.10.0

data/rbi/context_dev/resources/web.rbi

@@ -196,11 +196,7 @@ module ContextDev
           domain: String,
           full_screenshot:
             ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol,
-          handle_cookie_popup:
-            T.any(
-              T::Boolean,
-              ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
-            ),
+          handle_cookie_popup: T::Boolean,
           max_age_ms: T.nilable(Integer),
           page: ContextDev::WebScreenshotParams::Page::OrSymbol,
           scroll_offset: T.nilable(Integer),
@@ -439,26 +435,14 @@ module ContextDev
           country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol,
           exclude_selectors: T.nilable(T::Array[String]),
           headers: T::Hash[Symbol, String],
-          include_frames:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::OrSymbol
-            ),
+          include_frames: T::Boolean,
           include_selectors: T.nilable(T::Array[String]),
           max_age_ms: T.nilable(Integer),
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
-          settle_animations:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::OrSymbol
-            ),
+          settle_animations: T::Boolean,
           tags: T::Array[String],
           timeout_ms: Integer,
-          use_main_content_only:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::OrSymbol
-            ),
+          use_main_content_only: T::Boolean,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebWebScrapeHTMLParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -539,11 +523,7 @@ module ContextDev
                 )
               ]
             ),
-          dedupe:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeImagesParams::Dedupe::OrSymbol
-            ),
+          dedupe: T::Boolean,
           enrichment:
             T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash),
           headers: T::Hash[Symbol, String],
@@ -595,18 +575,31 @@ module ContextDev
       # responses from a recognized API key; use error_code to distinguish stable
       # failure categories.
       #
+      # ### YouTube
+      #
+      # YouTube URLs return the video or channel itself rather than the surrounding
+      # player and navigation chrome. A URL addressing a single video (`/watch`,
+      # `youtu.be`, `/shorts`, `/embed`, `/live`) returns its title, channel, duration,
+      # view count, keywords, full description, and the transcript when the video has
+      # captions that can be retrieved; videos without captions return everything except
+      # the transcript. A channel URL (`/channel/UC…`, `/@handle`, `/c/…`, `/user/…`)
+      # returns its name, handle, subscriber count, video count, and full description.
+      # When `includeImages=true`, video responses also include the thumbnail and
+      # channel responses include the avatar. Costs the same as any other scrape.
+      #
       # ### Billing & errors
       #
-      # | HTTP status | Billed?                                   | Meaning                                                                                  |
-      # | ----------- | ----------------------------------------- | ---------------------------------------------------------------------------------------- |
-      # | 200         | Yes — 1 credit, or 2 credits with actions | Successful scrape, including a zero-length result when includeSelectors matched nothing  |
-      # | 400         | No                                        | Invalid input, skipped PDF, or the page could not be scraped                             |
-      # | 401 / 403   | No                                        | Invalid/disabled key, insufficient permissions, or credits exhausted; inspect error_code |
-      # | 404         | No                                        | Target page returned or fingerprinted as not found                                       |
-      # | 408         | No                                        | Request timed out                                                                        |
-      # | 415         | No                                        | Unsupported content type                                                                 |
-      # | 429         | No                                        | Per-minute rate limit exceeded; honor Retry-After                                        |
-      # | 500         | No                                        | Internal error                                                                           |
+      # | HTTP status | Billed?                                   | Meaning                                                                                                                                                                                                                                                                                                       |
+      # | ----------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+      # | 200         | Yes — 1 credit, or 2 credits with actions | Successful scrape, including a zero-length result when includeSelectors matched nothing                                                                                                                                                                                                                       |
+      # | 400         | No                                        | Invalid input, skipped PDF, or the page could not be scraped. error_code WEBSITE_BLOCKED specifically means the site answered with an anti-bot challenge, CAPTCHA wall, or login shell instead of the page (even when the site returned HTTP 200) — retrying later or from another country sometimes succeeds |
+      # | 401 / 403   | No                                        | Invalid/disabled key, insufficient permissions, or credits exhausted; inspect error_code                                                                                                                                                                                                                      |
+      # | 404         | No                                        | Target page returned or fingerprinted as not found                                                                                                                                                                                                                                                            |
+      # | 408         | No                                        | Request timed out                                                                                                                                                                                                                                                                                             |
+      # | 413         | No                                        | Target content exceeds the maximum supported size (20 MB)                                                                                                                                                                                                                                                     |
+      # | 415         | No                                        | Unsupported content type                                                                                                                                                                                                                                                                                      |
+      # | 429         | No                                        | Per-minute rate limit exceeded; honor Retry-After                                                                                                                                                                                                                                                             |
+      # | 500         | No                                        | Internal error                                                                                                                                                                                                                                                                                                |
       sig do
         params(
           url: String,
@@ -622,41 +615,18 @@ module ContextDev
           country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol,
           exclude_selectors: T.nilable(T::Array[String]),
           headers: T::Hash[Symbol, String],
-          include_frames:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::IncludeFrames::OrSymbol
-            ),
-          include_images:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::IncludeImages::OrSymbol
-            ),
-          include_links:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::IncludeLinks::OrSymbol
-            ),
+          include_frames: T::Boolean,
+          include_html: T::Boolean,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
           include_selectors: T.nilable(T::Array[String]),
           max_age_ms: T.nilable(Integer),
           pdf: ContextDev::WebWebScrapeMdParams::Pdf::OrHash,
-          settle_animations:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::SettleAnimations::OrSymbol
-            ),
-          shorten_base64_images:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::ShortenBase64Images::OrSymbol
-            ),
+          settle_animations: T::Boolean,
+          shorten_base64_images: T::Boolean,
           tags: T::Array[String],
           timeout_ms: Integer,
-          use_main_content_only:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeMdParams::UseMainContentOnly::OrSymbol
-            ),
+          use_main_content_only: T::Boolean,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -683,6 +653,10 @@ module ContextDev
         headers: nil,
         # When true, the contents of iframes are rendered to Markdown.
         include_frames: nil,
+        # When true, the response also includes an `html` field with the page HTML the
+        # Markdown was converted from — the same body the Scrape HTML endpoint returns for
+        # the equivalent request.
+        include_html: nil,
         # Include image references in Markdown output
         include_images: nil,
         # Preserve hyperlinks in Markdown output
@@ -727,12 +701,17 @@ module ContextDev
       )
       end
 
-      # Crawl an entire website's sitemap and return all discovered page URLs.
+      # Crawl an entire website's sitemap and return all discovered page URLs. Pass
+      # `search` to have the crawled sitemap filtered down to the pages about a phrase
+      # (for example `pricing and plans` or `api authentication docs`), most relevant
+      # first — a searched crawl scans the whole sitemap and costs 2 credits instead
+      # of 1.
       sig do
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
           max_links: Integer,
+          search: String,
           sitemap_url: String,
           tags: T::Array[String],
           timeout_ms: Integer,
@@ -751,6 +730,10 @@ module ContextDev
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
+        # Optional search phrase. When provided, the crawled sitemap is filtered to the
+        # pages whose URLs are about that phrase, most relevant first, and the request
+        # costs 2 credits instead of 1.
+        search: nil,
         # Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
         # instead of discovering the domain's sitemaps.
         sitemap_url: nil,

data/sig/context_dev/client.rbs

@@ -26,6 +26,10 @@ module ContextDev
 
     attr_reader batch: ContextDev::Resources::Batch
 
+    attr_reader people: ContextDev::Resources::People
+
+    attr_reader news: ContextDev::Resources::News
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/context_dev/models/batch_delete_params.rbs

@@ -0,0 +1,23 @@
+module ContextDev
+  module Models
+    type batch_delete_params =
+      { batch_id: String } & ContextDev::Internal::Type::request_parameters
+
+    class BatchDeleteParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      attr_accessor batch_id: String
+
+      def initialize: (
+        batch_id: String,
+        ?request_options: ContextDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        batch_id: String,
+        request_options: ContextDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/context_dev/models/batch_delete_response.rbs

@@ -0,0 +1,57 @@
+module ContextDev
+  module Models
+    type batch_delete_response =
+      {
+        id: String,
+        deleted: bool,
+        key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata
+      }
+
+    class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader deleted: bool?
+
+      def deleted=: (bool) -> bool
+
+      attr_reader key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::BatchDeleteResponse::KeyMetadata
+      ) -> ContextDev::Models::BatchDeleteResponse::KeyMetadata
+
+      def initialize: (
+        ?id: String,
+        ?deleted: bool,
+        ?key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        deleted: bool,
+        key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata
+      }
+
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
+    end
+  end
+end

data/sig/context_dev/models/batch_get_results_response.rbs

@@ -58,7 +58,8 @@ module ContextDev
             html: String,
             item_id: String,
             markdown: String,
-            meta: ::Hash[Symbol, top]
+            meta: ::Hash[Symbol, top],
+            ocr_pages: Integer
           }
 
         class Ok < ContextDev::Internal::Type::BaseModel
@@ -88,6 +89,10 @@ module ContextDev
 
           def meta=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
+          attr_reader ocr_pages: Integer?
+
+          def ocr_pages=: (Integer) -> Integer
+
           def initialize: (
             final_url: String,
             http_status: Integer?,
@@ -97,6 +102,7 @@ module ContextDev
             ?item_id: String,
             ?markdown: String,
             ?meta: ::Hash[Symbol, top],
+            ?ocr_pages: Integer,
             ?status: :ok
           ) -> void
 
@@ -109,7 +115,8 @@ module ContextDev
             html: String,
             item_id: String,
             markdown: String,
-            meta: ::Hash[Symbol, top]
+            meta: ::Hash[Symbol, top],
+            ocr_pages: Integer
           }
 
           type metadata =
@@ -122,6 +129,7 @@ module ContextDev
               canonical_url: String,
               description: String,
               favicon: String,
+              headings: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading],
               image: String,
               json_ld: ::Array[::Hash[Symbol, top]],
               keywords: ::Array[String],
@@ -168,6 +176,12 @@ module ContextDev
 
             def favicon=: (String) -> String
 
+            attr_reader headings: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading]?
+
+            def headings=: (
+              ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading]
+            ) -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading]
+
             attr_reader image: String?
 
             def image=: (String) -> String
@@ -227,6 +241,7 @@ module ContextDev
               ?canonical_url: String,
               ?description: String,
               ?favicon: String,
+              ?headings: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading],
               ?image: String,
               ?json_ld: ::Array[::Hash[Symbol, top]],
               ?keywords: ::Array[String],
@@ -249,6 +264,7 @@ module ContextDev
               canonical_url: String,
               description: String,
               favicon: String,
+              headings: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading],
               image: String,
               json_ld: ::Array[::Hash[Symbol, top]],
               keywords: ::Array[String],
@@ -305,6 +321,18 @@ module ContextDev
               }
             end
 
+            type heading = { level: Integer, text: String }
+
+            class Heading < ContextDev::Internal::Type::BaseModel
+              attr_accessor level: Integer
+
+              attr_accessor text: String
+
+              def initialize: (level: Integer, text: String) -> void
+
+              def to_hash: -> { level: Integer, text: String }
+            end
+
             type open_graph = String | ::Array[String]
 
             module OpenGraph

data/sig/context_dev/models/batch_list_response.rbs

@@ -117,22 +117,36 @@ module ContextDev
           timing: ContextDev::Models::BatchListResponse::Data::Timing
         }
 
-        type credits = { net: Integer, refunded: Integer, reserved: Integer }
+        type credits =
+          {
+            net: Integer,
+            ocr_charged: Integer,
+            refunded: Integer,
+            reserved: Integer
+          }
 
         class Credits < ContextDev::Internal::Type::BaseModel
           attr_accessor net: Integer
 
+          attr_accessor ocr_charged: Integer
+
           attr_accessor refunded: Integer
 
           attr_accessor reserved: Integer
 
           def initialize: (
             net: Integer,
+            ocr_charged: Integer,
             refunded: Integer,
             reserved: Integer
           ) -> void
 
-          def to_hash: -> { net: Integer, refunded: Integer, reserved: Integer }
+          def to_hash: -> {
+            net: Integer,
+            ocr_charged: Integer,
+            refunded: Integer,
+            reserved: Integer
+          }
         end
 
         type format_ = :markdown | :html

data/sig/context_dev/models/batch_retrieve_response.rbs

@@ -90,22 +90,36 @@ module ContextDev
         key_metadata: ContextDev::Models::BatchRetrieveResponse::KeyMetadata
       }
 
-      type credits = { net: Integer, refunded: Integer, reserved: Integer }
+      type credits =
+        {
+          net: Integer,
+          ocr_charged: Integer,
+          refunded: Integer,
+          reserved: Integer
+        }
 
       class Credits < ContextDev::Internal::Type::BaseModel
         attr_accessor net: Integer
 
+        attr_accessor ocr_charged: Integer
+
         attr_accessor refunded: Integer
 
         attr_accessor reserved: Integer
 
         def initialize: (
           net: Integer,
+          ocr_charged: Integer,
           refunded: Integer,
           reserved: Integer
         ) -> void
 
-        def to_hash: -> { net: Integer, refunded: Integer, reserved: Integer }
+        def to_hash: -> {
+          net: Integer,
+          ocr_charged: Integer,
+          refunded: Integer,
+          reserved: Integer
+        }
       end
 
       type format_ = :markdown | :html