context.dev 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ef98d3030c8e13d2b4d3ec497e6b4603b18108b853b2dfbf72b784fcf2797d5
-  data.tar.gz: 05571a05f9ca05ca7b76fef39a942eccc063cd067584537af015c3c75bd8c171
+  metadata.gz: b7dd8a479baecbe8b5b5a3f70afc6b36ac9a4a6fc601efaed7975f7fdd5f0f8d
+  data.tar.gz: 24b81ca370c0fa65982b4fd6e1ef32ef8b4c9095ba26e6190848dd3551946e0f
 SHA512:
-  metadata.gz: 535b48a03656e47a7936e4e57b6e93cc479cfadb801a8d0b1d0dd814bfaa5be9612778286f2dde0727b3274e8fd14efa9248e1609a9ef07e22c65a3e64205d0a
-  data.tar.gz: 1da1214b1edddf28e4c442870b77fa58e117a0da698fb32a7c9f0562f760d40f784db28751aaf018d51c0e87c0597d5b9160e97aa9e3c4c5965f6c5671642c1b
+  metadata.gz: a7b014eb4f206b0e8629ef80c8a7ac817ec115694666d631438a2637266cb4cb5abde270c126afab870698c78d24211feb02f1350494816c5a99939cb07b9243
+  data.tar.gz: e2923cfd44f29539153438f72e73d7d1543bf85893731fe152afe3bdfdd1b93ea36e4407f69b7998a757c1820d9c8c8d0838539a1b14d522cec63066ea1ac26e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.12.0...v2.13.0) (2026-08-27)
+
+
+### Features
+
+* initial stlc build ([bf63ae0](https://github.com/context-dot-dev/context-ruby-sdk/commit/bf63ae0769d9756a0b36480fd0c2d05ae939997c))
+
 ## 2.12.0 (2026-08-23)
 
 Full Changelog: [v2.11.0...v2.12.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.11.0...v2.12.0)

data/README.md

@@ -8,8 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 Use the Context Dev MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
 
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=context.dev-mcp&config=eyJuYW1lIjoiY29udGV4dC5kZXYtbWNwIiwidHJhbnNwb3J0IjoiaHR0cCIsInVybCI6Imh0dHBzOi8vY29udGV4dC1kZXYuc3RsbWNwLmNvbSIsImhlYWRlcnMiOnsieC1jb250ZXh0LWRldi1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22context.dev-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fcontext-dev.stlmcp.com%22%2C%22headers%22%3A%7B%22x-context-dev-api-key%22%3A%22My%20API%20Key%22%7D%7D)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=context.dev-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbnRleHQuZGV2LW1jcCJdLCJlbnYiOnsiQ09OVEVYVF9ERVZfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22context.dev-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22context.dev-mcp%22%5D%2C%22env%22%3A%7B%22CONTEXT_DEV_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.12.0"
+gem "context.dev", "~> 2.13.0"
 ```
 
 <!-- x-release-please-end -->
@@ -43,7 +43,7 @@ context_dev = ContextDev::Client.new(
 
 brand = context_dev.brand.retrieve(body: {domain: "stripe.com", type: "by_domain"})
 
-puts(brand.brand)
+puts(brand.cache_metadata)
 ```
 
 ### Handling errors

data/lib/context_dev/models/ai_extract_product_response.rb

@@ -4,6 +4,14 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::AI#extract_product
     class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::AIExtractProductResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::AIExtractProductResponse::CacheMetadata }
+
       # @!attribute is_product_page
       #   Whether the given URL is a product detail page
       #
@@ -29,10 +37,12 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
       optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
 
-      # @!method initialize(is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
+      # @!method initialize(cache_metadata:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductResponse} for more details.
       #
+      #   @param cache_metadata [ContextDev::Models::AIExtractProductResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param is_product_page [Boolean] Whether the given URL is a product detail page
       #
       #   @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
@@ -41,6 +51,49 @@ module ContextDev
       #
       #   @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page
 
