brand.dev 0.0.2 → 0.1.0.pre.alpha.1

data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi

@@ -18,29 +18,15 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :transaction_info
 
-      # 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(
           transaction_info: String,
-          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Transaction information to identify the brand
         transaction_info:,
-        # 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
@@ -49,7 +35,6 @@ module BrandDev
         override.returns(
           {
             transaction_info: String,
-            timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi

@@ -159,6 +159,28 @@ module BrandDev
         sig { params(domain: String).void }
         attr_writer :domain
 
+        # An array of fonts used by the brand's website
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
+              ]
+            )
+          )
+        end
+        attr_reader :fonts
+
+        sig do
+          params(
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
+              ]
+          ).void
+        end
+        attr_writer :fonts
+
         # An array of logos associated with the brand
         sig do
           returns(
@@ -251,6 +273,10 @@ module BrandDev
               ],
             description: String,
             domain: String,
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
+              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash
@@ -276,6 +302,8 @@ module BrandDev
           description: nil,
           # The domain name of the brand
           domain: nil,
+          # An array of fonts used by the brand's website
+          fonts: nil,
           # An array of logos associated with the brand
           logos: nil,
           # The brand's slogan
@@ -305,6 +333,10 @@ module BrandDev
                 ],
               description: String,
               domain: String,
+              fonts:
+                T::Array[
+                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
+                ],
               logos:
                 T::Array[
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo
@@ -636,6 +668,43 @@ module BrandDev
           end
         end
 
+        class Font < BrandDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font,
+                BrandDev::Internal::AnyHash
+              )
+            end
+
+          # Name of the font
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # Usage of the font, e.g., 'title', 'body', 'button'
+          sig { returns(T.nilable(String)) }
+          attr_reader :usage
+
+          sig { params(usage: String).void }
+          attr_writer :usage
+
+          sig { params(name: String, usage: String).returns(T.attached_class) }
+          def self.new(
+            # Name of the font
+            name: nil,
+            # Usage of the font, e.g., 'title', 'body', 'button'
+            usage: nil
+          )
+          end
+
+          sig { override.returns({ name: String, usage: String }) }
+          def to_hash
+          end
+        end
+
         class Logo < BrandDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi

@@ -18,40 +18,22 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :ticker
 
-      # 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(
           ticker: String,
-          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
         ticker:,
-        # 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(
-          {
-            ticker: String,
-            timeout_ms: Integer,
-            request_options: BrandDev::RequestOptions
-          }
+          { ticker: String, request_options: BrandDev::RequestOptions }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi

@@ -154,6 +154,28 @@ module BrandDev
         sig { params(domain: String).void }
         attr_writer :domain
 
+        # An array of fonts used by the brand's website
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font
+              ]
+            )
+          )
+        end
+        attr_reader :fonts
+
+        sig do
+          params(
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font::OrHash
+              ]
+          ).void
+        end
+        attr_writer :fonts
+
         # An array of logos associated with the brand
         sig do
           returns(
@@ -246,6 +268,10 @@ module BrandDev
               ],
             description: String,
             domain: String,
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font::OrHash
+              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash
@@ -271,6 +297,8 @@ module BrandDev
           description: nil,
           # The domain name of the brand
           domain: nil,
+          # An array of fonts used by the brand's website
+          fonts: nil,
           # An array of logos associated with the brand
           logos: nil,
           # The brand's slogan
@@ -300,6 +328,10 @@ module BrandDev
                 ],
               description: String,
               domain: String,
+              fonts:
+                T::Array[
+                  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font
+                ],
               logos:
                 T::Array[
                   BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo
@@ -631,6 +663,43 @@ module BrandDev
           end
         end
 
+        class Font < BrandDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font,
+                BrandDev::Internal::AnyHash
+              )
+            end
+
+          # Name of the font
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # Usage of the font, e.g., 'title', 'body', 'button'
+          sig { returns(T.nilable(String)) }
+          attr_reader :usage
+
+          sig { params(usage: String).void }
+          attr_writer :usage
+
+          sig { params(name: String, usage: String).returns(T.attached_class) }
+          def self.new(
+            # Name of the font
+            name: nil,
+            # Usage of the font, e.g., 'title', 'body', 'button'
+            usage: nil
+          )
+          end
+
+          sig { override.returns({ name: String, usage: String }) }
+          def to_hash
+          end
+        end
+
         class Logo < BrandDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi

@@ -17,19 +17,9 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :input
 
-      # 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(
           input: String,
-          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -38,21 +28,13 @@ module BrandDev
         # in `input`, it will be used for classification, otherwise, we will search for
         # the brand using the provided title.
         input:,
-        # 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(
-          {
-            input: String,
-            timeout_ms: Integer,
-            request_options: BrandDev::RequestOptions
-          }
+          { input: String, request_options: BrandDev::RequestOptions }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_params.rbi

