module Yext::Api

API interface for Yext

Constants

VERSION

Public Class Methods

configuration() click to toggle source

Gets the configuration object for configuring a single item.

See Yext::Api::Utils::Configuration for details on the configuration options.

Usage:

Yext::Api.configuration.api_key = “my api key”

# File lib/yext/api.rb, line 29
def self.configuration
  Yext::Api::Utils::Configuration.instance
end
configure() { |configuration| ... } click to toggle source

Allows you to configure global settings for the Yext::Api.

See Yext::Api::Utils::Configuration for details on the configuration options.

Usage:

Yext::Api.configure do |config|

config.account_id = "my account_id"
config.api_key    = "my api key"

end

# File lib/yext/api.rb, line 18
def self.configure
  yield configuration if block_given?
end