brand.dev 0.0.1.pre.alpha.0 → 0.1.0.pre.alpha.2

data/rbi/brand_dev/models/brand_ai_query_params.rbi

@@ -0,0 +1,304 @@
+# 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
+
+      sig do
+        params(
+          data_to_extract:
+            T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
+          domain: String,
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
+          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,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data_to_extract:
+              T::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+            domain: String,
+            specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+            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.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module BrandDev
+  BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams
+
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 

data/rbi/brand_dev/resources/brand.rbi

@@ -21,6 +21,29 @@ module BrandDev
       )
       end
 
+      # Beta feature: Use AI to extract specific data points from a brand's website. The
+      # AI will crawl the website and extract the requested information based on the
+      # provided data points.
+      sig do
+        params(
+          data_to_extract:
+            T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
+          domain: String,
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandAIQueryResponse)
+      end
+      def ai_query(
+        # 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,
+        request_options: {}
+      )
+      end
+
       # Endpoint specially designed for platforms that want to identify transaction data
       # by the transaction title.
       sig do

data/sig/brand_dev/models/brand_ai_query_params.rbs

@@ -0,0 +1,155 @@
+module BrandDev
+  module Models
+    type brand_ai_query_params =
+      {
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages
+      }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandAIQueryParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract]
+
+      attr_accessor domain: String
+
+      attr_reader specific_pages: BrandDev::BrandAIQueryParams::SpecificPages?
+
+      def specific_pages=: (
+        BrandDev::BrandAIQueryParams::SpecificPages
+      ) -> BrandDev::BrandAIQueryParams::SpecificPages
+
+      def initialize: (
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        ?specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        request_options: BrandDev::RequestOptions
+      }
+
+      type data_to_extract =
+        {
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        }
+
+      class DataToExtract < BrandDev::Internal::Type::BaseModel
+        attr_accessor datapoint_description: String
+
+        attr_accessor datapoint_example: String
+
+        attr_accessor datapoint_name: String
+
+        attr_accessor datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+
+        def initialize: (
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        ) -> void
+
+        def to_hash: -> {
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        }
+
+        type datapoint_type = :text | :number | :date | :boolean | :list | :url
+
+        module DatapointType
+          extend BrandDev::Internal::Type::Enum
+
+          TEXT: :text
+          NUMBER: :number
+          DATE: :date
+          BOOLEAN: :boolean
+          LIST: :list
+          URL: :url
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type]
+        end
+      end
+
+      type specific_pages =
+        {
+          about_us: bool,
+          blog: bool,
+          careers: bool,
+          contact_us: bool,
+          faq: bool,
+          home_page: bool,
+          privacy_policy: bool,
+          terms_and_conditions: bool
+        }
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        attr_reader about_us: bool?
+
+        def about_us=: (bool) -> bool
+
+        attr_reader blog: bool?
+
+        def blog=: (bool) -> bool
+
+        attr_reader careers: bool?
+
+        def careers=: (bool) -> bool
+
+        attr_reader contact_us: bool?
+
+        def contact_us=: (bool) -> bool
+
+        attr_reader faq: bool?
+
+        def faq=: (bool) -> bool
+
+        attr_reader home_page: bool?
+
+        def home_page=: (bool) -> bool
+
+        attr_reader privacy_policy: bool?
+
+        def privacy_policy=: (bool) -> bool
+
+        attr_reader terms_and_conditions: bool?
+
+        def terms_and_conditions=: (bool) -> bool
+
+        def initialize: (
+          ?about_us: bool,
+          ?blog: bool,
+          ?careers: bool,
+          ?contact_us: bool,
+          ?faq: bool,
+          ?home_page: bool,
+          ?privacy_policy: bool,
+          ?terms_and_conditions: bool
+        ) -> void
+
+        def to_hash: -> {
+          about_us: bool,
+          blog: bool,
+          careers: bool,
+          contact_us: bool,
+          faq: bool,
+          home_page: bool,
+          privacy_policy: bool,
+          terms_and_conditions: bool
+        }
+      end
+    end
+  end
+end