Module: Yext::Api

Defined in:
lib/yext/api.rb,
lib/yext/api/engine.rb,
lib/yext/api/version.rb,
lib/yext/api/live_api.rb,
lib/yext/api/knowledge_api.rb,
lib/yext/api/utils/api_base.rb,
lib/yext/api/utils/api_finder.rb,
lib/yext/api/concerns/enum_all.rb,
lib/yext/api/live_api/location.rb,
lib/yext/api/administrative_api.rb,
lib/yext/api/utils/configuration.rb,
lib/yext/api/concerns/rate_limits.rb,
lib/yext/api/concerns/account_child.rb,
lib/yext/api/concerns/default_scopes.rb,
lib/yext/api/enumerations/validation.rb,
lib/yext/api/enumerations/error_codes.rb,
lib/yext/api/administrative_api/account.rb,
lib/yext/api/administrative_api/service.rb,
lib/yext/api/concerns/account_relations.rb,
lib/yext/api/enumerations/location_type.rb,
lib/yext/api/concerns/faraday_connection.rb,
lib/yext/api/enumerations/listing_status.rb,
lib/yext/api/utils/middleware/uri_cleanup.rb,
lib/yext/api/validators/account_validator.rb,
lib/yext/api/administrative_api/add_request.rb,
lib/yext/api/enumerations/add_request_status.rb,
lib/yext/api/utils/middleware/api_rate_limits.rb,
lib/yext/api/utils/middleware/response_parser.rb,
lib/yext/api/knowledge_api/health_check/health.rb,
app/controllers/yext/api/application_controller.rb,
lib/yext/api/enumerations/error_codes/ecl_errors.rb,
lib/yext/api/enumerations/optimization_link_mode.rb,
lib/yext/api/knowledge_api/account_settings/role.rb,
lib/yext/api/knowledge_api/account_settings/user.rb,
lib/yext/api/knowledge_api/powerlistings/listing.rb,
lib/yext/api/utils/middleware/default_parameters.rb,
lib/yext/api/enumerations/error_codes/users_errors.rb,
lib/yext/api/knowledge_api/powerlistings/publisher.rb,
lib/yext/api/enumerations/add_request_location_mode.rb,
lib/yext/api/enumerations/error_codes/social_errors.rb,
lib/yext/api/knowledge_api/account_settings/account.rb,
lib/yext/api/enumerations/error_codes/general_errors.rb,
lib/yext/api/enumerations/error_codes/reviews_errors.rb,
lib/yext/api/enumerations/error_codes/feedback_errors.rb,
lib/yext/api/enumerations/error_codes/live_api_errors.rb,
lib/yext/api/knowledge_api/knowledge_manager/category.rb,
lib/yext/api/knowledge_api/knowledge_manager/location.rb,
lib/yext/api/enumerations/error_codes/analytics_errors.rb,
lib/yext/api/enumerations/error_codes/customers_errros.rb,
lib/yext/api/enumerations/error_codes/locations_errors.rb,
lib/yext/api/enumerations/error_codes/agreements_errors.rb,
lib/yext/api/enumerations/error_codes/suppression_errors.rb,
app/controllers/yext/api/powerlistings/listing_controller.rb,
app/controllers/yext/api/agreements/add_request_controller.rb,
lib/yext/api/enumerations/error_codes/optimizations_errors.rb,
lib/yext/api/enumerations/error_codes/subscriptions_errors.rb,
lib/yext/api/knowledge_api/optimization_tasks/optimization_link.rb,
lib/yext/api/knowledge_api/optimization_tasks/optimization_task.rb,
lib/yext/api/enumerations/error_codes/publisher_suggestions_errors.rb

Overview

API interface for Yext

Defined Under Namespace

Modules: AdministrativeApi, Agreements, Concerns, Enumerations, KnowledgeApi, LiveApi, Powerlistings, Utils, Validators Classes: ApplicationController, Engine

Constant Summary collapse

VERSION = 
"0.1.11"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

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”



29
30
31
 
# File 'lib/yext/api.rb', line 29

def self.configuration
  Yext::Api::Utils::Configuration.instance
end

.configure {|configuration| ... } ⇒ Object

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. = "my account_id"
config.api_key    = "my api key"

end

Yields:



18
19
20
 
# File 'lib/yext/api.rb', line 18

def self.configure
  yield configuration if block_given?
end