context.dev 1.31.0 → 1.32.0

data/rbi/context_dev/models/industry_retrieve_naics_response.rbi

@@ -38,6 +38,25 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -59,6 +78,8 @@ module ContextDev
               ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash
             ],
           domain: String,
+          key_metadata:
+            ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata::OrHash,
           status: String,
           type: String
         ).returns(T.attached_class)
@@ -68,6 +89,9 @@ module ContextDev
         codes: nil,
         # Domain found for the brand
         domain: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil,
         # Industry classification type, for naics api it will be `naics`
@@ -81,6 +105,8 @@ module ContextDev
             codes:
               T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code],
             domain: String,
+            key_metadata:
+              ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata,
             status: String,
             type: String
           }
@@ -185,6 +211,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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/industry_retrieve_sic_response.rbi

@@ -58,6 +58,25 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -81,6 +100,8 @@ module ContextDev
               ContextDev::Models::IndustryRetrieveSicResponse::Code::OrHash
             ],
           domain: String,
+          key_metadata:
+            ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata::OrHash,
           status: String,
           type: String
         ).returns(T.attached_class)
@@ -94,6 +115,9 @@ module ContextDev
         codes: nil,
         # Domain found for the brand
         domain: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil,
         # Industry classification type, for sic api it will be `sic`
@@ -109,6 +133,8 @@ module ContextDev
             codes:
               T::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code],
             domain: String,
+            key_metadata:
+              ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata,
             status: String,
             type: String
           }
@@ -287,6 +313,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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/utility_prefetch_by_email_response.rbi

@@ -18,6 +18,25 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Success message
       sig { returns(T.nilable(String)) }
       attr_reader :message
@@ -33,13 +52,20 @@ module ContextDev
       attr_writer :status
 
       sig do
-        params(domain: String, message: String, status: String).returns(
-          T.attached_class
-        )
+        params(
+          domain: String,
+          key_metadata:
+            ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata::OrHash,
+          message: String,
+          status: String
+        ).returns(T.attached_class)
       end
       def self.new(
         # The domain that was queued for prefetching
         domain: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Success message
         message: nil,
         # Status of the response, e.g., 'ok'
@@ -48,10 +74,59 @@ module ContextDev
       end
 
       sig do
-        override.returns({ domain: String, message: String, status: String })
+        override.returns(
+          {
+            domain: String,
+            key_metadata:
+              ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata,
+            message: String,
+            status: String
+          }
+        )
       end
       def to_hash
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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/utility_prefetch_response.rbi

@@ -18,6 +18,23 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::UtilityPrefetchResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Success message
       sig { returns(T.nilable(String)) }
       attr_reader :message
@@ -33,13 +50,20 @@ module ContextDev
       attr_writer :status
 
       sig do
-        params(domain: String, message: String, status: String).returns(
-          T.attached_class
-        )
+        params(
+          domain: String,
+          key_metadata:
+            ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash,
+          message: String,
+          status: String
+        ).returns(T.attached_class)
       end
       def self.new(
         # The domain that was queued for prefetching
         domain: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Success message
         message: nil,
         # Status of the response, e.g., 'ok'
@@ -48,10 +72,59 @@ module ContextDev
       end
 
       sig do
-        override.returns({ domain: String, message: String, status: String })
+        override.returns(
+          {
+            domain: String,
+            key_metadata:
+              ContextDev::Models::UtilityPrefetchResponse::KeyMetadata,
+            message: String,
+            status: String
+          }
+        )
       end
       def to_hash
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::UtilityPrefetchResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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_response.rbi

@@ -45,6 +45,25 @@ module ContextDev
       end
       attr_writer :target
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           competitors:
@@ -55,7 +74,9 @@ module ContextDev
           status:
             ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol,
           target:
-            ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash
+            ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash,
+          key_metadata:
+            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -66,7 +87,10 @@ module ContextDev
         # Status of the response.
         status:,
         # Target company profile inferred from the landing page.
-        target:
+        target:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -80,7 +104,9 @@ module ContextDev
             domain: String,
             status:
               ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
-            target: ContextDev::Models::WebExtractCompetitorsResponse::Target
+            target: ContextDev::Models::WebExtractCompetitorsResponse::Target,
+            key_metadata:
+              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata
           }
         )
       end
@@ -292,6 +318,47 @@ module ContextDev
         def to_hash
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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_fonts_response.rbi

@@ -55,6 +55,23 @@ module ContextDev
       end
       attr_writer :font_links
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebExtractFontsResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           code: Integer,
@@ -66,7 +83,9 @@ module ContextDev
             T::Hash[
               Symbol,
               ContextDev::Models::WebExtractFontsResponse::FontLink::OrHash
-            ]
+            ],
+          key_metadata:
+            ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -81,7 +100,10 @@ module ContextDev
         # 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.
-        font_links: nil
+        font_links: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -96,7 +118,9 @@ module ContextDev
               T::Hash[
                 Symbol,
                 ContextDev::Models::WebExtractFontsResponse::FontLink
-              ]
+              ],
+            key_metadata:
+              ContextDev::Models::WebExtractFontsResponse::KeyMetadata
           }
         )
       end
@@ -296,6 +320,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractFontsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          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_params.rbi

@@ -64,6 +64,21 @@ module ContextDev
       sig { params(max_age_ms: Integer).void }
       attr_writer :max_age_ms
 
+      # Optional maximum link depth from the starting URL (0 = only the starting page).
+      # If omitted, there is no crawl depth limit.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_depth
+
+      sig { params(max_depth: Integer).void }
+      attr_writer :max_depth
+
+      # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_pages
+
+      sig { params(max_pages: Integer).void }
+      attr_writer :max_pages
+
       sig { returns(T.nilable(ContextDev::WebExtractParams::Pdf)) }
       attr_reader :pdf
 
@@ -104,6 +119,8 @@ module ContextDev
           include_frames: T::Boolean,
           instructions: String,
           max_age_ms: Integer,
+          max_depth: Integer,
+          max_pages: Integer,
           pdf: ContextDev::WebExtractParams::Pdf::OrHash,
           stop_after_ms: Integer,
           timeout_ms: Integer,
@@ -136,6 +153,11 @@ module ContextDev
         # Return cached scrape results if a prior scrape for the same parameters is
         # younger than this many milliseconds. Defaults to 7 days (604800000 ms).
         max_age_ms: nil,
+        # Optional maximum link depth from the starting URL (0 = only the starting page).
+        # If omitted, there is no crawl depth limit.
+        max_depth: nil,
+        # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+        max_pages: nil,
         pdf: nil,
         # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
         # (110s). Default: 80000 (80s).
@@ -161,6 +183,8 @@ module ContextDev
             include_frames: T::Boolean,
             instructions: String,
             max_age_ms: Integer,
+            max_depth: Integer,
+            max_pages: Integer,
             pdf: ContextDev::WebExtractParams::Pdf,
             stop_after_ms: Integer,
             timeout_ms: Integer,