context.dev 2.17.1 → 2.19.0

data/lib/context_dev/models/ai_extract_product_response.rb

@@ -1,352 +0,0 @@
-# frozen_string_literal: true
-
-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 request_id
-      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #   it when contacting support about a failed request.
-      #
-      #   @return [String]
-      required :request_id, String
-
-      # @!attribute is_product_page
-      #   Whether the given URL is a product detail page
-      #
-      #   @return [Boolean, nil]
-      optional :is_product_page, ContextDev::Internal::Type::Boolean
-
-      # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
-      #
-      #   @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
-
-      # @!attribute partial
-      #   True when the timeout ended processing and this response contains only usable
-      #   results completed so far. Unfinished results are omitted.
-      #
-      #   @return [Boolean, nil]
-      optional :partial, ContextDev::Internal::Type::Boolean
-
-      # @!attribute platform
-      #   The detected ecommerce platform, or null if not a product page
-      #
-      #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil]
-      optional :platform, enum: -> { ContextDev::Models::AIExtractProductResponse::Platform }, nil?: true
-
-      # @!attribute product
-      #   The extracted product data, or null if not a product page
-      #
-      #   @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
-      optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
-
-      # @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, partial: 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 request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #
-      #   @param is_product_page [Boolean] Whether the given URL is a product detail page
-      #
-      #   @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-      #
-      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
-      #
-      #   @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
-      #
-      #   @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page
-
-      # @see ContextDev::Models::AIExtractProductResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::AIExtractProductResponse::CacheMetadata} for more details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::AIExtractProductResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::AIExtractProductResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @see ContextDev::Models::AIExtractProductResponse#key_metadata
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute credits_consumed
-        #   Credits used by this request.
-        #
-        #   @return [Integer]
-        required :credits_consumed, Integer
-
-        # @!attribute credits_remaining
-        #   Credits remaining for your organization.
-        #
-        #   @return [Integer]
-        required :credits_remaining, Integer
-
-        # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
-        #
-        #   @param credits_consumed [Integer] Credits used by this request.
-        #
-        #   @param credits_remaining [Integer] Credits remaining for your organization.
-      end
-
-      # The detected ecommerce platform, or null if not a product page
-      #
-      # @see ContextDev::Models::AIExtractProductResponse#platform
-      module Platform
-        extend ContextDev::Internal::Type::Enum
-
-        AMAZON = :amazon
-        TIKTOK_SHOP = :tiktok_shop
-        ETSY = :etsy
-        GENERIC = :generic
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see ContextDev::Models::AIExtractProductResponse#product
-      class Product < ContextDev::Internal::Type::BaseModel
-        # @!attribute description
-        #   Description of the product
-        #
-        #   @return [String]
-        required :description, String
-
-        # @!attribute features
-        #   List of product features
-        #
-        #   @return [Array<String>]
-        required :features, ContextDev::Internal::Type::ArrayOf[String]
-
-        # @!attribute images
-        #   URLs to product images on the page (up to 7)
-        #
-        #   @return [Array<String>]
-        required :images, ContextDev::Internal::Type::ArrayOf[String]
-
-        # @!attribute name
-        #   Name of the product
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute sku
-        #   Stock Keeping Unit (product identifier). Null if no identifier is found.
-        #
-        #   @return [String, nil]
-        required :sku, String, nil?: true
-
-        # @!attribute tags
-        #   Tags associated with the product
-        #
-        #   @return [Array<String>]
-        required :tags, ContextDev::Internal::Type::ArrayOf[String]
-
-        # @!attribute target_audience
-        #   Target audience for the product (array of strings)
-        #
-        #   @return [Array<String>]
-        required :target_audience, ContextDev::Internal::Type::ArrayOf[String]
-
-        # @!attribute availability
-        #   Normalized stock or ordering availability
-        #
-        #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::Availability, nil]
-        optional :availability,
-                 enum: -> { ContextDev::Models::AIExtractProductResponse::Product::Availability },
-                 nil?: true
-
-        # @!attribute billing_frequency
-        #   Billing frequency for the product
-        #
-        #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency, nil]
-        optional :billing_frequency,
-                 enum: -> { ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency },
-                 nil?: true
-
-        # @!attribute category
-        #   Category of the product
-        #
-        #   @return [String, nil]
-        optional :category, String, nil?: true
-
-        # @!attribute currency
-        #   Currency code for the price (e.g., USD, EUR)
-        #
-        #   @return [String, nil]
-        optional :currency, String, nil?: true
-
-        # @!attribute dimensions
-        #   Dimension statements shown for the product, preserving labels, values, and units
-        #
-        #   @return [Array<String>, nil]
-        optional :dimensions, ContextDev::Internal::Type::ArrayOf[String]
-
-        # @!attribute image_url
-        #   URL to the product image
-        #
-        #   @return [String, nil]
-        optional :image_url, String, nil?: true
-
-        # @!attribute price
-        #   Price of the product
-        #
-        #   @return [Float, nil]
-        optional :price, Float, nil?: true
-
-        # @!attribute pricing_model
-        #   Pricing model for the product
-        #
-        #   @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::PricingModel, nil]
-        optional :pricing_model,
-                 enum: -> { ContextDev::Models::AIExtractProductResponse::Product::PricingModel },
-                 nil?: true
-
-        # @!attribute regular_price
-        #   Original or regular price before a displayed discount
-        #
-        #   @return [Float, nil]
-        optional :regular_price, Float, nil?: true
-
-        # @!attribute url
-        #   URL to the product page
-        #
-        #   @return [String, nil]
-        optional :url, String, nil?: true
-
-        # @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, availability: nil, billing_frequency: nil, category: nil, currency: nil, dimensions: nil, image_url: nil, price: nil, pricing_model: nil, regular_price: nil, url: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::AIExtractProductResponse::Product} for more details.
-        #
-        #   The extracted product data, or null if not a product page
-        #
-        #   @param description [String] Description of the product
-        #
-        #   @param features [Array<String>] List of product features
-        #
-        #   @param images [Array<String>] URLs to product images on the page (up to 7)
-        #
-        #   @param name [String] Name of the product
-        #
-        #   @param sku [String, nil] Stock Keeping Unit (product identifier). Null if no identifier is found.
-        #
-        #   @param tags [Array<String>] Tags associated with the product
-        #
-        #   @param target_audience [Array<String>] Target audience for the product (array of strings)
-        #
-        #   @param availability [Symbol, ContextDev::Models::AIExtractProductResponse::Product::Availability, nil] Normalized stock or ordering availability
-        #
-        #   @param billing_frequency [Symbol, ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency, nil] Billing frequency for the product
-        #
-        #   @param category [String, nil] Category of the product
-        #
-        #   @param currency [String, nil] Currency code for the price (e.g., USD, EUR)
-        #
-        #   @param dimensions [Array<String>] Dimension statements shown for the product, preserving labels, values, and units
-        #
-        #   @param image_url [String, nil] URL to the product image
-        #
-        #   @param price [Float, nil] Price of the product
-        #
-        #   @param pricing_model [Symbol, ContextDev::Models::AIExtractProductResponse::Product::PricingModel, nil] Pricing model for the product
-        #
-        #   @param regular_price [Float, nil] Original or regular price before a displayed discount
-        #
-        #   @param url [String, nil] URL to the product page
-
-        # Normalized stock or ordering availability
-        #
-        # @see ContextDev::Models::AIExtractProductResponse::Product#availability
-        module Availability
-          extend ContextDev::Internal::Type::Enum
-
-          IN_STOCK = :in_stock
-          OUT_OF_STOCK = :out_of_stock
-          LIMITED_AVAILABILITY = :limited_availability
-          PREORDER = :preorder
-          BACKORDER = :backorder
-          MADE_TO_ORDER = :made_to_order
-          DISCONTINUED = :discontinued
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Billing frequency for the product
-        #
-        # @see ContextDev::Models::AIExtractProductResponse::Product#billing_frequency
-        module BillingFrequency
-          extend ContextDev::Internal::Type::Enum
-
-          MONTHLY = :monthly
-          YEARLY = :yearly
-          ONE_TIME = :one_time
-          USAGE_BASED = :usage_based
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Pricing model for the product
-        #
-        # @see ContextDev::Models::AIExtractProductResponse::Product#pricing_model
-        module PricingModel
-          extend ContextDev::Internal::Type::Enum
-
-          PER_SEAT = :per_seat
-          FLAT = :flat
-          TIERED = :tiered
-          FREEMIUM = :freemium
-          CUSTOM = :custom
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/context_dev/models/ai_extract_products_params.rb

