brand.dev 0.1.0.pre.alpha.13 → 0.2.0

data/lib/brand_dev/models/brand_retrieve_response.rb

@@ -63,13 +63,17 @@ module BrandDev
         #   @return [String, nil]
         optional :domain, String
 
-        # @!attribute fonts
-        #   An array of fonts used by the brand's website. NOTE: This is deprecated and will
-        #   be removed in the future. Please migrate to the styleguide API.
+        # @!attribute email
+        #   Company email address
         #
-        #   @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>, nil]
-        optional :fonts,
-                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Font] }
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute is_nsfw
+        #   Indicates whether the brand content is not safe for work (NSFW)
+        #
+        #   @return [Boolean, nil]
+        optional :is_nsfw, BrandDev::Internal::Type::Boolean
 
         # @!attribute logos
         #   An array of logos associated with the brand
@@ -78,6 +82,12 @@ module BrandDev
         optional :logos,
                  -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Logo] }
 
+        # @!attribute phone
+        #   Company phone number
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
         # @!attribute slogan
         #   The brand's slogan
         #
@@ -104,7 +114,7 @@ module BrandDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, is_nsfw: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {BrandDev::Models::BrandRetrieveResponse::Brand} for more details.
         #
@@ -120,10 +130,14 @@ module BrandDev
         #
         #   @param domain [String] The domain name of the brand
         #
-        #   @param fonts [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>] An array of fonts used by the brand's website. NOTE: This is deprecated and will
+        #   @param email [String] Company email address
+        #
+        #   @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
         #
         #   @param logos [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
         #
+        #   @param phone [String] Company phone number
+        #
         #   @param slogan [String] The brand's slogan
         #
         #   @param socials [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Social>] An array of social media links for the brand
@@ -242,6 +256,12 @@ module BrandDev
 
           # @see BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop#resolution
           class Resolution < BrandDev::Internal::Type::BaseModel
+            # @!attribute aspect_ratio
+            #   Aspect ratio of the image (width/height)
+            #
+            #   @return [Float, nil]
+            optional :aspect_ratio, Float
+
             # @!attribute height
             #   Height of the image in pixels
             #
@@ -254,9 +274,11 @@ module BrandDev
             #   @return [Integer, nil]
             optional :width, Integer
 
-            # @!method initialize(height: nil, width: nil)
+            # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
             #   Resolution of the backdrop image
             #
+            #   @param aspect_ratio [Float] Aspect ratio of the image (width/height)
+            #
             #   @param height [Integer] Height of the image in pixels
             #
             #   @param width [Integer] Width of the image in pixels
@@ -282,25 +304,6 @@ module BrandDev
           #   @param name [String] Name of the color
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          # @!attribute name
-          #   Name of the font
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute usage
-          #   Usage of the font, e.g., 'title', 'body', 'button'
-          #
-          #   @return [String, nil]
-          optional :usage, String
-
-          # @!method initialize(name: nil, usage: nil)
-          #   @param name [String] Name of the font
-          #
-          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           # @!attribute colors
           #   Array of colors in the logo
@@ -309,17 +312,13 @@ module BrandDev
           optional :colors,
                    -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color] }
 
-          # @!attribute group
-          #   Group identifier for logos
-          #
-          #   @return [Integer, nil]
-          optional :group, Integer
-
           # @!attribute mode
-          #   Mode of the logo, e.g., 'dark', 'light'
+          #   Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          #   best for dark mode, 'has_opaque_background' = can be used for either as image
+          #   has its own background
           #
-          #   @return [String, nil]
-          optional :mode, String
+          #   @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode, nil]
+          optional :mode, enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode }
 
           # @!attribute resolution
           #   Resolution of the logo image
@@ -327,22 +326,31 @@ module BrandDev
           #   @return [BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution, nil]
           optional :resolution, -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution }
 
+          # @!attribute type
+          #   Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          #   @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Type, nil]
+          optional :type, enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Type }
+
           # @!attribute url
