context.dev 2.16.0 → 2.17.0

data/rbi/context_dev/models/web_answers_response.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebAnswersResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebAnswersResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # The answer, in the shape requested by json_format.
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :json_content
+
+      # URLs that supplied search results or readable page content, in first-seen order.
+      # Unreadable pages are excluded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :sources
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(T.nilable(ContextDev::Models::WebAnswersResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebAnswersResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      # True when the request deadline ended research and the answer uses the evidence
+      # collected so far.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
+      sig do
+        params(
+          json_content: T::Hash[Symbol, T.anything],
+          sources: T::Array[String],
+          key_metadata:
+            ContextDev::Models::WebAnswersResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The answer, in the shape requested by json_format.
+        json_content:,
+        # URLs that supplied search results or readable page content, in first-seen order.
+        # Unreadable pages are excluded.
+        sources:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil,
+        # True when the request deadline ended research and the answer uses the evidence
+        # collected so far.
+        partial: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            json_content: T::Hash[Symbol, T.anything],
+            sources: T::Array[String],
+            key_metadata: ContextDev::Models::WebAnswersResponse::KeyMetadata,
+            partial: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebAnswersResponse::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_extract_competitors_params.rbi

@@ -34,21 +34,29 @@ 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::WebExtractCompetitorsParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::WebExtractCompetitorsParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
           domain: String,
           num_competitors: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::WebExtractCompetitorsParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -61,10 +69,10 @@ 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,
         request_options: {}
       )
       end
@@ -75,13 +83,119 @@ module ContextDev
             domain: String,
             num_competitors: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebExtractCompetitorsParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebExtractCompetitorsParams::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.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::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.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::WebExtractCompetitorsParams::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.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_competitors_response.rbi

@@ -68,6 +68,14 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and this response contains only usable
+      # results completed so far. Unfinished results are omitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       sig do
         params(
           competitors:
@@ -81,7 +89,8 @@ module ContextDev
           target:
             ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash,
           key_metadata:
-            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -97,7 +106,10 @@ module ContextDev
         # Target company profile inferred from the landing page.
         target:,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        key_metadata: nil,
+        # True when the timeout ended processing and this response contains only usable
+        # results completed so far. Unfinished results are omitted.
+        partial: nil
       )
       end
 
@@ -114,7 +126,8 @@ module ContextDev
               ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
             target: ContextDev::Models::WebExtractCompetitorsResponse::Target,
             key_metadata:
-              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata
+              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end

data/rbi/context_dev/models/web_extract_fonts_params.rbi

@@ -33,9 +33,9 @@ module ContextDev
       attr_writer :domain
 
       # Maximum age in milliseconds for cached brand data before the API performs a hard
-      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      # year.
+      # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+      # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+      # are clamped to 1 year.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
@@ -47,14 +47,18 @@ 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 { returns(T.nilable(ContextDev::WebExtractFontsParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebExtractFontsParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
@@ -62,7 +66,7 @@ module ContextDev
           domain: String,
           max_age_ms: T.nilable(Integer),
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebExtractFontsParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -76,17 +80,17 @@ module ContextDev
         # 'domain' or 'directUrl', but not both.
         domain: nil,
         # Maximum age in milliseconds for cached brand data before the API performs a hard
-        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-        # year.
+        # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+        # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+        # are clamped to 1 year.
         max_age_ms: nil,
         # 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,
         request_options: {}
       )
       end
@@ -98,13 +102,122 @@ module ContextDev
             domain: String,
             max_age_ms: T.nilable(Integer),
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebExtractFontsParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebExtractFontsParams::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::WebExtractFontsParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebExtractFontsParams::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::WebExtractFontsParams::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::WebExtractFontsParams::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::WebExtractFontsParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_fonts_response.rbi

@@ -50,6 +50,28 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :status
 
+      # 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::WebExtractFontsResponse::FinalDomState::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :final_dom_state
+
+      sig do
+        params(
+          final_dom_state:
+            ContextDev::Models::WebExtractFontsResponse::FinalDomState::OrSymbol
+        ).void
+      end
+      attr_writer :final_dom_state
+
       # Font assets keyed by family name as it appears in the fonts array (non-generic
       # names only). Clients match entries in fonts to pick a file URL from files.
       # Omitted when no families resolve to Google or custom @font-face URLs.
@@ -102,6 +124,8 @@ module ContextDev
             T::Array[ContextDev::Models::WebExtractFontsResponse::Font::OrHash],
           request_id: String,
           status: String,
+          final_dom_state:
+            ContextDev::Models::WebExtractFontsResponse::FinalDomState::OrSymbol,
           font_links:
             T::Hash[
               Symbol,
@@ -127,6 +151,12 @@ module ContextDev
         request_id:,
         # Status of the response, e.g., 'ok'
         status:,
+        # 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,
         # Font assets keyed by family name as it appears in the fonts array (non-generic
         # names only). Clients match entries in fonts to pick a file URL from files.
         # Omitted when no families resolve to Google or custom @font-face URLs.
@@ -146,6 +176,8 @@ module ContextDev
             fonts: T::Array[ContextDev::Models::WebExtractFontsResponse::Font],
             request_id: String,
             status: String,
+            final_dom_state:
+              ContextDev::Models::WebExtractFontsResponse::FinalDomState::TaggedSymbol,
             font_links:
               T::Hash[
                 Symbol,
@@ -337,6 +369,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::WebExtractFontsResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebExtractFontsResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebExtractFontsResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebExtractFontsResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class FontLink < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do