brand.dev 0.0.1.pre.alpha.0 → 0.0.2

data/rbi/brand_dev/models/brand_prefetch_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandPrefetchResponse,
+            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/brand_retrieve_by_ticker_params.rbi

@@ -18,22 +18,40 @@ 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, request_options: BrandDev::RequestOptions }
+          {
+            ticker: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi

@@ -154,28 +154,6 @@ 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(
@@ -268,10 +246,6 @@ module BrandDev
               ],
             description: String,
             domain: String,
-            fonts:
-              T::Array[
-                BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font::OrHash
-              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash
@@ -297,8 +271,6 @@ 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
@@ -328,10 +300,6 @@ module BrandDev
                 ],
               description: String,
               domain: String,
-              fonts:
-                T::Array[
-                  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font
-                ],
               logos:
                 T::Array[
                   BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo
@@ -663,43 +631,6 @@ 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,9 +17,19 @@ 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
@@ -28,13 +38,21 @@ 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, request_options: BrandDev::RequestOptions }
+          {
+            input: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_params.rbi

@@ -30,11 +30,31 @@ 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
@@ -43,6 +63,14 @@ 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
@@ -53,6 +81,8 @@ 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,26 +144,6 @@ 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(
@@ -249,10 +229,6 @@ module BrandDev
               ],
             description: String,
             domain: String,
-            fonts:
-              T::Array[
-                BrandDev::Models::BrandRetrieveResponse::Brand::Font::OrHash
-              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandRetrieveResponse::Brand::Logo::OrHash
@@ -278,8 +254,6 @@ 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
@@ -306,8 +280,6 @@ 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,
@@ -636,43 +608,6 @@ 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_retrieve_simplified_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandRetrieveSimplifiedParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Domain name to retrieve simplified brand data for
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # 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,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to retrieve simplified brand data for
+        domain:,
+        # 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(
+          {
+            domain: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end