context.dev 2.18.0 → 2.20.0

data/rbi/context_dev/models/ai_extract_product_response.rbi

@@ -1,791 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ContextDev::Models::AIExtractProductResponse,
-            ContextDev::Internal::AnyHash
-          )
-        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
-
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
-      sig { returns(String) }
-      attr_accessor :request_id
-
-      # Whether the given URL is a product detail page
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :is_product_page
-
-      sig { params(is_product_page: T::Boolean).void }
-      attr_writer :is_product_page
-
-      # Credit usage, included whenever a valid API key is provided.
-      sig do
-        returns(
-          T.nilable(ContextDev::Models::AIExtractProductResponse::KeyMetadata)
-        )
-      end
-      attr_reader :key_metadata
-
-      sig do
-        params(
-          key_metadata:
-            ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash
-        ).void
-      end
-      attr_writer :key_metadata
-
-      # True when the timeout ended processing and this response contains only usable
-      # results completed so far. Unfinished results are omitted.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :partial
-
-      sig { params(partial: T::Boolean).void }
-      attr_writer :partial
-
-      # The detected ecommerce platform, or null if not a product page
-      sig do
-        returns(
-          T.nilable(
-            ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-          )
-        )
-      end
-      attr_accessor :platform
-
-      # The extracted product data, or null if not a product page
-      sig do
-        returns(
-          T.nilable(ContextDev::Models::AIExtractProductResponse::Product)
-        )
-      end
-      attr_reader :product
-
-      sig do
-        params(
-          product:
-            T.nilable(
-              ContextDev::Models::AIExtractProductResponse::Product::OrHash
-            )
-        ).void
-      end
-      attr_writer :product
-
-      sig do
-        params(
-          cache_metadata:
-            ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash,
-          request_id: String,
-          is_product_page: T::Boolean,
-          key_metadata:
-            ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
-          partial: T::Boolean,
-          platform:
-            T.nilable(
-              ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol
-            ),
-          product:
-            T.nilable(
-              ContextDev::Models::AIExtractProductResponse::Product::OrHash
-            )
-        ).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:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
-        request_id:,
-        # Whether the given URL is a product detail page
-        is_product_page: nil,
-        # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil,
-        # True when the timeout ended processing and this response contains only usable
-        # results completed so far. Unfinished results are omitted.
-        partial: nil,
-        # The detected ecommerce platform, or null if not a product page
-        platform: nil,
-        # The extracted product data, or null if not a product page
-        product: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            cache_metadata:
-              ContextDev::Models::AIExtractProductResponse::CacheMetadata,
-            request_id: String,
-            is_product_page: T::Boolean,
-            key_metadata:
-              ContextDev::Models::AIExtractProductResponse::KeyMetadata,
-            partial: T::Boolean,
-            platform:
-              T.nilable(
-                ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-              ),
-            product:
-              T.nilable(ContextDev::Models::AIExtractProductResponse::Product)
-          }
-        )
-      end
-      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
-            T.any(
-              ContextDev::Models::AIExtractProductResponse::KeyMetadata,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Credits used by this request.
-        sig { returns(Integer) }
-        attr_accessor :credits_consumed
-
-        # Credits remaining for your organization.
-        sig { returns(Integer) }
-        attr_accessor :credits_remaining
-
-        # Credit usage, included whenever a valid API key is provided.
-        sig do
-          params(credits_consumed: Integer, credits_remaining: Integer).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Credits used by this request.
-          credits_consumed:,
-          # Credits remaining for your organization.
-          credits_remaining:
-        )
-        end
-
-        sig do
-          override.returns(
-            { credits_consumed: Integer, credits_remaining: Integer }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # The detected ecommerce platform, or null if not a product page
-      module Platform
-        extend ContextDev::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              ContextDev::Models::AIExtractProductResponse::Platform
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        AMAZON =
-          T.let(
-            :amazon,
-            ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-          )
-        TIKTOK_SHOP =
-          T.let(
-            :tiktok_shop,
-            ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-          )
-        ETSY =
-          T.let(
-            :etsy,
-            ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-          )
-        GENERIC =
-          T.let(
-            :generic,
-            ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class Product < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::AIExtractProductResponse::Product,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Description of the product
-        sig { returns(String) }
-        attr_accessor :description
-
-        # List of product features
-        sig { returns(T::Array[String]) }
-        attr_accessor :features
-
-        # URLs to product images on the page (up to 7)
-        sig { returns(T::Array[String]) }
-        attr_accessor :images
-
-        # Name of the product
-        sig { returns(String) }
-        attr_accessor :name
-
-        # Stock Keeping Unit (product identifier). Null if no identifier is found.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :sku
-
-        # Tags associated with the product
-        sig { returns(T::Array[String]) }
-        attr_accessor :tags
-
-        # Target audience for the product (array of strings)
-        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(
-            T.nilable(
-              ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-            )
-          )
-        end
-        attr_accessor :billing_frequency
-
-        # Category of the product
-        sig { returns(T.nilable(String)) }
-        attr_accessor :category
-
-        # Currency code for the price (e.g., USD, EUR)
-        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
-
-        # Price of the product
-        sig { returns(T.nilable(Float)) }
-        attr_accessor :price
-
-        # Pricing model for the product
-        sig do
-          returns(
-            T.nilable(
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-          )
-        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
-
-        # Product variations, such as different colors or sizes, with their attributes and
-        # images. Empty if none are found. May not include every variation offered by the
-        # store.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                ContextDev::Models::AIExtractProductResponse::Product::Variant
-              ]
-            )
-          )
-        end
-        attr_reader :variants
-
-        sig do
-          params(
-            variants:
-              T::Array[
-                ContextDev::Models::AIExtractProductResponse::Product::Variant::OrHash
-              ]
-          ).void
-        end
-        attr_writer :variants
-
-        # The extracted product data, or null if not a product page
-        sig do
-          params(
-            description: String,
-            features: T::Array[String],
-            images: T::Array[String],
-            name: String,
-            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),
-            variants:
-              T::Array[
-                ContextDev::Models::AIExtractProductResponse::Product::Variant::OrHash
-              ]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Description of the product
-          description:,
-          # List of product features
-          features:,
-          # URLs to product images on the page (up to 7)
-          images:,
-          # Name of the product
-          name:,
-          # Stock Keeping Unit (product identifier). Null if no identifier is found.
-          sku:,
-          # Tags associated with the product
-          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,
-          # Product variations, such as different colors or sizes, with their attributes and
-          # images. Empty if none are found. May not include every variation offered by the
-          # store.
-          variants: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              description: String,
-              features: T::Array[String],
-              images: T::Array[String],
-              name: String,
-              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),
-              variants:
-                T::Array[
-                  ContextDev::Models::AIExtractProductResponse::Product::Variant
-                ]
-            }
-          )
-        end
-        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
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          MONTHLY =
-            T.let(
-              :monthly,
-              ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-            )
-          YEARLY =
-            T.let(
-              :yearly,
-              ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-            )
-          ONE_TIME =
-            T.let(
-              :one_time,
-              ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-            )
-          USAGE_BASED =
-            T.let(
-              :usage_based,
-              ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Pricing model for the product
-        module PricingModel
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::AIExtractProductResponse::Product::PricingModel
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          PER_SEAT =
-            T.let(
-              :per_seat,
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-          FLAT =
-            T.let(
-              :flat,
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-          TIERED =
-            T.let(
-              :tiered,
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-          FREEMIUM =
-            T.let(
-              :freemium,
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-          CUSTOM =
-            T.let(
-              :custom,
-              ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        class Variant < ContextDev::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ContextDev::Models::AIExtractProductResponse::Product::Variant,
-                ContextDev::Internal::AnyHash
-              )
-            end
-
-          # Explicit variant attributes such as color, size, material, pattern and
-          # properties declared by page.
-          sig { returns(T::Hash[Symbol, String]) }
-          attr_accessor :attributes
-
-          # Original source image URLs explicitly attached to this variant.
-          sig { returns(T::Array[String]) }
-          attr_accessor :images
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :sku
-
-          # Variant or offer URL when provided by the source. May be shared by variants.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :url
-
-          sig do
-            params(
-              attributes: T::Hash[Symbol, String],
-              images: T::Array[String],
-              sku: T.nilable(String),
-              url: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Explicit variant attributes such as color, size, material, pattern and
-            # properties declared by page.
-            attributes:,
-            # Original source image URLs explicitly attached to this variant.
-            images:,
-            sku:,
-            # Variant or offer URL when provided by the source. May be shared by variants.
-            url:
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                attributes: T::Hash[Symbol, String],
-                images: T::Array[String],
-                sku: T.nilable(String),
-                url: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end