context.dev 2.11.0 → 2.13.0

data/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
@@ -232,6 +351,16 @@ module ContextDev
         sig { returns(T::Array[String]) }
         attr_accessor :target_audience
 
+        # Normalized stock or ordering availability
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :availability
+
         # Billing frequency for the product
         sig do
           returns(
@@ -250,6 +379,13 @@ module ContextDev
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
 
+        # Dimension statements shown for the product, preserving labels, values, and units
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :dimensions
+
+        sig { params(dimensions: T::Array[String]).void }
+        attr_writer :dimensions
+
         # URL to the product image
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
@@ -268,6 +404,10 @@ module ContextDev
         end
         attr_accessor :pricing_model
 
+        # Original or regular price before a displayed discount
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :regular_price
+
         # URL to the product page
         sig { returns(T.nilable(String)) }
         attr_accessor :url
@@ -282,18 +422,24 @@ module ContextDev
             sku: T.nilable(String),
             tags: T::Array[String],
             target_audience: T::Array[String],
+            availability:
+              T.nilable(
+                ContextDev::Models::AIExtractProductResponse::Product::Availability::OrSymbol
+              ),
             billing_frequency:
               T.nilable(
                 ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::OrSymbol
               ),
             category: T.nilable(String),
             currency: T.nilable(String),
+            dimensions: T::Array[String],
             image_url: T.nilable(String),
             price: T.nilable(Float),
             pricing_model:
               T.nilable(
                 ContextDev::Models::AIExtractProductResponse::Product::PricingModel::OrSymbol
               ),
+            regular_price: T.nilable(Float),
             url: T.nilable(String)
           ).returns(T.attached_class)
         end
@@ -312,18 +458,24 @@ module ContextDev
           tags:,
           # Target audience for the product (array of strings)
           target_audience:,
+          # Normalized stock or ordering availability
+          availability: nil,
           # Billing frequency for the product
           billing_frequency: nil,
           # Category of the product
           category: nil,
           # Currency code for the price (e.g., USD, EUR)
           currency: nil,
+          # Dimension statements shown for the product, preserving labels, values, and units
+          dimensions: nil,
           # URL to the product image
           image_url: nil,
           # Price of the product
           price: nil,
           # Pricing model for the product
           pricing_model: nil,
+          # Original or regular price before a displayed discount
+          regular_price: nil,
           # URL to the product page
           url: nil
         )
@@ -339,18 +491,24 @@ module ContextDev
               sku: T.nilable(String),
               tags: T::Array[String],
               target_audience: T::Array[String],
+              availability:
+                T.nilable(
+                  ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+                ),
               billing_frequency:
                 T.nilable(
                   ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
                 ),
               category: T.nilable(String),
               currency: T.nilable(String),
+              dimensions: T::Array[String],
               image_url: T.nilable(String),
               price: T.nilable(Float),
               pricing_model:
                 T.nilable(
                   ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
                 ),
+              regular_price: T.nilable(Float),
               url: T.nilable(String)
             }
           )
@@ -358,6 +516,66 @@ module ContextDev
         def to_hash
         end
 
+        # Normalized stock or ordering availability
+        module Availability
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::AIExtractProductResponse::Product::Availability
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_STOCK =
+            T.let(
+              :in_stock,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          OUT_OF_STOCK =
+            T.let(
+              :out_of_stock,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          LIMITED_AVAILABILITY =
+            T.let(
+              :limited_availability,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          PREORDER =
+            T.let(
+              :preorder,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          BACKORDER =
+            T.let(
+              :backorder,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          MADE_TO_ORDER =
+            T.let(
+              :made_to_order,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+          DISCONTINUED =
+            T.let(
+              :discontinued,
+              ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::AIExtractProductResponse::Product::Availability::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Billing frequency for the product
         module BillingFrequency
           extend ContextDev::Internal::Type::Enum

data/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
@@ -158,6 +277,16 @@ module ContextDev
         sig { returns(T::Array[String]) }
         attr_accessor :target_audience
 
+        # Normalized stock or ordering availability
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :availability
+
         # Billing frequency for the product
         sig do
           returns(
@@ -176,6 +305,13 @@ module ContextDev
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
 
+        # Dimension statements shown for the product, preserving labels, values, and units
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :dimensions
+
+        sig { params(dimensions: T::Array[String]).void }
+        attr_writer :dimensions
+
         # URL to the product image
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
@@ -194,6 +330,10 @@ module ContextDev
         end
         attr_accessor :pricing_model
 
+        # Original or regular price before a displayed discount
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :regular_price
+
         # URL to the product page
         sig { returns(T.nilable(String)) }
         attr_accessor :url
@@ -207,18 +347,24 @@ module ContextDev
             sku: T.nilable(String),
             tags: T::Array[String],
             target_audience: T::Array[String],
+            availability:
+              T.nilable(
+                ContextDev::Models::AIExtractProductsResponse::Product::Availability::OrSymbol
+              ),
             billing_frequency:
               T.nilable(
                 ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::OrSymbol
               ),
             category: T.nilable(String),
             currency: T.nilable(String),
+            dimensions: T::Array[String],
             image_url: T.nilable(String),
             price: T.nilable(Float),
             pricing_model:
               T.nilable(
                 ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::OrSymbol
               ),
+            regular_price: T.nilable(Float),
             url: T.nilable(String)
           ).returns(T.attached_class)
         end
@@ -237,18 +383,24 @@ module ContextDev
           tags:,
           # Target audience for the product (array of strings)
           target_audience:,
+          # Normalized stock or ordering availability
+          availability: nil,
           # Billing frequency for the product
           billing_frequency: nil,
           # Category of the product
           category: nil,
           # Currency code for the price (e.g., USD, EUR)
           currency: nil,
+          # Dimension statements shown for the product, preserving labels, values, and units
+          dimensions: nil,
           # URL to the product image
           image_url: nil,
           # Price of the product
           price: nil,
           # Pricing model for the product
           pricing_model: nil,
+          # Original or regular price before a displayed discount
+          regular_price: nil,
           # URL to the product page
           url: nil
         )
@@ -264,18 +416,24 @@ module ContextDev
               sku: T.nilable(String),
               tags: T::Array[String],
               target_audience: T::Array[String],
+              availability:
+                T.nilable(
+                  ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+                ),
               billing_frequency:
                 T.nilable(
                   ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol
                 ),
               category: T.nilable(String),
               currency: T.nilable(String),
+              dimensions: T::Array[String],
               image_url: T.nilable(String),
               price: T.nilable(Float),
               pricing_model:
                 T.nilable(
                   ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol
                 ),
+              regular_price: T.nilable(Float),
               url: T.nilable(String)
             }
           )
@@ -283,6 +441,66 @@ module ContextDev
         def to_hash
         end
 
+        # Normalized stock or ordering availability
+        module Availability
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::AIExtractProductsResponse::Product::Availability
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_STOCK =
+            T.let(
+              :in_stock,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          OUT_OF_STOCK =
+            T.let(
+              :out_of_stock,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          LIMITED_AVAILABILITY =
+            T.let(
+              :limited_availability,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          PREORDER =
+            T.let(
+              :preorder,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          BACKORDER =
+            T.let(
+              :backorder,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          MADE_TO_ORDER =
+            T.let(
+              :made_to_order,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+          DISCONTINUED =
+            T.let(
+              :discontinued,
+              ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Billing frequency for the product
         module BillingFrequency
           extend ContextDev::Internal::Type::Enum