context.dev 2.5.0 → 2.7.0

data/rbi/context_dev/resources/web.rbi

@@ -216,9 +216,8 @@ 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,
-        # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
-        # residential proxy exit location. Must be one of Context.dev's supported
-        # countries. When provided, Context.dev fetches the target page from that country.
+        # Fetch the target page through a residential proxy in 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
@@ -355,9 +354,8 @@ module ContextDev
       def web_crawl_md(
         # The starting URL for the crawl (must include http:// or https:// protocol)
         url:,
-        # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
-        # residential proxy exit location. Must be one of Context.dev's supported
-        # countries. When provided, Context.dev fetches the target page from that country.
+        # Fetch the target page through a residential proxy in this country (ISO 3166-1
+        # alpha-2).
         country: nil,
         # CSS selectors to remove before each crawled page is converted to Markdown.
         # Applied after includeSelectors. Exclusion takes precedence: an element matching
@@ -473,9 +471,8 @@ module ContextDev
         # content is captured. Requires a paid plan. Send a JSON array in the query
         # parameter. Maximum: 5 actions.
         actions: nil,
-        # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
-        # residential proxy exit location. Must be one of Context.dev's supported
-        # countries. When provided, Context.dev fetches the target page from that country.
+        # Fetch the target page through a residential proxy in this country (ISO 3166-1
+        # alpha-2).
         country: nil,
         # CSS selectors to remove from the result. Applied after includeSelectors.
         # Exclusion takes precedence: an element matching both is removed. Examples:
@@ -673,9 +670,8 @@ module ContextDev
         # content is captured. Requires a paid plan. Send a JSON array in the query
         # parameter. Maximum: 5 actions.
         actions: nil,
-        # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
-        # residential proxy exit location. Must be one of Context.dev's supported
-        # countries. When provided, Context.dev fetches the target page from that country.
+        # Fetch the target page through a residential proxy in this country (ISO 3166-1
+        # alpha-2).
         country: nil,
         # CSS selectors to remove before conversion to Markdown. Applied after
         # includeSelectors. Exclusion takes precedence: an element matching both is

data/sig/context_dev/client.rbs

@@ -24,6 +24,8 @@ module ContextDev
 
     attr_reader monitors: ContextDev::Resources::Monitors
 
+    attr_reader batch: ContextDev::Resources::Batch
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/context_dev/models/batch_cancel_params.rbs

@@ -0,0 +1,23 @@
+module ContextDev
+  module Models
+    type batch_cancel_params =
+      { batch_id: String } & ContextDev::Internal::Type::request_parameters
+
+    class BatchCancelParams < 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_cancel_response.rbs

@@ -0,0 +1,174 @@
+module ContextDev
+  module Models
+    type batch_cancel_response =
+      {
+        id: String,
+        crawl: ContextDev::CrawlControls?,
+        credits: ContextDev::Models::BatchCancelResponse::Credits,
+        format_: ContextDev::Models::BatchCancelResponse::format_,
+        input: ContextDev::Intake,
+        mode: ContextDev::Models::BatchCancelResponse::mode,
+        page_errors: ::Array[ContextDev::PageErrorCount],
+        progress: ContextDev::Models::BatchCancelResponse::Progress,
+        status: ContextDev::Models::BatchCancelResponse::status,
+        tags: ::Array[String],
+        timing: ContextDev::Models::BatchCancelResponse::Timing,
+        key_metadata: ContextDev::Models::BatchCancelResponse::KeyMetadata
+      }
+
+    class BatchCancelResponse < ContextDev::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor crawl: ContextDev::CrawlControls?
+
+      attr_accessor credits: ContextDev::Models::BatchCancelResponse::Credits
+
+      attr_accessor format_: ContextDev::Models::BatchCancelResponse::format_
+
+      attr_accessor input: ContextDev::Intake
+
+      attr_accessor mode: ContextDev::Models::BatchCancelResponse::mode
+
+      attr_accessor page_errors: ::Array[ContextDev::PageErrorCount]
+
+      attr_accessor progress: ContextDev::Models::BatchCancelResponse::Progress
+
+      attr_accessor status: ContextDev::Models::BatchCancelResponse::status
+
+      attr_accessor tags: ::Array[String]
+
+      attr_accessor timing: ContextDev::Models::BatchCancelResponse::Timing
+
+      attr_reader key_metadata: ContextDev::Models::BatchCancelResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::BatchCancelResponse::KeyMetadata
+      ) -> ContextDev::Models::BatchCancelResponse::KeyMetadata
+
+      def initialize: (
+        id: String,
+        crawl: ContextDev::CrawlControls?,
+        credits: ContextDev::Models::BatchCancelResponse::Credits,
+        format_: ContextDev::Models::BatchCancelResponse::format_,
+        input: ContextDev::Intake,
+        mode: ContextDev::Models::BatchCancelResponse::mode,
+        page_errors: ::Array[ContextDev::PageErrorCount],
+        progress: ContextDev::Models::BatchCancelResponse::Progress,
+        status: ContextDev::Models::BatchCancelResponse::status,
+        tags: ::Array[String],
+        timing: ContextDev::Models::BatchCancelResponse::Timing,
+        ?key_metadata: ContextDev::Models::BatchCancelResponse::KeyMetadata
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        crawl: ContextDev::CrawlControls?,
+        credits: ContextDev::Models::BatchCancelResponse::Credits,
+        format_: ContextDev::Models::BatchCancelResponse::format_,
+        input: ContextDev::Intake,
+        mode: ContextDev::Models::BatchCancelResponse::mode,
+        page_errors: ::Array[ContextDev::PageErrorCount],
+        progress: ContextDev::Models::BatchCancelResponse::Progress,
+        status: ContextDev::Models::BatchCancelResponse::status,
+        tags: ::Array[String],
+        timing: ContextDev::Models::BatchCancelResponse::Timing,
+        key_metadata: ContextDev::Models::BatchCancelResponse::KeyMetadata
+      }
+
+      type credits = { reserved: Integer }
+
+      class Credits < ContextDev::Internal::Type::BaseModel
+        attr_accessor reserved: Integer
+
+        def initialize: (reserved: Integer) -> void
+
+        def to_hash: -> { reserved: Integer }
+      end
+
+      type format_ = :markdown | :html
+
+      module Format
+        extend ContextDev::Internal::Type::Enum
+
+        MARKDOWN: :markdown
+        HTML: :html
+
+        def self?.values: -> ::Array[ContextDev::Models::BatchCancelResponse::format_]
+      end
+
+      type mode = :scrape | :crawl
+
+      module Mode
+        extend ContextDev::Internal::Type::Enum
+
+        SCRAPE: :scrape
+        CRAWL: :crawl
+
+        def self?.values: -> ::Array[ContextDev::Models::BatchCancelResponse::mode]
+      end
+
+      type progress = { failed: Integer, pending: Integer, succeeded: Integer }
+
+      class Progress < ContextDev::Internal::Type::BaseModel
+        attr_accessor failed: Integer
+
+        attr_accessor pending: Integer
+
+        attr_accessor succeeded: Integer
+
+        def initialize: (
+          failed: Integer,
+          pending: Integer,
+          succeeded: Integer
+        ) -> void
+
+        def to_hash: -> {
+          failed: Integer,
+          pending: Integer,
+          succeeded: Integer
+        }
+      end
+
+      type status = :cancelling
+
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        CANCELLING: :cancelling
+
+        def self?.values: -> ::Array[ContextDev::Models::BatchCancelResponse::status]
+      end
+
+      type timing = { created_at: String, started_at: String? }
+
+      class Timing < ContextDev::Internal::Type::BaseModel
+        attr_accessor created_at: String
+
+        attr_accessor started_at: String?
+
+        def initialize: (created_at: String, started_at: String?) -> void
+
+        def to_hash: -> { created_at: String, started_at: String? }
+      end
+
+      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_params.rbs

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

