brand.dev 0.1.0.pre.alpha.8 → 0.1.0.pre.alpha.9

data/rbi/brand_dev/models/brand_screenshot_params.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandScreenshotParams, BrandDev::Internal::AnyHash)
+        end
+
+      # 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
+
+      # 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).
+      sig do
+        returns(
+          T.nilable(BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol)
+        )
+      end
+      attr_reader :full_screenshot
+
+      sig do
+        params(
+          full_screenshot:
+            BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol
+        ).void
+      end
+      attr_writer :full_screenshot
+
+      sig do
+        params(
+          domain: String,
+          full_screenshot:
+            BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
+        # domain will be automatically normalized and validated.
+        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
+        # screenshot (standard browser view).
+        full_screenshot: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            domain: String,
+            full_screenshot:
+              BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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).
+      module FullScreenshot
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, BrandDev::BrandScreenshotParams::FullScreenshot)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_screenshot_response.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandScreenshotResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # HTTP status code
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :code
+
+      sig { params(code: Integer).void }
+      attr_writer :code
+
+      # The normalized domain that was processed
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # Public URL of the uploaded screenshot image
+      sig { returns(T.nilable(String)) }
+      attr_reader :screenshot
+
+      sig { params(screenshot: String).void }
+      attr_writer :screenshot
+
+      # Type of screenshot that was captured
+      sig do
+        returns(
+          T.nilable(
+            BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :screenshot_type
+
+      sig do
+        params(
+          screenshot_type:
+            BrandDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol
+        ).void
+      end
+      attr_writer :screenshot_type
+
+      # 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(
+          code: Integer,
+          domain: String,
+          screenshot: String,
+          screenshot_type:
+            BrandDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol,
+          status: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # HTTP status code
+        code: nil,
+        # The normalized domain that was processed
+        domain: nil,
+        # Public URL of the uploaded screenshot image
+        screenshot: nil,
+        # Type of screenshot that was captured
+        screenshot_type: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: Integer,
+            domain: String,
+            screenshot: String,
+            screenshot_type:
+              BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol,
+            status: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Type of screenshot that was captured
+      module ScreenshotType
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              BrandDev::Models::BrandScreenshotResponse::ScreenshotType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        VIEWPORT =
+          T.let(
+            :viewport,
+            BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol
+          )
+        FULL_PAGE =
+          T.let(
+            :fullPage,
+            BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_styleguide_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandStyleguideParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      # domain will be automatically normalized and validated.
+      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 extract styleguide from (e.g., 'example.com', 'google.com'). The
+        # domain will be automatically normalized and validated.
+        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