context.dev 0.0.2

data/rbi/context_dev/models/brand_ai_product_response.rbi

@@ -0,0 +1,380 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::BrandAIProductResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # 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
+
+      # The detected ecommerce platform, or null if not a product page
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :platform
+
+      # The extracted product data, or null if not a product page
+      sig do
+        returns(T.nilable(ContextDev::Models::BrandAIProductResponse::Product))
+      end
+      attr_reader :product
+
+      sig do
+        params(
+          product:
+            T.nilable(
+              ContextDev::Models::BrandAIProductResponse::Product::OrHash
+            )
+        ).void
+      end
+      attr_writer :product
+
+      sig do
+        params(
+          is_product_page: T::Boolean,
+          platform:
+            T.nilable(
+              ContextDev::Models::BrandAIProductResponse::Platform::OrSymbol
+            ),
+          product:
+            T.nilable(
+              ContextDev::Models::BrandAIProductResponse::Product::OrHash
+            )
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether the given URL is a product detail page
+        is_product_page: 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(
+          {
+            is_product_page: T::Boolean,
+            platform:
+              T.nilable(
+                ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+              ),
+            product:
+              T.nilable(ContextDev::Models::BrandAIProductResponse::Product)
+          }
+        )
+      end
+      def to_hash
+      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::BrandAIProductResponse::Platform)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AMAZON =
+          T.let(
+            :amazon,
+            ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+          )
+        TIKTOK_SHOP =
+          T.let(
+            :tiktok_shop,
+            ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+          )
+        ETSY =
+          T.let(
+            :etsy,
+            ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+          )
+        GENERIC =
+          T.let(
+            :generic,
+            ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Product < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandAIProductResponse::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
+
+        # 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
+
+        # Billing frequency for the product
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::BrandAIProductResponse::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
+
+        # 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::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :pricing_model
+
+        # URL to the product page
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # 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,
+            tags: T::Array[String],
+            target_audience: T::Array[String],
+            billing_frequency:
+              T.nilable(
+                ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::OrSymbol
+              ),
+            category: T.nilable(String),
+            currency: T.nilable(String),
+            image_url: T.nilable(String),
+            price: T.nilable(Float),
+            pricing_model:
+              T.nilable(
+                ContextDev::Models::BrandAIProductResponse::Product::PricingModel::OrSymbol
+              ),
+            url: T.nilable(String)
+          ).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:,
+          # Tags associated with the product
+          tags:,
+          # Target audience for the product (array of strings)
+          target_audience:,
+          # 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,
+          # URL to the product image
+          image_url: nil,
+          # Price of the product
+          price: nil,
+          # Pricing model for the product
+          pricing_model: nil,
+          # URL to the product page
+          url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              features: T::Array[String],
+              images: T::Array[String],
+              name: String,
+              tags: T::Array[String],
+              target_audience: T::Array[String],
+              billing_frequency:
+                T.nilable(
+                  ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol
+                ),
+              category: T.nilable(String),
+              currency: T.nilable(String),
+              image_url: T.nilable(String),
+              price: T.nilable(Float),
+              pricing_model:
+                T.nilable(
+                  ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+                ),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Billing frequency for the product
+        module BillingFrequency
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MONTHLY =
+            T.let(
+              :monthly,
+              ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          YEARLY =
+            T.let(
+              :yearly,
+              ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          ONE_TIME =
+            T.let(
+              :one_time,
+              ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          USAGE_BASED =
+            T.let(
+              :usage_based,
+              ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::BrandAIProductResponse::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::BrandAIProductResponse::Product::PricingModel
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PER_SEAT =
+            T.let(
+              :per_seat,
+              ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+          FLAT =
+            T.let(
+              :flat,
+              ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+          TIERED =
+            T.let(
+              :tiered,
+              ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+          FREEMIUM =
+            T.let(
+              :freemium,
+              ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/brand_ai_products_params.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandAIProductsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::BrandAIProductsParams,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.any(
+            ContextDev::BrandAIProductsParams::Body::ByDomain,
+            ContextDev::BrandAIProductsParams::Body::ByDirectURL
+          )
+        )
+      end
+      attr_accessor :body
+
+      sig do
+        params(
+          body:
+            T.any(
+              ContextDev::BrandAIProductsParams::Body::ByDomain::OrHash,
+              ContextDev::BrandAIProductsParams::Body::ByDirectURL::OrHash
+            ),
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(body:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            body:
+              T.any(
+                ContextDev::BrandAIProductsParams::Body::ByDomain,
+                ContextDev::BrandAIProductsParams::Body::ByDirectURL
+              ),
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Body
+        extend ContextDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              ContextDev::BrandAIProductsParams::Body::ByDomain,
+              ContextDev::BrandAIProductsParams::Body::ByDirectURL
+            )
+          end
+
+        class ByDomain < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::BrandAIProductsParams::Body::ByDomain,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # The domain name to analyze.
+          sig { returns(String) }
+          attr_accessor :domain
+
+          # Maximum number of products to extract.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_products
+
+          sig { params(max_products: Integer).void }
+          attr_writer :max_products
+
+          # Optional timeout in milliseconds for the request. Maximum allowed value is
+          # 300000ms (5 minutes).
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :timeout_ms
+
+          sig { params(timeout_ms: Integer).void }
+          attr_writer :timeout_ms
+
+          sig do
+            params(
+              domain: String,
+              max_products: Integer,
+              timeout_ms: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The domain name to analyze.
+            domain:,
+            # Maximum number of products to extract.
+            max_products: nil,
+            # Optional timeout in milliseconds for the request. Maximum allowed value is
+            # 300000ms (5 minutes).
+            timeout_ms: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { domain: String, max_products: Integer, timeout_ms: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class ByDirectURL < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::BrandAIProductsParams::Body::ByDirectURL,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # A specific URL to use directly as the starting point for extraction without
+          # domain resolution.
+          sig { returns(String) }
+          attr_accessor :direct_url
+
+          # Maximum number of products to extract.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_products
+
+          sig { params(max_products: Integer).void }
+          attr_writer :max_products
+
+          # Optional timeout in milliseconds for the request. Maximum allowed value is
+          # 300000ms (5 minutes).
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :timeout_ms
+
+          sig { params(timeout_ms: Integer).void }
+          attr_writer :timeout_ms
+
+          sig do
+            params(
+              direct_url: String,
+              max_products: Integer,
+              timeout_ms: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A specific URL to use directly as the starting point for extraction without
+            # domain resolution.
+            direct_url:,
+            # Maximum number of products to extract.
+            max_products: nil,
+            # Optional timeout in milliseconds for the request. Maximum allowed value is
+            # 300000ms (5 minutes).
+            timeout_ms: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { direct_url: String, max_products: Integer, timeout_ms: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::BrandAIProductsParams::Body::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end