@@ -1,233 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::AI#extract_products
-    class AIExtractProductsParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute body
-      #
-      #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL]
-      required :body, union: -> { ContextDev::AIExtractProductsParams::Body }
-
-      # @!method initialize(body:, request_options: {})
-      #   @param body [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL]
-      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
-
-      module Body
-        extend ContextDev::Internal::Type::Union
-
-        variant -> { ContextDev::AIExtractProductsParams::Body::ByDomain }
-
-        variant -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL }
-
-        class ByDomain < ContextDev::Internal::Type::BaseModel
-          # @!attribute domain
-          #   The domain name to analyze.
-          #
-          #   @return [String]
-          required :domain, String
-
-          # @!attribute max_age_ms
-          #   Return a cached result if a prior scrape for the same parameters exists and is
-          #   younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
-          #   omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
-          #
-          #   @return [Integer, nil]
-          optional :max_age_ms, Integer, api_name: :maxAgeMs
-
-          # @!attribute max_products
-          #   Maximum number of products to extract.
-          #
-          #   @return [Integer, nil]
-          optional :max_products, Integer, api_name: :maxProducts
-
-          # @!attribute tags
-          #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
-          #
-          #   @return [Array<String>, nil]
-          optional :tags, ContextDev::Internal::Type::ArrayOf[String]
-
-          # @!attribute timeout_opts
-          #   Optional request deadline and behavior on timeout. For GET requests, use
-          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-          #   timeoutOpts object.
-          #
-          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts, nil]
-          optional :timeout_opts,
-                   -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts },
-                   api_name: :timeoutOpts
-
-          # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain} for more details.
-          #
-          #   @param domain [String] The domain name to analyze.
-          #
-          #   @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
-          #
-          #   @param max_products [Integer] Maximum number of products to extract.
-          #
-          #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
-          #
-          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-
-          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain#timeout_opts
-          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-            # @!attribute milliseconds
-            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-            #
-            #   @return [Integer]
-            required :milliseconds, Integer
-
-            # @!attribute behavior
-            #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-            #   credits. "return-partial" returns usable results collected so far; if none are
-            #   available, the request still fails without charging credits. Partial results are
-            #   not cached as complete results.
-            #
-            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior, nil]
-            optional :behavior,
-                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior }
-
-            # @!method initialize(milliseconds:, behavior: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts} for
-            #   more details.
-            #
-            #   Optional request deadline and behavior on timeout. For GET requests, use
-            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-            #   timeoutOpts object.
-            #
-            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-            #
-            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-
-            # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-            # credits. "return-partial" returns usable results collected so far; if none are
-            # available, the request still fails without charging credits. Partial results are
-            # not cached as complete results.
-            #
-            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts#behavior
-            module Behavior
-              extend ContextDev::Internal::Type::Enum
-
-              FAIL = :fail
-              RETURN_PARTIAL = :"return-partial"
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-        end
-
-        class ByDirectURL < ContextDev::Internal::Type::BaseModel
-          # @!attribute direct_url
-          #   A specific URL to use directly as the starting point for extraction without
-          #   domain resolution.
-          #
-          #   @return [String]
-          required :direct_url, String, api_name: :directUrl
-
-          # @!attribute max_age_ms
-          #   Return a cached result if a prior scrape for the same parameters exists and is
-          #   younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
-          #   omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
-          #
-          #   @return [Integer, nil]
-          optional :max_age_ms, Integer, api_name: :maxAgeMs
-
-          # @!attribute max_products
-          #   Maximum number of products to extract.
-          #
-          #   @return [Integer, nil]
-          optional :max_products, Integer, api_name: :maxProducts
-
-          # @!attribute tags
-          #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
-          #
-          #   @return [Array<String>, nil]
-          optional :tags, ContextDev::Internal::Type::ArrayOf[String]
-
-          # @!attribute timeout_opts
-          #   Optional request deadline and behavior on timeout. For GET requests, use
-          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-          #   timeoutOpts object.
-          #
-          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts, nil]
-          optional :timeout_opts,
-                   -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts },
-                   api_name: :timeoutOpts
-
-          # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL} for more
-          #   details.
-          #
-          #   @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma
-          #
-          #   @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
-          #
-          #   @param max_products [Integer] Maximum number of products to extract.
-          #
-          #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
-          #
-          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-
-          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL#timeout_opts
-          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-            # @!attribute milliseconds
-            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-            #
-            #   @return [Integer]
-            required :milliseconds, Integer
-
-            # @!attribute behavior
-            #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-            #   credits. "return-partial" returns usable results collected so far; if none are
-            #   available, the request still fails without charging credits. Partial results are
-            #   not cached as complete results.
-            #
-            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior, nil]
-            optional :behavior,
-                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior }
-
-            # @!method initialize(milliseconds:, behavior: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts}
-            #   for more details.
-            #
-            #   Optional request deadline and behavior on timeout. For GET requests, use
-            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-            #   timeoutOpts object.
-            #
-            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-            #
-            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-
-            # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-            # credits. "return-partial" returns usable results collected so far; if none are
-            # available, the request still fails without charging credits. Partial results are
-            # not cached as complete results.
-            #
-            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts#behavior
-            module Behavior
-              extend ContextDev::Internal::Type::Enum
-
-              FAIL = :fail
-              RETURN_PARTIAL = :"return-partial"
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-        end
-
-        # @!method self.variants
-        #   @return [Array(ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL)]
-      end
-    end
-  end
-end