brand.dev 0.1.0 → 0.2.1

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/rbi/brand_dev/internal/transport/base_client.rbi

@@ -213,7 +213,7 @@ module BrandDev
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/brand_dev/models/brand_ai_query_response.rbi

@@ -11,13 +11,6 @@ module BrandDev
           )
         end
 
-      # HTTP status code
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :code
-
-      sig { params(code: Integer).void }
-      attr_writer :code
-
       # Array of extracted data points
       sig do
         returns(
@@ -61,7 +54,6 @@ module BrandDev
 
       sig do
         params(
-          code: Integer,
           data_extracted:
             T::Array[
               BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash
@@ -72,8 +64,6 @@ module BrandDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # HTTP status code
-        code: nil,
         # Array of extracted data points
         data_extracted: nil,
         # The domain that was analyzed
@@ -88,7 +78,6 @@ module BrandDev
       sig do
         override.returns(
           {
-            code: Integer,
             data_extracted:
               T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
             domain: String,

data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi

@@ -159,6 +159,13 @@ module BrandDev
         sig { params(domain: String).void }
         attr_writer :domain
 
+        # Company email address
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
         # Indicates whether the brand content is not safe for work (NSFW)
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_nsfw
@@ -188,6 +195,13 @@ module BrandDev
         end
         attr_writer :logos
 
+        # Company phone number
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone
+
+        sig { params(phone: String).void }
+        attr_writer :phone
+
         # The brand's slogan
         sig { returns(T.nilable(String)) }
         attr_reader :slogan
@@ -258,11 +272,13 @@ module BrandDev
               ],
             description: String,
             domain: String,
+            email: String,
             is_nsfw: T::Boolean,
             logos:
               T::Array[
                 BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash
               ],
+            phone: String,
             slogan: String,
             socials:
               T::Array[
@@ -284,10 +300,14 @@ module BrandDev
           description: nil,
           # The domain name of the brand
           domain: nil,
+          # Company email address
+          email: nil,
           # Indicates whether the brand content is not safe for work (NSFW)
           is_nsfw: nil,
           # An array of logos associated with the brand
           logos: nil,
+          # Company phone number
+          phone: nil,
           # The brand's slogan
           slogan: nil,
           # An array of social media links for the brand
@@ -315,11 +335,13 @@ module BrandDev
                 ],
               description: String,
               domain: String,
+              email: String,
               is_nsfw: T::Boolean,
               logos:
                 T::Array[
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo
                 ],
+              phone: String,
               slogan: String,
               socials:
                 T::Array[
@@ -578,6 +600,13 @@ module BrandDev
                 )
               end
 
+            # Aspect ratio of the image (width/height)
+            sig { returns(T.nilable(Float)) }
+            attr_reader :aspect_ratio
+
+            sig { params(aspect_ratio: Float).void }
+            attr_writer :aspect_ratio
+
             # Height of the image in pixels
             sig { returns(T.nilable(Integer)) }
             attr_reader :height
@@ -594,9 +623,15 @@ module BrandDev
 
             # Resolution of the backdrop image
             sig do
-              params(height: Integer, width: Integer).returns(T.attached_class)
+              params(
+                aspect_ratio: Float,
+                height: Integer,
+                width: Integer
+              ).returns(T.attached_class)
             end
             def self.new(
+              # Aspect ratio of the image (width/height)
+              aspect_ratio: nil,
               # Height of the image in pixels
               height: nil,
               # Width of the image in pixels
@@ -604,7 +639,11 @@ module BrandDev
             )
             end
 
-            sig { override.returns({ height: Integer, width: Integer }) }
+            sig do
+              override.returns(
+                { aspect_ratio: Float, height: Integer, width: Integer }
+              )
+            end
             def to_hash
             end
           end
@@ -678,18 +717,24 @@ module BrandDev
           end
           attr_writer :colors
 
-          # Group identifier for logos
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :group
-
-          sig { params(group: Integer).void }
-          attr_writer :group
-
-          # Mode of the logo, e.g., 'dark', 'light'
-          sig { returns(T.nilable(String)) }
+          # 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
+          sig do
+            returns(
+              T.nilable(
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            )
+          end
           attr_reader :mode
 
-          sig { params(mode: String).void }
+          sig do
+            params(
+              mode:
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::OrSymbol
+            ).void
+          end
           attr_writer :mode
 
           # Resolution of the logo image
@@ -710,7 +755,25 @@ module BrandDev
           end
           attr_writer :resolution
 
-          # URL of the logo image
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          sig do
+            returns(
+              T.nilable(
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          # CDN hosted url of the logo (ready for display)
           sig { returns(T.nilable(String)) }
           attr_reader :url
 
@@ -723,23 +786,27 @@ module BrandDev
                 T::Array[
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color::OrHash
                 ],
-              group: Integer,
-              mode: String,
+              mode:
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::OrSymbol,
               resolution:
                 BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution::OrHash,
+              type:
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::OrSymbol,
               url: String
             ).returns(T.attached_class)
           end
           def self.new(
             # Array of colors in the logo
             colors: nil,
-            # Group identifier for logos
-            group: nil,
-            # 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
             mode: nil,
             # Resolution of the logo image
             resolution: nil,
-            # URL of the logo image
+            # Type of the logo based on resolution (e.g., 'icon', 'logo')
+            type: nil,
+            # CDN hosted url of the logo (ready for display)
             url: nil
           )
           end
@@ -751,10 +818,12 @@ module BrandDev
                   T::Array[
                     BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color
                   ],
-                group: Integer,
-                mode: String,
+                mode:
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol,
                 resolution:
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution,
+                type:
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol,
                 url: String
               }
             )
@@ -799,6 +868,48 @@ module BrandDev
             end
           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
+          module Mode
+            extend BrandDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LIGHT =
+              T.let(
+                :light,
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            DARK =
+              T.let(
+                :dark,
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            HAS_OPAQUE_BACKGROUND =
+              T.let(
+                :has_opaque_background,
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           class Resolution < BrandDev::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
@@ -808,6 +919,13 @@ module BrandDev
                 )
               end
 
+            # Aspect ratio of the image (width/height)
+            sig { returns(T.nilable(Float)) }
+            attr_reader :aspect_ratio
+
+            sig { params(aspect_ratio: Float).void }
+            attr_writer :aspect_ratio
+
             # Height of the image in pixels
             sig { returns(T.nilable(Integer)) }
             attr_reader :height
@@ -824,9 +942,15 @@ module BrandDev
 
             # Resolution of the logo image
             sig do
-              params(height: Integer, width: Integer).returns(T.attached_class)
+              params(
+                aspect_ratio: Float,
+                height: Integer,
+                width: Integer
+              ).returns(T.attached_class)
             end
             def self.new(
+              # Aspect ratio of the image (width/height)
+              aspect_ratio: nil,
               # Height of the image in pixels
               height: nil,
               # Width of the image in pixels
@@ -834,10 +958,49 @@ module BrandDev
             )
             end
 
-            sig { override.returns({ height: Integer, width: Integer }) }
+            sig do
+              override.returns(
+                { aspect_ratio: Float, height: Integer, width: Integer }
+              )
+            end
             def to_hash
             end
           end
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          module Type
+            extend BrandDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ICON =
+              T.let(
+                :icon,
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
+              )
+            LOGO =
+              T.let(
+                :logo,
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class Social < BrandDev::Internal::Type::BaseModel