Class: Yext::Api::KnowledgeApi::KnowledgeManager::Location

Inherits:
Utils::ApiBase
  • Object
show all
Includes:
Concerns::AccountChild
Defined in:
lib/yext/api/knowledge_api/knowledge_manager/location.rb

Overview

:knowledge_api:

:knowledge_manager:
  :Location:
    - :action: :index
      :method: :get
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations
      :path_regex: v2/accounts/[^/]+?/locations
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocations
      :comment: Get multiple Locations (primary profiles only).
      :sandbox_only: false
    - :action: :create
      :method: :post
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations
      :path_regex: v2/accounts/[^/]+?/locations
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/createLocation
      :comment: Create a new Location.
      :sandbox_only: false
    - :action: :search
      :method: :get
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/locationsearch
      :path_regex: v2/accounts/[^/]+?/locationsearch
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/searchLocations
      :comment: Get multiple Locations (primary profiles only) that match provided filters.
      :sandbox_only: false
    - :action: :show
      :method: :get
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
      :path_regex: v2/accounts/[^/]+?/locations/[^/]+??
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation
      :comment: Gets the primary profile for a single Location.
      :sandbox_only: false
    - :action: :update
      :method: :put
      :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
      :path_regex: v2/accounts/[^/]+?/locations/[^/]+??
      :default_version: 20161012
      :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation
      :comment: Updates the primary profile for a Location.
      :sandbox_only: false

Method Summary

Methods included from Concerns::AccountChild

ensure_relation, with_account_path

Methods included from Concerns::FaradayConnection

faraday_connection