Class: ContextDev::Models::WebExtractStyleguideResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebExtractStyleguideResponse

Defined in:

lib/context_dev/models/web_extract_styleguide_response.rb

Overview

See Also:

• Resources::Web#extract_styleguide

Defined Under Namespace

Classes: KeyMetadata, Styleguide

Instance Attribute Summary

• #code ⇒ Integer^?

  HTTP status code.

• #domain ⇒ String^?

  The normalized domain that was processed.

• #key_metadata ⇒ ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata^?

  Metadata about the API key used for the request.

• #status ⇒ String^?

  Status of the response, e.g., ‘ok’.

• #styleguide ⇒ ContextDev::Models::WebExtractStyleguideResponse::Styleguide^?

  Comprehensive styleguide data extracted from the website.

Instance Method Summary

• #initialize(credits_consumed:, credits_remaining:) ⇒ Object constructor

  Metadata about the API key used for the request.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(credits_consumed:, credits_remaining:) ⇒ Object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Parameters:

• credits_consumed (Integer) —

  The number of credits consumed by this request.

• credits_remaining (Integer) —

  The number of credits remaining for your organization after this request.

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 38

Instance Attribute Details

#code ⇒ Integer^?

HTTP status code

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 11

optional :code, Integer

#domain ⇒ String^?

The normalized domain that was processed

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 17

optional :domain, String

#key_metadata ⇒ ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata^?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:

• (ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, nil)

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 24

optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata }

#status ⇒ String^?

Status of the response, e.g., ‘ok’

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 30

optional :status, String

#styleguide ⇒ ContextDev::Models::WebExtractStyleguideResponse::Styleguide^?

Comprehensive styleguide data extracted from the website

Returns:

• (ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil)

# File 'lib/context_dev/models/web_extract_styleguide_response.rb', line 36

optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }