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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 308ab90d3e6f03ff0fb725a2aece6d8c14bb16ff54ed00fab2fee5ad217a72fe
-  data.tar.gz: 92c6e324a4885ac710359c9556dad60e904d8630a25510c79c122de0d436f420
+  metadata.gz: a94f139a55d3e88238d913a185093f41026e151b9fd968eb8f249f19ddb54202
+  data.tar.gz: 5387c49ab7a97f07f29ff7c937bba1a49377d3555b98299c61fafe22f2d862d7
 SHA512:
-  metadata.gz: 9d454dbf45c518f184acb12ec4f9f418add64888c748939005d7a88df98affd9f4935cc5346088aca69041fd18096d6d92d8f4c69b8dbcc537278050c4358e19
-  data.tar.gz: 9aa4d6101d29030416e70f1ded7cd38550c582baf2822b5face0f3706718c7989ac27d964f7bd9f08ab55fffdb3e4c5ef7f369fd7ecfea5e409fcc67a991ef49
+  metadata.gz: 7b44cbd8f70815be419af79dfdf414647e5b274e27fa7f8feb01e0671e22b51299728af2867400360adf711c3a756b05a30f1272b9fedc28ab357ba6bf6c0e6b
+  data.tar.gz: 5b2565644ee946cd873a26afeaa9ec5698d360c39677d90d9c6289883be3b0a90f6df1fac6558292798d83877b03f3b3248d309d2137b47223f67a9782781a28

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## 0.1.0-alpha.2 (2025-06-05)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** manual updates ([6613bcd](https://github.com/brand-dot-dev/ruby-sdk/commit/6613bcdddf846a0dbcb1e507da7ec58c93e4125d))
+
+
+### Bug Fixes
+
+* `to_sorbet_type` should not return branded types ([0047f7c](https://github.com/brand-dot-dev/ruby-sdk/commit/0047f7ce754514e6c5ac04546aa262d1e4df68f5))
+* default content-type for text in multi-part formdata uploads should be text/plain ([c39a8a7](https://github.com/brand-dot-dev/ruby-sdk/commit/c39a8a78f5445fa88de3b9f765d6211889ba78ef))
+
+## 0.1.0-alpha.1 (2025-06-02)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** manual updates ([1c2a095](https://github.com/brand-dot-dev/ruby-sdk/commit/1c2a09538494964e67752f572ed11a41f4bf4e29))
+
+
+### Chores
+
+* configure new SDK language ([4b2d19e](https://github.com/brand-dot-dev/ruby-sdk/commit/4b2d19e3ea9342c01529655c0231e1258c04de35))
+* sync repo ([fc86136](https://github.com/brand-dot-dev/ruby-sdk/commit/fc86136bdab0b1c30529662a3dedb8016726d8bc))

data/README.md

@@ -1,6 +1,6 @@
 # Brand Dev Ruby API library
 
-The Brand Dev Ruby library provides convenient access to the Brand Dev REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/stainless-sdks/brand.dev-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+The Brand Dev Ruby library provides convenient access to the Brand Dev REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/brand-dot-dev/ruby-sdk#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -12,10 +12,14 @@ Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
+<!-- x-release-please-start-version -->
+
 ```ruby
-gem "brand.dev", "~> 0.0.1.pre.alpha.0"
+gem "brand.dev", "~> 0.1.0.pre.alpha.2"
 ```
 
+<!-- x-release-please-end -->
+
 ## Usage
 
 ```ruby
@@ -226,4 +230,4 @@ Ruby 3.2.0 or higher.
 
 ## Contributing
 
-See [the contributing documentation](https://github.com/stainless-sdks/brand.dev-ruby/tree/main/CONTRIBUTING.md).
+See [the contributing documentation](https://github.com/brand-dot-dev/ruby-sdk/tree/main/CONTRIBUTING.md).

data/lib/brand_dev/internal/type/enum.rb

@@ -91,11 +91,14 @@ module BrandDev
         #
         # @return [Object]
         def to_sorbet_type
-          case values
+          types = values.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
-          in [value, *_]
-            T.all(BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          in [type]
+            type
+          else
+            T.any(*types)
           end
         end
 

data/lib/brand_dev/internal/type/union.rb

@@ -195,11 +195,14 @@ module BrandDev
         #
         # @return [Object]
         def to_sorbet_type
-          case (v = variants)
+          types = variants.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
+          in [type]
+            type
           else
-            T.any(*v.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+            T.any(*types)
           end
         end
 

data/lib/brand_dev/internal/util.rb

@@ -497,7 +497,7 @@ module BrandDev
         # @param closing [Array<Proc>]
         # @param content_type [String, nil]
         private def write_multipart_content(y, val:, closing:, content_type: nil)
-          content_type ||= "application/octet-stream"
+          content_line = "Content-Type: %s\r\n\r\n"
 
           case val
           in BrandDev::FilePart
@@ -508,24 +508,21 @@ module BrandDev
               content_type: val.content_type
             )
           in Pathname
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             io = val.open(binmode: true)
             closing << io.method(:close)
             IO.copy_stream(io, y)
           in IO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             IO.copy_stream(val, y)
           in StringIO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             y << val.string
-          in String
-            y << "Content-Type: #{content_type}\r\n\r\n"
-            y << val.to_s
           in -> { primitive?(_1) }
-            y << "Content-Type: text/plain\r\n\r\n"
+            y << format(content_line, content_type || "text/plain")
             y << val.to_s
           else
-            y << "Content-Type: application/json\r\n\r\n"
+            y << format(content_line, content_type || "application/json")
             y << JSON.generate(val)
           end
           y << "\r\n"
@@ -563,6 +560,8 @@ module BrandDev
 
         # @api private
         #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
+        #
         # @param body [Object]
         #
         # @return [Array(String, Enumerable<String>)]

data/lib/brand_dev/models/brand_ai_query_params.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_query
+    class BrandAIQueryParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute data_to_extract
+      #   Array of data points to extract from the website
+      #
+      #   @return [Array<BrandDev::Models::BrandAIQueryParams::DataToExtract>]
+      required :data_to_extract,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::BrandAIQueryParams::DataToExtract] }
+
+      # @!attribute domain
+      #   The domain name to analyze
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute specific_pages
+      #   Optional object specifying which pages to analyze
+      #
+      #   @return [BrandDev::Models::BrandAIQueryParams::SpecificPages, nil]
+      optional :specific_pages, -> { BrandDev::BrandAIQueryParams::SpecificPages }
+
+      # @!method initialize(data_to_extract:, domain:, specific_pages: nil, request_options: {})
+      #   @param data_to_extract [Array<BrandDev::Models::BrandAIQueryParams::DataToExtract>] Array of data points to extract from the website
+      #
+      #   @param domain [String] The domain name to analyze
+      #
+      #   @param specific_pages [BrandDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+
+      class DataToExtract < BrandDev::Internal::Type::BaseModel
+        # @!attribute datapoint_description
+        #   Description of what to extract
+        #
+        #   @return [String]
+        required :datapoint_description, String
+
+        # @!attribute datapoint_example
+        #   Example of the expected value
+        #
+        #   @return [String]
+        required :datapoint_example, String
+
+        # @!attribute datapoint_name
+        #   Name of the data point to extract
+        #
+        #   @return [String]
+        required :datapoint_name, String
+
+        # @!attribute datapoint_type
+        #   Type of the data point
+        #
+        #   @return [Symbol, BrandDev::Models::BrandAIQueryParams::DataToExtract::DatapointType]
+        required :datapoint_type, enum: -> { BrandDev::BrandAIQueryParams::DataToExtract::DatapointType }
+
+        # @!method initialize(datapoint_description:, datapoint_example:, datapoint_name:, datapoint_type:)
+        #   @param datapoint_description [String] Description of what to extract
+        #
+        #   @param datapoint_example [String] Example of the expected value
+        #
+        #   @param datapoint_name [String] Name of the data point to extract
+        #
+        #   @param datapoint_type [Symbol, BrandDev::Models::BrandAIQueryParams::DataToExtract::DatapointType] Type of the data point
+
+        # Type of the data point
+        #
+        # @see BrandDev::Models::BrandAIQueryParams::DataToExtract#datapoint_type
+        module DatapointType
+          extend BrandDev::Internal::Type::Enum
+
+          TEXT = :text
+          NUMBER = :number
+          DATE = :date
+          BOOLEAN = :boolean
+          LIST = :list
+          URL = :url
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        # @!attribute about_us
+        #   Whether to analyze the about us page
+        #
+        #   @return [Boolean, nil]
+        optional :about_us, BrandDev::Internal::Type::Boolean
+
+        # @!attribute blog
+        #   Whether to analyze the blog
+        #
+        #   @return [Boolean, nil]
+        optional :blog, BrandDev::Internal::Type::Boolean
+
+        # @!attribute careers
+        #   Whether to analyze the careers page
+        #
+        #   @return [Boolean, nil]
+        optional :careers, BrandDev::Internal::Type::Boolean
+
+        # @!attribute contact_us
+        #   Whether to analyze the contact us page
+        #
+        #   @return [Boolean, nil]
+        optional :contact_us, BrandDev::Internal::Type::Boolean
+
+        # @!attribute faq
+        #   Whether to analyze the FAQ page
+        #
+        #   @return [Boolean, nil]
+        optional :faq, BrandDev::Internal::Type::Boolean
+
+        # @!attribute home_page
+        #   Whether to analyze the home page
+        #
+        #   @return [Boolean, nil]
+        optional :home_page, BrandDev::Internal::Type::Boolean
+
+        # @!attribute privacy_policy
+        #   Whether to analyze the privacy policy page
+        #
+        #   @return [Boolean, nil]
+        optional :privacy_policy, BrandDev::Internal::Type::Boolean
+
+        # @!attribute terms_and_conditions
+        #   Whether to analyze the terms and conditions page
+        #
+        #   @return [Boolean, nil]
+        optional :terms_and_conditions, BrandDev::Internal::Type::Boolean
+
+        # @!method initialize(about_us: nil, blog: nil, careers: nil, contact_us: nil, faq: nil, home_page: nil, privacy_policy: nil, terms_and_conditions: nil)
+        #   Optional object specifying which pages to analyze
+        #
+        #   @param about_us [Boolean] Whether to analyze the about us page
+        #
+        #   @param blog [Boolean] Whether to analyze the blog
+        #
+        #   @param careers [Boolean] Whether to analyze the careers page
+        #
+        #   @param contact_us [Boolean] Whether to analyze the contact us page
+        #
+        #   @param faq [Boolean] Whether to analyze the FAQ page
+        #
+        #   @param home_page [Boolean] Whether to analyze the home page
+        #
+        #   @param privacy_policy [Boolean] Whether to analyze the privacy policy page
+        #
+        #   @param terms_and_conditions [Boolean] Whether to analyze the terms and conditions page
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_ai_query_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_query
+    class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute data_extracted
+      #   Array of extracted data points
+      #
+      #   @return [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>, nil]
+      optional :data_extracted,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIQueryResponse::DataExtracted] }
+
+      # @!attribute domain
+      #   The domain that was analyzed
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute urls_analyzed
+      #   List of URLs that were analyzed
+      #
+      #   @return [Array<String>, nil]
+      optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(data_extracted: nil, domain: nil, urls_analyzed: nil)
+      #   @param data_extracted [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>] Array of extracted data points
+      #
+      #   @param domain [String] The domain that was analyzed
+      #
+      #   @param urls_analyzed [Array<String>] List of URLs that were analyzed
+
+      class DataExtracted < BrandDev::Internal::Type::BaseModel
+        # @!attribute datapoint_name
+        #   Name of the extracted data point
+        #
+        #   @return [String, nil]
+        optional :datapoint_name, String
+
+        # @!attribute datapoint_value
+        #   Value of the extracted data point
+        #
+        #   @return [String, Float, Boolean, Array<String>, Array<Float>, nil]
+        optional :datapoint_value,
+                 union: -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue }
+
+        # @!method initialize(datapoint_name: nil, datapoint_value: nil)
+        #   @param datapoint_name [String] Name of the extracted data point
+        #
+        #   @param datapoint_value [String, Float, Boolean, Array<String>, Array<Float>] Value of the extracted data point
+
+        # Value of the extracted data point
+        #
+        # @see BrandDev::Models::BrandAIQueryResponse::DataExtracted#datapoint_value
+        module DatapointValue
+          extend BrandDev::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant BrandDev::Internal::Type::Boolean
+
+          variant -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::StringArray }
+
+          variant -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::FloatArray }
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean, Array<String>, Array<Float>)]
+
+          # @type [BrandDev::Internal::Type::Converter]
+          StringArray = BrandDev::Internal::Type::ArrayOf[String]
+
+          # @type [BrandDev::Internal::Type::Converter]
+          FloatArray = BrandDev::Internal::Type::ArrayOf[Float]
+        end
+      end
+    end
+  end
+end

data/lib/brand_dev/models.rb

@@ -11,16 +11,16 @@ module BrandDev
       mod.constants.each do |name|
         case mod.const_get(name)
         in true | false
-          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
           mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
         in Integer
-          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
           mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
         in Float
-          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
           mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
         in Symbol
-          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
           mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
         else
         end
@@ -39,6 +39,8 @@ module BrandDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams
+
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams

data/lib/brand_dev/resources/brand.rb

@@ -27,6 +27,34 @@ 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.
+      #
+      # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, request_options: {})
+      #
+      # @param data_to_extract [Array<BrandDev::Models::BrandAIQueryParams::DataToExtract>] Array of data points to extract from the website
+      #
+      # @param domain [String] The domain name to analyze
+      #
+      # @param specific_pages [BrandDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandAIQueryResponse]
+      #
+      # @see BrandDev::Models::BrandAIQueryParams
+      def ai_query(params)
+        parsed, options = BrandDev::BrandAIQueryParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/ai/query",
+          body: parsed,
+          model: BrandDev::Models::BrandAIQueryResponse,
+          options: options
+        )
+      end
+
       # Endpoint specially designed for platforms that want to identify transaction data
       # by the transaction title.
       #

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.0.1.pre.alpha.0"
+  VERSION = "0.1.0.pre.alpha.2"
 end

data/lib/brand_dev.rb

@@ -50,6 +50,8 @@ require_relative "brand_dev/errors"
 require_relative "brand_dev/internal/transport/base_client"
 require_relative "brand_dev/internal/transport/pooled_net_requester"
 require_relative "brand_dev/client"
+require_relative "brand_dev/models/brand_ai_query_params"
+require_relative "brand_dev/models/brand_ai_query_response"
 require_relative "brand_dev/models/brand_identify_from_transaction_params"
 require_relative "brand_dev/models/brand_identify_from_transaction_response"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_params"

data/rbi/brand_dev/internal/util.rbi

@@ -332,6 +332,8 @@ module BrandDev
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end