+      # @see ContextDev::Models::AIExtractProductResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::AIExtractProductResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::AIExtractProductResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::AIExtractProductResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/ai_extract_products_response.rb

@@ -4,6 +4,14 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::AI#extract_products
     class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::AIExtractProductsResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata }
+
       # @!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.
@@ -18,14 +26,59 @@ module ContextDev
       optional :products,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
 
-      # @!method initialize(key_metadata: nil, products: nil)
+      # @!method initialize(cache_metadata:, key_metadata: nil, products: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductsResponse} for more details.
       #
+      #   @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
       #
       #   @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
 
+      # @see ContextDev::Models::AIExtractProductsResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::AIExtractProductsResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::AIExtractProductsResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::AIExtractProductsResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/batch_get_results_response.rb

@@ -55,6 +55,14 @@ module ContextDev
         variant :error, -> { ContextDev::Models::BatchGetResultsResponse::Data::Error }
 
         class Ok < ContextDev::Internal::Type::BaseModel
+          # @!attribute cache_metadata
+          #   Cache outcome for this response. Composite responses are hits only when every
+          #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+          #   oldest contributing hit.
+          #
+          #   @return [ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata]
+          required :cache_metadata, -> { ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata }
+
           # @!attribute final_url
           #   URL the content was read from, after redirects.
           #
@@ -117,12 +125,14 @@ module ContextDev
           #   @return [Integer, nil]
           optional :ocr_pages, Integer
 
-          # @!method initialize(final_url:, http_status:, metadata:, url:, html: nil, item_id: nil, markdown: nil, meta: nil, ocr_pages: nil, status: :ok)
+          # @!method initialize(cache_metadata:, final_url:, http_status:, metadata:, url:, html: nil, item_id: nil, markdown: nil, meta: nil, ocr_pages: nil, status: :ok)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::BatchGetResultsResponse::Data::Ok} for more details.
           #
           #   A page the batch fetched successfully.
           #
+          #   @param cache_metadata [ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+          #
           #   @param final_url [String] URL the content was read from, after redirects.
           #
           #   @param http_status [Integer, nil] HTTP status of the final response, when known.
@@ -143,6 +153,51 @@ module ContextDev
           #
           #   @param status [Symbol, :ok] The page was scraped.
 
+          # @see ContextDev::Models::BatchGetResultsResponse::Data::Ok#cache_metadata
+          class CacheMetadata < ContextDev::Internal::Type::BaseModel
+            # @!attribute age_ms
+            #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+            #
+            #   @return [Integer]
+            required :age_ms, Integer
+
+            # @!attribute status
+            #   Whether the response was served from cache, required fresh work, or honored
+            #   zero-data-retention cache bypass.
+            #
+            #   @return [Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status]
+            required :status,
+                     enum: -> { ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status }
+
+            # @!method initialize(age_ms:, status:)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata} for more
+            #   details.
+            #
+            #   Cache outcome for this response. Composite responses are hits only when every
+            #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+            #   oldest contributing hit.
+            #
+            #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+            #
+            #   @param status [Symbol, ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+            # Whether the response was served from cache, required fresh work, or honored
+            # zero-data-retention cache bypass.
+            #
+            # @see ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata#status
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              HIT = :hit
+              MISS = :miss
+              ZDR = :zdr
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           # @see ContextDev::Models::BatchGetResultsResponse::Data::Ok#metadata
           class Metadata < ContextDev::Internal::Type::BaseModel
             # @!attribute final_url

data/lib/context_dev/models/batch_submit_response.rb

@@ -10,6 +10,14 @@ module ContextDev
       #   @return [String]
       required :id, String
 
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::BatchSubmitResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::BatchSubmitResponse::CacheMetadata }
+
       # @!attribute crawl
       #   The crawl controls as submitted, so the limits requested can be compared against
       #   what the crawl reached.
@@ -79,12 +87,14 @@ module ContextDev
       #   @return [String, nil]
       optional :webhook_secret, String
 
