yext-api 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +25 -0
- data/.rspec +3 -0
- data/.rubocop.yml +100 -0
- data/.ruby-version +1 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +187 -0
- data/LICENSE.txt +21 -0
- data/README.md +206 -0
- data/Rakefile +30 -0
- data/app/assets/config/yext_api_manifest.js +2 -0
- data/app/assets/images/yext/api/.keep +0 -0
- data/app/assets/javascripts/yext/api/application.js +13 -0
- data/app/assets/stylesheets/yext/api/application.css +15 -0
- data/app/controllers/yext/api/application_controller.rb +12 -0
- data/app/docs/notes.txt +45 -0
- data/app/helpers/yext/api/application_helper.rb +11 -0
- data/app/jobs/yext/api/application_job.rb +8 -0
- data/app/mailers/yext/api/application_mailer.rb +11 -0
- data/app/models/yext/api/application_record.rb +10 -0
- data/app/views/layouts/yext/api/application.html.erb +14 -0
- data/bin/console +16 -0
- data/bin/rails +16 -0
- data/bin/setup +8 -0
- data/config/initializers/spyke.rb +3 -0
- data/config/routes.rb +4 -0
- data/lib/config/api.yml +1100 -0
- data/lib/tasks/yext/api_tasks.rake +6 -0
- data/lib/yext/api.rb +33 -0
- data/lib/yext/api/administrative_api.rb +12 -0
- data/lib/yext/api/administrative_api/account.rb +62 -0
- data/lib/yext/api/administrative_api/add_request.rb +34 -0
- data/lib/yext/api/administrative_api/service.rb +38 -0
- data/lib/yext/api/concerns/account_child.rb +92 -0
- data/lib/yext/api/concerns/account_relations.rb +25 -0
- data/lib/yext/api/concerns/api_finder.rb +61 -0
- data/lib/yext/api/concerns/default_scopes.rb +37 -0
- data/lib/yext/api/concerns/enum_all.rb +18 -0
- data/lib/yext/api/concerns/faraday_connection.rb +45 -0
- data/lib/yext/api/concerns/rate_limits.rb +31 -0
- data/lib/yext/api/engine.rb +13 -0
- data/lib/yext/api/enumerations/validation.rb +16 -0
- data/lib/yext/api/knowledge_api.rb +12 -0
- data/lib/yext/api/knowledge_api/account_settings/account.rb +33 -0
- data/lib/yext/api/knowledge_api/health_check/health.rb +25 -0
- data/lib/yext/api/knowledge_api/knowledge_manager/category.rb +25 -0
- data/lib/yext/api/knowledge_api/knowledge_manager/location.rb +59 -0
- data/lib/yext/api/live_api.rb +12 -0
- data/lib/yext/api/live_api/location.rb +37 -0
- data/lib/yext/api/utils/api_base.rb +13 -0
- data/lib/yext/api/utils/api_rate_limits.rb +36 -0
- data/lib/yext/api/utils/configuration.rb +97 -0
- data/lib/yext/api/utils/default_parameters.rb +57 -0
- data/lib/yext/api/utils/response_parser.rb +84 -0
- data/lib/yext/api/version.rb +7 -0
- data/lib/yext/include_rails.rb +31 -0
- data/yext-api.gemspec +51 -0
- metadata +271 -0
data/Rakefile
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
begin
|
4
|
+
require "bundler/setup"
|
5
|
+
rescue LoadError
|
6
|
+
puts "You must `gem install bundler` and `bundle install` to run rake tasks"
|
7
|
+
end
|
8
|
+
|
9
|
+
# require "rdoc/task"
|
10
|
+
#
|
11
|
+
# RDoc::Task.new(:rdoc) do |rdoc|
|
12
|
+
# rdoc.rdoc_dir = "rdoc"
|
13
|
+
# rdoc.title = "Yext::Api"
|
14
|
+
# rdoc.options << "--line-numbers"
|
15
|
+
# rdoc.rdoc_files.include("README.md")
|
16
|
+
# rdoc.rdoc_files.include("lib/**/*.rb")
|
17
|
+
# end
|
18
|
+
|
19
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
20
|
+
|
21
|
+
load "rails/tasks/engine.rake"
|
22
|
+
|
23
|
+
load "rails/tasks/statistics.rake"
|
24
|
+
|
25
|
+
require "bundler/gem_tasks"
|
26
|
+
require "rspec/core/rake_task"
|
27
|
+
|
28
|
+
RSpec::Core::RakeTask.new(:spec)
|
29
|
+
|
30
|
+
task default: :spec
|
File without changes
|
@@ -0,0 +1,13 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// compiled file. JavaScript code in this file should be added after the last require_* statement.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
|
10
|
+
* files in this directory. Styles in this file should be added after the last require_* statement.
|
11
|
+
* It is generally better to create a new file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
data/app/docs/notes.txt
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
Other
|
2
|
+
Date/time: Time.now.iso8601
|
3
|
+
Date: Time.now.to_date.iso8601
|
4
|
+
|
5
|
+
Classes examples:
|
6
|
+
AdministrativeApi::Account
|
7
|
+
AdministrativeApi::AddRequest
|
8
|
+
AdministrativeApi::Service
|
9
|
+
KnowledgeApi::HealthCheck::Health
|
10
|
+
KnowledgeApi::KnowledgeManager::Location
|
11
|
+
KnowledgeApi::KnowledgeManager::Folder
|
12
|
+
KnowledgeApi::KnowledgeManager::Menu
|
13
|
+
KnowledgeApi::KnowledgeManager::Bio
|
14
|
+
KnowledgeApi::KnowledgeManager::Product
|
15
|
+
KnowledgeApi::KnowledgeManager::Event
|
16
|
+
KnowledgeApi::KnowledgeManager::Category
|
17
|
+
KnowledgeApi::KnowledgeManager::GoogleField
|
18
|
+
KnowledgeApi::KnowledgeManager::CustomField
|
19
|
+
KnowledgeApi::KnowledgeManager::LanguageProfile
|
20
|
+
KnowledgeApi::KnowledgeManager::Asset
|
21
|
+
KnowledgeApi::PowerListings::Publisher
|
22
|
+
KnowledgeApi::PowerListings::Listing
|
23
|
+
KnowledgeApi::PowerListings::PublisherSuggestion
|
24
|
+
KnowledgeApi::Analytics::MaxDate
|
25
|
+
KnowledgeApi::Analytics::Report
|
26
|
+
KnowledgeApi::Analytics::Activity
|
27
|
+
KnowledgeApi::Reviews::Review
|
28
|
+
KnowledgeApi::Reviews::Comment
|
29
|
+
KnowledgeApi::Reviews::ReviewInvitation
|
30
|
+
KnowledgeApi::Reviews::ReviewGenerationSetting
|
31
|
+
KnowledgeApi::Social::Post
|
32
|
+
KnowledgeApi::Social::Comment
|
33
|
+
KnowledgeApi::Social::LinkedAccount
|
34
|
+
KnowledgeApi::AccountSettings::Role
|
35
|
+
KnowledgeApi::AccountSettings::User
|
36
|
+
KnowledgeApi::AccountSettings::Account
|
37
|
+
KnowledgeApi::OptimizationTasks::OptimizationTask
|
38
|
+
LiveApi::Menu
|
39
|
+
LiveApi::Bio
|
40
|
+
LiveApi::Product
|
41
|
+
LiveApi::Event
|
42
|
+
LiveApi::LanguageProfile
|
43
|
+
LiveApi::LanguageProfileSchema
|
44
|
+
LiveApi::Location
|
45
|
+
LiveApi::LocationSchema
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>Yext Api</title>
|
5
|
+
<%= stylesheet_link_tag "yext/api/application", media: "all" %>
|
6
|
+
<%= javascript_include_tag "yext/api/application" %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
data/bin/console
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
#!/usr/bin/env ruby
|
4
|
+
|
5
|
+
require "bundler/setup"
|
6
|
+
require "yext/api"
|
7
|
+
|
8
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
9
|
+
# with your gem easier. You can also use a different console, if you like.
|
10
|
+
|
11
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
12
|
+
# require "pry"
|
13
|
+
# Pry.start
|
14
|
+
|
15
|
+
require "irb"
|
16
|
+
IRB.start(__FILE__)
|
data/bin/rails
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
#!/usr/bin/env ruby
|
4
|
+
# This command will automatically be run when you run "rails" with Rails gems
|
5
|
+
# installed from the root of your application.
|
6
|
+
|
7
|
+
ENGINE_ROOT = File.expand_path("../..", __FILE__)
|
8
|
+
ENGINE_PATH = File.expand_path("../../lib/yext/api/engine", __FILE__)
|
9
|
+
APP_PATH = File.expand_path("../../spec/dummy/config/application", __FILE__)
|
10
|
+
|
11
|
+
# Set up gems listed in the Gemfile.
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
|
13
|
+
require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
|
14
|
+
|
15
|
+
require "yext/include_rails"
|
16
|
+
require "rails/engine/commands"
|
data/bin/setup
ADDED
data/config/routes.rb
ADDED
data/lib/config/api.yml
ADDED
@@ -0,0 +1,1100 @@
|
|
1
|
+
:administrative_api:
|
2
|
+
:documentation: http://developer.yext.com/docs/administrative-api
|
3
|
+
:objects:
|
4
|
+
:account:
|
5
|
+
:actions:
|
6
|
+
- :action: :create
|
7
|
+
:method: :post
|
8
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/newlocationaddrequests
|
9
|
+
:path_regex: v2/accounts/[^/]+?/newlocationaddrequests
|
10
|
+
:default_version: 20161012
|
11
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createNewLocationAddRequest
|
12
|
+
:comment: Request that a new location be added and services added to it. The location is created only if the request succeeds.
|
13
|
+
:sandbox_only: false
|
14
|
+
- :action: :add_services
|
15
|
+
:method: :post
|
16
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/existinglocationaddrequests
|
17
|
+
:path_regex: v2/accounts/[^/]+?/existinglocationaddrequests
|
18
|
+
:default_version: 20161012
|
19
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest
|
20
|
+
:comment: Request that one or more available services be added to an existing location.
|
21
|
+
:sandbox_only: false
|
22
|
+
- :action: :change_status
|
23
|
+
:method: :post
|
24
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/processaddrequest
|
25
|
+
:path_regex: v2/accounts/[^/]+?/processaddrequest
|
26
|
+
:default_version: 20161012
|
27
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createProcessReviewAddRequest
|
28
|
+
:comment: Request that an add request in REVIEW be processed to COMPLETE, CANCELED, or FAILED.
|
29
|
+
:sandbox_only: true
|
30
|
+
- :action: :index
|
31
|
+
:method: :get
|
32
|
+
# :endpoint: https://api.yext.com/v2/accounts
|
33
|
+
# :path_regex: v2/accounts
|
34
|
+
:default_version: 20161012
|
35
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listAccounts
|
36
|
+
:comment: List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account.
|
37
|
+
:sandbox_only: false
|
38
|
+
- :action: :show
|
39
|
+
:method: :get
|
40
|
+
# :endpoint: https://api.yext.com/v2/accounts/{accountId}
|
41
|
+
# :path_regex: v2/accounts/[^/]+?
|
42
|
+
:default_version: 20161012
|
43
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/getAccount
|
44
|
+
:comment: Get details for an account.
|
45
|
+
:sandbox_only: false
|
46
|
+
- :action: :update
|
47
|
+
:method: :put
|
48
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}
|
49
|
+
:path_regex: v2/accounts/[^/]+?
|
50
|
+
:default_version: 20161012
|
51
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/updateAccount
|
52
|
+
:comment: Update an account's name or ID.
|
53
|
+
:sandbox_only: false
|
54
|
+
:add_request:
|
55
|
+
:actions:
|
56
|
+
- :action: :index
|
57
|
+
:method: :get
|
58
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests
|
59
|
+
:path_regex: v2/accounts/[^/]+?/addrequests
|
60
|
+
:default_version: 20161012
|
61
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listAddRequests
|
62
|
+
:comment: Get all of the add requests in the account. The response includes both New Location Add Requests and Existing Location Add Requests.
|
63
|
+
:sandbox_only: false
|
64
|
+
- :action: :show
|
65
|
+
:method: :get
|
66
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests/{addRequestId}
|
67
|
+
:path_regex: v2/accounts/[^/]+?/addrequests/[^/]+??
|
68
|
+
:default_version: 20161012
|
69
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/getAddRequest
|
70
|
+
:comment: Get status information about an add request previously created.
|
71
|
+
:sandbox_only: false
|
72
|
+
:service:
|
73
|
+
:actions:
|
74
|
+
- :action: :available
|
75
|
+
:method: :get
|
76
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/availableservices
|
77
|
+
:path_regex: v2/accounts/[^/]+?/availableservices
|
78
|
+
:default_version: 20161012
|
79
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listAvailableServices
|
80
|
+
:comment: Return list of services available to you under your agreements.
|
81
|
+
:sandbox_only: false
|
82
|
+
- :action: :index
|
83
|
+
:method: :get
|
84
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/services
|
85
|
+
:path_regex: v2/accounts/[^/]+?/services
|
86
|
+
:default_version: 20161012
|
87
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listServices
|
88
|
+
:comment: Retrieve a list of all services provisioned through this account.
|
89
|
+
:sandbox_only: false
|
90
|
+
- :action: :destroy
|
91
|
+
:method: :post
|
92
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/cancelservices
|
93
|
+
:path_regex: v2/accounts/[^/]+?/cancelservices
|
94
|
+
:default_version: 20161012
|
95
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/cancelServices
|
96
|
+
:comment: Cancel one or more active services.
|
97
|
+
:sandbox_only: false
|
98
|
+
:knowledge_api:
|
99
|
+
:documentation: http://developer.yext.com/docs/api-reference/
|
100
|
+
:health_check:
|
101
|
+
:objects:
|
102
|
+
:health:
|
103
|
+
:actions:
|
104
|
+
- :action: :show
|
105
|
+
:method: :get
|
106
|
+
:endpoint: https://api.yext.com/v2/healthy
|
107
|
+
:path_regex: v2/healthy
|
108
|
+
:default_version: 20161012
|
109
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/healthCheck
|
110
|
+
:comment: The Health Check endpoint allows you to monitor the status of Yext's systems.
|
111
|
+
:sandbox_only: false
|
112
|
+
:knowledge_manager:
|
113
|
+
:objects:
|
114
|
+
:location:
|
115
|
+
:has_many: language_profiles
|
116
|
+
:actions:
|
117
|
+
- :action: :index
|
118
|
+
:method: :get
|
119
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations
|
120
|
+
:path_regex: v2/accounts/[^/]+?/locations
|
121
|
+
:default_version: 20161012
|
122
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocations
|
123
|
+
:comment: Get multiple Locations (primary profiles only).
|
124
|
+
:sandbox_only: false
|
125
|
+
- :action: :create
|
126
|
+
:method: :post
|
127
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations
|
128
|
+
:path_regex: v2/accounts/[^/]+?/locations
|
129
|
+
:default_version: 20161012
|
130
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createLocation
|
131
|
+
:comment: Create a new Location.
|
132
|
+
:sandbox_only: false
|
133
|
+
- :action: :search
|
134
|
+
:method: :get
|
135
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locationsearch
|
136
|
+
:path_regex: v2/accounts/[^/]+?/locationsearch
|
137
|
+
:default_version: 20161012
|
138
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/searchLocations
|
139
|
+
:comment: Get multiple Locations (primary profiles only) that match provided filters.
|
140
|
+
:sandbox_only: false
|
141
|
+
- :action: :show
|
142
|
+
:method: :get
|
143
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
144
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??
|
145
|
+
:default_version: 20161012
|
146
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation
|
147
|
+
:comment: Gets the primary profile for a single Location.
|
148
|
+
:sandbox_only: false
|
149
|
+
- :action: :update
|
150
|
+
:method: :put
|
151
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
152
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??
|
153
|
+
:default_version: 20161012
|
154
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation
|
155
|
+
:comment: Updates the primary profile for a Location.
|
156
|
+
:sandbox_only: false
|
157
|
+
:folder:
|
158
|
+
:actions:
|
159
|
+
- :action: :index
|
160
|
+
:method: :get
|
161
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/folders
|
162
|
+
:path_regex: v2/accounts/[^/]+?/folders
|
163
|
+
:default_version: 20161012
|
164
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocationFolders
|
165
|
+
:comment: Returns a list of Location Folders in an Account.
|
166
|
+
:sandbox_only: false
|
167
|
+
:menu:
|
168
|
+
:actions:
|
169
|
+
- :action: :index
|
170
|
+
:method: :get
|
171
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus
|
172
|
+
:path_regex: v2/accounts/[^/]+?/menus
|
173
|
+
:default_version: 20161012
|
174
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMenus
|
175
|
+
:comment: Retrieve all Menus for an account.
|
176
|
+
:sandbox_only: false
|
177
|
+
- :action: :create
|
178
|
+
:method: :post
|
179
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus
|
180
|
+
:path_regex: v2/accounts/[^/]+?/menus
|
181
|
+
:default_version: 20161012
|
182
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createMenu
|
183
|
+
:comment: Create a new Menu.
|
184
|
+
:sandbox_only: false
|
185
|
+
- :action: :show
|
186
|
+
:method: :get
|
187
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
188
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+??
|
189
|
+
:default_version: 20161012
|
190
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMenu
|
191
|
+
:comment: Retrieve a specific Menu.
|
192
|
+
:sandbox_only: false
|
193
|
+
- :action: :update
|
194
|
+
:method: :put
|
195
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
196
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+??
|
197
|
+
:default_version: 20161012
|
198
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateMenu
|
199
|
+
:comment: Update an existing Menu.
|
200
|
+
:sandbox_only: false
|
201
|
+
- :action: :destroy
|
202
|
+
:method: :delete
|
203
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
204
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+??
|
205
|
+
:default_version: 20161012
|
206
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteMenuList
|
207
|
+
:comment: Delete an existing Menu.
|
208
|
+
:sandbox_only: false
|
209
|
+
:bio:
|
210
|
+
:actions:
|
211
|
+
- :action: :index
|
212
|
+
:method: :get
|
213
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios
|
214
|
+
:path_regex: v2/accounts/[^/]+?/bios
|
215
|
+
:default_version: 20161012
|
216
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBios
|
217
|
+
:comment: Retrieve all Bio Lists for an account.
|
218
|
+
:sandbox_only: false
|
219
|
+
- :action: :create
|
220
|
+
:method: :post
|
221
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios
|
222
|
+
:path_regex: v2/accounts/[^/]+?/bios
|
223
|
+
:default_version: 20161012
|
224
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createBio
|
225
|
+
:comment: Create a new Bio List.
|
226
|
+
:sandbox_only: false
|
227
|
+
- :action: :show
|
228
|
+
:method: :get
|
229
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
230
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+??
|
231
|
+
:default_version: 20161012
|
232
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBio
|
233
|
+
:comment: Retrieve a specific Bio List.
|
234
|
+
:sandbox_only: false
|
235
|
+
- :action: :update
|
236
|
+
:method: :put
|
237
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
238
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+??
|
239
|
+
:default_version: 20161012
|
240
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateBio
|
241
|
+
:comment: Update an existing Bio List.
|
242
|
+
:sandbox_only: false
|
243
|
+
- :action: :destroy
|
244
|
+
:method: :delete
|
245
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
246
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+??
|
247
|
+
:default_version: 20161012
|
248
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteBioList
|
249
|
+
:comment: Delete an existing Bios List.
|
250
|
+
:sandbox_only: false
|
251
|
+
:product:
|
252
|
+
:actions:
|
253
|
+
- :action: :index
|
254
|
+
:method: :get
|
255
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products
|
256
|
+
:path_regex: v2/accounts/[^/]+?/products
|
257
|
+
:default_version: 20161012
|
258
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getProducts
|
259
|
+
:comment: Retrieve all Product Lists for an account.
|
260
|
+
:sandbox_only: false
|
261
|
+
- :action: :create
|
262
|
+
:method: :post
|
263
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products
|
264
|
+
:path_regex: v2/accounts/[^/]+?/products
|
265
|
+
:default_version: 20161012
|
266
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createProduct
|
267
|
+
:comment: Create a new Product List.
|
268
|
+
:sandbox_only: false
|
269
|
+
- :action: :show
|
270
|
+
:method: :get
|
271
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
272
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+??
|
273
|
+
:default_version: 20161012
|
274
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getProduct
|
275
|
+
:comment: Retrieve a specific Product List.
|
276
|
+
:sandbox_only: false
|
277
|
+
- :action: :update
|
278
|
+
:method: :put
|
279
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
280
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+??
|
281
|
+
:default_version: 20161012
|
282
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateProduct
|
283
|
+
:comment: Update an existing Product List.
|
284
|
+
:sandbox_only: false
|
285
|
+
- :action: :destroy
|
286
|
+
:method: :delete
|
287
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
288
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+??
|
289
|
+
:default_version: 20161012
|
290
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteProductList
|
291
|
+
:comment: Delete an existing Products List.
|
292
|
+
:sandbox_only: false
|
293
|
+
:event:
|
294
|
+
:actions:
|
295
|
+
- :action: :index
|
296
|
+
:method: :get
|
297
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events
|
298
|
+
:path_regex: v2/accounts/[^/]+?/events
|
299
|
+
:default_version: 20161012
|
300
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getEvents
|
301
|
+
:comment: Retrieve all Event Lists for an account.
|
302
|
+
:sandbox_only: false
|
303
|
+
- :action: :create
|
304
|
+
:method: :post
|
305
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events
|
306
|
+
:path_regex: v2/accounts/[^/]+?/events
|
307
|
+
:default_version: 20161012
|
308
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createEvent
|
309
|
+
:comment: Create a new Event List.
|
310
|
+
:sandbox_only: false
|
311
|
+
- :action: :show
|
312
|
+
:method: :get
|
313
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
314
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+??
|
315
|
+
:default_version: 20161012
|
316
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getEvent
|
317
|
+
:comment: Retrieve a specific Event List.
|
318
|
+
:sandbox_only: false
|
319
|
+
- :action: :update
|
320
|
+
:method: :put
|
321
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
322
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+??
|
323
|
+
:default_version: 20161012
|
324
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateEvent
|
325
|
+
:comment: Update an existing Event List.
|
326
|
+
:sandbox_only: false
|
327
|
+
- :action: :destroy
|
328
|
+
:method: :delete
|
329
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
330
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+??
|
331
|
+
:default_version: 20161012
|
332
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteEventList
|
333
|
+
:comment: Delete an existing Events List.
|
334
|
+
:sandbox_only: false
|
335
|
+
:category:
|
336
|
+
:actions:
|
337
|
+
- :action: :index
|
338
|
+
:method: :get
|
339
|
+
:endpoint: https://api.yext.com/v2/categories
|
340
|
+
:path_regex: v2/categories
|
341
|
+
:default_version: 20161012
|
342
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBusinessCategories
|
343
|
+
:comment: Get available Categories.
|
344
|
+
:sandbox_only: false
|
345
|
+
:google_field:
|
346
|
+
:actions:
|
347
|
+
- :action: :index
|
348
|
+
:method: :get
|
349
|
+
:endpoint: https://api.yext.com/v2/googlefields
|
350
|
+
:path_regex: v2/googlefields
|
351
|
+
:default_version: 20161012
|
352
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getGoogleKeywords
|
353
|
+
:comment: >
|
354
|
+
Use the Google Fields endpoint to retrieve a complete list of Google's location attributes
|
355
|
+
for each business category. This list includes attributes that may not apply to all
|
356
|
+
Locations in an account. The set of attributes available to a Location depends on its
|
357
|
+
primary business category. You can view and edit the attributes of Locations in the
|
358
|
+
googleAttributes Location field.
|
359
|
+
:sandbox_only: false
|
360
|
+
:custom_field:
|
361
|
+
:actions:
|
362
|
+
- :action: :index
|
363
|
+
:method: :get
|
364
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields
|
365
|
+
:path_regex: v2/accounts/[^/]+?/customfields
|
366
|
+
:default_version: 20161012
|
367
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomFields
|
368
|
+
:comment: Returns a list of Custom Fields in an Account.
|
369
|
+
:sandbox_only: false
|
370
|
+
- :action: :create
|
371
|
+
:method: :post
|
372
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields
|
373
|
+
:path_regex: v2/accounts/[^/]+?/customfields
|
374
|
+
:default_version: 20161012
|
375
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createCustomField
|
376
|
+
:comment: Creates a new Custom Field in an Account.
|
377
|
+
:sandbox_only: false
|
378
|
+
- :action: :show
|
379
|
+
:method: :get
|
380
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
381
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+??
|
382
|
+
:default_version: 20161012
|
383
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomField
|
384
|
+
:comment: Gets a specific Custom Field in an Account.
|
385
|
+
:sandbox_only: false
|
386
|
+
- :action: :update
|
387
|
+
:method: :put
|
388
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
389
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+??
|
390
|
+
:default_version: 20161012
|
391
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateCustomField
|
392
|
+
:comment: Updates a single Custom Field in an Account.
|
393
|
+
:sandbox_only: false
|
394
|
+
- :action: :destroy
|
395
|
+
:method: :delete
|
396
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
397
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+??
|
398
|
+
:default_version: 20161012
|
399
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteCustomField
|
400
|
+
:comment: Deletes a Custom Field in an Account.
|
401
|
+
:sandbox_only: false
|
402
|
+
:language_profile:
|
403
|
+
:belongs_to: location
|
404
|
+
:actions:
|
405
|
+
- :action: :index
|
406
|
+
:method: :get
|
407
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles
|
408
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles
|
409
|
+
:default_version: 20161012
|
410
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfiles
|
411
|
+
:comment: Get Language Profiles for a Location.
|
412
|
+
:sandbox_only: false
|
413
|
+
- :action: :create
|
414
|
+
:alias: :update
|
415
|
+
- :action: :show
|
416
|
+
:method: :get
|
417
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
418
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??
|
419
|
+
:default_version: 20161012
|
420
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfile
|
421
|
+
:comment: Gets the the requested Language Profile for a given Location.
|
422
|
+
:sandbox_only: false
|
423
|
+
- :action: :update
|
424
|
+
:method: :put
|
425
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
426
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??
|
427
|
+
:default_version: 20161012
|
428
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLanguageProfile
|
429
|
+
:comment: Creates and / or sets the fields for a Language Profile
|
430
|
+
:sandbox_only: false
|
431
|
+
- :action: :destroy
|
432
|
+
:method: :delete
|
433
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
434
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??
|
435
|
+
:default_version: 20161012
|
436
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteLanguageProfile
|
437
|
+
:comment: Remove a Language Profile from a location.
|
438
|
+
:sandbox_only: false
|
439
|
+
:asset:
|
440
|
+
:actions:
|
441
|
+
- :action: :index
|
442
|
+
:method: :get
|
443
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets
|
444
|
+
:path_regex: v2/accounts/[^/]+?/assets
|
445
|
+
:default_version: 20161012
|
446
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAssets
|
447
|
+
:comment: List assets in an account.
|
448
|
+
:sandbox_only: false
|
449
|
+
- :action: :create
|
450
|
+
:method: :post
|
451
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets
|
452
|
+
:path_regex: v2/accounts/[^/]+?/assets
|
453
|
+
:default_version: 20161012
|
454
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createAsset
|
455
|
+
:comment: Creates a new Asset in an account.
|
456
|
+
:sandbox_only: false
|
457
|
+
- :action: :show
|
458
|
+
:method: :get
|
459
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
460
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+??
|
461
|
+
:default_version: 20161012
|
462
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAsset
|
463
|
+
:comment: Get a specific asset.
|
464
|
+
:sandbox_only: false
|
465
|
+
- :action: :update
|
466
|
+
:method: :put
|
467
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
468
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+??
|
469
|
+
:default_version: 20161012
|
470
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateAsset
|
471
|
+
:comment: Update a specific asset.
|
472
|
+
:sandbox_only: false
|
473
|
+
- :action: :destroy
|
474
|
+
:method: :delete
|
475
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
476
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+??
|
477
|
+
:default_version: 20161012
|
478
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset
|
479
|
+
:comment: Delete a specific asset.
|
480
|
+
:sandbox_only: false
|
481
|
+
:power_listings:
|
482
|
+
:objects:
|
483
|
+
:publishser:
|
484
|
+
:actions:
|
485
|
+
- :action: :index
|
486
|
+
:method: :get
|
487
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishers
|
488
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishers
|
489
|
+
:default_version: 20161012
|
490
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listPublishers
|
491
|
+
:comment: Retrieve a list of publishers included in an account's subscription.
|
492
|
+
:sandbox_only: false
|
493
|
+
:listing:
|
494
|
+
:actions:
|
495
|
+
- :action: :index
|
496
|
+
:method: :get
|
497
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings
|
498
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/listings
|
499
|
+
:default_version: 20161012
|
500
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listListings
|
501
|
+
:comment: Retrieve all Listings matching the given criteria including status and reasons why a Listing may be unavailable.
|
502
|
+
:sandbox_only: false
|
503
|
+
- :action: :opt_in
|
504
|
+
:method: :put
|
505
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optin
|
506
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/listings/optin
|
507
|
+
:default_version: 20161012
|
508
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/optInListings
|
509
|
+
:comment: Opts designated locations into designated publishers.
|
510
|
+
:sandbox_only: false
|
511
|
+
- :action: :opt_out
|
512
|
+
:method: :put
|
513
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optout
|
514
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/listings/optout
|
515
|
+
:default_version: 20161012
|
516
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/optOutListings
|
517
|
+
:comment: Opts designated locations out of designated publishers.
|
518
|
+
:sandbox_only: false
|
519
|
+
:publisher_suggestion:
|
520
|
+
:actions:
|
521
|
+
- :action: :index
|
522
|
+
:method: :get
|
523
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions
|
524
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions
|
525
|
+
:default_version: 20161012
|
526
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listPublisherSuggestions
|
527
|
+
:comment: Retrieve suggestions publishers have submitted for the Locations in an account.
|
528
|
+
:sandbox_only: false
|
529
|
+
- :action: :show
|
530
|
+
:method: :get
|
531
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId}
|
532
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+??
|
533
|
+
:default_version: 20161012
|
534
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getPublisherSuggestion
|
535
|
+
:comment: Fetches details of a specific Publisher Suggestion.
|
536
|
+
:sandbox_only: false
|
537
|
+
- :action: :update
|
538
|
+
:method: :put
|
539
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId}
|
540
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+??
|
541
|
+
:default_version: 20161012
|
542
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updatePublisherSuggestion
|
543
|
+
:comment: Accept or reject a Publisher Suggestion.
|
544
|
+
:sandbox_only: false
|
545
|
+
:duplicate:
|
546
|
+
:actions:
|
547
|
+
- :action: :index
|
548
|
+
:method: :get
|
549
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates
|
550
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates
|
551
|
+
:default_version: 20161012
|
552
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listDuplicates
|
553
|
+
:comment: Retrieve Duplicates for an account.
|
554
|
+
:sandbox_only: false
|
555
|
+
- :action: :create
|
556
|
+
:method: :post
|
557
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates
|
558
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates
|
559
|
+
:default_version: 20161012
|
560
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createDuplicate
|
561
|
+
:comment: Creates a new Duplicate with status SUPPRESSION_REQUESTED.
|
562
|
+
:sandbox_only: false
|
563
|
+
- :action: :destroy
|
564
|
+
:method: :delete
|
565
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId}
|
566
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+??
|
567
|
+
:default_version: 20161012
|
568
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteDuplicate
|
569
|
+
:comment: Indicates that a Duplicate should be ignored.
|
570
|
+
:sandbox_only: false
|
571
|
+
- :action: :suppress
|
572
|
+
:method: :put
|
573
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId}
|
574
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+??
|
575
|
+
:default_version: 20161012
|
576
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/suppressDuplicate
|
577
|
+
:comment: Request suppression of a Duplicate.
|
578
|
+
:sandbox_only: false
|
579
|
+
:analytics:
|
580
|
+
:objects:
|
581
|
+
:max_date:
|
582
|
+
:actions:
|
583
|
+
- :action: :index
|
584
|
+
:method: :get
|
585
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/maxdates
|
586
|
+
:path_regex: v2/accounts/[^/]+?/analytics/maxdates
|
587
|
+
:default_version: 20161012
|
588
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMaxDates
|
589
|
+
:comment: The dates through which reporting data is available.
|
590
|
+
:sandbox_only: false
|
591
|
+
:report:
|
592
|
+
:actions:
|
593
|
+
- :action: :create
|
594
|
+
:method: :post
|
595
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/reports
|
596
|
+
:path_regex: v2/accounts/[^/]+?/analytics/reports
|
597
|
+
:default_version: 20161012
|
598
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReports
|
599
|
+
:comment: Begins the process of producing a report.
|
600
|
+
:sandbox_only: false
|
601
|
+
- :action: :show
|
602
|
+
:method: :get
|
603
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/standardreports/{reportId}
|
604
|
+
:path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]+??
|
605
|
+
:default_version: 20161012
|
606
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/reportStatus
|
607
|
+
:comment: Checks the status of a Report created with async=true.
|
608
|
+
:sandbox_only: false
|
609
|
+
:activity:
|
610
|
+
:actions:
|
611
|
+
- :action: :index
|
612
|
+
:method: :get
|
613
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/activity
|
614
|
+
:path_regex: v2/accounts/[^/]+?/analytics/activity
|
615
|
+
:default_version: 20161012
|
616
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/activityLog
|
617
|
+
:comment: Fetches account activity information.
|
618
|
+
:sandbox_only: false
|
619
|
+
:reviews:
|
620
|
+
:objects:
|
621
|
+
:review:
|
622
|
+
:has_many: comments
|
623
|
+
:actions:
|
624
|
+
- :action: :index
|
625
|
+
:method: :get
|
626
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews
|
627
|
+
:path_regex: v2/accounts/[^/]+?/reviews
|
628
|
+
:default_version: 20161012
|
629
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listReviews
|
630
|
+
:comment: Retrieve all Reviews matching the given criteria.
|
631
|
+
:sandbox_only: false
|
632
|
+
- :action: :create
|
633
|
+
:method: :post
|
634
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews
|
635
|
+
:path_regex: v2/accounts/[^/]+?/reviews
|
636
|
+
:default_version: 20161012
|
637
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReview
|
638
|
+
:comment: Create a new External First Party Review.
|
639
|
+
:sandbox_only: false
|
640
|
+
- :action: :show
|
641
|
+
:method: :get
|
642
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}
|
643
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+??
|
644
|
+
:default_version: 20161012
|
645
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReview
|
646
|
+
:comment: Retrieve a specific Review.
|
647
|
+
:sandbox_only: false
|
648
|
+
- :action: :update
|
649
|
+
:method: :put
|
650
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}
|
651
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+??
|
652
|
+
:default_version: 20161012
|
653
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateReview
|
654
|
+
:comment: Updates an External First Party Review.
|
655
|
+
:sandbox_only: false
|
656
|
+
:comment:
|
657
|
+
:belongs_to: review
|
658
|
+
:actions:
|
659
|
+
- :action: :create
|
660
|
+
:method: :post
|
661
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}/comments
|
662
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+??/comments
|
663
|
+
:default_version: 20161012
|
664
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createComment
|
665
|
+
:comment: Creates a new Comment on a Review.
|
666
|
+
:sandbox_only: false
|
667
|
+
:review_invitation:
|
668
|
+
:actions:
|
669
|
+
- :action: :index
|
670
|
+
:method: :get
|
671
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites
|
672
|
+
:path_regex: v2/accounts/[^/]+?/reviewinvites
|
673
|
+
:default_version: 20161012
|
674
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listReviewInvitations
|
675
|
+
:comment: Retrieves all review invitations for an account.
|
676
|
+
:sandbox_only: false
|
677
|
+
- :action: :create
|
678
|
+
:method: :post
|
679
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites
|
680
|
+
:path_regex: v2/accounts/[^/]+?/reviewinvites
|
681
|
+
:default_version: 20161012
|
682
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReviewInvites
|
683
|
+
:comment: Sends review invitations to one or more consumers.
|
684
|
+
:sandbox_only: false
|
685
|
+
- :action: :show
|
686
|
+
:method: :get
|
687
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites/{invitationId}
|
688
|
+
:path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]+??
|
689
|
+
:default_version: 20161012
|
690
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewInvitation
|
691
|
+
:comment: Retrieve a specific review invitation.
|
692
|
+
:sandbox_only: false
|
693
|
+
:review_generation_setting:
|
694
|
+
:actions:
|
695
|
+
- :action: :index
|
696
|
+
:method: :get
|
697
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/settings/generation
|
698
|
+
:path_regex: v2/accounts/[^/]+?/reviews/settings/generation
|
699
|
+
:default_version: 20161012
|
700
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewGenerationSettings
|
701
|
+
:comment: Returns all current generation settings for a specified account.
|
702
|
+
:sandbox_only: false
|
703
|
+
- :action: :create
|
704
|
+
:alias: :update
|
705
|
+
- :action: :update
|
706
|
+
:method: :post
|
707
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/settings/generation
|
708
|
+
:path_regex: v2/accounts/[^/]+?/reviews/settings/generation
|
709
|
+
:default_version: 20161012
|
710
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateReviewGenerationSettings
|
711
|
+
:comment: >
|
712
|
+
Updates any generation settings specified in a specified account. Call may include any/all
|
713
|
+
settings available to the account. Settings not included will remain unchanged.
|
714
|
+
:sandbox_only: false
|
715
|
+
:social:
|
716
|
+
:objects:
|
717
|
+
:post:
|
718
|
+
:has_many: comments
|
719
|
+
:actions:
|
720
|
+
- :action: :index
|
721
|
+
:method: :get
|
722
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts
|
723
|
+
:path_regex: v2/accounts/[^/]+?/posts
|
724
|
+
:default_version: 20161012
|
725
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getPosts
|
726
|
+
:comment: Retrieve list of Posts.
|
727
|
+
:sandbox_only: false
|
728
|
+
- :action: :create
|
729
|
+
:method: :post
|
730
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts
|
731
|
+
:path_regex: v2/accounts/[^/]+?/posts
|
732
|
+
:default_version: 20161012
|
733
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createPosts
|
734
|
+
:comment: Create a new Post.
|
735
|
+
:sandbox_only: false
|
736
|
+
- :action: :destroy
|
737
|
+
:method: :delete
|
738
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}
|
739
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+??
|
740
|
+
:default_version: 20161012
|
741
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deletePost
|
742
|
+
:comment: Deletes an existing Post.
|
743
|
+
:sandbox_only: false
|
744
|
+
:comment:
|
745
|
+
:belongs_to: post
|
746
|
+
:actions:
|
747
|
+
- :action: :index
|
748
|
+
:method: :get
|
749
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments
|
750
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments
|
751
|
+
:default_version: 20161012
|
752
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getComments
|
753
|
+
:comment: Retrieve list of Comments for a Post.
|
754
|
+
:sandbox_only: false
|
755
|
+
- :action: :create
|
756
|
+
:method: :post
|
757
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments
|
758
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments
|
759
|
+
:default_version: 20161012
|
760
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createComment
|
761
|
+
:comment: Create a new Comment in response to another Post / Comment.
|
762
|
+
:sandbox_only: false
|
763
|
+
- :action: :update
|
764
|
+
:method: :put
|
765
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId}
|
766
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments/[^/]+??
|
767
|
+
:default_version: 20161012
|
768
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateComment
|
769
|
+
:comment: Updates an existing Comment.
|
770
|
+
:sandbox_only: false
|
771
|
+
- :action: :destroy
|
772
|
+
:method: :delete
|
773
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId}
|
774
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments/[^/]+??
|
775
|
+
:default_version: 20161012
|
776
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteComment
|
777
|
+
:comment: Deletes an existing Comment.
|
778
|
+
:sandbox_only: false
|
779
|
+
:linked_account:
|
780
|
+
:actions:
|
781
|
+
- :action: :index
|
782
|
+
:method: :get
|
783
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts
|
784
|
+
:path_regex: v2/accounts/[^/]+?/linkedaccounts
|
785
|
+
:default_version: 20161012
|
786
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccounts
|
787
|
+
:comment: Retrieve all Linked Accounts and their last known statuses.
|
788
|
+
:sandbox_only: false
|
789
|
+
- :action: :show
|
790
|
+
:method: :get
|
791
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId}
|
792
|
+
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+??
|
793
|
+
:default_version: 20161012
|
794
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccount
|
795
|
+
:comment: Retrieve a specific Linked Account.
|
796
|
+
:sandbox_only: false
|
797
|
+
- :action: :update
|
798
|
+
:method: :put
|
799
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId}
|
800
|
+
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+??
|
801
|
+
:default_version: 20161012
|
802
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLinkedAccount
|
803
|
+
:comment: Assign or Unassign a Linked Account to one or more Locations.
|
804
|
+
:sandbox_only: false
|
805
|
+
:account_settings:
|
806
|
+
:objects:
|
807
|
+
:role:
|
808
|
+
:actions:
|
809
|
+
- :action: :index
|
810
|
+
:method: :get
|
811
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/roles
|
812
|
+
:path_regex: v2/accounts/[^/]+?/roles
|
813
|
+
:default_version: 20161012
|
814
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getRoles
|
815
|
+
:comment: Retrieves a list of the roles that users can have within a customer’s account.
|
816
|
+
:sandbox_only: false
|
817
|
+
:user:
|
818
|
+
:actions:
|
819
|
+
- :action: :index
|
820
|
+
:method: :get
|
821
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users
|
822
|
+
:path_regex: v2/accounts/[^/]+?/users
|
823
|
+
:default_version: 20161012
|
824
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getUsers
|
825
|
+
:comment: Lists all Users in an account.
|
826
|
+
:sandbox_only: false
|
827
|
+
- :action: :create
|
828
|
+
:method: :post
|
829
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users
|
830
|
+
:path_regex: v2/accounts/[^/]+?/users
|
831
|
+
:default_version: 20161012
|
832
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/createUser
|
833
|
+
:comment: Create a new User.
|
834
|
+
:sandbox_only: false
|
835
|
+
- :action: :show
|
836
|
+
:method: :get
|
837
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
838
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+??
|
839
|
+
:default_version: 20161012
|
840
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getUser
|
841
|
+
:comment: Retrieves details of a specific User.
|
842
|
+
:sandbox_only: false
|
843
|
+
- :action: :update
|
844
|
+
:method: :put
|
845
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
846
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+??
|
847
|
+
:default_version: 20161012
|
848
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser
|
849
|
+
:comment: Updates an existing User.
|
850
|
+
:sandbox_only: false
|
851
|
+
- :action: :destroy
|
852
|
+
:method: :delete
|
853
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
854
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+??
|
855
|
+
:default_version: 20161012
|
856
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser
|
857
|
+
:comment: Deletes an existing User.
|
858
|
+
:sandbox_only: false
|
859
|
+
- :action: :change_password
|
860
|
+
:method: :put
|
861
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}/password
|
862
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+??/password
|
863
|
+
:default_version: 20161012
|
864
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword
|
865
|
+
:comment: Updates a User's password.
|
866
|
+
:sandbox_only: false
|
867
|
+
:account:
|
868
|
+
:actions:
|
869
|
+
- :action: :index
|
870
|
+
:method: :get
|
871
|
+
:endpoint: https://api.yext.com/v2/accounts
|
872
|
+
:path_regex: v2/accounts
|
873
|
+
:default_version: 20161012
|
874
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/listAccounts
|
875
|
+
:comment: >
|
876
|
+
List all accounts that you have access to. Unless you are in Partner Portal mode,
|
877
|
+
this will only be your own account.
|
878
|
+
:sandbox_only: false
|
879
|
+
- :action: :show
|
880
|
+
:method: :get
|
881
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}
|
882
|
+
:path_regex: v2/accounts/[^/]+?
|
883
|
+
:default_version: 20161012
|
884
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAccount
|
885
|
+
:comment: Get details for an account.
|
886
|
+
:sandbox_only: false
|
887
|
+
:optimization_tasks:
|
888
|
+
:objects:
|
889
|
+
:optimization_task:
|
890
|
+
:actions:
|
891
|
+
- :action: :index
|
892
|
+
:method: :get
|
893
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationtasks
|
894
|
+
:path_regex: v2/accounts/[^/]+?/optimizationtasks
|
895
|
+
:default_version: 20161012
|
896
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getOptimizationTasks
|
897
|
+
:comment: List Optimization Tasks for the account, optionally filtered by task and location.
|
898
|
+
:sandbox_only: false
|
899
|
+
- :action: :show
|
900
|
+
:method: :get
|
901
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationlink
|
902
|
+
:path_regex: v2/accounts/[^/]+?/optimizationlink
|
903
|
+
:default_version: 20161012
|
904
|
+
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkOptimizationTask
|
905
|
+
:comment: Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location.
|
906
|
+
:sandbox_only: false
|
907
|
+
:live_api:
|
908
|
+
:documentation: http://developer.yext.com/docs/live-api/
|
909
|
+
:objects:
|
910
|
+
:menu:
|
911
|
+
:actions:
|
912
|
+
- :action: :show
|
913
|
+
:method: :get
|
914
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/menus/{listId}
|
915
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/menus/[^/]+??
|
916
|
+
:default_version: 20161012
|
917
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getMenus
|
918
|
+
:comment: Retrieve a specific Menu.
|
919
|
+
:sandbox_only: false
|
920
|
+
:bio:
|
921
|
+
:actions:
|
922
|
+
- :action: :show
|
923
|
+
:method: :get
|
924
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/bios/{listId}
|
925
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/bios/[^/]+??
|
926
|
+
:default_version: 20161012
|
927
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getBios
|
928
|
+
:comment: Retrieve a specific Bios ECL.
|
929
|
+
:sandbox_only: false
|
930
|
+
:product:
|
931
|
+
:actions:
|
932
|
+
- :action: :show
|
933
|
+
:method: :get
|
934
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/products/{listId}
|
935
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/products/[^/]+??
|
936
|
+
:default_version: 20161012
|
937
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getProducts
|
938
|
+
:comment: Retrieve a specific Products ECL.
|
939
|
+
:sandbox_only: false
|
940
|
+
:event:
|
941
|
+
:actions:
|
942
|
+
- :action: :show
|
943
|
+
:method: :get
|
944
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/events/{listId}
|
945
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/events/[^/]+??
|
946
|
+
:default_version: 20161012
|
947
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getEvents
|
948
|
+
:comment: Retrieve a specific Events ECL.
|
949
|
+
:sandbox_only: false
|
950
|
+
:language_profile:
|
951
|
+
:belongs_to: location
|
952
|
+
:has_many: language_profile_schema
|
953
|
+
:actions:
|
954
|
+
- :action: :index
|
955
|
+
:method: :get
|
956
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/
|
957
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/
|
958
|
+
:default_version: 20161012
|
959
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/listLanguageProfiles
|
960
|
+
:comment: Gets all Language Profiles for a Location.
|
961
|
+
:sandbox_only: false
|
962
|
+
- :action: :show
|
963
|
+
:method: :get
|
964
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}
|
965
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??
|
966
|
+
:default_version: 20161012
|
967
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfiles
|
968
|
+
:comment: Gets the requested Language Profile for a given Location.
|
969
|
+
:sandbox_only: false
|
970
|
+
:language_profile_schema:
|
971
|
+
:belongs_to: language_profile
|
972
|
+
:actions:
|
973
|
+
- :action: :show
|
974
|
+
:method: :get
|
975
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}/schema
|
976
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??/schema
|
977
|
+
:default_version: 20161012
|
978
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfilesSchema
|
979
|
+
:comment: >
|
980
|
+
Gets the schema.org compliant schema for the requested Language Profile of a given Location.
|
981
|
+
Schema will vary depending on the primary category of the Location.
|
982
|
+
:sandbox_only: false
|
983
|
+
:location:
|
984
|
+
:has_many: language_profile
|
985
|
+
:has_many: location_schema
|
986
|
+
:actions:
|
987
|
+
- :action: :index
|
988
|
+
:method: :get
|
989
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations
|
990
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations
|
991
|
+
:default_version: 20161012
|
992
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/locationsList
|
993
|
+
:comment: >
|
994
|
+
Get multiple Locations (primary profile only). Filters are evaluated against all language
|
995
|
+
profiles as well as the primary profile.
|
996
|
+
:sandbox_only: false
|
997
|
+
- :action: :show
|
998
|
+
:method: :get
|
999
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
1000
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??
|
1001
|
+
:default_version: 20161012
|
1002
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getLocation
|
1003
|
+
:comment: Gets the primary profile for a single Location.
|
1004
|
+
:sandbox_only: false
|
1005
|
+
:location_schema:
|
1006
|
+
:actions:
|
1007
|
+
- :action: :show
|
1008
|
+
:method: :get
|
1009
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/schema
|
1010
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/schema
|
1011
|
+
:default_version: 20161012
|
1012
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getLocationSchema
|
1013
|
+
:comment: >
|
1014
|
+
Gets the schema.org compliant schema for the primary profile of a single Location. Schema
|
1015
|
+
will vary depending on the primary category of the Location.
|
1016
|
+
:sandbox_only: false
|
1017
|
+
- :action: :geo_search
|
1018
|
+
:method: :get
|
1019
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/geosearch
|
1020
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/geosearch
|
1021
|
+
:default_version: 20161012
|
1022
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/geoSearch
|
1023
|
+
:comment: >
|
1024
|
+
Gets multiple Locations (primary profile only) near a given location, ordered by proximity
|
1025
|
+
to the location (if no other sort criteria are given) and restricted to a radius. Searches
|
1026
|
+
through all language profiles, including the primary profile.
|
1027
|
+
:sandbox_only: false
|
1028
|
+
:webhooks:
|
1029
|
+
:documentation: http://developer.yext.com/docs/webhooks/
|
1030
|
+
:knowledge_manager:
|
1031
|
+
:location:
|
1032
|
+
:endpoint: https://[your_hostname]/[your_locations_webhook_path]
|
1033
|
+
:default_version: 20161012
|
1034
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/locationsWebhook
|
1035
|
+
:comment: Sends an updated Location to your server.
|
1036
|
+
:sandbox_only: false
|
1037
|
+
:menu:
|
1038
|
+
:endpoint: https://[your_hostname]/[your_menus_webhook_path]
|
1039
|
+
:default_version: 20161012
|
1040
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/menusWebhook
|
1041
|
+
:comment: Sends an updated Menu object to your server.
|
1042
|
+
:sandbox_only: false
|
1043
|
+
:bio:
|
1044
|
+
:endpoint: https://[your_hostname]/[your_bios_webhook_path]
|
1045
|
+
:default_version: 20161012
|
1046
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/biosWebhook
|
1047
|
+
:comment: Sends an updated Bios object to your server.
|
1048
|
+
:sandbox_only: false
|
1049
|
+
:product:
|
1050
|
+
:endpoint: https://[your_hostname]/[your_products_webhook_path]
|
1051
|
+
:default_version: 20161012
|
1052
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/productsWebhook
|
1053
|
+
:comment: Sends an updated Product List object to your server.
|
1054
|
+
:sandbox_only: false
|
1055
|
+
:event:
|
1056
|
+
:endpoint: https://[your_hostname]/[your_events_webhook_path]
|
1057
|
+
:default_version: 20161012
|
1058
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/eventsWebhook
|
1059
|
+
:comment: Sends an updated Events List (Calendar) object to your server.
|
1060
|
+
:sandbox_only: false
|
1061
|
+
:power_listings:
|
1062
|
+
:listing:
|
1063
|
+
:endpoint: https://[your_hostname]/[your_listings_webhook_path]
|
1064
|
+
:default_version: 20161012
|
1065
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/listingsWebhook
|
1066
|
+
:comment: Sends an updated Listing object to your server.
|
1067
|
+
:sandbox_only: false
|
1068
|
+
:duplicate:
|
1069
|
+
:endpoint: https://[your_hostname]/[your_duplicates_webhook_path]
|
1070
|
+
:default_version: 20161012
|
1071
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/duplicatesWebhook
|
1072
|
+
:comment: Sends an updated Duplicate object to your server.
|
1073
|
+
:sandbox_only: false
|
1074
|
+
:publisher_suggestion:
|
1075
|
+
:endpoint: https://[your_hostname]/[your_publisherSuggestions_webhook_path]
|
1076
|
+
:default_version: 20161012
|
1077
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/publisherSuggestionsWebhook
|
1078
|
+
:comment: Sends an updated Publisher Suggestion object to your server.
|
1079
|
+
:sandbox_only: false
|
1080
|
+
:reviews:
|
1081
|
+
:review:
|
1082
|
+
:endpoint: https://[your_hostname]/[your_reviews_webhook_path]
|
1083
|
+
:default_version: 20161012
|
1084
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/reviewsWebhook
|
1085
|
+
:comment: Sends an updated Review object to your server whenever a Review or one of its Comments are created or modified.
|
1086
|
+
:sandbox_only: false
|
1087
|
+
:app_directory:
|
1088
|
+
:review:
|
1089
|
+
:endpoint: https://[your_hostname]/[your_unlink_account_webhook_path]
|
1090
|
+
:default_version: 20161012
|
1091
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/unlinkWebhook
|
1092
|
+
:comment: Fired when an account uninstalls your App.
|
1093
|
+
:sandbox_only: false
|
1094
|
+
:agreements:
|
1095
|
+
:add_request_update:
|
1096
|
+
:endpoint: https://[your_hostname]/[your_add_request_webhook_path]
|
1097
|
+
:default_version: 20161012
|
1098
|
+
:documentation: http://developer.yext.com/docs/webhooks/#operation/addRequestWebhook
|
1099
|
+
:comment: Fired when an Add Request is updated.
|
1100
|
+
:sandbox_only: false
|