context.dev 2.17.1 → 2.18.0

data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi

@@ -0,0 +1,332 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebWebScrapeScreenshotResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebWebScrapeScreenshotResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Cache outcome for this response. Composite responses are hits only when every
+      # cache-controlled fetch contributing to the output was a hit; age_ms is the
+      # oldest contributing hit.
+      sig do
+        returns(
+          ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata
+        )
+      end
+      attr_reader :cache_metadata
+
+      sig do
+        params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::OrHash
+        ).void
+      end
+      attr_writer :cache_metadata
+
+      # Height of the returned image in pixels.
+      sig { returns(Integer) }
+      attr_accessor :height
+
+      # 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
+
+      # Public image URL for standard requests, or an in-memory data URL when ZDR is
+      # enabled.
+      sig { returns(String) }
+      attr_accessor :screenshot
+
+      # The requested page URL.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Width of the returned image in pixels.
+      sig { returns(Integer) }
+      attr_accessor :width
+
+      # 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(
+          T.nilable(
+            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :final_dom_state
+
+      sig do
+        params(
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::OrSymbol
+        ).void
+      end
+      attr_writer :final_dom_state
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::OrHash,
+          height: Integer,
+          request_id: String,
+          screenshot: String,
+          url: String,
+          width: Integer,
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::OrSymbol,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cache outcome for this response. Composite responses are hits only when every
+        # cache-controlled fetch contributing to the output was a hit; age_ms is the
+        # oldest contributing hit.
+        cache_metadata:,
+        # Height of the returned image in pixels.
+        height:,
+        # 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:,
+        # Public image URL for standard requests, or an in-memory data URL when ZDR is
+        # enabled.
+        screenshot:,
+        # The requested page URL.
+        url:,
+        # Width of the returned image in pixels.
+        width:,
+        # 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: nil,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cache_metadata:
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata,
+            height: Integer,
+            request_id: String,
+            screenshot: String,
+            url: String,
+            width: Integer,
+            final_dom_state:
+              ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        sig { returns(Integer) }
+        attr_accessor :age_ms
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        sig do
+          returns(
+            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Cache outcome for this response. Composite responses are hits only when every
+        # cache-controlled fetch contributing to the output was a hit; age_ms is the
+        # oldest contributing hit.
+        sig do
+          params(
+            age_ms: Integer,
+            status:
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+          age_ms:,
+          # Whether the response was served from cache, required fresh work, or honored
+          # zero-data-retention cache bypass.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              age_ms: Integer,
+              status:
+                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIT =
+            T.let(
+              :hit,
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          MISS =
+            T.let(
+              :miss,
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          ZDR =
+            T.let(
+              :zdr,
+              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        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::WebWebScrapeScreenshotResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeScreenshotResponse::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_sitemap_params.rbi

@@ -93,9 +93,10 @@ module ContextDev
       attr_writer :url_regex
 
       # 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 do
         returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol))
       end
@@ -153,9 +154,10 @@ module ContextDev
         # returned and counted against maxLinks.
         url_regex: 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: {}
       )
@@ -288,9 +290,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.rbi

@@ -106,5 +106,8 @@ module ContextDev
 
   WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams
 
+  WebWebScrapeScreenshotParams =
+    ContextDev::Models::WebWebScrapeScreenshotParams
+
   WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams
 end

data/rbi/context_dev/resources/ai.rbi

@@ -11,6 +11,7 @@ module ContextDev
           max_age_ms: Integer,
           tags: T::Array[String],
           timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash,
+          zdr: ContextDev::AIExtractProductParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::AIExtractProductResponse)
       end
@@ -27,6 +28,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

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/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