context.dev 2.16.0 → 2.17.0

data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi

@@ -0,0 +1,238 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebWebScrapeBytesResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebWebScrapeBytesResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Base64-encoded resource bytes, without a data URI prefix. Decode this field to
+      # recover the downloaded file.
+      sig { returns(String) }
+      attr_accessor :bytes
+
+      # Number of decoded resource bytes, before base64 encoding.
+      sig { returns(Integer) }
+      attr_accessor :content_length
+
+      # The Content-Type returned by the origin, including any charset. Defaults to
+      # application/octet-stream when absent.
+      sig { returns(String) }
+      attr_accessor :content_type
+
+      sig do
+        returns(
+          ContextDev::Models::WebWebScrapeBytesResponse::Encoding::TaggedSymbol
+        )
+      end
+      attr_accessor :encoding
+
+      # The resource URL after redirects.
+      sig { returns(String) }
+      attr_accessor :final_url
+
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      # HTTP status returned by the origin.
+      sig { returns(Integer) }
+      attr_accessor :status_code
+
+      sig do
+        returns(
+          ContextDev::Models::WebWebScrapeBytesResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      # The requested resource URL.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          bytes: String,
+          content_length: Integer,
+          content_type: String,
+          encoding:
+            ContextDev::Models::WebWebScrapeBytesResponse::Encoding::OrSymbol,
+          final_url: String,
+          request_id: String,
+          status_code: Integer,
+          success:
+            ContextDev::Models::WebWebScrapeBytesResponse::Success::OrBoolean,
+          url: String,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Base64-encoded resource bytes, without a data URI prefix. Decode this field to
+        # recover the downloaded file.
+        bytes:,
+        # Number of decoded resource bytes, before base64 encoding.
+        content_length:,
+        # The Content-Type returned by the origin, including any charset. Defaults to
+        # application/octet-stream when absent.
+        content_type:,
+        encoding:,
+        # The resource URL after redirects.
+        final_url:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
+        # HTTP status returned by the origin.
+        status_code:,
+        success:,
+        # The requested resource URL.
+        url:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            bytes: String,
+            content_length: Integer,
+            content_type: String,
+            encoding:
+              ContextDev::Models::WebWebScrapeBytesResponse::Encoding::TaggedSymbol,
+            final_url: String,
+            request_id: String,
+            status_code: Integer,
+            success:
+              ContextDev::Models::WebWebScrapeBytesResponse::Success::TaggedBoolean,
+            url: String,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Encoding
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::WebWebScrapeBytesResponse::Encoding
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BASE64 =
+          T.let(
+            :base64,
+            ContextDev::Models::WebWebScrapeBytesResponse::Encoding::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeBytesResponse::Encoding::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              ContextDev::Models::WebWebScrapeBytesResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            ContextDev::Models::WebWebScrapeBytesResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeBytesResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits used by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits used by this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/web_web_scrape_html_params.rbi

@@ -111,14 +111,20 @@ module ContextDev
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # Optional timeout in milliseconds for the request. If the request takes longer
-      # than this value, it will be aborted with a 408 status code. Maximum allowed
-      # value is 300000ms (5 minutes).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig do
+        returns(T.nilable(ContextDev::WebWebScrapeHTMLParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # When true, return only the page's main content in the HTML response, excluding
       # headers, footers, sidebars, and navigation when detectable.
@@ -129,8 +135,8 @@ module ContextDev
       attr_writer :use_main_content_only
 
       # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
-      # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
-      # waitForMs + 10000 ms; a shorter deadline is rejected with 400
+      # 30000 (30 seconds). When combined with timeoutOpts, timeoutOpts.milliseconds
+      # must be at least waitForMs + 10000 ms; a shorter deadline is rejected with 400
       # TIMEOUT_TOO_SHORT_FOR_WAIT.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :wait_for_ms
@@ -171,7 +177,7 @@ module ContextDev
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
           settle_animations: T::Boolean,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::OrHash,
           use_main_content_only: T::Boolean,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebWebScrapeHTMLParams::Zdr::OrSymbol,
@@ -216,16 +222,16 @@ module ContextDev
         # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
         # characters.
         tags: nil,
-        # Optional timeout in milliseconds for the request. If the request takes longer
-        # than this value, it will be aborted with a 408 status code. Maximum allowed
-        # value is 300000ms (5 minutes).
-        timeout_ms: 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,
         # When true, return only the page's main content in the HTML response, excluding
         # headers, footers, sidebars, and navigation when detectable.
         use_main_content_only: nil,
         # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
-        # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
-        # waitForMs + 10000 ms; a shorter deadline is rejected with 400
+        # 30000 (30 seconds). When combined with timeoutOpts, timeoutOpts.milliseconds
+        # must be at 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
@@ -260,7 +266,7 @@ module ContextDev
             pdf: ContextDev::WebWebScrapeHTMLParams::Pdf,
             settle_animations: T::Boolean,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebWebScrapeHTMLParams::TimeoutOpts,
             use_main_content_only: T::Boolean,
             wait_for_ms: T.nilable(Integer),
             zdr: ContextDev::WebWebScrapeHTMLParams::Zdr::OrSymbol,
@@ -1068,6 +1074,115 @@ module ContextDev
         end
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        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 15000.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::OrSymbol
+          ).void
+        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.
+        sig do
+          params(
+            milliseconds: Integer,
+            behavior:
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          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 15000.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::OrSymbol
+            }
+          )
+        end
+        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 15000.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      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

data/rbi/context_dev/models/web_web_scrape_html_response.rbi

@@ -27,6 +27,18 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # 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.
+      sig do
+        returns(
+          ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::TaggedSymbol
+        )
+      end
+      attr_accessor :final_dom_state
+
       # The scraped content of the page. For normal pages this is the raw HTML. When the
       # page is a sitemap or feed served behind an XSL stylesheet (which browsers render
       # into HTML), this is the underlying XML instead — see the `type` field.
@@ -123,6 +135,8 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::OrHash,
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::OrSymbol,
           html: String,
           metadata:
             ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::OrHash,
@@ -145,6 +159,12 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # 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.
+        final_dom_state:,
         # The scraped content of the page. For normal pages this is the raw HTML. When the
         # page is a sitemap or feed served behind an XSL stylesheet (which browsers render
         # into HTML), this is the underlying XML instead — see the `type` field.
@@ -178,6 +198,8 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata,
+            final_dom_state:
+              ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::TaggedSymbol,
             html: String,
             metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata,
             request_id: String,
@@ -294,6 +316,45 @@ 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.
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Metadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do