feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 6
+configured_endpoints: 7
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-1f1bc5d70a89b56425a3bafbc06a80c233300b5d5d64438aa633597085a45974.yml
 openapi_spec_hash: e87e758c5f59476e0ec486fa59455d60
-config_hash: 372b187172495fc2f76f05ba016b4a45
+config_hash: bb3f3ba0dca413263e40968648f9a1a6

lib/brand_dev.rb

@@ -54,6 +54,8 @@
 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_prefetch_params"
+require_relative "brand_dev/models/brand_prefetch_response"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_params"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_response"
 require_relative "brand_dev/models/brand_retrieve_naics_params"

lib/brand_dev/models.rb

@@ -43,6 +43,8 @@ module BrandDev
 
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

lib/brand_dev/models/brand_prefetch_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to prefetch brand data for
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!method initialize(domain:, request_options: {})
+      #   @param domain [String] Domain name to prefetch brand data for
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

lib/brand_dev/models/brand_prefetch_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute domain
+      #   The domain that was queued for prefetching
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute message
+      #   Success message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(domain: nil, message: nil, status: nil)
+      #   @param domain [String] The domain that was queued for prefetching
+      #
+      #   @param message [String] Success message
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+    end
+  end
+end

lib/brand_dev/resources/brand.rb

@@ -78,6 +78,31 @@ def identify_from_transaction(params)
         )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. This endpoint does not charge credits and is available for paid
+      # customers to optimize future requests. [You must be on a paid plan to use this
+      # endpoint]
+      #
+      # @overload prefetch(domain:, request_options: {})
+      #
+      # @param domain [String] Domain name to prefetch brand data for
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandPrefetchResponse]
+      #
+      # @see BrandDev::Models::BrandPrefetchParams
+      def prefetch(params)
+        parsed, options = BrandDev::BrandPrefetchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch",
+          body: parsed,
+          model: BrandDev::Models::BrandPrefetchResponse,
+          options: options
+        )
+      end
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       #
       # @overload retrieve_by_ticker(ticker:, request_options: {})

rbi/brand_dev/models.rbi

@@ -6,6 +6,8 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

rbi/brand_dev/models/brand_prefetch_params.rbi

@@ -0,0 +1,40 @@
+# 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
+
+      sig do
+        params(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { domain: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

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

rbi/brand_dev/resources/brand.rbi

@@ -59,6 +59,23 @@ module BrandDev
       )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. This endpoint does not charge credits and is available for paid
+      # customers to optimize future requests. [You must be on a paid plan to use this
+      # endpoint]
+      sig do
+        params(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchResponse)
+      end
+      def prefetch(
+        # Domain name to prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       sig do
         params(