context.dev 1.31.0 → 1.32.0

data/lib/context_dev/models/industry_retrieve_naics_response.rb

@@ -17,6 +17,13 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata }
+
       # @!attribute status
       #   Status of the response, e.g., 'ok'
       #
@@ -29,11 +36,16 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(codes: nil, domain: nil, status: nil, type: nil)
+      # @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
+      #
       #   @param codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
       #
       #   @param domain [String] Domain found for the brand
       #
+      #   @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param type [String] Industry classification type, for naics api it will be `naics`
@@ -78,6 +90,29 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::IndustryRetrieveNaicsResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/industry_retrieve_sic_response.rb

@@ -25,6 +25,13 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
+
       # @!attribute status
       #   Status of the response, e.g., 'ok'
       #
@@ -37,7 +44,7 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(classification: nil, codes: nil, domain: nil, status: nil, type: nil)
+      # @!method initialize(classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::IndustryRetrieveSicResponse} for more details.
       #
@@ -47,6 +54,8 @@ module ContextDev
       #
       #   @param domain [String] Domain found for the brand
       #
+      #   @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param type [String] Industry classification type, for sic api it will be `sic`
@@ -134,6 +143,29 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::IndustryRetrieveSicResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/utility_prefetch_by_email_response.rb

@@ -10,6 +10,13 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata }
+
       # @!attribute message
       #   Success message
       #
@@ -22,12 +29,40 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(domain: nil, message: nil, status: nil)
+      # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::UtilityPrefetchByEmailResponse} for more details.
+      #
       #   @param domain [String] The domain that was queued for prefetching
       #
+      #   @param key_metadata [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param message [String] Success message
       #
       #   @param status [String] Status of the response, e.g., 'ok'
+
+      # @see ContextDev::Models::UtilityPrefetchByEmailResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/utility_prefetch_response.rb

@@ -10,6 +10,13 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchResponse::KeyMetadata }
+
       # @!attribute message
       #   Success message
       #
@@ -22,12 +29,40 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(domain: nil, message: nil, status: nil)
+      # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::UtilityPrefetchResponse} for more details.
+      #
       #   @param domain [String] The domain that was queued for prefetching
       #
+      #   @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param message [String] Success message
       #
       #   @param status [String] Status of the response, e.g., 'ok'
+
+      # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_extract_competitors_response.rb

@@ -29,7 +29,17 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractCompetitorsResponse::Target]
       required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target }
 
-      # @!method initialize(competitors:, domain:, status:, target:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
+
+      # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebExtractCompetitorsResponse} for more details.
+      #
       #   @param competitors [Array<ContextDev::Models::WebExtractCompetitorsResponse::Competitor>] Direct competitors ordered by relevance and confidence.
       #
       #   @param domain [String] Normalized input domain.
@@ -37,6 +47,8 @@ module ContextDev
       #   @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response.
       #
       #   @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
+      #
+      #   @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       class Competitor < ContextDev::Internal::Type::BaseModel
         # @!attribute confidence
@@ -152,6 +164,29 @@ module ContextDev
         #
         #   @param website_url [String] Resolved URL used for the landing page analysis.
       end
+
+      # @see ContextDev::Models::WebExtractCompetitorsResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_extract_fonts_response.rb

@@ -39,7 +39,14 @@ module ContextDev
                -> { ContextDev::Internal::Type::HashOf[ContextDev::Models::WebExtractFontsResponse::FontLink] },
                api_name: :fontLinks
 
-      # @!method initialize(code:, domain:, fonts:, status:, font_links: nil)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata }
+
+      # @!method initialize(code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractFontsResponse} for more details.
       #
@@ -52,6 +59,8 @@ module ContextDev
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n
+      #
+      #   @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       class Font < ContextDev::Internal::Type::BaseModel
         # @!attribute fallbacks
@@ -163,6 +172,29 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::WebExtractFontsResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_extract_params.rb

@@ -59,6 +59,19 @@ module ContextDev
       #   @return [Integer, nil]
       optional :max_age_ms, Integer, api_name: :maxAgeMs
 