@@ -30,31 +30,11 @@ module BrandDev
       end
       attr_writer :force_language
 
-      # Optional parameter to optimize the API call for maximum speed. When set to true,
-      # the API will skip time-consuming operations for faster response at the cost of
-      # less comprehensive data.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :max_speed
-
-      sig { params(max_speed: T::Boolean).void }
-      attr_writer :max_speed
-
-      # 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(
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
-          max_speed: T::Boolean,
-          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -63,14 +43,6 @@ module BrandDev
         domain:,
         # Optional parameter to force the language of the retrieved brand data
         force_language: nil,
-        # Optional parameter to optimize the API call for maximum speed. When set to true,
-        # the API will skip time-consuming operations for faster response at the cost of
-        # less comprehensive data.
-        max_speed: 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
@@ -81,8 +53,6 @@ module BrandDev
             domain: String,
             force_language:
               BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
-            max_speed: T::Boolean,
-            timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models/brand_retrieve_response.rbi

@@ -144,6 +144,26 @@ module BrandDev
         sig { params(domain: String).void }
         attr_writer :domain
 
+        # An array of fonts used by the brand's website
+        sig do
+          returns(
+            T.nilable(
+              T::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font]
+            )
+          )
+        end
+        attr_reader :fonts
+
+        sig do
+          params(
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandRetrieveResponse::Brand::Font::OrHash
+              ]
+          ).void
+        end
+        attr_writer :fonts
+
         # An array of logos associated with the brand
         sig do
           returns(
@@ -229,6 +249,10 @@ module BrandDev
               ],
             description: String,
             domain: String,
+            fonts:
+              T::Array[
+                BrandDev::Models::BrandRetrieveResponse::Brand::Font::OrHash
+              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandRetrieveResponse::Brand::Logo::OrHash
@@ -254,6 +278,8 @@ module BrandDev
           description: nil,
           # The domain name of the brand
           domain: nil,
+          # An array of fonts used by the brand's website
+          fonts: nil,
           # An array of logos associated with the brand
           logos: nil,
           # The brand's slogan
@@ -280,6 +306,8 @@ module BrandDev
                 T::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color],
               description: String,
               domain: String,
+              fonts:
+                T::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font],
               logos:
                 T::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo],
               slogan: String,
@@ -608,6 +636,43 @@ module BrandDev
           end
         end
 
+        class Font < BrandDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                BrandDev::Models::BrandRetrieveResponse::Brand::Font,
+                BrandDev::Internal::AnyHash
+              )
+            end
+
+          # Name of the font
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # Usage of the font, e.g., 'title', 'body', 'button'
+          sig { returns(T.nilable(String)) }
+          attr_reader :usage
+
+          sig { params(usage: String).void }
+          attr_writer :usage
+
+          sig { params(name: String, usage: String).returns(T.attached_class) }
+          def self.new(
+            # Name of the font
+            name: nil,
+            # Usage of the font, e.g., 'title', 'body', 'button'
+            usage: nil
+          )
+          end
+
+          sig { override.returns({ name: String, usage: String }) }
+          def to_hash
+          end
+        end
+
         class Logo < BrandDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/brand_dev/models/brand_search_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandSearchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandSearchParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Query string to search brands
+      sig { returns(String) }
+      attr_accessor :query
+
+      sig do
+        params(
+          query: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Query string to search brands
+        query:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { query: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_search_response.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandSearchResponseItem < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandSearchResponseItem,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Domain name of the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # URL of the brand's logo
+      sig { returns(T.nilable(String)) }
+      attr_reader :logo
+
+      sig { params(logo: String).void }
+      attr_writer :logo
+
+      # Title or name of the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
+
+      sig { params(title: String).void }
+      attr_writer :title
+
+      sig do
+        params(domain: String, logo: String, title: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Domain name of the brand
+        domain: nil,
+        # URL of the brand's logo
+        logo: nil,
+        # Title or name of the brand
+        title: nil
+      )
+      end
+
+      sig { override.returns({ domain: String, logo: String, title: String }) }
+      def to_hash
+      end
+    end
+
+    BrandSearchResponse =
+      T.let(
+        BrandDev::Internal::Type::ArrayOf[
+          BrandDev::Models::BrandSearchResponseItem
+        ],
+        BrandDev::Internal::Type::Converter
+      )
+  end
+end

data/rbi/brand_dev/models.rbi

@@ -6,18 +6,11 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
-  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
-
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
 
   BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
 
-  BrandRetrieveSimplifiedParams =
-    BrandDev::Models::BrandRetrieveSimplifiedParams
-
-  BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
-
-  BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
+  BrandSearchParams = BrandDev::Models::BrandSearchParams
 end