context.dev 0.0.2

data/lib/context_dev/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Internal
+    extend ContextDev::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{ContextDev::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, ContextDev::FilePart) }
+    end
+  end
+end

data/lib/context_dev/models/brand_ai_product_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#ai_product
+    class BrandAIProductParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   The product page URL to extract product data from.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute timeout_ms
+      #   Optional timeout in milliseconds for the request. Maximum allowed value is
+      #   300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(url:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandAIProductParams} for more details.
+      #
+      #   @param url [String] The product page URL to extract product data from.
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_ai_product_response.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#ai_product
+    class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel
+      # @!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 platform
+      #   The detected ecommerce platform, or null if not a product page
+      #
+      #   @return [Symbol, ContextDev::Models::BrandAIProductResponse::Platform, nil]
+      optional :platform, enum: -> { ContextDev::Models::BrandAIProductResponse::Platform }, nil?: true
+
+      # @!attribute product
+      #   The extracted product data, or null if not a product page
+      #
+      #   @return [ContextDev::Models::BrandAIProductResponse::Product, nil]
+      optional :product, -> { ContextDev::Models::BrandAIProductResponse::Product }, nil?: true
+
+      # @!method initialize(is_product_page: nil, platform: nil, product: nil)
+      #   @param is_product_page [Boolean] Whether the given URL is a product detail page
+      #
+      #   @param platform [Symbol, ContextDev::Models::BrandAIProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
+      #
+      #   @param product [ContextDev::Models::BrandAIProductResponse::Product, nil] The extracted product data, or null if not a product page
+
+      # The detected ecommerce platform, or null if not a product page
+      #
+      # @see ContextDev::Models::BrandAIProductResponse#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::BrandAIProductResponse#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 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 billing_frequency
+        #   Billing frequency for the product
+        #
+        #   @return [Symbol, ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency, nil]
+        optional :billing_frequency,
+                 enum: -> { ContextDev::Models::BrandAIProductResponse::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 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::BrandAIProductResponse::Product::PricingModel, nil]
+        optional :pricing_model,
+                 enum: -> { ContextDev::Models::BrandAIProductResponse::Product::PricingModel },
+                 nil?: true
+
+        # @!attribute url
+        #   URL to the product page
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(description:, features:, images:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil)
+        #   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 tags [Array<String>] Tags associated with the product
+        #
+        #   @param target_audience [Array<String>] Target audience for the product (array of strings)
+        #
+        #   @param billing_frequency [Symbol, ContextDev::Models::BrandAIProductResponse::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 image_url [String, nil] URL to the product image
+        #
+        #   @param price [Float, nil] Price of the product
+        #
+        #   @param pricing_model [Symbol, ContextDev::Models::BrandAIProductResponse::Product::PricingModel, nil] Pricing model for the product
+        #
+        #   @param url [String, nil] URL to the product page
+
+        # Billing frequency for the product
+        #
+        # @see ContextDev::Models::BrandAIProductResponse::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::BrandAIProductResponse::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/brand_ai_products_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#ai_products
+    class BrandAIProductsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL]
+      required :body, union: -> { ContextDev::BrandAIProductsParams::Body }
+
+      # @!method initialize(body:, request_options: {})
+      #   @param body [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL]
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      module Body
+        extend ContextDev::Internal::Type::Union
+
+        variant -> { ContextDev::BrandAIProductsParams::Body::ByDomain }
+
+        variant -> { ContextDev::BrandAIProductsParams::Body::ByDirectURL }
+
+        class ByDomain < ContextDev::Internal::Type::BaseModel
+          # @!attribute domain
+          #   The domain name to analyze.
+          #
+          #   @return [String]
+          required :domain, String
+
+          # @!attribute max_products
+          #   Maximum number of products to extract.
+          #
+          #   @return [Integer, nil]
+          optional :max_products, Integer, api_name: :maxProducts
+
+          # @!attribute timeout_ms
+          #   Optional timeout in milliseconds for the request. Maximum allowed value is
+          #   300000ms (5 minutes).
+          #
+          #   @return [Integer, nil]
+          optional :timeout_ms, Integer, api_name: :timeoutMS
+
+          # @!method initialize(domain:, max_products: nil, timeout_ms: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::BrandAIProductsParams::Body::ByDomain} for more details.
+          #
+          #   @param domain [String] The domain name to analyze.
+          #
+          #   @param max_products [Integer] Maximum number of products to extract.
+          #
+          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+        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_products
+          #   Maximum number of products to extract.
+          #
+          #   @return [Integer, nil]
+          optional :max_products, Integer, api_name: :maxProducts
+
+          # @!attribute timeout_ms
+          #   Optional timeout in milliseconds for the request. Maximum allowed value is
+          #   300000ms (5 minutes).
+          #
+          #   @return [Integer, nil]
+          optional :timeout_ms, Integer, api_name: :timeoutMS
+
+          # @!method initialize(direct_url:, max_products: nil, timeout_ms: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::BrandAIProductsParams::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_products [Integer] Maximum number of products to extract.
+          #
+          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+        end
+
+        # @!method self.variants
+        #   @return [Array(ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL)]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_ai_products_response.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#ai_products
+    class BrandAIProductsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute products
+      #   Array of products extracted from the website
+      #
+      #   @return [Array<ContextDev::Models::BrandAIProductsResponse::Product>, nil]
+      optional :products,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandAIProductsResponse::Product] }
+
+      # @!method initialize(products: nil)
+      #   @param products [Array<ContextDev::Models::BrandAIProductsResponse::Product>] Array of products extracted from the website
+
+      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 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 billing_frequency
+        #   Billing frequency for the product
+        #
+        #   @return [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil]
+        optional :billing_frequency,
+                 enum: -> { ContextDev::Models::BrandAIProductsResponse::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 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::BrandAIProductsResponse::Product::PricingModel, nil]
+        optional :pricing_model,
+                 enum: -> { ContextDev::Models::BrandAIProductsResponse::Product::PricingModel },
+                 nil?: true
+
+        # @!attribute url
+        #   URL to the product page
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(description:, features:, images:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil)
+        #   @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 tags [Array<String>] Tags associated with the product
+        #
+        #   @param target_audience [Array<String>] Target audience for the product (array of strings)
+        #
+        #   @param billing_frequency [Symbol, ContextDev::Models::BrandAIProductsResponse::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 image_url [String, nil] URL to the product image
+        #
+        #   @param price [Float, nil] Price of the product
+        #
+        #   @param pricing_model [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] Pricing model for the product
+        #
+        #   @param url [String, nil] URL to the product page
+
+        # Billing frequency for the product
+        #
+        # @see ContextDev::Models::BrandAIProductsResponse::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::BrandAIProductsResponse::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