+      # @!attribute max_depth
+      #   Optional maximum link depth from the starting URL (0 = only the starting page).
+      #   If omitted, there is no crawl depth limit.
+      #
+      #   @return [Integer, nil]
+      optional :max_depth, Integer, api_name: :maxDepth
+
+      # @!attribute max_pages
+      #   Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+      #
+      #   @return [Integer, nil]
+      optional :max_pages, Integer, api_name: :maxPages
+
       # @!attribute pdf
       #
       #   @return [ContextDev::Models::WebExtractParams::Pdf, nil]
@@ -86,7 +99,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, api_name: :waitForMs
 
-      # @!method initialize(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractParams} for more details.
       #
@@ -104,6 +117,10 @@ module ContextDev
       #
       #   @param max_age_ms [Integer] Return cached scrape results if a prior scrape for the same parameters is younge
       #
+      #   @param max_depth [Integer] Optional maximum link depth from the starting URL (0 = only the starting page).
+      #
+      #   @param max_pages [Integer] Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+      #
       #   @param pdf [ContextDev::Models::WebExtractParams::Pdf]
       #
       #   @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 (1

data/lib/context_dev/models/web_extract_response.rb

@@ -33,7 +33,17 @@ module ContextDev
       #   @return [Array<String>]
       required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
+
+      # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebExtractResponse} for more details.
+      #
       #   @param data [Hash{Symbol=>Object}] Extracted data matching the request schema
       #
       #   @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
@@ -43,6 +53,8 @@ module ContextDev
       #   @param url [String] The starting URL that was analyzed
       #
       #   @param urls_analyzed [Array<String>] List of URLs whose Markdown was used for extraction
+      #
+      #   @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # @see ContextDev::Models::WebExtractResponse#metadata
       class Metadata < ContextDev::Internal::Type::BaseModel
@@ -78,6 +90,29 @@ module ContextDev
         #   @param num_succeeded [Integer]
         #   @param num_urls [Integer]
       end
+
+      # @see ContextDev::Models::WebExtractResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_extract_styleguide_response.rb

@@ -16,6 +16,13 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata }
+
       # @!attribute status
       #   Status of the response, e.g., 'ok'
       #
@@ -28,15 +35,43 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil]
       optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }
 
-      # @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil)
+      # @!method initialize(code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebExtractStyleguideResponse} for more details.
+      #
       #   @param code [Integer] HTTP status code
       #
       #   @param domain [String] The normalized domain that was processed
       #
+      #   @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
 
+      # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+
       # @see ContextDev::Models::WebExtractStyleguideResponse#styleguide
       class Styleguide < ContextDev::Internal::Type::BaseModel
         # @!attribute colors

data/lib/context_dev/models/web_screenshot_response.rb

@@ -22,6 +22,13 @@ module ContextDev
       #   @return [Integer, nil]
       optional :height, Integer
 
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebScreenshotResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
+
       # @!attribute screenshot
       #   Public URL of the uploaded screenshot image
       #
@@ -48,13 +55,18 @@ module ContextDev
       #   @return [Integer, nil]
       optional :width, Integer
 
-      # @!method initialize(code: nil, domain: nil, height: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
+      # @!method initialize(code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebScreenshotResponse} for more details.
+      #
       #   @param code [Integer] HTTP status code
       #
       #   @param domain [String] The normalized domain that was processed
       #
       #   @param height [Integer] Height in pixels of the returned screenshot image
       #
+      #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #
       #   @param screenshot [String] Public URL of the uploaded screenshot image
       #
       #   @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
@@ -63,6 +75,29 @@ module ContextDev
       #
       #   @param width [Integer] Width in pixels of the returned screenshot image
 
+      # @see ContextDev::Models::WebScreenshotResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+
       # Type of screenshot that was captured
       #
       # @see ContextDev::Models::WebScreenshotResponse#screenshot_type

data/lib/context_dev/models/web_search_response.rb

@@ -16,10 +16,22 @@ module ContextDev
       required :results,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result] }
 
-      # @!method initialize(query:, results:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
+
+      # @!method initialize(query:, results:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebSearchResponse} for more details.
+      #
       #   @param query [String] Echo of the original query (useful when fanout was enabled).
       #
       #   @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
+      #
+      #   @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       class Result < ContextDev::Internal::Type::BaseModel
         # @!attribute description
@@ -119,6 +131,29 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::WebSearchResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end