-          #   URL of the logo image
+          #   CDN hosted url of the logo (ready for display)
           #
           #   @return [String, nil]
           optional :url, String
 
-          # @!method initialize(colors: nil, group: nil, mode: nil, resolution: nil, url: nil)
-          #   @param colors [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color>] Array of colors in the logo
+          # @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {BrandDev::Models::BrandRetrieveResponse::Brand::Logo} for more details.
           #
-          #   @param group [Integer] Group identifier for logos
+          #   @param colors [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color>] Array of colors in the logo
           #
-          #   @param mode [String] Mode of the logo, e.g., 'dark', 'light'
+          #   @param mode [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
           #
           #   @param resolution [BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution] Resolution of the logo image
           #
-          #   @param url [String] URL of the logo image
+          #   @param type [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          #   @param url [String] CDN hosted url of the logo (ready for display)
 
           class Color < BrandDev::Internal::Type::BaseModel
             # @!attribute hex
@@ -363,8 +371,30 @@ module BrandDev
             #   @param name [String] Name of the color
           end
 
+          # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          # best for dark mode, 'has_opaque_background' = can be used for either as image
+          # has its own background
+          #
+          # @see BrandDev::Models::BrandRetrieveResponse::Brand::Logo#mode
+          module Mode
+            extend BrandDev::Internal::Type::Enum
+
+            LIGHT = :light
+            DARK = :dark
+            HAS_OPAQUE_BACKGROUND = :has_opaque_background
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see BrandDev::Models::BrandRetrieveResponse::Brand::Logo#resolution
           class Resolution < BrandDev::Internal::Type::BaseModel
+            # @!attribute aspect_ratio
+            #   Aspect ratio of the image (width/height)
+            #
+            #   @return [Float, nil]
+            optional :aspect_ratio, Float
+
             # @!attribute height
             #   Height of the image in pixels
             #
@@ -377,13 +407,28 @@ module BrandDev
             #   @return [Integer, nil]
             optional :width, Integer
 
-            # @!method initialize(height: nil, width: nil)
+            # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
             #   Resolution of the logo image
             #
+            #   @param aspect_ratio [Float] Aspect ratio of the image (width/height)
+            #
             #   @param height [Integer] Height of the image in pixels
             #
             #   @param width [Integer] Width of the image in pixels
           end
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          # @see BrandDev::Models::BrandRetrieveResponse::Brand::Logo#type
+          module Type
+            extend BrandDev::Internal::Type::Enum
+
+            ICON = :icon
+            LOGO = :logo
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
         class Social < BrandDev::Internal::Type::BaseModel

data/lib/brand_dev/models/brand_retrieve_simplified_response.rb

@@ -182,17 +182,13 @@ module BrandDev
           optional :colors,
                    -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color] }
 
-          # @!attribute group
-          #   Group identifier for logos
-          #
-          #   @return [Integer, nil]
-          optional :group, Integer
-
           # @!attribute mode
-          #   Mode of the logo, e.g., 'dark', 'light'
+          #   Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          #   best for dark mode, 'has_opaque_background' = can be used for either as image
+          #   has its own background
           #
-          #   @return [String, nil]
-          optional :mode, String
+          #   @return [Symbol, BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode, nil]
+          optional :mode, enum: -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode }
 
           # @!attribute resolution
           #   Resolution of the logo image
@@ -201,29 +197,31 @@ module BrandDev
           optional :resolution, -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution }
 
           # @!attribute type
-          #   Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
+          #   Type of the logo based on resolution (e.g., 'icon', 'logo')
           #
-          #   @return [String, nil]
-          optional :type, String
+          #   @return [Symbol, BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type, nil]
+          optional :type, enum: -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type }
 
           # @!attribute url
-          #   URL of the logo image
+          #   CDN hosted url of the logo (ready for display)
           #
           #   @return [String, nil]
           optional :url, String
 
