diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 0746cbe2..e6eadb43 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.12.0" + ".": "2.13.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index ad6cd802..9aabd7da 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 41 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-2c3f4e4b357ca78c019a3aacd006e2bb8b332d4172a300ee6c46c076a216ed3f.yml -openapi_spec_hash: b89be415cf6ee594b521885a9deb25ac +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-dc61df29e1b6282f9df685fadd65f3683afe352deccae94d0c080092e0eae4b3.yml +openapi_spec_hash: 258caa98cd0de5f7149f6937d071c912 config_hash: 0fb0ceca5946298c416cec0cca5260c7 diff --git a/CHANGELOG.md b/CHANGELOG.md index 6230918d..92fa3265 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## 2.13.0 (2026-08-27) + +Full Changelog: [v2.12.0...v2.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.12.0...v2.13.0) + +### Features + +* **api:** api update ([4013ce1](https://github.com/context-dot-dev/context-ruby-sdk/commit/4013ce1096f05d3ccf50bf261eb04c6e10daf23a)) +* **api:** api update ([52fcdf2](https://github.com/context-dot-dev/context-ruby-sdk/commit/52fcdf27ba3a0a00c7ebc3800d2057dde4b620dc)) + ## 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) diff --git a/Gemfile.lock b/Gemfile.lock index cacfdc3a..10fa530d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (2.12.0) + context.dev (2.13.0) cgi connection_pool diff --git a/README.md b/README.md index 611fa5cb..cd3adfea 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 2.12.0" +gem "context.dev", "~> 2.13.0" ``` @@ -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 diff --git a/lib/context_dev/models/ai_extract_product_response.rb b/lib/context_dev/models/ai_extract_product_response.rb index adb580c6..d9f8e317 100644 --- a/lib/context_dev/models/ai_extract_product_response.rb +++ b/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 @@ class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel # # @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] + end + end + # @see ContextDev::Models::AIExtractProductResponse#key_metadata class KeyMetadata < ContextDev::Internal::Type::BaseModel # @!attribute credits_consumed diff --git a/lib/context_dev/models/ai_extract_products_response.rb b/lib/context_dev/models/ai_extract_products_response.rb index 22c9ba3c..75ebfb67 100644 --- a/lib/context_dev/models/ai_extract_products_response.rb +++ b/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 @@ class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel 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] 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] + end + end + # @see ContextDev::Models::AIExtractProductsResponse#key_metadata class KeyMetadata < ContextDev::Internal::Type::BaseModel # @!attribute credits_consumed diff --git a/lib/context_dev/models/batch_get_results_response.rb b/lib/context_dev/models/batch_get_results_response.rb index 8e24062b..a14c2077 100644 --- a/lib/context_dev/models/batch_get_results_response.rb +++ b/lib/context_dev/models/batch_get_results_response.rb @@ -55,6 +55,14 @@ module Data 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 @@ class Ok < ContextDev::Internal::Type::BaseModel # @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 @@ class Ok < ContextDev::Internal::Type::BaseModel # # @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] + end + end + # @see ContextDev::Models::BatchGetResultsResponse::Data::Ok#metadata class Metadata < ContextDev::Internal::Type::BaseModel # @!attribute final_url diff --git a/lib/context_dev/models/batch_submit_response.rb b/lib/context_dev/models/batch_submit_response.rb index 40dff81a..12ac3613 100644 --- a/lib/context_dev/models/batch_submit_response.rb +++ b/lib/context_dev/models/batch_submit_response.rb @@ -10,6 +10,14 @@ class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel # # @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] + end + end + # @see ContextDev::Models::BatchSubmitResponse#credits class Credits < ContextDev::Internal::Type::BaseModel # @!attribute reserved diff --git a/lib/context_dev/models/brand_retrieve_response.rb b/lib/context_dev/models/brand_retrieve_response.rb index 44dd5e63..26046f66 100644 --- a/lib/context_dev/models/brand_retrieve_response.rb +++ b/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 @@ class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel # # @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] + end + end + # @see ContextDev::Models::BrandRetrieveResponse#brand class Brand < ContextDev::Internal::Type::BaseModel # @!attribute address @@ -106,7 +159,9 @@ class Brand < ContextDev::Internal::Type::BaseModel 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, nil] optional :logos, @@ -178,7 +233,7 @@ class Brand < ContextDev::Internal::Type::BaseModel # # @param links [ContextDev::Models::BrandRetrieveResponse::Brand::Links] Important website links for the brand # - # @param logos [Array] An array of logos associated with the brand + # @param logos [Array] An array of logos associated with the brand. When a similarly shaped SVG variant # # @param phone [String] Company phone number # diff --git a/lib/context_dev/models/brand_retrieve_simplified_response.rb b/lib/context_dev/models/brand_retrieve_simplified_response.rb index b42dde6e..518cdd05 100644 --- a/lib/context_dev/models/brand_retrieve_simplified_response.rb +++ b/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 @@ class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel # # @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] + end + end + # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand class Brand < ContextDev::Internal::Type::BaseModel # @!attribute backdrops diff --git a/lib/context_dev/models/web_extract_fonts_response.rb b/lib/context_dev/models/web_extract_fonts_response.rb index 66a7bb8d..7a93870d 100644 --- a/lib/context_dev/models/web_extract_fonts_response.rb +++ b/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 @@ class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel # @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 @@ class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel # # @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] + end + end + class Font < ContextDev::Internal::Type::BaseModel # @!attribute fallbacks # Array of fallback font families diff --git a/lib/context_dev/models/web_extract_response.rb b/lib/context_dev/models/web_extract_response.rb index 3637820e..c8fd29a8 100644 --- a/lib/context_dev/models/web_extract_response.rb +++ b/lib/context_dev/models/web_extract_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#extract class WebExtractResponse < 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::WebExtractResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebExtractResponse::CacheMetadata } + # @!attribute data # Extracted data matching the request schema # @@ -40,10 +48,12 @@ class WebExtractResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata } - # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil) + # @!method initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebExtractResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebExtractResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param data [Hash{Symbol=>Object}] Extracted data matching the request schema # # @param metadata [ContextDev::Models::WebExtractResponse::Metadata] @@ -56,6 +66,49 @@ class WebExtractResponse < ContextDev::Internal::Type::BaseModel # # @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#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::WebExtractResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebExtractResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractResponse::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::WebExtractResponse::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::WebExtractResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebExtractResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel # @!attribute max_crawl_depth diff --git a/lib/context_dev/models/web_extract_styleguide_response.rb b/lib/context_dev/models/web_extract_styleguide_response.rb index edbcc801..9f7ecdd4 100644 --- a/lib/context_dev/models/web_extract_styleguide_response.rb +++ b/lib/context_dev/models/web_extract_styleguide_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#extract_styleguide class WebExtractStyleguideResponse < 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::WebExtractStyleguideResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata } + # @!attribute code # HTTP status code # @@ -35,10 +43,12 @@ class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil] optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide } - # @!method initialize(code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil) + # @!method initialize(cache_metadata:, 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 cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param code [Integer] HTTP status code # # @param domain [String] The normalized domain that was processed @@ -49,6 +59,50 @@ class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel # # @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website + # @see ContextDev::Models::WebExtractStyleguideResponse#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::WebExtractStyleguideResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractStyleguideResponse::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::WebExtractStyleguideResponse::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::WebExtractStyleguideResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata class KeyMetadata < ContextDev::Internal::Type::BaseModel # @!attribute credits_consumed diff --git a/lib/context_dev/models/web_screenshot_response.rb b/lib/context_dev/models/web_screenshot_response.rb index bfec9c69..f5ecb4e7 100644 --- a/lib/context_dev/models/web_screenshot_response.rb +++ b/lib/context_dev/models/web_screenshot_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#screenshot class WebScreenshotResponse < 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::WebScreenshotResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata } + # @!attribute code # HTTP status code # @@ -56,10 +64,12 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :width, Integer - # @!method initialize(code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil) + # @!method initialize(cache_metadata:, 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 cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param code [Integer] HTTP status code # # @param domain [String] The normalized domain that was processed @@ -76,6 +86,49 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # # @param width [Integer] Width in pixels of the returned screenshot image + # @see ContextDev::Models::WebScreenshotResponse#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::WebScreenshotResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebScreenshotResponse::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::WebScreenshotResponse::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::WebScreenshotResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebScreenshotResponse#key_metadata class KeyMetadata < ContextDev::Internal::Type::BaseModel # @!attribute credits_consumed diff --git a/lib/context_dev/models/web_search_response.rb b/lib/context_dev/models/web_search_response.rb index f263a333..4ec380ed 100644 --- a/lib/context_dev/models/web_search_response.rb +++ b/lib/context_dev/models/web_search_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#search class WebSearchResponse < 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::WebSearchResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebSearchResponse::CacheMetadata } + # @!attribute query # Echo of the original query (useful when fanout was enabled). # @@ -23,16 +31,61 @@ class WebSearchResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata } - # @!method initialize(query:, results:, key_metadata: nil) + # @!method initialize(cache_metadata:, query:, results:, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebSearchResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebSearchResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param query [String] Echo of the original query (useful when fanout was enabled). # # @param results [Array] # # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see ContextDev::Models::WebSearchResponse#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::WebSearchResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebSearchResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebSearchResponse::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::WebSearchResponse::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::WebSearchResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + class Result < ContextDev::Internal::Type::BaseModel # @!attribute description # Snippet excerpt from the page. diff --git a/lib/context_dev/models/web_web_crawl_md_response.rb b/lib/context_dev/models/web_web_crawl_md_response.rb index 54ab0e16..b8a23026 100644 --- a/lib/context_dev/models/web_web_crawl_md_response.rb +++ b/lib/context_dev/models/web_web_crawl_md_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#web_crawl_md class WebWebCrawlMdResponse < 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::WebWebCrawlMdResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata } + # @!attribute metadata # # @return [ContextDev::Models::WebWebCrawlMdResponse::Metadata] @@ -22,16 +30,61 @@ class WebWebCrawlMdResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } - # @!method initialize(metadata:, results:, key_metadata: nil) + # @!method initialize(cache_metadata:, metadata:, results:, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebCrawlMdResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata] # # @param results [Array] # # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see ContextDev::Models::WebWebCrawlMdResponse#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::WebWebCrawlMdResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebCrawlMdResponse::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::WebWebCrawlMdResponse::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::WebWebCrawlMdResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebWebCrawlMdResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel # @!attribute max_crawl_depth diff --git a/lib/context_dev/models/web_web_scrape_html_response.rb b/lib/context_dev/models/web_web_scrape_html_response.rb index bd6823de..6108d412 100644 --- a/lib/context_dev/models/web_web_scrape_html_response.rb +++ b/lib/context_dev/models/web_web_scrape_html_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#web_scrape_html class WebWebScrapeHTMLResponse < 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::WebWebScrapeHTMLResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata } + # @!attribute html # The scraped content of the page. For normal pages this is the raw HTML. When the # page is a sitemap or feed served behind an XSL stylesheet (which browsers render @@ -61,10 +69,12 @@ class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } - # @!method initialize(html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil) + # @!method initialize(cache_metadata:, html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeHTMLResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the # # @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML. @@ -81,6 +91,49 @@ class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # # @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see ContextDev::Models::WebWebScrapeHTMLResponse#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::WebWebScrapeHTMLResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebWebScrapeHTMLResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel # @!attribute final_url diff --git a/lib/context_dev/models/web_web_scrape_images_response.rb b/lib/context_dev/models/web_web_scrape_images_response.rb index fc58fe83..0dc6463c 100644 --- a/lib/context_dev/models/web_web_scrape_images_response.rb +++ b/lib/context_dev/models/web_web_scrape_images_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#web_scrape_images class WebWebScrapeImagesResponse < 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::WebWebScrapeImagesResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata } + # @!attribute images # Images found on the page. # @@ -38,10 +46,12 @@ class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } - # @!method initialize(images:, success:, url:, actions_applied: nil, key_metadata: nil) + # @!method initialize(cache_metadata:, images:, success:, url:, actions_applied: nil, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeImagesResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param images [Array] Images found on the page. # # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success. @@ -52,6 +62,50 @@ class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel # # @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see ContextDev::Models::WebWebScrapeImagesResponse#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::WebWebScrapeImagesResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + class Image < ContextDev::Internal::Type::BaseModel # @!attribute alt # Image alt text, or null when unavailable. diff --git a/lib/context_dev/models/web_web_scrape_md_response.rb b/lib/context_dev/models/web_web_scrape_md_response.rb index 99339e86..72b65bf6 100644 --- a/lib/context_dev/models/web_web_scrape_md_response.rb +++ b/lib/context_dev/models/web_web_scrape_md_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#web_scrape_md class WebWebScrapeMdResponse < 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::WebWebScrapeMdResponse::CacheMetadata] + required :cache_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata } + # @!attribute content_length # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result # and compare small values against your workload's minimum useful-content @@ -66,10 +74,12 @@ class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } - # @!method initialize(content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil) + # @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeMdResponse} for more details. # + # @param cache_metadata [ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca + # # @param content_length [Integer] UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result an # # @param markdown [String] Page content converted to GitHub Flavored Markdown @@ -88,6 +98,49 @@ class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # # @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see ContextDev::Models::WebWebScrapeMdResponse#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::WebWebScrapeMdResponse::CacheMetadata::Status] + required :status, enum: -> { ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status } + + # @!method initialize(age_ms:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeMdResponse::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::WebWebScrapeMdResponse::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::WebWebScrapeMdResponse::CacheMetadata#status + module Status + extend ContextDev::Internal::Type::Enum + + HIT = :hit + MISS = :miss + ZDR = :zdr + + # @!method self.values + # @return [Array] + end + end + # @see ContextDev::Models::WebWebScrapeMdResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel # @!attribute final_url diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 9bf00f9c..7ee161bb 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "2.12.0" + VERSION = "2.13.0" end diff --git a/rbi/context_dev/models/ai_extract_product_response.rbi b/rbi/context_dev/models/ai_extract_product_response.rbi index 6e49b0f3..8105df08 100644 --- a/rbi/context_dev/models/ai_extract_product_response.rbi +++ b/rbi/context_dev/models/ai_extract_product_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::AIExtractProductResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Whether the given URL is a product detail page sig { returns(T.nilable(T::Boolean)) } attr_reader :is_product_page @@ -65,6 +81,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash, is_product_page: T::Boolean, key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash, @@ -79,6 +97,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Whether the given URL is a product detail page is_product_page: nil, # Metadata about the API key used for the request. Included in every response @@ -94,6 +116,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::AIExtractProductResponse::CacheMetadata, is_product_page: T::Boolean, key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, @@ -109,6 +133,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::AIExtractProductResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class KeyMetadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/ai_extract_products_response.rbi b/rbi/context_dev/models/ai_extract_products_response.rbi index bb14b00c..13ebd23e 100644 --- a/rbi/context_dev/models/ai_extract_products_response.rbi +++ b/rbi/context_dev/models/ai_extract_products_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::AIExtractProductsResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_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. sig do @@ -50,6 +66,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::OrHash, key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash, products: @@ -59,6 +77,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_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. key_metadata: nil, @@ -70,6 +92,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::AIExtractProductsResponse::CacheMetadata, key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: @@ -80,6 +104,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::AIExtractProductsResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::AIExtractProductsResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class KeyMetadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/batch_get_results_response.rbi b/rbi/context_dev/models/batch_get_results_response.rbi index 86782247..b29da622 100644 --- a/rbi/context_dev/models/batch_get_results_response.rbi +++ b/rbi/context_dev/models/batch_get_results_response.rbi @@ -130,6 +130,24 @@ module ContextDev ) end + # 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. + sig do + returns( + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata + ) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # URL the content was read from, after redirects. sig { returns(String) } attr_accessor :final_url @@ -202,6 +220,8 @@ module ContextDev # A page the batch fetched successfully. sig do params( + cache_metadata: + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::OrHash, final_url: String, http_status: T.nilable(Integer), metadata: @@ -216,6 +236,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # URL the content was read from, after redirects. final_url:, # HTTP status of the final response, when known. @@ -244,6 +268,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata, final_url: String, http_status: T.nilable(Integer), metadata: @@ -261,6 +287,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Metadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/batch_submit_response.rbi b/rbi/context_dev/models/batch_submit_response.rbi index f8502c65..c829868c 100644 --- a/rbi/context_dev/models/batch_submit_response.rbi +++ b/rbi/context_dev/models/batch_submit_response.rbi @@ -15,6 +15,20 @@ module ContextDev sig { returns(String) } attr_accessor :id + # 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. + sig { returns(ContextDev::Models::BatchSubmitResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::BatchSubmitResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # The crawl controls as submitted, so the limits requested can be compared against # what the crawl reached. sig { returns(T.nilable(ContextDev::CrawlControls)) } @@ -98,6 +112,8 @@ module ContextDev sig do params( id: String, + cache_metadata: + ContextDev::Models::BatchSubmitResponse::CacheMetadata::OrHash, crawl: T.nilable(ContextDev::CrawlControls::OrHash), created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits::OrHash, @@ -118,6 +134,10 @@ module ContextDev def self.new( # Batch ID. Poll GET /batch/{batch_id} with it. id:, + # 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. + cache_metadata:, # The crawl controls as submitted, so the limits requested can be compared against # what the crawl reached. crawl:, @@ -149,6 +169,8 @@ module ContextDev override.returns( { id: String, + cache_metadata: + ContextDev::Models::BatchSubmitResponse::CacheMetadata, crawl: T.nilable(ContextDev::CrawlControls), created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits, @@ -169,6 +191,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BatchSubmitResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::BatchSubmitResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Credits < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/brand_retrieve_response.rbi b/rbi/context_dev/models/brand_retrieve_response.rbi index f91ea189..eb0b4b9b 100644 --- a/rbi/context_dev/models/brand_retrieve_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::BrandRetrieveResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Detailed brand information sig do returns(T.nilable(ContextDev::Models::BrandRetrieveResponse::Brand)) @@ -57,6 +71,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash, brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash, code: Integer, key_metadata: @@ -65,6 +81,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Detailed brand information brand: nil, # HTTP status code @@ -80,6 +100,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::BrandRetrieveResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, key_metadata: @@ -91,6 +113,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Brand < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do @@ -238,7 +355,9 @@ module ContextDev end attr_writer :links - # 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 sig do returns( T.nilable( @@ -389,7 +508,9 @@ module ContextDev is_nsfw: nil, # Important website links for the brand links: nil, - # 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 logos: nil, # Company phone number phone: nil, diff --git a/rbi/context_dev/models/brand_retrieve_simplified_response.rbi b/rbi/context_dev/models/brand_retrieve_simplified_response.rbi index da89c784..fa4c8b0e 100644 --- a/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_simplified_response.rbi @@ -11,6 +11,24 @@ module ContextDev ) end + # 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. + sig do + returns( + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata + ) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Simplified brand information sig do returns( @@ -62,6 +80,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash, brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash, code: Integer, @@ -71,6 +91,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Simplified brand information brand: nil, # HTTP status code of the response @@ -86,6 +110,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, key_metadata: @@ -97,6 +123,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Brand < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_extract_fonts_response.rbi b/rbi/context_dev/models/web_extract_fonts_response.rbi index f733cb52..3db2dddb 100644 --- a/rbi/context_dev/models/web_extract_fonts_response.rbi +++ b/rbi/context_dev/models/web_extract_fonts_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::WebExtractFontsResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # HTTP status code, e.g., 200 sig { returns(Integer) } attr_accessor :code @@ -74,6 +90,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::OrHash, code: Integer, domain: String, fonts: @@ -89,6 +107,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # HTTP status code, e.g., 200 code:, # The normalized domain that was processed @@ -110,6 +132,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebExtractFontsResponse::CacheMetadata, code: Integer, domain: String, fonts: T::Array[ContextDev::Models::WebExtractFontsResponse::Font], @@ -127,6 +151,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractFontsResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebExtractFontsResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Font < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_extract_response.rbi b/rbi/context_dev/models/web_extract_response.rbi index af444db0..e7ace608 100644 --- a/rbi/context_dev/models/web_extract_response.rbi +++ b/rbi/context_dev/models/web_extract_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::WebExtractResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebExtractResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Extracted data matching the request schema sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :data @@ -54,6 +68,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebExtractResponse::CacheMetadata::OrHash, data: T::Hash[Symbol, T.anything], metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash, status: String, @@ -64,6 +80,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Extracted data matching the request schema data:, metadata:, @@ -82,6 +102,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebExtractResponse::CacheMetadata, data: T::Hash[Symbol, T.anything], metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, @@ -94,6 +116,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebExtractResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebExtractResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Metadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_extract_styleguide_response.rbi b/rbi/context_dev/models/web_extract_styleguide_response.rbi index 864321d0..9747f75f 100644 --- a/rbi/context_dev/models/web_extract_styleguide_response.rbi +++ b/rbi/context_dev/models/web_extract_styleguide_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # HTTP status code sig { returns(T.nilable(Integer)) } attr_reader :code @@ -71,6 +87,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::OrHash, code: Integer, domain: String, key_metadata: @@ -81,6 +99,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # HTTP status code code: nil, # The normalized domain that was processed @@ -98,6 +120,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, code: Integer, domain: String, key_metadata: @@ -111,6 +135,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class KeyMetadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_screenshot_response.rbi b/rbi/context_dev/models/web_screenshot_response.rbi index 42f8dec3..4ecb0172 100644 --- a/rbi/context_dev/models/web_screenshot_response.rbi +++ b/rbi/context_dev/models/web_screenshot_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::WebScreenshotResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebScreenshotResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # HTTP status code sig { returns(T.nilable(Integer)) } attr_reader :code @@ -91,6 +105,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebScreenshotResponse::CacheMetadata::OrHash, code: Integer, domain: String, height: Integer, @@ -104,6 +120,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # HTTP status code code: nil, # The normalized domain that was processed @@ -128,6 +148,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebScreenshotResponse::CacheMetadata, code: Integer, domain: String, height: Integer, @@ -144,6 +166,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebScreenshotResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebScreenshotResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class KeyMetadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_search_response.rbi b/rbi/context_dev/models/web_search_response.rbi index 17f1c2ce..e1e3b93f 100644 --- a/rbi/context_dev/models/web_search_response.rbi +++ b/rbi/context_dev/models/web_search_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::WebSearchResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebSearchResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Echo of the original query (useful when fanout was enabled). sig { returns(String) } attr_accessor :query @@ -35,6 +49,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebSearchResponse::CacheMetadata::OrHash, query: String, results: T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash], @@ -43,6 +59,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Echo of the original query (useful when fanout was enabled). query:, results:, @@ -55,6 +75,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebSearchResponse::CacheMetadata, query: String, results: T::Array[ContextDev::Models::WebSearchResponse::Result], key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata @@ -64,6 +86,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebSearchResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebSearchResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebSearchResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Result < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_crawl_md_response.rbi b/rbi/context_dev/models/web_web_crawl_md_response.rbi index 804d3c35..6843a3ff 100644 --- a/rbi/context_dev/models/web_web_crawl_md_response.rbi +++ b/rbi/context_dev/models/web_web_crawl_md_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + sig { returns(ContextDev::Models::WebWebCrawlMdResponse::Metadata) } attr_reader :metadata @@ -45,6 +59,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::OrHash, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash, results: T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash], @@ -53,6 +69,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, metadata:, results:, # Metadata about the API key used for the request. Included in every response @@ -64,6 +84,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, results: T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], @@ -74,6 +96,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Metadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_scrape_html_response.rbi b/rbi/context_dev/models/web_web_scrape_html_response.rbi index f45d6659..172fe12f 100644 --- a/rbi/context_dev/models/web_web_scrape_html_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # The scraped content of the page. For normal pages this is the raw HTML. When the # page is a sitemap or feed served behind an XSL stylesheet (which browsers render # into HTML), this is the underlying XML instead — see the `type` field. @@ -101,6 +117,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::OrHash, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::OrHash, @@ -118,6 +136,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # The scraped content of the page. For normal pages this is the raw HTML. When the # page is a sitemap or feed served behind an XSL stylesheet (which browsers render # into HTML), this is the underlying XML instead — see the `type` field. @@ -147,6 +169,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata, success: @@ -167,6 +191,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Metadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_scrape_images_response.rbi b/rbi/context_dev/models/web_web_scrape_images_response.rbi index f05ac660..dead16b2 100644 --- a/rbi/context_dev/models/web_web_scrape_images_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_response.rbi @@ -11,6 +11,22 @@ module ContextDev ) end + # 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. + sig do + returns(ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata) + end + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # Images found on the page. sig do returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image]) @@ -70,6 +86,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash, images: T::Array[ ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash @@ -86,6 +104,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # Images found on the page. images:, # Always true on success. @@ -103,6 +125,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, images: T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: @@ -120,6 +144,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Image < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_scrape_md_response.rbi b/rbi/context_dev/models/web_web_scrape_md_response.rbi index 371c3a21..294bc632 100644 --- a/rbi/context_dev/models/web_web_scrape_md_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_response.rbi @@ -11,6 +11,20 @@ module ContextDev ) end + # 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. + sig { returns(ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata) } + attr_reader :cache_metadata + + sig do + params( + cache_metadata: + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::OrHash + ).void + end + attr_writer :cache_metadata + # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result # and compare small values against your workload's minimum useful-content # threshold. @@ -100,6 +114,8 @@ module ContextDev sig do params( + cache_metadata: + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::OrHash, content_length: Integer, markdown: String, metadata: @@ -118,6 +134,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # 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. + cache_metadata:, # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result # and compare small values against your workload's minimum useful-content # threshold. @@ -148,6 +168,8 @@ module ContextDev sig do override.returns( { + cache_metadata: + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, @@ -168,6 +190,101 @@ module ContextDev def to_hash end + class CacheMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, + ContextDev::Internal::AnyHash + ) + end + + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + sig { returns(Integer) } + attr_accessor :age_ms + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + sig do + returns( + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + ) + end + attr_accessor :status + + # 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. + sig do + params( + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Age of the cached data in milliseconds. Zero for miss and zdr responses. + age_ms:, + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + status: + ) + end + + sig do + override.returns( + { + age_ms: Integer, + status: + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + } + ) + end + def to_hash + end + + # Whether the response was served from cache, required fresh work, or honored + # zero-data-retention cache bypass. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIT = + T.let( + :hit, + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + ) + MISS = + T.let( + :miss, + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + ) + ZDR = + T.let( + :zdr, + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + class Metadata < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/sig/context_dev/models/ai_extract_product_response.rbs b/sig/context_dev/models/ai_extract_product_response.rbs index 7d2872e9..027e3067 100644 --- a/sig/context_dev/models/ai_extract_product_response.rbs +++ b/sig/context_dev/models/ai_extract_product_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type ai_extract_product_response = { + cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata, is_product_page: bool, key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, platform: ContextDev::Models::AIExtractProductResponse::platform?, @@ -9,6 +10,8 @@ module ContextDev } class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata + attr_reader is_product_page: bool? def is_product_page=: (bool) -> bool @@ -24,6 +27,7 @@ module ContextDev attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product? def initialize: ( + cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata, ?is_product_page: bool, ?key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, ?platform: ContextDev::Models::AIExtractProductResponse::platform?, @@ -31,12 +35,47 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata, is_product_page: bool, key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, platform: ContextDev::Models::AIExtractProductResponse::platform?, product: ContextDev::Models::AIExtractProductResponse::Product? } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::CacheMetadata::status] + end + end + type key_metadata = { credits_consumed: Integer, credits_remaining: Integer } diff --git a/sig/context_dev/models/ai_extract_products_response.rbs b/sig/context_dev/models/ai_extract_products_response.rbs index d327ebb4..a9792f99 100644 --- a/sig/context_dev/models/ai_extract_products_response.rbs +++ b/sig/context_dev/models/ai_extract_products_response.rbs @@ -2,11 +2,14 @@ module ContextDev module Models type ai_extract_products_response = { + cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata, key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata + attr_reader key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata? def key_metadata=: ( @@ -20,15 +23,51 @@ module ContextDev ) -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product] def initialize: ( + cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata, ?key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, ?products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata, key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status] + end + end + type key_metadata = { credits_consumed: Integer, credits_remaining: Integer } diff --git a/sig/context_dev/models/batch_get_results_response.rbs b/sig/context_dev/models/batch_get_results_response.rbs index a9e30000..c526a3ea 100644 --- a/sig/context_dev/models/batch_get_results_response.rbs +++ b/sig/context_dev/models/batch_get_results_response.rbs @@ -50,6 +50,7 @@ module ContextDev type ok = { + cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata, final_url: String, http_status: Integer?, metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata, @@ -63,6 +64,8 @@ module ContextDev } class Ok < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata + attr_accessor final_url: String attr_accessor http_status: Integer? @@ -94,6 +97,7 @@ module ContextDev def ocr_pages=: (Integer) -> Integer def initialize: ( + cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata, final_url: String, http_status: Integer?, metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata, @@ -107,6 +111,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata, final_url: String, http_status: Integer?, metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata, @@ -119,6 +124,40 @@ module ContextDev ocr_pages: Integer } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status] + end + end + type metadata = { final_url: String, diff --git a/sig/context_dev/models/batch_submit_response.rbs b/sig/context_dev/models/batch_submit_response.rbs index 0ac4fba2..abb6c8cf 100644 --- a/sig/context_dev/models/batch_submit_response.rbs +++ b/sig/context_dev/models/batch_submit_response.rbs @@ -3,6 +3,7 @@ module ContextDev type batch_submit_response = { id: String, + cache_metadata: ContextDev::Models::BatchSubmitResponse::CacheMetadata, crawl: ContextDev::CrawlControls?, created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits, @@ -19,6 +20,8 @@ module ContextDev class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel attr_accessor id: String + attr_accessor cache_metadata: ContextDev::Models::BatchSubmitResponse::CacheMetadata + attr_accessor crawl: ContextDev::CrawlControls? attr_accessor created_at: String @@ -49,6 +52,7 @@ module ContextDev def initialize: ( id: String, + cache_metadata: ContextDev::Models::BatchSubmitResponse::CacheMetadata, crawl: ContextDev::CrawlControls?, created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits, @@ -64,6 +68,7 @@ module ContextDev def to_hash: -> { id: String, + cache_metadata: ContextDev::Models::BatchSubmitResponse::CacheMetadata, crawl: ContextDev::CrawlControls?, created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits, @@ -77,6 +82,40 @@ module ContextDev webhook_secret: String } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::BatchSubmitResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::BatchSubmitResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::BatchSubmitResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::BatchSubmitResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::BatchSubmitResponse::CacheMetadata::status] + end + end + type credits = { reserved: Integer } class Credits < ContextDev::Internal::Type::BaseModel diff --git a/sig/context_dev/models/brand_retrieve_response.rbs b/sig/context_dev/models/brand_retrieve_response.rbs index 18080690..2d953540 100644 --- a/sig/context_dev/models/brand_retrieve_response.rbs +++ b/sig/context_dev/models/brand_retrieve_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type brand_retrieve_response = { + cache_metadata: ContextDev::Models::BrandRetrieveResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, @@ -9,6 +10,8 @@ module ContextDev } class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::BrandRetrieveResponse::CacheMetadata + attr_reader brand: ContextDev::Models::BrandRetrieveResponse::Brand? def brand=: ( @@ -30,6 +33,7 @@ module ContextDev def status=: (String) -> String def initialize: ( + cache_metadata: ContextDev::Models::BrandRetrieveResponse::CacheMetadata, ?brand: ContextDev::Models::BrandRetrieveResponse::Brand, ?code: Integer, ?key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, @@ -37,12 +41,47 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::BrandRetrieveResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::BrandRetrieveResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::BrandRetrieveResponse::CacheMetadata::status] + end + end + type brand = { address: ContextDev::Models::BrandRetrieveResponse::Brand::Address, diff --git a/sig/context_dev/models/brand_retrieve_simplified_response.rbs b/sig/context_dev/models/brand_retrieve_simplified_response.rbs index fbae681b..83a20dfc 100644 --- a/sig/context_dev/models/brand_retrieve_simplified_response.rbs +++ b/sig/context_dev/models/brand_retrieve_simplified_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type brand_retrieve_simplified_response = { + cache_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, @@ -9,6 +10,8 @@ module ContextDev } class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata + attr_reader brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand? def brand=: ( @@ -30,6 +33,7 @@ module ContextDev def status=: (String) -> String def initialize: ( + cache_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, ?brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, ?code: Integer, ?key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, @@ -37,12 +41,47 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::status] + end + end + type brand = { backdrops: ::Array[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop], diff --git a/sig/context_dev/models/web_extract_fonts_response.rbs b/sig/context_dev/models/web_extract_fonts_response.rbs index 4a2f6d96..89267879 100644 --- a/sig/context_dev/models/web_extract_fonts_response.rbs +++ b/sig/context_dev/models/web_extract_fonts_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_extract_fonts_response = { + cache_metadata: ContextDev::Models::WebExtractFontsResponse::CacheMetadata, code: Integer, domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], @@ -11,6 +12,8 @@ module ContextDev } class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebExtractFontsResponse::CacheMetadata + attr_accessor code: Integer attr_accessor domain: String @@ -32,6 +35,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractFontsResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebExtractFontsResponse::CacheMetadata, code: Integer, domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], @@ -41,6 +45,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebExtractFontsResponse::CacheMetadata, code: Integer, domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], @@ -49,6 +54,40 @@ module ContextDev key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebExtractFontsResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebExtractFontsResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebExtractFontsResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebExtractFontsResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebExtractFontsResponse::CacheMetadata::status] + end + end + type font = { fallbacks: ::Array[String], diff --git a/sig/context_dev/models/web_extract_response.rbs b/sig/context_dev/models/web_extract_response.rbs index 59142056..3fa6eb0a 100644 --- a/sig/context_dev/models/web_extract_response.rbs +++ b/sig/context_dev/models/web_extract_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_extract_response = { + cache_metadata: ContextDev::Models::WebExtractResponse::CacheMetadata, data: ::Hash[Symbol, top], metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, @@ -11,6 +12,8 @@ module ContextDev } class WebExtractResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebExtractResponse::CacheMetadata + attr_accessor data: ::Hash[Symbol, top] attr_accessor metadata: ContextDev::Models::WebExtractResponse::Metadata @@ -28,6 +31,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebExtractResponse::CacheMetadata, data: ::Hash[Symbol, top], metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, @@ -37,6 +41,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebExtractResponse::CacheMetadata, data: ::Hash[Symbol, top], metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, @@ -45,6 +50,40 @@ module ContextDev key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebExtractResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebExtractResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebExtractResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebExtractResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebExtractResponse::CacheMetadata::status] + end + end + type metadata = { max_crawl_depth: Integer, diff --git a/sig/context_dev/models/web_extract_styleguide_response.rbs b/sig/context_dev/models/web_extract_styleguide_response.rbs index 6d1ae003..f976b094 100644 --- a/sig/context_dev/models/web_extract_styleguide_response.rbs +++ b/sig/context_dev/models/web_extract_styleguide_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_extract_styleguide_response = { + cache_metadata: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, code: Integer, domain: String, key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, @@ -10,6 +11,8 @@ module ContextDev } class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata + attr_reader code: Integer? def code=: (Integer) -> Integer @@ -35,6 +38,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractStyleguideResponse::Styleguide def initialize: ( + cache_metadata: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, ?code: Integer, ?domain: String, ?key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, @@ -43,6 +47,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, code: Integer, domain: String, key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, @@ -50,6 +55,40 @@ module ContextDev styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::status] + end + end + type key_metadata = { credits_consumed: Integer, credits_remaining: Integer } diff --git a/sig/context_dev/models/web_screenshot_response.rbs b/sig/context_dev/models/web_screenshot_response.rbs index 0e1827e9..3d7ecdbd 100644 --- a/sig/context_dev/models/web_screenshot_response.rbs +++ b/sig/context_dev/models/web_screenshot_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_screenshot_response = { + cache_metadata: ContextDev::Models::WebScreenshotResponse::CacheMetadata, code: Integer, domain: String, height: Integer, @@ -13,6 +14,8 @@ module ContextDev } class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebScreenshotResponse::CacheMetadata + attr_reader code: Integer? def code=: (Integer) -> Integer @@ -50,6 +53,7 @@ module ContextDev def width=: (Integer) -> Integer def initialize: ( + cache_metadata: ContextDev::Models::WebScreenshotResponse::CacheMetadata, ?code: Integer, ?domain: String, ?height: Integer, @@ -61,6 +65,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebScreenshotResponse::CacheMetadata, code: Integer, domain: String, height: Integer, @@ -71,6 +76,40 @@ module ContextDev width: Integer } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebScreenshotResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebScreenshotResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebScreenshotResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebScreenshotResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotResponse::CacheMetadata::status] + end + end + type key_metadata = { credits_consumed: Integer, credits_remaining: Integer } diff --git a/sig/context_dev/models/web_search_response.rbs b/sig/context_dev/models/web_search_response.rbs index 4ad20474..16b21c70 100644 --- a/sig/context_dev/models/web_search_response.rbs +++ b/sig/context_dev/models/web_search_response.rbs @@ -2,12 +2,15 @@ module ContextDev module Models type web_search_response = { + cache_metadata: ContextDev::Models::WebSearchResponse::CacheMetadata, query: String, results: ::Array[ContextDev::Models::WebSearchResponse::Result], key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata } class WebSearchResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebSearchResponse::CacheMetadata + attr_accessor query: String attr_accessor results: ::Array[ContextDev::Models::WebSearchResponse::Result] @@ -19,17 +22,53 @@ module ContextDev ) -> ContextDev::Models::WebSearchResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebSearchResponse::CacheMetadata, query: String, results: ::Array[ContextDev::Models::WebSearchResponse::Result], ?key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebSearchResponse::CacheMetadata, query: String, results: ::Array[ContextDev::Models::WebSearchResponse::Result], key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebSearchResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebSearchResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebSearchResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebSearchResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebSearchResponse::CacheMetadata::status] + end + end + type result = { description: String, diff --git a/sig/context_dev/models/web_web_crawl_md_response.rbs b/sig/context_dev/models/web_web_crawl_md_response.rbs index 45e931ad..3e351c14 100644 --- a/sig/context_dev/models/web_web_crawl_md_response.rbs +++ b/sig/context_dev/models/web_web_crawl_md_response.rbs @@ -2,12 +2,15 @@ module ContextDev module Models type web_web_crawl_md_response = { + cache_metadata: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } class WebWebCrawlMdResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata + attr_accessor metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata attr_accessor results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] @@ -19,17 +22,53 @@ module ContextDev ) -> ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], ?key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::status] + end + end + type metadata = { max_crawl_depth: Integer, diff --git a/sig/context_dev/models/web_web_scrape_html_response.rbs b/sig/context_dev/models/web_web_scrape_html_response.rbs index 6b219eb1..69a7d6b1 100644 --- a/sig/context_dev/models/web_web_scrape_html_response.rbs +++ b/sig/context_dev/models/web_web_scrape_html_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_web_scrape_html_response = { + cache_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, @@ -13,6 +14,8 @@ module ContextDev } class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata + attr_accessor html: String attr_accessor metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata @@ -40,6 +43,7 @@ module ContextDev ) -> ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, @@ -51,6 +55,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, @@ -61,6 +66,40 @@ module ContextDev key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::status] + end + end + type metadata = { final_url: String, diff --git a/sig/context_dev/models/web_web_scrape_images_response.rbs b/sig/context_dev/models/web_web_scrape_images_response.rbs index 4bd88bac..40b93d7d 100644 --- a/sig/context_dev/models/web_web_scrape_images_response.rbs +++ b/sig/context_dev/models/web_web_scrape_images_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_web_scrape_images_response = { + cache_metadata: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, url: String, @@ -10,6 +11,8 @@ module ContextDev } class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata + attr_accessor images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image] attr_accessor success: ContextDev::Models::WebWebScrapeImagesResponse::success @@ -29,6 +32,7 @@ module ContextDev ) -> ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, url: String, @@ -37,6 +41,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, url: String, @@ -44,6 +49,40 @@ module ContextDev key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::status] + end + end + type image = { alt: String?, diff --git a/sig/context_dev/models/web_web_scrape_md_response.rbs b/sig/context_dev/models/web_web_scrape_md_response.rbs index 58f4a72e..641b9f77 100644 --- a/sig/context_dev/models/web_web_scrape_md_response.rbs +++ b/sig/context_dev/models/web_web_scrape_md_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_web_scrape_md_response = { + cache_metadata: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, @@ -14,6 +15,8 @@ module ContextDev } class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + attr_accessor cache_metadata: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata + attr_accessor content_length: Integer attr_accessor markdown: String @@ -45,6 +48,7 @@ module ContextDev ) -> ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata def initialize: ( + cache_metadata: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, @@ -57,6 +61,7 @@ module ContextDev ) -> void def to_hash: -> { + cache_metadata: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, @@ -68,6 +73,40 @@ module ContextDev key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } + type cache_metadata = + { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::status + } + + class CacheMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor age_ms: Integer + + attr_accessor status: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::status + + def initialize: ( + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::status + ) -> void + + def to_hash: -> { + age_ms: Integer, + status: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::status + } + + type status = :hit | :miss | :zdr + + module Status + extend ContextDev::Internal::Type::Enum + + HIT: :hit + MISS: :miss + ZDR: :zdr + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::status] + end + end + type metadata = { final_url: String, diff --git a/test/context_dev/resources/ai_test.rb b/test/context_dev/resources/ai_test.rb index 56dcda1c..2683e0ff 100644 --- a/test/context_dev/resources/ai_test.rb +++ b/test/context_dev/resources/ai_test.rb @@ -14,6 +14,7 @@ def test_extract_product_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata, is_product_page: ContextDev::Internal::Type::Boolean | nil, key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata | nil, platform: ContextDev::Models::AIExtractProductResponse::Platform | nil, @@ -33,6 +34,7 @@ def test_extract_products_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata, key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata | nil, products: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product]) | nil } diff --git a/test/context_dev/resources/batch_test.rb b/test/context_dev/resources/batch_test.rb index 6f6cdb7d..9c6ea5ef 100644 --- a/test/context_dev/resources/batch_test.rb +++ b/test/context_dev/resources/batch_test.rb @@ -137,6 +137,7 @@ def test_submit_required_params assert_pattern do response => { id: String, + cache_metadata: ContextDev::Models::BatchSubmitResponse::CacheMetadata, crawl: ContextDev::CrawlControls | nil, created_at: String, credits: ContextDev::Models::BatchSubmitResponse::Credits, diff --git a/test/context_dev/resources/brand_test.rb b/test/context_dev/resources/brand_test.rb index adc28de8..3f6f7323 100644 --- a/test/context_dev/resources/brand_test.rb +++ b/test/context_dev/resources/brand_test.rb @@ -14,6 +14,7 @@ def test_retrieve_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::BrandRetrieveResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveResponse::Brand | nil, code: Integer | nil, key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata | nil, @@ -33,6 +34,7 @@ def test_retrieve_simplified_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata, brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand | nil, code: Integer | nil, key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata | nil, diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb index cb68886d..3cc9c0ae 100644 --- a/test/context_dev/resources/web_test.rb +++ b/test/context_dev/resources/web_test.rb @@ -18,6 +18,7 @@ def test_extract_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebExtractResponse::CacheMetadata, data: ^(ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]), metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, @@ -59,6 +60,7 @@ def test_extract_fonts assert_pattern do response => { + cache_metadata: ContextDev::Models::WebExtractFontsResponse::CacheMetadata, code: Integer, domain: String, fonts: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractFontsResponse::Font]), @@ -80,6 +82,7 @@ def test_extract_styleguide assert_pattern do response => { + cache_metadata: ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata, code: Integer | nil, domain: String | nil, key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata | nil, @@ -100,6 +103,7 @@ def test_screenshot assert_pattern do response => { + cache_metadata: ContextDev::Models::WebScreenshotResponse::CacheMetadata, code: Integer | nil, domain: String | nil, height: Integer | nil, @@ -123,6 +127,7 @@ def test_search_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebSearchResponse::CacheMetadata, query: String, results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result]), key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata | nil @@ -141,6 +146,7 @@ def test_web_crawl_md_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata, metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result]), key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata | nil @@ -159,6 +165,7 @@ def test_web_scrape_html_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata, html: String, metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata, success: ContextDev::Models::WebWebScrapeHTMLResponse::Success, @@ -182,6 +189,7 @@ def test_web_scrape_images_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata, images: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image]), success: ContextDev::Models::WebWebScrapeImagesResponse::Success, url: String, @@ -202,6 +210,7 @@ def test_web_scrape_md_required_params assert_pattern do response => { + cache_metadata: ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata, content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata,