feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 20
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f2509d0b758e88572e5a8145b8296cb330154727d9797e615ad19e44e050af26.yml
-openapi_spec_hash: 40640a033ee09bda79ec066ba3744206
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-905e35387d755a84a2e7cd711f31eeea130e08a83bb7b39d3fa5445a187ef62f.yml
+openapi_spec_hash: 205b2c17cb40ad54d76c2c06c9e5dda4
 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011

lib/brand_dev/models/brand_screenshot_params.rb

@@ -7,12 +7,20 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
+      # @!attribute direct_url
+      #   A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+      #   'https://example.com/pricing'). When provided, the screenshot is taken of this
+      #   exact URL.
+      #
+      #   @return [String, nil]
+      optional :direct_url, String
+
       # @!attribute domain
       #   Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
       #   domain will be automatically normalized and validated.
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [String, nil]
+      optional :domain, String
 
       # @!attribute full_screenshot
       #   Optional parameter to determine screenshot type. If 'true', takes a full page
@@ -26,7 +34,8 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
       #   Optional parameter to specify which page type to screenshot. If provided, the
       #   system will scrape the domain's links and use heuristics to find the most
       #   appropriate URL for the specified page type (30 supported languages). If not
-      #   provided, screenshots the main domain landing page.
+      #   provided, screenshots the main domain landing page. Only applicable when using
+      #   'domain', not 'directUrl'.
       #
       #   @return [Symbol, BrandDev::Models::BrandScreenshotParams::Page, nil]
       optional :page, enum: -> { BrandDev::BrandScreenshotParams::Page }
@@ -39,10 +48,12 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
       #   @return [Symbol, BrandDev::Models::BrandScreenshotParams::Prioritize, nil]
       optional :prioritize, enum: -> { BrandDev::BrandScreenshotParams::Prioritize }
 
-      # @!method initialize(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
+      # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandScreenshotParams} for more details.
       #
+      #   @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
+      #
       #   @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
       #
       #   @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
@@ -69,7 +80,8 @@ module FullScreenshot
       # Optional parameter to specify which page type to screenshot. If provided, the
       # system will scrape the domain's links and use heuristics to find the most
       # appropriate URL for the specified page type (30 supported languages). If not
-      # provided, screenshots the main domain landing page.
+      # provided, screenshots the main domain landing page. Only applicable when using
+      # 'domain', not 'directUrl'.
       module Page
         extend BrandDev::Internal::Type::Enum
 

lib/brand_dev/resources/brand.rb

@@ -465,10 +465,13 @@ def retrieve_simplified(params)
       #
       # Capture a screenshot of a website. Supports both viewport (standard browser
       # view) and full-page screenshots. Can also screenshot specific page types (login,
-      # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
-      # the uploaded screenshot image hosted on our CDN.
+      # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain'
+      # or 'directUrl' must be provided as a query parameter, but not both. Returns a
+      # URL to the uploaded screenshot image hosted on our CDN.
       #
-      # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
+      # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
+      #
+      # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
       #
       # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
       #
@@ -483,13 +486,13 @@ def retrieve_simplified(params)
       # @return [BrandDev::Models::BrandScreenshotResponse]
       #
       # @see BrandDev::Models::BrandScreenshotParams
-      def screenshot(params)
+      def screenshot(params = {})
         parsed, options = BrandDev::BrandScreenshotParams.dump_request(params)
         query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/screenshot",
-          query: query.transform_keys(full_screenshot: "fullScreenshot"),
+          query: query.transform_keys(direct_url: "directUrl", full_screenshot: "fullScreenshot"),
           model: BrandDev::Models::BrandScreenshotResponse,
           options: options
         )

rbi/brand_dev/models/brand_screenshot_params.rbi

@@ -11,10 +11,22 @@ module BrandDev
           T.any(BrandDev::BrandScreenshotParams, BrandDev::Internal::AnyHash)
         end
 
+      # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+      # 'https://example.com/pricing'). When provided, the screenshot is taken of this
+      # exact URL.
+      sig { returns(T.nilable(String)) }
+      attr_reader :direct_url
+
+      sig { params(direct_url: String).void }
+      attr_writer :direct_url
+
       # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
       # domain will be automatically normalized and validated.
-      sig { returns(String) }
-      attr_accessor :domain
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
 
       # Optional parameter to determine screenshot type. If 'true', takes a full page
       # screenshot capturing all content. If 'false' or not provided, takes a viewport
@@ -37,7 +49,8 @@ module BrandDev
       # Optional parameter to specify which page type to screenshot. If provided, the
       # system will scrape the domain's links and use heuristics to find the most
       # appropriate URL for the specified page type (30 supported languages). If not
-      # provided, screenshots the main domain landing page.
+      # provided, screenshots the main domain landing page. Only applicable when using
+      # 'domain', not 'directUrl'.
       sig do
         returns(T.nilable(BrandDev::BrandScreenshotParams::Page::OrSymbol))
       end
@@ -65,6 +78,7 @@ module BrandDev
 
       sig do
         params(
+          direct_url: String,
           domain: String,
           full_screenshot:
             BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
@@ -74,17 +88,22 @@ module BrandDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+        # 'https://example.com/pricing'). When provided, the screenshot is taken of this
+        # exact URL.
+        direct_url: nil,
         # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to determine screenshot type. If 'true', takes a full page
         # screenshot capturing all content. If 'false' or not provided, takes a viewport
         # screenshot (standard browser view).
         full_screenshot: nil,
         # Optional parameter to specify which page type to screenshot. If provided, the
         # system will scrape the domain's links and use heuristics to find the most
         # appropriate URL for the specified page type (30 supported languages). If not
-        # provided, screenshots the main domain landing page.
+        # provided, screenshots the main domain landing page. Only applicable when using
+        # 'domain', not 'directUrl'.
         page: nil,
         # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
         # faster capture with basic quality. If 'quality', optimizes for higher quality
@@ -97,6 +116,7 @@ module BrandDev
       sig do
         override.returns(
           {
+            direct_url: String,
             domain: String,
             full_screenshot:
               BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
@@ -146,7 +166,8 @@ module BrandDev
       # Optional parameter to specify which page type to screenshot. If provided, the
       # system will scrape the domain's links and use heuristics to find the most
       # appropriate URL for the specified page type (30 supported languages). If not
-      # provided, screenshots the main domain landing page.
+      # provided, screenshots the main domain landing page. Only applicable when using
+      # 'domain', not 'directUrl'.
       module Page
         extend BrandDev::Internal::Type::Enum
 

rbi/brand_dev/resources/brand.rbi

@@ -399,10 +399,12 @@ module BrandDev
 
       # Capture a screenshot of a website. Supports both viewport (standard browser
       # view) and full-page screenshots. Can also screenshot specific page types (login,
-      # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
-      # the uploaded screenshot image hosted on our CDN.
+      # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain'
+      # or 'directUrl' must be provided as a query parameter, but not both. Returns a
+      # URL to the uploaded screenshot image hosted on our CDN.
       sig do
         params(
+          direct_url: String,
           domain: String,
           full_screenshot:
             BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
@@ -412,17 +414,22 @@ module BrandDev
         ).returns(BrandDev::Models::BrandScreenshotResponse)
       end
       def screenshot(
+        # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+        # 'https://example.com/pricing'). When provided, the screenshot is taken of this
+        # exact URL.
+        direct_url: nil,
         # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to determine screenshot type. If 'true', takes a full page
         # screenshot capturing all content. If 'false' or not provided, takes a viewport
         # screenshot (standard browser view).
         full_screenshot: nil,
         # Optional parameter to specify which page type to screenshot. If provided, the
         # system will scrape the domain's links and use heuristics to find the most
         # appropriate URL for the specified page type (30 supported languages). If not
-        # provided, screenshots the main domain landing page.
+        # provided, screenshots the main domain landing page. Only applicable when using
+        # 'domain', not 'directUrl'.
         page: nil,
         # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
         # faster capture with basic quality. If 'quality', optimizes for higher quality

sig/brand_dev/models/brand_screenshot_params.rbs

@@ -2,6 +2,7 @@ module BrandDev
   module Models
     type brand_screenshot_params =
       {
+        direct_url: String,
         domain: String,
         full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
         page: BrandDev::Models::BrandScreenshotParams::page,
@@ -13,7 +14,13 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
-      attr_accessor domain: String
+      attr_reader direct_url: String?
+
+      def direct_url=: (String) -> String
+
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
 
       attr_reader full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot?
 
@@ -34,14 +41,16 @@ module BrandDev
       ) -> BrandDev::Models::BrandScreenshotParams::prioritize
 
       def initialize: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
         ?page: BrandDev::Models::BrandScreenshotParams::page,
         ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
+        direct_url: String,
         domain: String,
         full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
         page: BrandDev::Models::BrandScreenshotParams::page,

sig/brand_dev/resources/brand.rbs

@@ -108,7 +108,8 @@ module BrandDev
       ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse
 
       def screenshot: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
         ?page: BrandDev::Models::BrandScreenshotParams::page,
         ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize,

test/brand_dev/resources/brand_test.rb

@@ -267,10 +267,10 @@ def test_retrieve_simplified_required_params
     end
   end
 
-  def test_screenshot_required_params
+  def test_screenshot
     skip("Mock server tests are disabled")
 
-    response = @brand_dev.brand.screenshot(domain: "domain")
+    response = @brand_dev.brand.screenshot
 
     assert_pattern do
       response => BrandDev::Models::BrandScreenshotResponse