|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module ContextDev |
| 4 | + module Models |
| 5 | + # @see ContextDev::Resources::Web#extract_styleguide |
| 6 | + class WebExtractStyleguideParams < ContextDev::Internal::Type::BaseModel |
| 7 | + extend ContextDev::Internal::Type::RequestParameters::Converter |
| 8 | + include ContextDev::Internal::Type::RequestParameters |
| 9 | + |
| 10 | + # @!attribute direct_url |
| 11 | + # A specific URL to fetch the styleguide from directly, bypassing domain |
| 12 | + # resolution (e.g., 'https://example.com/design-system'). When provided, the |
| 13 | + # styleguide is extracted from this exact URL. You must provide either 'domain' or |
| 14 | + # 'directUrl', but not both. |
| 15 | + # |
| 16 | + # @return [String, nil] |
| 17 | + optional :direct_url, String |
| 18 | + |
| 19 | + # @!attribute domain |
| 20 | + # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The |
| 21 | + # domain will be automatically normalized and validated. You must provide either |
| 22 | + # 'domain' or 'directUrl', but not both. |
| 23 | + # |
| 24 | + # @return [String, nil] |
| 25 | + optional :domain, String |
| 26 | + |
| 27 | + # @!attribute timeout_ms |
| 28 | + # Optional timeout in milliseconds for the request. If the request takes longer |
| 29 | + # than this value, it will be aborted with a 408 status code. Maximum allowed |
| 30 | + # value is 300000ms (5 minutes). |
| 31 | + # |
| 32 | + # @return [Integer, nil] |
| 33 | + optional :timeout_ms, Integer |
| 34 | + |
| 35 | + # @!method initialize(direct_url: nil, domain: nil, timeout_ms: nil, request_options: {}) |
| 36 | + # Some parameter documentations has been truncated, see |
| 37 | + # {ContextDev::Models::WebExtractStyleguideParams} for more details. |
| 38 | + # |
| 39 | + # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio |
| 40 | + # |
| 41 | + # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The |
| 42 | + # |
| 43 | + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th |
| 44 | + # |
| 45 | + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] |
| 46 | + end |
| 47 | + end |
| 48 | +end |
0 commit comments