-          # @!method initialize(colors: nil, group: nil, mode: nil, resolution: nil, type: nil, url: nil)
-          #   @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>] Array of colors in the logo
+          # @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo} for more
+          #   details.
           #
-          #   @param group [Integer] Group identifier for logos
+          #   @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>] Array of colors in the logo
           #
-          #   @param mode [String] Mode of the logo, e.g., 'dark', 'light'
+          #   @param mode [Symbol, BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
           #
           #   @param resolution [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution] Resolution of the logo image
           #
-          #   @param type [String] Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
+          #   @param type [Symbol, BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
           #
-          #   @param url [String] URL of the logo image
+          #   @param url [String] CDN hosted url of the logo (ready for display)
 
           class Color < BrandDev::Internal::Type::BaseModel
             # @!attribute hex
@@ -244,6 +242,22 @@ module BrandDev
             #   @param name [String] Name of the color
           end
 
+          # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          # best for dark mode, 'has_opaque_background' = can be used for either as image
+          # has its own background
+          #
+          # @see BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#mode
+          module Mode
+            extend BrandDev::Internal::Type::Enum
+
+            LIGHT = :light
+            DARK = :dark
+            HAS_OPAQUE_BACKGROUND = :has_opaque_background
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#resolution
           class Resolution < BrandDev::Internal::Type::BaseModel
             # @!attribute aspect_ratio
@@ -273,6 +287,19 @@ module BrandDev
             #
             #   @param width [Integer] Width of the image in pixels
           end
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          # @see BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#type
+          module Type
+            extend BrandDev::Internal::Type::Enum
+
+            ICON = :icon
+            LOGO = :logo
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/brand_dev/models.rb

@@ -55,7 +55,5 @@ module BrandDev
 
   BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
 
-  BrandSearchParams = BrandDev::Models::BrandSearchParams
-
   BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
 end

data/lib/brand_dev/resources/brand.rb

@@ -237,33 +237,6 @@ module BrandDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {BrandDev::Models::BrandSearchParams} for more details.
-      #
-      # Search brands by query
-      #
-      # @overload search(query:, timeout_ms: nil, request_options: {})
-      #
-      # @param query [String] Query string to search brands
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Array<BrandDev::Models::BrandSearchResponseItem>]
-      #
-      # @see BrandDev::Models::BrandSearchParams
-      def search(params)
-        parsed, options = BrandDev::BrandSearchParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "brand/search",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
-          model: BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandSearchResponseItem],
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandStyleguideParams} for more details.
       #

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.1.0.pre.alpha.13"
+  VERSION = "0.2.0"
 end

data/lib/brand_dev.rb

@@ -66,8 +66,6 @@ require_relative "brand_dev/models/brand_retrieve_simplified_params"
 require_relative "brand_dev/models/brand_retrieve_simplified_response"
 require_relative "brand_dev/models/brand_screenshot_params"
 require_relative "brand_dev/models/brand_screenshot_response"
-require_relative "brand_dev/models/brand_search_params"
-require_relative "brand_dev/models/brand_search_response"
 require_relative "brand_dev/models/brand_styleguide_params"
 require_relative "brand_dev/models/brand_styleguide_response"
 require_relative "brand_dev/models"

data/rbi/brand_dev/models/brand_ai_query_response.rbi

@@ -38,6 +38,13 @@ module BrandDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
       # List of URLs that were analyzed
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :urls_analyzed
@@ -52,6 +59,7 @@ module BrandDev
               BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash
             ],
           domain: String,
+          status: String,
           urls_analyzed: T::Array[String]
         ).returns(T.attached_class)
       end
@@ -60,6 +68,8 @@ module BrandDev
         data_extracted: nil,
         # The domain that was analyzed
         domain: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil,
         # List of URLs that were analyzed
         urls_analyzed: nil
       )
@@ -71,6 +81,7 @@ module BrandDev
             data_extracted:
               T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
             domain: String,
+            status: String,
             urls_analyzed: T::Array[String]
           }
         )