data/sig/context_dev/models/batch_get_results_response.rbs

@@ -0,0 +1,399 @@
+module ContextDev
+  module Models
+    type batch_get_results_response =
+      {
+        data: ::Array[ContextDev::Models::BatchGetResultsResponse::data],
+        has_more: bool,
+        key_metadata: ContextDev::Models::BatchGetResultsResponse::KeyMetadata,
+        next_cursor: String?
+      }
+
+    class BatchGetResultsResponse < ContextDev::Internal::Type::BaseModel
+      attr_reader data: ::Array[ContextDev::Models::BatchGetResultsResponse::data]?
+
+      def data=: (
+        ::Array[ContextDev::Models::BatchGetResultsResponse::data]
+      ) -> ::Array[ContextDev::Models::BatchGetResultsResponse::data]
+
+      attr_reader has_more: bool?
+
+      def has_more=: (bool) -> bool
+
+      attr_reader key_metadata: ContextDev::Models::BatchGetResultsResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::BatchGetResultsResponse::KeyMetadata
+      ) -> ContextDev::Models::BatchGetResultsResponse::KeyMetadata
+
+      attr_accessor next_cursor: String?
+
+      def initialize: (
+        ?data: ::Array[ContextDev::Models::BatchGetResultsResponse::data],
+        ?has_more: bool,
+        ?key_metadata: ContextDev::Models::BatchGetResultsResponse::KeyMetadata,
+        ?next_cursor: String?
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[ContextDev::Models::BatchGetResultsResponse::data],
+        has_more: bool,
+        key_metadata: ContextDev::Models::BatchGetResultsResponse::KeyMetadata,
+        next_cursor: String?
+      }
+
+      type data =
+        ContextDev::Models::BatchGetResultsResponse::Data::Ok
+        | ContextDev::Models::BatchGetResultsResponse::Data::Error
+
+      module Data
+        extend ContextDev::Internal::Type::Union
+
+        type ok =
+          {
+            final_url: String,
+            http_status: Integer?,
+            metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
+            status: :ok,
+            url: String,
+            html: String,
+            item_id: String,
+            markdown: String,
+            meta: ::Hash[Symbol, top]
+          }
+
+        class Ok < ContextDev::Internal::Type::BaseModel
+          attr_accessor final_url: String
+
+          attr_accessor http_status: Integer?
+
+          attr_accessor metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata
+
+          attr_accessor status: :ok
+
+          attr_accessor url: String
+
+          attr_reader html: String?
+
+          def html=: (String) -> String
+
+          attr_reader item_id: String?
+
+          def item_id=: (String) -> String
+
+          attr_reader markdown: String?
+
+          def markdown=: (String) -> String
+
+          attr_reader meta: ::Hash[Symbol, top]?
+
+          def meta=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          def initialize: (
+            final_url: String,
+            http_status: Integer?,
+            metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
+            url: String,
+            ?html: String,
+            ?item_id: String,
+            ?markdown: String,
+            ?meta: ::Hash[Symbol, top],
+            ?status: :ok
+          ) -> void
+
+          def to_hash: -> {
+            final_url: String,
+            http_status: Integer?,
+            metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
+            status: :ok,
+            url: String,
+            html: String,
+            item_id: String,
+            markdown: String,
+            meta: ::Hash[Symbol, top]
+          }
+
+          type metadata =
+            {
+              final_url: String,
+              source_url: String,
+              additional_meta: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta],
+              alternates: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate],
+              author: String,
+              canonical_url: String,
+              description: String,
+              favicon: String,
+              image: String,
+              json_ld: ::Array[::Hash[Symbol, top]],
+              keywords: ::Array[String],
+              language: String,
+              modified_time: String,
+              open_graph: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph],
+              published_time: String,
+              robots: String,
+              site_name: String,
+              title: String,
+              twitter: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+            }
+
+          class Metadata < ContextDev::Internal::Type::BaseModel
+            attr_accessor final_url: String
+
+            attr_accessor source_url: String
+
+            attr_reader additional_meta: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta]?
+
+            def additional_meta=: (
+              ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta]
+            ) -> ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta]
+
+            attr_reader alternates: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate]?
+
+            def alternates=: (
+              ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate]
+            ) -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate]
+
+            attr_reader author: String?
+
+            def author=: (String) -> String
+
+            attr_reader canonical_url: String?
+
+            def canonical_url=: (String) -> String
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            attr_reader favicon: String?
+
+            def favicon=: (String) -> String
+
+            attr_reader image: String?
+
+            def image=: (String) -> String
+
+            attr_reader json_ld: ::Array[::Hash[Symbol, top]]?
+
+            def json_ld=: (
+              ::Array[::Hash[Symbol, top]]
+            ) -> ::Array[::Hash[Symbol, top]]
+
+            attr_reader keywords: ::Array[String]?
+
+            def keywords=: (::Array[String]) -> ::Array[String]
+
+            attr_reader language: String?
+
+            def language=: (String) -> String
+
+            attr_reader modified_time: String?
+
+            def modified_time=: (String) -> String
+
+            attr_reader open_graph: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph]?
+
+            def open_graph=: (
+              ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph]
+            ) -> ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph]
+
+            attr_reader published_time: String?
+
+            def published_time=: (String) -> String
+
+            attr_reader robots: String?
+
+            def robots=: (String) -> String
+
+            attr_reader site_name: String?
+
+            def site_name=: (String) -> String
+
+            attr_reader title: String?
+
+            def title=: (String) -> String
+
+            attr_reader twitter: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]?
+
+            def twitter=: (
+              ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+            ) -> ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+
+            def initialize: (
+              final_url: String,
+              source_url: String,
+              ?additional_meta: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta],
+              ?alternates: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate],
+              ?author: String,
+              ?canonical_url: String,
+              ?description: String,
+              ?favicon: String,
+              ?image: String,
+              ?json_ld: ::Array[::Hash[Symbol, top]],
+              ?keywords: ::Array[String],
+              ?language: String,
+              ?modified_time: String,
+              ?open_graph: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph],
+              ?published_time: String,
+              ?robots: String,
+              ?site_name: String,
+              ?title: String,
+              ?twitter: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+            ) -> void
+
+            def to_hash: -> {
+              final_url: String,
+              source_url: String,
+              additional_meta: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta],
+              alternates: ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Alternate],
+              author: String,
+              canonical_url: String,
+              description: String,
+              favicon: String,
+              image: String,
+              json_ld: ::Array[::Hash[Symbol, top]],
+              keywords: ::Array[String],
+              language: String,
+              modified_time: String,
+              open_graph: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph],
+              published_time: String,
+              robots: String,
+              site_name: String,
+              title: String,
+              twitter: ::Hash[Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+            }
+
+            type additional_meta = String | ::Array[String]
+
+            module AdditionalMeta
+              extend ContextDev::Internal::Type::Union
+
+              def self?.variants: -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::additional_meta]
+
+              StringArray: ContextDev::Internal::Type::Converter
+            end
+
+            type alternate =
+              { href: String, hreflang: String, title: String, type: String }
+
+            class Alternate < ContextDev::Internal::Type::BaseModel
+              attr_accessor href: String
+
+              attr_reader hreflang: String?
+
+              def hreflang=: (String) -> String
+
+              attr_reader title: String?
+
+              def title=: (String) -> String
+
+              attr_reader type: String?
+
+              def type=: (String) -> String
+
+              def initialize: (
+                href: String,
+                ?hreflang: String,
+                ?title: String,
+                ?type: String
+              ) -> void
+
+              def to_hash: -> {
+                href: String,
+                hreflang: String,
+                title: String,
+                type: String
+              }
+            end
+
+            type open_graph = String | ::Array[String]
+
+            module OpenGraph
+              extend ContextDev::Internal::Type::Union
+
+              def self?.variants: -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::open_graph]
+
+              StringArray: ContextDev::Internal::Type::Converter
+            end
+
+            type twitter = String | ::Array[String]
+
+            module Twitter
+              extend ContextDev::Internal::Type::Union
+
+              def self?.variants: -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::twitter]
+
+              StringArray: ContextDev::Internal::Type::Converter
+            end
+          end
+        end
+
+        type error =
+          {
+            error_code: String,
+            message: String,
+            status: :error,
+            url: String,
+            item_id: String,
+            meta: ::Hash[Symbol, top]
+          }
+
+        class Error < ContextDev::Internal::Type::BaseModel
+          attr_accessor error_code: String
+
+          attr_accessor message: String
+
+          attr_accessor status: :error
+
+          attr_accessor url: String
+
+          attr_reader item_id: String?
+
+          def item_id=: (String) -> String
+
+          attr_reader meta: ::Hash[Symbol, top]?
+
+          def meta=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          def initialize: (
+            error_code: String,
+            message: String,
+            url: String,
+            ?item_id: String,
+            ?meta: ::Hash[Symbol, top],
+            ?status: :error
+          ) -> void
+
+          def to_hash: -> {
+            error_code: String,
+            message: String,
+            status: :error,
+            url: String,
+            item_id: String,
+            meta: ::Hash[Symbol, top]
+          }
+        end
+
+        def self?.variants: -> ::Array[ContextDev::Models::BatchGetResultsResponse::data]
+      end
+
+      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