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

data/rbi/brand_dev/models/brand_ai_query_params.rbi

@@ -0,0 +1,319 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandAIQueryParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandAIQueryParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Array of data points to extract from the website
+      sig { returns(T::Array[BrandDev::BrandAIQueryParams::DataToExtract]) }
+      attr_accessor :data_to_extract
+
+      # The domain name to analyze
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Optional object specifying which pages to analyze
+      sig { returns(T.nilable(BrandDev::BrandAIQueryParams::SpecificPages)) }
+      attr_reader :specific_pages
+
+      sig do
+        params(
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash
+        ).void
+      end
+      attr_writer :specific_pages
+
+      # 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(
+          data_to_extract:
+            T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
+          domain: String,
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of data points to extract from the website
+        data_to_extract:,
+        # The domain name to analyze
+        domain:,
+        # Optional object specifying which pages to analyze
+        specific_pages: 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
+
+      sig do
+        override.returns(
+          {
+            data_to_extract:
+              T::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+            domain: String,
+            specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DataToExtract < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::BrandAIQueryParams::DataToExtract,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Description of what to extract
+        sig { returns(String) }
+        attr_accessor :datapoint_description
+
+        # Example of the expected value
+        sig { returns(String) }
+        attr_accessor :datapoint_example
+
+        # Name of the data point to extract
+        sig { returns(String) }
+        attr_accessor :datapoint_name
+
+        # Type of the data point
+        sig do
+          returns(
+            BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol
+          )
+        end
+        attr_accessor :datapoint_type
+
+        sig do
+          params(
+            datapoint_description: String,
+            datapoint_example: String,
+            datapoint_name: String,
+            datapoint_type:
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Description of what to extract
+          datapoint_description:,
+          # Example of the expected value
+          datapoint_example:,
+          # Name of the data point to extract
+          datapoint_name:,
+          # Type of the data point
+          datapoint_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              datapoint_description: String,
+              datapoint_example: String,
+              datapoint_name: String,
+              datapoint_type:
+                BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Type of the data point
+        module DatapointType
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::BrandAIQueryParams::DataToExtract::DatapointType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TEXT =
+            T.let(
+              :text,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+          NUMBER =
+            T.let(
+              :number,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+          DATE =
+            T.let(
+              :date,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+          BOOLEAN =
+            T.let(
+              :boolean,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+          LIST =
+            T.let(
+              :list,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+          URL =
+            T.let(
+              :url,
+              BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::BrandAIQueryParams::SpecificPages,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Whether to analyze the about us page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :about_us
+
+        sig { params(about_us: T::Boolean).void }
+        attr_writer :about_us
+
+        # Whether to analyze the blog
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :blog
+
+        sig { params(blog: T::Boolean).void }
+        attr_writer :blog
+
+        # Whether to analyze the careers page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :careers
+
+        sig { params(careers: T::Boolean).void }
+        attr_writer :careers
+
+        # Whether to analyze the contact us page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :contact_us
+
+        sig { params(contact_us: T::Boolean).void }
+        attr_writer :contact_us
+
+        # Whether to analyze the FAQ page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :faq
+
+        sig { params(faq: T::Boolean).void }
+        attr_writer :faq
+
+        # Whether to analyze the home page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :home_page
+
+        sig { params(home_page: T::Boolean).void }
+        attr_writer :home_page
+
+        # Whether to analyze the privacy policy page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :privacy_policy
+
+        sig { params(privacy_policy: T::Boolean).void }
+        attr_writer :privacy_policy
+
+        # Whether to analyze the terms and conditions page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :terms_and_conditions
+
+        sig { params(terms_and_conditions: T::Boolean).void }
+        attr_writer :terms_and_conditions
+
+        # Optional object specifying which pages to analyze
+        sig do
+          params(
+            about_us: T::Boolean,
+            blog: T::Boolean,
+            careers: T::Boolean,
+            contact_us: T::Boolean,
+            faq: T::Boolean,
+            home_page: T::Boolean,
+            privacy_policy: T::Boolean,
+            terms_and_conditions: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether to analyze the about us page
+          about_us: nil,
+          # Whether to analyze the blog
+          blog: nil,
+          # Whether to analyze the careers page
+          careers: nil,
+          # Whether to analyze the contact us page
+          contact_us: nil,
+          # Whether to analyze the FAQ page
+          faq: nil,
+          # Whether to analyze the home page
+          home_page: nil,
+          # Whether to analyze the privacy policy page
+          privacy_policy: nil,
+          # Whether to analyze the terms and conditions page
+          terms_and_conditions: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              about_us: T::Boolean,
+              blog: T::Boolean,
+              careers: T::Boolean,
+              contact_us: T::Boolean,
+              faq: T::Boolean,
+              home_page: T::Boolean,
+              privacy_policy: T::Boolean,
+              terms_and_conditions: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_ai_query_response.rbi

@@ -0,0 +1,182 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandAIQueryResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Array of extracted data points
+      sig do
+        returns(
+          T.nilable(
+            T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted]
+          )
+        )
+      end
+      attr_reader :data_extracted
+
+      sig do
+        params(
+          data_extracted:
+            T::Array[
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash
+            ]
+        ).void
+      end
+      attr_writer :data_extracted
+
+      # The domain that was analyzed
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # List of URLs that were analyzed
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :urls_analyzed
+
+      sig { params(urls_analyzed: T::Array[String]).void }
+      attr_writer :urls_analyzed
+
+      sig do
+        params(
+          data_extracted:
+            T::Array[
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash
+            ],
+          domain: String,
+          urls_analyzed: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of extracted data points
+        data_extracted: nil,
+        # The domain that was analyzed
+        domain: nil,
+        # List of URLs that were analyzed
+        urls_analyzed: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data_extracted:
+              T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
+            domain: String,
+            urls_analyzed: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DataExtracted < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Name of the extracted data point
+        sig { returns(T.nilable(String)) }
+        attr_reader :datapoint_name
+
+        sig { params(datapoint_name: String).void }
+        attr_writer :datapoint_name
+
+        # Value of the extracted data point
+        sig do
+          returns(
+            T.nilable(
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants
+            )
+          )
+        end
+        attr_reader :datapoint_value
+
+        sig do
+          params(
+            datapoint_value:
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants
+          ).void
+        end
+        attr_writer :datapoint_value
+
+        sig do
+          params(
+            datapoint_name: String,
+            datapoint_value:
+              BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Name of the extracted data point
+          datapoint_name: nil,
+          # Value of the extracted data point
+          datapoint_value: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              datapoint_name: String,
+              datapoint_value:
+                BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Value of the extracted data point
+        module DatapointValue
+          extend BrandDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                Float,
+                T::Boolean,
+                T::Array[String],
+                T::Array[Float]
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          StringArray =
+            T.let(
+              BrandDev::Internal::Type::ArrayOf[String],
+              BrandDev::Internal::Type::Converter
+            )
+
+          FloatArray =
+            T.let(
+              BrandDev::Internal::Type::ArrayOf[Float],
+              BrandDev::Internal::Type::Converter
+            )
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi

@@ -18,15 +18,29 @@ 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
@@ -35,6 +49,7 @@ 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,28 +159,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::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(
@@ -273,10 +251,6 @@ module BrandDev
               ],
             description: String,
             domain: String,
-            fonts:
-              T::Array[
-                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
-              ],
             logos:
               T::Array[
                 BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash
@@ -302,8 +276,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
@@ -333,10 +305,6 @@ module BrandDev
                 ],
               description: String,
               domain: String,
-              fonts:
-                T::Array[
-                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
-                ],
               logos:
                 T::Array[
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo
@@ -668,43 +636,6 @@ 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_prefetch_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandPrefetchParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Domain name to prefetch 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 prefetch 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