-      # @!method initialize(id:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
+      # @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchSubmitResponse} for more details.
       #
       #   @param id [String] Batch ID. Poll GET /batch/{batch_id} with it.
       #
+      #   @param cache_metadata [ContextDev::Models::BatchSubmitResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param crawl [ContextDev::Models::CrawlControls, nil] The crawl controls as submitted, so the limits requested can be compared against
       #
       #   @param created_at [String] When the batch was created.
@@ -107,6 +117,49 @@ module ContextDev
       #
       #   @param webhook_secret [String] Signing secret for the completion webhook, returned only here and never again. S
 
+      # @see ContextDev::Models::BatchSubmitResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BatchSubmitResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BatchSubmitResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BatchSubmitResponse#credits
       class Credits < ContextDev::Internal::Type::BaseModel
         # @!attribute reserved

data/lib/context_dev/models/brand_retrieve_response.rb

@@ -4,6 +4,14 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve
     class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata }
+
       # @!attribute brand
       #   Detailed brand information
       #
@@ -29,10 +37,12 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveResponse} for more details.
       #
+      #   @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
       #
       #   @param code [Integer] HTTP status code
@@ -41,6 +51,49 @@ module ContextDev
       #
       #   @param status [String] Status of the response, e.g., 'ok'
 
+      # @see ContextDev::Models::BrandRetrieveResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
         # @!attribute address
@@ -106,7 +159,9 @@ module ContextDev
         optional :links, -> { ContextDev::Models::BrandRetrieveResponse::Brand::Links }
 
         # @!attribute logos
-        #   An array of logos associated with the brand
+        #   An array of logos associated with the brand. When a similarly shaped SVG variant
+        #   exists, it is returned ahead of its raster equivalent; otherwise relevance order
+        #   is preserved
         #
         #   @return [Array<ContextDev::Models::BrandRetrieveResponse::Brand::Logo>, nil]
         optional :logos,
@@ -178,7 +233,7 @@ module ContextDev
         #
         #   @param links [ContextDev::Models::BrandRetrieveResponse::Brand::Links] Important website links for the brand
         #
-        #   @param logos [Array<ContextDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
+        #   @param logos [Array<ContextDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand. When a similarly shaped SVG variant
         #
         #   @param phone [String] Company phone number
         #

data/lib/context_dev/models/brand_retrieve_simplified_response.rb

@@ -4,6 +4,14 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve_simplified
     class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata }
+
       # @!attribute brand
       #   Simplified brand information
       #
@@ -29,10 +37,12 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
       #
+      #   @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
       #
       #   @param code [Integer] HTTP status code of the response
@@ -41,6 +51,50 @@ module ContextDev
       #
       #   @param status [String] Status of the response, e.g., 'ok'
 
+      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
+        #   details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
         # @!attribute backdrops

data/lib/context_dev/models/web_extract_fonts_response.rb

@@ -4,6 +4,14 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Web#extract_fonts
     class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute cache_metadata
+      #   Cache outcome for this response. Composite responses are hits only when every
+      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+      #   oldest contributing hit.
+      #
+      #   @return [ContextDev::Models::WebExtractFontsResponse::CacheMetadata]
+      required :cache_metadata, -> { ContextDev::Models::WebExtractFontsResponse::CacheMetadata }
+
       # @!attribute code
       #   HTTP status code, e.g., 200
       #
@@ -46,10 +54,12 @@ module ContextDev
       #   @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)
+      # @!method initialize(cache_metadata:, code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractFontsResponse} for more details.
       #
+      #   @param cache_metadata [ContextDev::Models::WebExtractFontsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #
       #   @param code [Integer] HTTP status code, e.g., 200
       #
       #   @param domain [String] The normalized domain that was processed
@@ -62,6 +72,49 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
+      # @see ContextDev::Models::WebExtractFontsResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebExtractFontsResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::WebExtractFontsResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       class Font < ContextDev::Internal::Type::BaseModel
         # @!attribute fallbacks
         #   Array of fallback font families