brand.dev 0.18.0 → 0.20.0

data/rbi/brand_dev/models/brand_ai_products_response.rbi

@@ -0,0 +1,298 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandAIProductsResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Array of products extracted from the website
+      sig do
+        returns(
+          T.nilable(
+            T::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+          )
+        )
+      end
+      attr_reader :products
+
+      sig do
+        params(
+          products:
+            T::Array[BrandDev::Models::BrandAIProductsResponse::Product::OrHash]
+        ).void
+      end
+      attr_writer :products
+
+      sig do
+        params(
+          products:
+            T::Array[BrandDev::Models::BrandAIProductsResponse::Product::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of products extracted from the website
+        products: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            products:
+              T::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Product < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::Models::BrandAIProductsResponse::Product,
+              BrandDev::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
+
+        # 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(
+              BrandDev::Models::BrandAIProductsResponse::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(
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :pricing_model
+
+        # URL to the product page
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig do
+          params(
+            description: String,
+            features: T::Array[String],
+            name: String,
+            tags: T::Array[String],
+            target_audience: T::Array[String],
+            billing_frequency:
+              T.nilable(
+                BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::OrSymbol
+              ),
+            category: T.nilable(String),
+            currency: T.nilable(String),
+            image_url: T.nilable(String),
+            price: T.nilable(Float),
+            pricing_model:
+              T.nilable(
+                BrandDev::Models::BrandAIProductsResponse::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:,
+          # 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],
+              name: String,
+              tags: T::Array[String],
+              target_audience: T::Array[String],
+              billing_frequency:
+                T.nilable(
+                  BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+                ),
+              category: T.nilable(String),
+              currency: T.nilable(String),
+              image_url: T.nilable(String),
+              price: T.nilable(Float),
+              pricing_model:
+                T.nilable(
+                  BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+                ),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Billing frequency for the product
+        module BillingFrequency
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MONTHLY =
+            T.let(
+              :monthly,
+              BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          YEARLY =
+            T.let(
+              :yearly,
+              BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          ONE_TIME =
+            T.let(
+              :one_time,
+              BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+            )
+          USAGE_BASED =
+            T.let(
+              :usage_based,
+              BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Pricing model for the product
+        module PricingModel
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::Models::BrandAIProductsResponse::Product::PricingModel
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PER_SEAT =
+            T.let(
+              :per_seat,
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+          FLAT =
+            T.let(
+              :flat,
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+          TIERED =
+            T.let(
+              :tiered,
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+          FREEMIUM =
+            T.let(
+              :freemium,
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_prefetch_by_email_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandPrefetchByEmailParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Email address to prefetch brand data for. The domain will be extracted from the
+      # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+      # addresses are not allowed.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Optional timeout in milliseconds for the request. If the request takes longer
+      # than this value, it will be aborted with a 408 status code. 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(
+          email: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address to prefetch brand data for. The domain will be extracted from the
+        # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+        # addresses are not allowed.
+        email:,
+        # Optional timeout in milliseconds for the request. If the request takes longer
+        # than this value, it will be aborted with a 408 status code. Maximum allowed
+        # value is 300000ms (5 minutes).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchByEmailResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandPrefetchByEmailResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # The domain that was queued for prefetching
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # Success message
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      sig do
+        params(domain: String, message: String, status: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The domain that was queued for prefetching
+        domain: nil,
+        # Success message
+        message: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil
+      )
+      end
+
+      sig do
+        override.returns({ domain: String, message: String, status: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module BrandDev
+  BrandAIProductsParams = BrandDev::Models::BrandAIProductsParams
+
   BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams
 
   BrandFontsParams = BrandDev::Models::BrandFontsParams
@@ -8,6 +10,8 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams
+
   BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
 
   BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams

data/rbi/brand_dev/resources/brand.rbi

@@ -34,9 +34,33 @@ module BrandDev
       )
       end
 
-      # Beta feature: Use AI to extract specific data points from a brand's website. The
-      # AI will crawl the website and extract the requested information based on the
-      # provided data points.
+      # Beta feature: Extract product information from a brand's website. Brand.dev will
+      # analyze the website and return a list of products with details such as name,
+      # description, image, pricing, features, and more.
+      sig do
+        params(
+          domain: String,
+          max_products: Integer,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandAIProductsResponse)
+      end
+      def ai_products(
+        # The domain name to analyze
+        domain:,
+        # Maximum number of products to extract.
+        max_products: nil,
+        # Optional timeout in milliseconds for the request. If the request takes longer
+        # than this value, it will be aborted with a 408 status code. Maximum allowed
+        # value is 300000ms (5 minutes).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      # Use AI to extract specific data points from a brand's website. The AI will crawl
+      # the website and extract the requested information based on the provided data
+      # points.
       sig do
         params(
           data_to_extract:
@@ -62,8 +86,8 @@ module BrandDev
       )
       end
 
-      # Beta feature: Extract font information from a brand's website including font
-      # families, usage statistics, fallbacks, and element/word counts.
+      # Extract font information from a brand's website including font families, usage
+      # statistics, fallbacks, and element/word counts.
       sig do
         params(
           domain: String,
@@ -149,6 +173,32 @@ module BrandDev
       )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. This endpoint accepts an email address, extracts the domain from it,
+      # validates that it's not a disposable or free email provider, and queues the
+      # domain for prefetching. This endpoint does not charge credits and is available
+      # for paid customers to optimize future requests. [You must be on a paid plan to
+      # use this endpoint]
+      sig do
+        params(
+          email: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchByEmailResponse)
+      end
+      def prefetch_by_email(
+        # Email address to prefetch brand data for. The domain will be extracted from the
+        # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+        # addresses are not allowed.
+        email:,
+        # Optional timeout in milliseconds for the request. If the request takes longer
+        # than this value, it will be aborted with a 408 status code. Maximum allowed
+        # value is 300000ms (5 minutes).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieve brand information using an email address while detecting disposable and
       # free email addresses. This endpoint extracts the domain from the email address
       # and returns brand data for that domain. Disposable and free email addresses
@@ -327,10 +377,10 @@ module BrandDev
       )
       end
 
-      # Beta feature: Capture a screenshot of a website. Supports both viewport
-      # (standard browser view) and full-page screenshots. Can also screenshot specific
-      # page types (login, pricing, etc.) by using heuristics to find the appropriate
-      # URL. Returns a URL to the uploaded screenshot image hosted on our CDN.
+      # Capture a screenshot of a website. Supports both viewport (standard browser
+      # view) and full-page screenshots. Can also screenshot specific page types (login,
+      # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
+      # the uploaded screenshot image hosted on our CDN.
       sig do
         params(
           domain: String,
@@ -362,9 +412,8 @@ module BrandDev
       )
       end
 
-      # Beta feature: Automatically extract comprehensive design system information from
-      # a brand's website including colors, typography, spacing, shadows, and UI
-      # components.
+      # Automatically extract comprehensive design system information from a brand's
+      # website including colors, typography, spacing, shadows, and UI components.
       sig do
         params(
           domain: String,

data/sig/brand_dev/models/brand_ai_products_params.rbs

@@ -0,0 +1,36 @@
+module BrandDev
+  module Models
+    type brand_ai_products_params =
+      { domain: String, max_products: Integer, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandAIProductsParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_reader max_products: Integer?
+
+      def max_products=: (Integer) -> Integer
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        domain: String,
+        ?max_products: Integer,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        max_products: Integer,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_ai_products_response.rbs

@@ -0,0 +1,121 @@
+module BrandDev
+  module Models
+    type brand_ai_products_response =
+      { products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product] }
+
+    class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product]?
+
+      def products=: (
+        ::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+      ) -> ::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+
+      def initialize: (
+        ?products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+      ) -> void
+
+      def to_hash: -> {
+        products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product]
+      }
+
+      type product =
+        {
+          description: String,
+          features: ::Array[String],
+          name: String,
+          tags: ::Array[String],
+          target_audience: ::Array[String],
+          billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?,
+          category: String?,
+          currency: String?,
+          image_url: String?,
+          price: Float?,
+          pricing_model: BrandDev::Models::BrandAIProductsResponse::Product::pricing_model?,
+          url: String?
+        }
+
+      class Product < BrandDev::Internal::Type::BaseModel
+        attr_accessor description: String
+
+        attr_accessor features: ::Array[String]
+
+        attr_accessor name: String
+
+        attr_accessor tags: ::Array[String]
+
+        attr_accessor target_audience: ::Array[String]
+
+        attr_accessor billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?
+
+        attr_accessor category: String?
+
+        attr_accessor currency: String?
+
+        attr_accessor image_url: String?
+
+        attr_accessor price: Float?
+
+        attr_accessor pricing_model: BrandDev::Models::BrandAIProductsResponse::Product::pricing_model?
+
+        attr_accessor url: String?
+
+        def initialize: (
+          description: String,
+          features: ::Array[String],
+          name: String,
+          tags: ::Array[String],
+          target_audience: ::Array[String],
+          ?billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?,
+          ?category: String?,
+          ?currency: String?,
+          ?image_url: String?,
+          ?price: Float?,
+          ?pricing_model: BrandDev::Models::BrandAIProductsResponse::Product::pricing_model?,
+          ?url: String?
+        ) -> void
+
+        def to_hash: -> {
+          description: String,
+          features: ::Array[String],
+          name: String,
+          tags: ::Array[String],
+          target_audience: ::Array[String],
+          billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?,
+          category: String?,
+          currency: String?,
+          image_url: String?,
+          price: Float?,
+          pricing_model: BrandDev::Models::BrandAIProductsResponse::Product::pricing_model?,
+          url: String?
+        }
+
+        type billing_frequency = :monthly | :yearly | :one_time | :usage_based
+
+        module BillingFrequency
+          extend BrandDev::Internal::Type::Enum
+
+          MONTHLY: :monthly
+          YEARLY: :yearly
+          ONE_TIME: :one_time
+          USAGE_BASED: :usage_based
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency]
+        end
+
+        type pricing_model = :per_seat | :flat | :tiered | :freemium | :custom
+
+        module PricingModel
+          extend BrandDev::Internal::Type::Enum
+
+          PER_SEAT: :per_seat
+          FLAT: :flat
+          TIERED: :tiered
+          FREEMIUM: :freemium
+          CUSTOM: :custom
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandAIProductsResponse::Product::pricing_model]
+        end
+      end
+    end
+  end
+end