brand.dev 0.0.1.pre.alpha.0 → 0.0.2

data/lib/brand_dev/models/brand_screenshot_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#screenshot
+    class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!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
+
+      # @!attribute full_screenshot
+      #   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).
+      #
+      #   @return [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot, nil]
+      optional :full_screenshot, enum: -> { BrandDev::BrandScreenshotParams::FullScreenshot }
+
+      # @!method initialize(domain:, full_screenshot: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandScreenshotParams} for more details.
+      #
+      #   @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
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_screenshot_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#screenshot
+    class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute domain
+      #   The normalized domain that was processed
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute screenshot
+      #   Public URL of the uploaded screenshot image
+      #
+      #   @return [String, nil]
+      optional :screenshot, String
+
+      # @!attribute screenshot_type
+      #   Type of screenshot that was captured
+      #
+      #   @return [Symbol, BrandDev::Models::BrandScreenshotResponse::ScreenshotType, nil]
+      optional :screenshot_type,
+               enum: -> { BrandDev::Models::BrandScreenshotResponse::ScreenshotType },
+               api_name: :screenshotType
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(code: nil, domain: nil, screenshot: nil, screenshot_type: nil, status: nil)
+      #   @param code [Integer] HTTP status code
+      #
+      #   @param domain [String] The normalized domain that was processed
+      #
+      #   @param screenshot [String] Public URL of the uploaded screenshot image
+      #
+      #   @param screenshot_type [Symbol, BrandDev::Models::BrandScreenshotResponse::ScreenshotType] Type of screenshot that was captured
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+
+      # Type of screenshot that was captured
+      #
+      # @see BrandDev::Models::BrandScreenshotResponse#screenshot_type
+      module ScreenshotType
+        extend BrandDev::Internal::Type::Enum
+
+        VIEWPORT = :viewport
+        FULL_PAGE = :fullPage
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_styleguide_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#styleguide
+    class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #   domain will be automatically normalized and validated.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(domain:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandStyleguideParams} for more details.
+      #
+      #   @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end