context.dev 1.31.0 → 1.32.0

data/rbi/context_dev/models/web_extract_response.rbi

@@ -37,13 +37,30 @@ module ContextDev
       sig { returns(T::Array[String]) }
       attr_accessor :urls_analyzed
 
+      # 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::WebExtractResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           data: T::Hash[Symbol, T.anything],
           metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash,
           status: String,
           url: String,
-          urls_analyzed: T::Array[String]
+          urls_analyzed: T::Array[String],
+          key_metadata:
+            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -55,7 +72,10 @@ module ContextDev
         # The starting URL that was analyzed
         url:,
         # List of URLs whose Markdown was used for extraction
-        urls_analyzed:
+        urls_analyzed:,
+        # 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
 
@@ -66,7 +86,8 @@ module ContextDev
             metadata: ContextDev::Models::WebExtractResponse::Metadata,
             status: String,
             url: String,
-            urls_analyzed: T::Array[String]
+            urls_analyzed: T::Array[String],
+            key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata
           }
         )
       end
@@ -129,6 +150,47 @@ module ContextDev
         def to_hash
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractResponse::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_styleguide_response.rbi

@@ -25,6 +25,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::WebExtractStyleguideResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -54,6 +73,8 @@ module ContextDev
         params(
           code: Integer,
           domain: String,
+          key_metadata:
+            ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash,
           status: String,
           styleguide:
             ContextDev::Models::WebExtractStyleguideResponse::Styleguide::OrHash
@@ -64,6 +85,9 @@ module ContextDev
         code: nil,
         # The normalized domain that was processed
         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,
         # Comprehensive styleguide data extracted from the website
@@ -76,6 +100,8 @@ module ContextDev
           {
             code: Integer,
             domain: String,
+            key_metadata:
+              ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata,
             status: String,
             styleguide:
               ContextDev::Models::WebExtractStyleguideResponse::Styleguide
@@ -85,6 +111,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractStyleguideResponse::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
+
       class Styleguide < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/models/web_screenshot_response.rbi

@@ -32,6 +32,23 @@ module ContextDev
       sig { params(height: Integer).void }
       attr_writer :height
 
+      # 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::WebScreenshotResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Public URL of the uploaded screenshot image
       sig { returns(T.nilable(String)) }
       attr_reader :screenshot
@@ -76,6 +93,8 @@ module ContextDev
           code: Integer,
           domain: String,
           height: Integer,
+          key_metadata:
+            ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash,
           screenshot: String,
           screenshot_type:
             ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol,
@@ -90,6 +109,9 @@ module ContextDev
         domain: nil,
         # Height in pixels of the returned screenshot image
         height: 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,
         # Public URL of the uploaded screenshot image
         screenshot: nil,
         # Type of screenshot that was captured
@@ -107,6 +129,8 @@ module ContextDev
             code: Integer,
             domain: String,
             height: Integer,
+            key_metadata:
+              ContextDev::Models::WebScreenshotResponse::KeyMetadata,
             screenshot: String,
             screenshot_type:
               ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol,
@@ -118,6 +142,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebScreenshotResponse::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
+
       # Type of screenshot that was captured
       module ScreenshotType
         extend ContextDev::Internal::Type::Enum

data/rbi/context_dev/models/web_search_response.rbi

@@ -18,17 +18,37 @@ module ContextDev
       sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
       attr_accessor :results
 
+      # 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::WebSearchResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           query: String,
           results:
-            T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash]
+            T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash],
+          key_metadata:
+            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Echo of the original query (useful when fanout was enabled).
         query:,
-        results:
+        results:,
+        # 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
 
@@ -36,7 +56,8 @@ module ContextDev
         override.returns(
           {
             query: String,
-            results: T::Array[ContextDev::Models::WebSearchResponse::Result]
+            results: T::Array[ContextDev::Models::WebSearchResponse::Result],
+            key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata
           }
         )
       end
@@ -266,6 +287,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebSearchResponse::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_web_crawl_md_response.rbi

@@ -26,21 +26,48 @@ module ContextDev
       end
       attr_accessor :results
 
+      # 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::WebWebCrawlMdResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash,
           results:
-            T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash]
+            T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash],
+          key_metadata:
+            ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(metadata:, results:)
+      def self.new(
+        metadata:,
+        results:,
+        # 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
 
       sig do
         override.returns(
           {
             metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata,
-            results: T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result]
+            results:
+              T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result],
+            key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata
           }
         )
       end
@@ -235,6 +262,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebCrawlMdResponse::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_web_scrape_html_response.rbi

@@ -38,13 +38,32 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # 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::WebWebScrapeHTMLResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           html: String,
           success:
             ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean,
           type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::OrSymbol,
-          url: String
+          url: String,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -58,7 +77,10 @@ module ContextDev
         # surfaced as `xml`; ordinary pages are `html`.
         type:,
         # The URL that was scraped
-        url:
+        url:,
+        # 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
 
@@ -70,7 +92,9 @@ module ContextDev
               ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean,
             type:
               ContextDev::Models::WebWebScrapeHTMLResponse::Type::TaggedSymbol,
-            url: String
+            url: String,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata
           }
         )
       end
@@ -169,6 +193,47 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeHTMLResponse::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_web_scrape_images_response.rbi

@@ -29,6 +29,23 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # 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::WebWebScrapeImagesResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           images:
@@ -37,7 +54,9 @@ module ContextDev
             ],
           success:
             ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean,
-          url: String
+          url: String,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -46,7 +65,10 @@ module ContextDev
         # Always true on success.
         success:,
         # Page URL that was scraped.
-        url:
+        url:,
+        # 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
 
@@ -57,7 +79,9 @@ module ContextDev
               T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
             success:
               ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean,
-            url: String
+            url: String,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata
           }
         )
       end
@@ -459,6 +483,47 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeImagesResponse::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