Class: ContextDev::Resources::Utility

Inherits:

Object

• Object
• ContextDev::Resources::Utility

Defined in:

lib/context_dev/resources/utility.rb,
sig/context_dev/resources/utility.rbs

Instance Method Summary

• #initialize(client:) ⇒ Utility constructor private

  A new instance of Utility.

• #prefetch(identifier:, type:, tags: nil, timeout_ms: nil, request_options: {}) ⇒ ContextDev::Models::UtilityPrefetchResponse

  Some parameter documentations has been truncated, see Models::UtilityPrefetchParams for more details.

Constructor Details

#initialize(client:) ⇒ Utility

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Utility.

Parameters:

• client (ContextDev::Client)
• client: (ContextDev::Client)

# File 'lib/context_dev/resources/utility.rb', line 44

def initialize(client:)
  @client = client
end

Instance Method Details

#prefetch(identifier:, type:, tags: nil, timeout_ms: nil, request_options: {}) ⇒ ContextDev::Models::UtilityPrefetchResponse

Some parameter documentations has been truncated, see Models::UtilityPrefetchParams for more details.

Signal that you may fetch data soon to improve latency. The type field selects what to prefetch ('brand' queues a brand data fetch, 'styleguide' queues a styleguide extraction) and identifier carries exactly one lookup key: a domain, or an email whose domain is extracted and validated (free email providers and disposable email addresses are not allowed).

Parameters:

• identifier (ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier) —

  Identifier of the target to prefetch. Provide exactly one of domain or email.

• type (Symbol, ContextDev::Models::UtilityPrefetchParams::Type) —

  What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the sty

• tags (Array<String>) —

  Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

• timeout_ms (Integer) —

  Optional timeout in milliseconds for the request. If the request takes longer th

• request_options (ContextDev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (ContextDev::Models::UtilityPrefetchResponse)

See Also:

• Models::UtilityPrefetchParams

# File 'lib/context_dev/resources/utility.rb', line 30

def prefetch(params)
  parsed, options = ContextDev::UtilityPrefetchParams.dump_request(params)
  @client.request(
    method: :post,
    path: "utility/prefetch",
    body: parsed,
    model: ContextDev::Models::UtilityPrefetchResponse,
    options: options
  )
end