yext-api 0.1.1 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +16 -8
- data/PULL_REQUEST_TEMPLATE.md +11 -0
- data/README.md +25 -7
- data/app/controllers/yext/api/agreements/add_request_controller.rb +78 -0
- data/app/controllers/yext/api/application_controller.rb +1 -3
- data/config/initializers/memoist.rb +3 -0
- data/config/routes.rb +3 -0
- data/lib/config/api.yml +95 -230
- data/lib/yext/api/administrative_api/account.rb +37 -27
- data/lib/yext/api/administrative_api/add_request.rb +87 -3
- data/lib/yext/api/administrative_api/service.rb +26 -4
- data/lib/yext/api/concerns/account_child.rb +37 -8
- data/lib/yext/api/concerns/account_relations.rb +16 -1
- data/lib/yext/api/concerns/default_scopes.rb +8 -2
- data/lib/yext/api/concerns/faraday_connection.rb +21 -7
- data/lib/yext/api/concerns/rate_limits.rb +8 -1
- data/lib/yext/api/enumerations/add_request_status.rb +19 -0
- data/lib/yext/api/enumerations/location_type.rb +18 -0
- data/lib/yext/api/knowledge_api/account_settings/account.rb +0 -2
- data/lib/yext/api/knowledge_api/account_settings/role.rb +24 -0
- data/lib/yext/api/knowledge_api/account_settings/user.rb +81 -0
- data/lib/yext/api/knowledge_api/health_check/health.rb +0 -1
- data/lib/yext/api/knowledge_api/knowledge_manager/category.rb +0 -1
- data/lib/yext/api/knowledge_api/knowledge_manager/location.rb +18 -6
- data/lib/yext/api/live_api/location.rb +0 -4
- data/lib/yext/api/utils/api_base.rb +8 -0
- data/lib/yext/api/utils/api_finder.rb +100 -0
- data/lib/yext/api/utils/configuration.rb +93 -0
- data/lib/yext/api/utils/middleware/api_rate_limits.rb +35 -0
- data/lib/yext/api/utils/middleware/default_parameters.rb +138 -0
- data/lib/yext/api/utils/middleware/response_parser.rb +111 -0
- data/lib/yext/api/utils/middleware/uri_cleanup.rb +48 -0
- data/lib/yext/api/utils/params.rb +69 -0
- data/lib/yext/api/version.rb +1 -1
- data/yext-api.gemspec +6 -7
- metadata +56 -31
- data/.travis.yml +0 -5
- data/app/assets/config/yext_api_manifest.js +0 -2
- data/app/assets/images/yext/api/.keep +0 -0
- data/app/assets/javascripts/yext/api/application.js +0 -13
- data/app/assets/stylesheets/yext/api/application.css +0 -15
- data/app/docs/notes.txt +0 -45
- data/app/helpers/yext/api/application_helper.rb +0 -11
- data/app/jobs/yext/api/application_job.rb +0 -8
- data/app/mailers/yext/api/application_mailer.rb +0 -11
- data/app/models/yext/api/application_record.rb +0 -10
- data/app/views/layouts/yext/api/application.html.erb +0 -14
- data/lib/tasks/yext/api_tasks.rake +0 -6
- data/lib/yext/api/concerns/api_finder.rb +0 -61
- data/lib/yext/api/utils/api_rate_limits.rb +0 -36
- data/lib/yext/api/utils/default_parameters.rb +0 -57
- data/lib/yext/api/utils/response_parser.rb +0 -84
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5ce7d01dbd9e9f86ee887b0316ad5daac4a03767
|
4
|
+
data.tar.gz: 539b2d9959f9295d55149a2c96d4895630d33103
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 639206c698f5c4daafa14663966acd800663429521dc6e8838839c9567b779dfbc3da861eac32f9fc75b69d8c1f21d0fa1d8bb61061395454772e3ab76d3b629
|
7
|
+
data.tar.gz: c72da8551f456fea3ae50621dd2a18656a6e106fea62cfba200450d582a7aee416f6d8110960ef773924af20838e0e88f9b2ca69d6d97378d9533af8b1efb669
|
data/Gemfile
CHANGED
@@ -2,9 +2,11 @@
|
|
2
2
|
|
3
3
|
source "https://rubygems.org"
|
4
4
|
|
5
|
-
git_source(:github) { |_repo_name| "https://github.com/
|
5
|
+
git_source(:github) { |_repo_name| "https://github.com/CardTapp/yext-api" }
|
6
6
|
|
7
7
|
# Specify your gem's dependencies in yext-api.gemspec
|
8
8
|
gemspec
|
9
9
|
|
10
|
+
gem "codecov"
|
10
11
|
gem "gem-release"
|
12
|
+
gem "simplecov"
|
data/Gemfile.lock
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
yext-api (0.1.
|
5
|
-
|
4
|
+
yext-api (0.1.3)
|
5
|
+
memoist (~> 0)
|
6
|
+
rails (> 4)
|
6
7
|
spyke (~> 5)
|
7
8
|
|
8
9
|
GEM
|
@@ -49,6 +50,10 @@ GEM
|
|
49
50
|
public_suffix (>= 2.0.2, < 4.0)
|
50
51
|
arel (8.0.0)
|
51
52
|
builder (3.2.3)
|
53
|
+
codecov (0.1.10)
|
54
|
+
json
|
55
|
+
simplecov
|
56
|
+
url
|
52
57
|
concurrent-ruby (1.0.5)
|
53
58
|
cornucopia (0.1.40)
|
54
59
|
activesupport
|
@@ -58,7 +63,7 @@ GEM
|
|
58
63
|
diff-lcs (1.3)
|
59
64
|
docile (1.1.5)
|
60
65
|
erubi (1.7.0)
|
61
|
-
faraday (0.
|
66
|
+
faraday (0.14.0)
|
62
67
|
multipart-post (>= 1.2, < 3)
|
63
68
|
faraday_middleware (0.12.2)
|
64
69
|
faraday (>= 0.7.4, < 1.0)
|
@@ -75,6 +80,7 @@ GEM
|
|
75
80
|
nokogiri (>= 1.5.9)
|
76
81
|
mail (2.7.0)
|
77
82
|
mini_mime (>= 0.1.1)
|
83
|
+
memoist (0.16.0)
|
78
84
|
method_source (0.9.0)
|
79
85
|
mini_mime (1.0.0)
|
80
86
|
mini_portile2 (2.3.0)
|
@@ -147,7 +153,7 @@ GEM
|
|
147
153
|
actionpack (>= 4.0)
|
148
154
|
activesupport (>= 4.0)
|
149
155
|
sprockets (>= 3.0.0)
|
150
|
-
spyke (5.
|
156
|
+
spyke (5.3.0)
|
151
157
|
activemodel (>= 4.0.0, < 6.0)
|
152
158
|
activesupport (>= 4.0.0, < 6.0)
|
153
159
|
addressable (>= 2.5.2)
|
@@ -157,6 +163,7 @@ GEM
|
|
157
163
|
thread_safe (0.3.6)
|
158
164
|
tzinfo (1.2.4)
|
159
165
|
thread_safe (~> 0.1)
|
166
|
+
url (0.3.2)
|
160
167
|
vcr (4.0.0)
|
161
168
|
webmock (3.2.1)
|
162
169
|
addressable (>= 2.3.6)
|
@@ -170,12 +177,13 @@ PLATFORMS
|
|
170
177
|
ruby
|
171
178
|
|
172
179
|
DEPENDENCIES
|
173
|
-
bundler
|
180
|
+
bundler
|
181
|
+
codecov
|
174
182
|
cornucopia
|
175
183
|
gem-release
|
176
184
|
hashie
|
177
|
-
rake (~> 10
|
178
|
-
rspec
|
185
|
+
rake (~> 10)
|
186
|
+
rspec
|
179
187
|
rspec-rails
|
180
188
|
simplecov
|
181
189
|
simplecov-rcov
|
@@ -184,4 +192,4 @@ DEPENDENCIES
|
|
184
192
|
yext-api!
|
185
193
|
|
186
194
|
BUNDLED WITH
|
187
|
-
1.16.
|
195
|
+
1.16.1
|
@@ -0,0 +1,11 @@
|
|
1
|
+
## CHANGES
|
2
|
+
|
3
|
+
A brief description of the changes being made and the reason for the changes.
|
4
|
+
|
5
|
+
## DEVELOPER NOTES
|
6
|
+
|
7
|
+
- [ ] Notes on the code changes and what to pay particular attention to in the PR.
|
8
|
+
|
9
|
+
## TESTING NOTES
|
10
|
+
|
11
|
+
- [ ] Notes on Tests added and how to manually reproduce/test this on a live project.
|
data/README.md
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
[![Gem Version](https://badge.fury.io/rb/yext-api.svg)](https://badge.fury.io/rb/yext-api.svg)
|
2
|
+
[![CircleCI](https://circleci.com/gh/CardTapp/yext-api.svg?style=svg)](https://circleci.com/gh/CardTapp/yext-api)
|
3
|
+
[![codecov](https://codecov.io/gh/CardTapp/yext-api/branch/master/graph/badge.svg)](https://codecov.io/gh/CardTapp/yext-api)
|
4
|
+
[![Dependency Status](https://gemnasium.com/badges/github.com/CardTapp/yext-api.svg)](https://gemnasium.com/github.com/CardTapp/yext-api)
|
5
|
+
[![Maintainability](https://api.codeclimate.com/v1/badges/d80882f00aafa1ed5c7b/maintainability)](https://codeclimate.com/github/CardTapp/yext-api/maintainability)
|
6
|
+
|
1
7
|
# Yext::Api
|
2
8
|
|
3
9
|
This gem provides a Rails interface with the Yext API.
|
@@ -46,19 +52,19 @@ The global configurations can be initialized with ENV values. The following con
|
|
46
52
|
This is the Account ID that is used in the path to API endpoints that require an account ID. This
|
47
53
|
value will default to `"me"` if not specified.
|
48
54
|
|
49
|
-
You can specify this on a per-call basis using `
|
55
|
+
You can specify this on a per-call basis using `account("new account_id")`. This option is only
|
50
56
|
available for objects that require an account ID for all calls.
|
51
57
|
|
52
58
|
* `api_key` - `ENV["YEXT_API_KEY"]`
|
53
59
|
This is the API_KEY from the Yext Application that you are using.
|
54
60
|
|
55
|
-
You can specify this on a per-call basis using `
|
61
|
+
You can specify this on a per-call basis using `application("new application key")`.
|
56
62
|
|
57
63
|
* `api_version` - `ENV["YEXT_API_VERSION"]`
|
58
64
|
This is the version number of the `v2` API endpoint to be used. This value be defaulted to the most
|
59
65
|
recent version of the API that the gem is aware of or `"2016101"`
|
60
66
|
|
61
|
-
You can specify this on a per-call basis using `
|
67
|
+
You can specify this on a per-call basis using `version("new version")`.
|
62
68
|
|
63
69
|
* `yext_username` - `ENV["YEXT_USERNAME"]`
|
64
70
|
This is the username to be associated with changes in Yext. This option is available on all calls but
|
@@ -87,9 +93,21 @@ The global configurations can be initialized with ENV values. The following con
|
|
87
93
|
|
88
94
|
### General Usage
|
89
95
|
|
90
|
-
The API namespaces are setup to mimic the structure of the Yext API documentation to make it easier
|
91
|
-
to find or guess at an objects name. Objects are defined based on the routes for those objects.
|
92
|
-
|
96
|
+
The API namespaces are setup to mimic the structure of the Yext API documentation to make it easier
|
97
|
+
to find or guess at an objects name. Objects are defined based on the routes for those objects.
|
98
|
+
|
99
|
+
In general to see what an object will look like or what to pass in as arguments to some custom routes
|
100
|
+
that update or create objects, please refer to the Yext API documentation:
|
101
|
+
|
102
|
+
* http://developer.yext.com/docs/api-reference/
|
103
|
+
* http://developer.yext.com/docs/administrative-api/
|
104
|
+
* http://developer.yext.com/docs/live-api/
|
105
|
+
* http://developer.yext.com/docs/webhooks/
|
106
|
+
|
107
|
+
The config/api.yml file contains links to the documentation for every action. In general, each
|
108
|
+
class should also include the same information to point you at/to the related documentation.
|
109
|
+
|
110
|
+
The following classes are planned based on that structure:
|
93
111
|
|
94
112
|
* AdministrativeApi::Account
|
95
113
|
* AdministrativeApi::AddRequest
|
@@ -153,7 +171,7 @@ account = Yext::Api::AdministrativeApi::Account.find("my-id")
|
|
153
171
|
#### Overriding configuration options
|
154
172
|
|
155
173
|
```ruby
|
156
|
-
other_account_services = Yext::Api::AdministrativeApi::Service.
|
174
|
+
other_account_services = Yext::Api::AdministrativeApi::Service.account("6664444").application("777821019292928").to_a
|
157
175
|
```
|
158
176
|
|
159
177
|
#### Using custom actions
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Yext
|
4
|
+
module Api
|
5
|
+
module Agreements
|
6
|
+
# This controller processes Yext add_request webhook callbacks.
|
7
|
+
#
|
8
|
+
# The controller will call the add_request_changed function on the configured class
|
9
|
+
# for the add_request_changed function.
|
10
|
+
|
11
|
+
# :webhooks:
|
12
|
+
# :agreements:
|
13
|
+
# :add_request_update:
|
14
|
+
# :endpoint: https://[your_hostname]/[your_add_request_webhook_path]
|
15
|
+
# :default_version: 20161012
|
16
|
+
# :documentation: http://developer.yext.com/docs/webhooks/#operation/addRequestWebhook
|
17
|
+
# :sandbox_only: false
|
18
|
+
class AddRequestController < Yext::Api::ApplicationController
|
19
|
+
extend Memoist
|
20
|
+
|
21
|
+
def create
|
22
|
+
process_add_request_changed
|
23
|
+
|
24
|
+
head :ok
|
25
|
+
end
|
26
|
+
|
27
|
+
private
|
28
|
+
|
29
|
+
def process_add_request_changed
|
30
|
+
processor = Yext::Api.configuration.get_callback_processor(:add_request_changed)
|
31
|
+
|
32
|
+
return if processor.blank?
|
33
|
+
|
34
|
+
processor.new(processor_args[:meta],
|
35
|
+
Yext::Api::AdministrativeApi::AddRequest.new(processor_args[:addRequest]),
|
36
|
+
nil).
|
37
|
+
add_request_changed
|
38
|
+
end
|
39
|
+
|
40
|
+
def processor_args
|
41
|
+
params_hash.convert_epoch :meta, :timestamp
|
42
|
+
params_hash.convert_time :addRequest, :dateSubmitted
|
43
|
+
params_hash.convert_time :addRequest, :dateCompleted
|
44
|
+
|
45
|
+
params_hash.params
|
46
|
+
end
|
47
|
+
|
48
|
+
# rubocop:disable MethodLength
|
49
|
+
|
50
|
+
def params_hash
|
51
|
+
Yext::Api::Utils::Params.
|
52
|
+
new(params.
|
53
|
+
permit(meta: %i[eventType uuid timestamp accountId actor appSpecificAccountId],
|
54
|
+
addRequest: [:id,
|
55
|
+
:locationMode,
|
56
|
+
:existingLocationId,
|
57
|
+
:newLocationId,
|
58
|
+
:newLocationAccountId,
|
59
|
+
:newAccountParentAccountId,
|
60
|
+
:newLocationData,
|
61
|
+
{ skus: [] },
|
62
|
+
:agreementId,
|
63
|
+
:status,
|
64
|
+
:dateSubmitted,
|
65
|
+
:dateCompleted,
|
66
|
+
:statusDetail]).
|
67
|
+
to_hash.
|
68
|
+
with_indifferent_access)
|
69
|
+
end
|
70
|
+
|
71
|
+
# rubocop:enable MethodLength
|
72
|
+
|
73
|
+
memoize :processor_args,
|
74
|
+
:params_hash
|
75
|
+
end
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -1,12 +1,10 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
# :nocov:
|
4
3
|
module Yext
|
5
4
|
module Api
|
6
5
|
# The base class for the Engines controllers.
|
7
6
|
class ApplicationController < ActionController::Base
|
8
|
-
protect_from_forgery with: :exception
|
7
|
+
# protect_from_forgery with: :exception
|
9
8
|
end
|
10
9
|
end
|
11
10
|
end
|
12
|
-
# :nocov:
|
data/config/routes.rb
CHANGED
data/lib/config/api.yml
CHANGED
@@ -3,37 +3,12 @@
|
|
3
3
|
:objects:
|
4
4
|
:account:
|
5
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
6
|
- :action: :index
|
31
7
|
:method: :get
|
32
8
|
# :endpoint: https://api.yext.com/v2/accounts
|
33
9
|
# :path_regex: v2/accounts
|
34
10
|
:default_version: 20161012
|
35
11
|
: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
12
|
:sandbox_only: false
|
38
13
|
- :action: :show
|
39
14
|
:method: :get
|
@@ -41,7 +16,6 @@
|
|
41
16
|
# :path_regex: v2/accounts/[^/]+?
|
42
17
|
:default_version: 20161012
|
43
18
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/getAccount
|
44
|
-
:comment: Get details for an account.
|
45
19
|
:sandbox_only: false
|
46
20
|
- :action: :update
|
47
21
|
:method: :put
|
@@ -49,7 +23,6 @@
|
|
49
23
|
:path_regex: v2/accounts/[^/]+?
|
50
24
|
:default_version: 20161012
|
51
25
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/updateAccount
|
52
|
-
:comment: Update an account's name or ID.
|
53
26
|
:sandbox_only: false
|
54
27
|
:add_request:
|
55
28
|
:actions:
|
@@ -59,15 +32,34 @@
|
|
59
32
|
:path_regex: v2/accounts/[^/]+?/addrequests
|
60
33
|
:default_version: 20161012
|
61
34
|
: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
35
|
:sandbox_only: false
|
64
36
|
- :action: :show
|
65
37
|
:method: :get
|
66
38
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests/{addRequestId}
|
67
|
-
:path_regex: v2/accounts/[^/]+?/addrequests/[^/]
|
39
|
+
:path_regex: v2/accounts/[^/]+?/addrequests/[^/]+?
|
68
40
|
:default_version: 20161012
|
69
41
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/getAddRequest
|
70
|
-
:
|
42
|
+
:sandbox_only: false
|
43
|
+
- :action: :create
|
44
|
+
:method: :post
|
45
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/newlocationaddrequests
|
46
|
+
:path_regex: v2/accounts/[^/]+?/newlocationaddrequests
|
47
|
+
:default_version: 20161012
|
48
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createNewLocationAddRequest
|
49
|
+
:sandbox_only: false
|
50
|
+
- :action: :change_status
|
51
|
+
:method: :post
|
52
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/processaddrequest
|
53
|
+
:path_regex: v2/accounts/[^/]+?/processaddrequest
|
54
|
+
:default_version: 20161012
|
55
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createProcessReviewAddRequest
|
56
|
+
:sandbox_only: true
|
57
|
+
- :action: :add_services
|
58
|
+
:method: :post
|
59
|
+
:endpoint: https://api.yext.com/v2/accounts/{accountId}/existinglocationaddrequests
|
60
|
+
:path_regex: v2/accounts/[^/]+?/existinglocationaddrequests
|
61
|
+
:default_version: 20161012
|
62
|
+
:documentation: http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest
|
71
63
|
:sandbox_only: false
|
72
64
|
:service:
|
73
65
|
:actions:
|
@@ -77,7 +69,6 @@
|
|
77
69
|
:path_regex: v2/accounts/[^/]+?/availableservices
|
78
70
|
:default_version: 20161012
|
79
71
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listAvailableServices
|
80
|
-
:comment: Return list of services available to you under your agreements.
|
81
72
|
:sandbox_only: false
|
82
73
|
- :action: :index
|
83
74
|
:method: :get
|
@@ -85,7 +76,6 @@
|
|
85
76
|
:path_regex: v2/accounts/[^/]+?/services
|
86
77
|
:default_version: 20161012
|
87
78
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/listServices
|
88
|
-
:comment: Retrieve a list of all services provisioned through this account.
|
89
79
|
:sandbox_only: false
|
90
80
|
- :action: :destroy
|
91
81
|
:method: :post
|
@@ -93,7 +83,6 @@
|
|
93
83
|
:path_regex: v2/accounts/[^/]+?/cancelservices
|
94
84
|
:default_version: 20161012
|
95
85
|
:documentation: http://developer.yext.com/docs/administrative-api/#operation/cancelServices
|
96
|
-
:comment: Cancel one or more active services.
|
97
86
|
:sandbox_only: false
|
98
87
|
:knowledge_api:
|
99
88
|
:documentation: http://developer.yext.com/docs/api-reference/
|
@@ -107,7 +96,6 @@
|
|
107
96
|
:path_regex: v2/healthy
|
108
97
|
:default_version: 20161012
|
109
98
|
: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
99
|
:sandbox_only: false
|
112
100
|
:knowledge_manager:
|
113
101
|
:objects:
|
@@ -120,7 +108,6 @@
|
|
120
108
|
:path_regex: v2/accounts/[^/]+?/locations
|
121
109
|
:default_version: 20161012
|
122
110
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocations
|
123
|
-
:comment: Get multiple Locations (primary profiles only).
|
124
111
|
:sandbox_only: false
|
125
112
|
- :action: :create
|
126
113
|
:method: :post
|
@@ -128,7 +115,6 @@
|
|
128
115
|
:path_regex: v2/accounts/[^/]+?/locations
|
129
116
|
:default_version: 20161012
|
130
117
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createLocation
|
131
|
-
:comment: Create a new Location.
|
132
118
|
:sandbox_only: false
|
133
119
|
- :action: :search
|
134
120
|
:method: :get
|
@@ -136,23 +122,20 @@
|
|
136
122
|
:path_regex: v2/accounts/[^/]+?/locationsearch
|
137
123
|
:default_version: 20161012
|
138
124
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/searchLocations
|
139
|
-
:comment: Get multiple Locations (primary profiles only) that match provided filters.
|
140
125
|
:sandbox_only: false
|
141
126
|
- :action: :show
|
142
127
|
:method: :get
|
143
128
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
144
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
129
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?
|
145
130
|
:default_version: 20161012
|
146
131
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation
|
147
|
-
:comment: Gets the primary profile for a single Location.
|
148
132
|
:sandbox_only: false
|
149
133
|
- :action: :update
|
150
134
|
:method: :put
|
151
135
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
152
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
136
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?
|
153
137
|
:default_version: 20161012
|
154
138
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation
|
155
|
-
:comment: Updates the primary profile for a Location.
|
156
139
|
:sandbox_only: false
|
157
140
|
:folder:
|
158
141
|
:actions:
|
@@ -162,7 +145,6 @@
|
|
162
145
|
:path_regex: v2/accounts/[^/]+?/folders
|
163
146
|
:default_version: 20161012
|
164
147
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLocationFolders
|
165
|
-
:comment: Returns a list of Location Folders in an Account.
|
166
148
|
:sandbox_only: false
|
167
149
|
:menu:
|
168
150
|
:actions:
|
@@ -172,7 +154,6 @@
|
|
172
154
|
:path_regex: v2/accounts/[^/]+?/menus
|
173
155
|
:default_version: 20161012
|
174
156
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMenus
|
175
|
-
:comment: Retrieve all Menus for an account.
|
176
157
|
:sandbox_only: false
|
177
158
|
- :action: :create
|
178
159
|
:method: :post
|
@@ -180,31 +161,27 @@
|
|
180
161
|
:path_regex: v2/accounts/[^/]+?/menus
|
181
162
|
:default_version: 20161012
|
182
163
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createMenu
|
183
|
-
:comment: Create a new Menu.
|
184
164
|
:sandbox_only: false
|
185
165
|
- :action: :show
|
186
166
|
:method: :get
|
187
167
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
188
|
-
:path_regex: v2/accounts/[^/]+?/menus/[^/]
|
168
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+?
|
189
169
|
:default_version: 20161012
|
190
170
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMenu
|
191
|
-
:comment: Retrieve a specific Menu.
|
192
171
|
:sandbox_only: false
|
193
172
|
- :action: :update
|
194
173
|
:method: :put
|
195
174
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
196
|
-
:path_regex: v2/accounts/[^/]+?/menus/[^/]
|
175
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+?
|
197
176
|
:default_version: 20161012
|
198
177
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateMenu
|
199
|
-
:comment: Update an existing Menu.
|
200
178
|
:sandbox_only: false
|
201
179
|
- :action: :destroy
|
202
180
|
:method: :delete
|
203
181
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId}
|
204
|
-
:path_regex: v2/accounts/[^/]+?/menus/[^/]
|
182
|
+
:path_regex: v2/accounts/[^/]+?/menus/[^/]+?
|
205
183
|
:default_version: 20161012
|
206
184
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteMenuList
|
207
|
-
:comment: Delete an existing Menu.
|
208
185
|
:sandbox_only: false
|
209
186
|
:bio:
|
210
187
|
:actions:
|
@@ -214,7 +191,6 @@
|
|
214
191
|
:path_regex: v2/accounts/[^/]+?/bios
|
215
192
|
:default_version: 20161012
|
216
193
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBios
|
217
|
-
:comment: Retrieve all Bio Lists for an account.
|
218
194
|
:sandbox_only: false
|
219
195
|
- :action: :create
|
220
196
|
:method: :post
|
@@ -222,31 +198,27 @@
|
|
222
198
|
:path_regex: v2/accounts/[^/]+?/bios
|
223
199
|
:default_version: 20161012
|
224
200
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createBio
|
225
|
-
:comment: Create a new Bio List.
|
226
201
|
:sandbox_only: false
|
227
202
|
- :action: :show
|
228
203
|
:method: :get
|
229
204
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
230
|
-
:path_regex: v2/accounts/[^/]+?/bios/[^/]
|
205
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+?
|
231
206
|
:default_version: 20161012
|
232
207
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBio
|
233
|
-
:comment: Retrieve a specific Bio List.
|
234
208
|
:sandbox_only: false
|
235
209
|
- :action: :update
|
236
210
|
:method: :put
|
237
211
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
238
|
-
:path_regex: v2/accounts/[^/]+?/bios/[^/]
|
212
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+?
|
239
213
|
:default_version: 20161012
|
240
214
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateBio
|
241
|
-
:comment: Update an existing Bio List.
|
242
215
|
:sandbox_only: false
|
243
216
|
- :action: :destroy
|
244
217
|
:method: :delete
|
245
218
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId}
|
246
|
-
:path_regex: v2/accounts/[^/]+?/bios/[^/]
|
219
|
+
:path_regex: v2/accounts/[^/]+?/bios/[^/]+?
|
247
220
|
:default_version: 20161012
|
248
221
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteBioList
|
249
|
-
:comment: Delete an existing Bios List.
|
250
222
|
:sandbox_only: false
|
251
223
|
:product:
|
252
224
|
:actions:
|
@@ -256,7 +228,6 @@
|
|
256
228
|
:path_regex: v2/accounts/[^/]+?/products
|
257
229
|
:default_version: 20161012
|
258
230
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getProducts
|
259
|
-
:comment: Retrieve all Product Lists for an account.
|
260
231
|
:sandbox_only: false
|
261
232
|
- :action: :create
|
262
233
|
:method: :post
|
@@ -264,31 +235,27 @@
|
|
264
235
|
:path_regex: v2/accounts/[^/]+?/products
|
265
236
|
:default_version: 20161012
|
266
237
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createProduct
|
267
|
-
:comment: Create a new Product List.
|
268
238
|
:sandbox_only: false
|
269
239
|
- :action: :show
|
270
240
|
:method: :get
|
271
241
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
272
|
-
:path_regex: v2/accounts/[^/]+?/products/[^/]
|
242
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+?
|
273
243
|
:default_version: 20161012
|
274
244
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getProduct
|
275
|
-
:comment: Retrieve a specific Product List.
|
276
245
|
:sandbox_only: false
|
277
246
|
- :action: :update
|
278
247
|
:method: :put
|
279
248
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
280
|
-
:path_regex: v2/accounts/[^/]+?/products/[^/]
|
249
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+?
|
281
250
|
:default_version: 20161012
|
282
251
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateProduct
|
283
|
-
:comment: Update an existing Product List.
|
284
252
|
:sandbox_only: false
|
285
253
|
- :action: :destroy
|
286
254
|
:method: :delete
|
287
255
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId}
|
288
|
-
:path_regex: v2/accounts/[^/]+?/products/[^/]
|
256
|
+
:path_regex: v2/accounts/[^/]+?/products/[^/]+?
|
289
257
|
:default_version: 20161012
|
290
258
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteProductList
|
291
|
-
:comment: Delete an existing Products List.
|
292
259
|
:sandbox_only: false
|
293
260
|
:event:
|
294
261
|
:actions:
|
@@ -298,7 +265,6 @@
|
|
298
265
|
:path_regex: v2/accounts/[^/]+?/events
|
299
266
|
:default_version: 20161012
|
300
267
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getEvents
|
301
|
-
:comment: Retrieve all Event Lists for an account.
|
302
268
|
:sandbox_only: false
|
303
269
|
- :action: :create
|
304
270
|
:method: :post
|
@@ -306,31 +272,27 @@
|
|
306
272
|
:path_regex: v2/accounts/[^/]+?/events
|
307
273
|
:default_version: 20161012
|
308
274
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createEvent
|
309
|
-
:comment: Create a new Event List.
|
310
275
|
:sandbox_only: false
|
311
276
|
- :action: :show
|
312
277
|
:method: :get
|
313
278
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
314
|
-
:path_regex: v2/accounts/[^/]+?/events/[^/]
|
279
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+?
|
315
280
|
:default_version: 20161012
|
316
281
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getEvent
|
317
|
-
:comment: Retrieve a specific Event List.
|
318
282
|
:sandbox_only: false
|
319
283
|
- :action: :update
|
320
284
|
:method: :put
|
321
285
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
322
|
-
:path_regex: v2/accounts/[^/]+?/events/[^/]
|
286
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+?
|
323
287
|
:default_version: 20161012
|
324
288
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateEvent
|
325
|
-
:comment: Update an existing Event List.
|
326
289
|
:sandbox_only: false
|
327
290
|
- :action: :destroy
|
328
291
|
:method: :delete
|
329
292
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId}
|
330
|
-
:path_regex: v2/accounts/[^/]+?/events/[^/]
|
293
|
+
:path_regex: v2/accounts/[^/]+?/events/[^/]+?
|
331
294
|
:default_version: 20161012
|
332
295
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteEventList
|
333
|
-
:comment: Delete an existing Events List.
|
334
296
|
:sandbox_only: false
|
335
297
|
:category:
|
336
298
|
:actions:
|
@@ -340,7 +302,6 @@
|
|
340
302
|
:path_regex: v2/categories
|
341
303
|
:default_version: 20161012
|
342
304
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getBusinessCategories
|
343
|
-
:comment: Get available Categories.
|
344
305
|
:sandbox_only: false
|
345
306
|
:google_field:
|
346
307
|
:actions:
|
@@ -350,12 +311,6 @@
|
|
350
311
|
:path_regex: v2/googlefields
|
351
312
|
:default_version: 20161012
|
352
313
|
: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
314
|
:sandbox_only: false
|
360
315
|
:custom_field:
|
361
316
|
:actions:
|
@@ -365,7 +320,6 @@
|
|
365
320
|
:path_regex: v2/accounts/[^/]+?/customfields
|
366
321
|
:default_version: 20161012
|
367
322
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomFields
|
368
|
-
:comment: Returns a list of Custom Fields in an Account.
|
369
323
|
:sandbox_only: false
|
370
324
|
- :action: :create
|
371
325
|
:method: :post
|
@@ -373,31 +327,27 @@
|
|
373
327
|
:path_regex: v2/accounts/[^/]+?/customfields
|
374
328
|
:default_version: 20161012
|
375
329
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createCustomField
|
376
|
-
:comment: Creates a new Custom Field in an Account.
|
377
330
|
:sandbox_only: false
|
378
331
|
- :action: :show
|
379
332
|
:method: :get
|
380
333
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
381
|
-
:path_regex: v2/accounts/[^/]+?/customfields/[^/]
|
334
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+?
|
382
335
|
:default_version: 20161012
|
383
336
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomField
|
384
|
-
:comment: Gets a specific Custom Field in an Account.
|
385
337
|
:sandbox_only: false
|
386
338
|
- :action: :update
|
387
339
|
:method: :put
|
388
340
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
389
|
-
:path_regex: v2/accounts/[^/]+?/customfields/[^/]
|
341
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+?
|
390
342
|
:default_version: 20161012
|
391
343
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateCustomField
|
392
|
-
:comment: Updates a single Custom Field in an Account.
|
393
344
|
:sandbox_only: false
|
394
345
|
- :action: :destroy
|
395
346
|
:method: :delete
|
396
347
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId}
|
397
|
-
:path_regex: v2/accounts/[^/]+?/customfields/[^/]
|
348
|
+
:path_regex: v2/accounts/[^/]+?/customfields/[^/]+?
|
398
349
|
:default_version: 20161012
|
399
350
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteCustomField
|
400
|
-
:comment: Deletes a Custom Field in an Account.
|
401
351
|
:sandbox_only: false
|
402
352
|
:language_profile:
|
403
353
|
:belongs_to: location
|
@@ -405,36 +355,32 @@
|
|
405
355
|
- :action: :index
|
406
356
|
:method: :get
|
407
357
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles
|
408
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
358
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles
|
409
359
|
:default_version: 20161012
|
410
360
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfiles
|
411
|
-
:comment: Get Language Profiles for a Location.
|
412
361
|
:sandbox_only: false
|
413
362
|
- :action: :create
|
414
363
|
:alias: :update
|
415
364
|
- :action: :show
|
416
365
|
:method: :get
|
417
366
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
418
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
367
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?
|
419
368
|
:default_version: 20161012
|
420
369
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfile
|
421
|
-
:comment: Gets the the requested Language Profile for a given Location.
|
422
370
|
:sandbox_only: false
|
423
371
|
- :action: :update
|
424
372
|
:method: :put
|
425
373
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
426
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
374
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?
|
427
375
|
:default_version: 20161012
|
428
376
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLanguageProfile
|
429
|
-
:comment: Creates and / or sets the fields for a Language Profile
|
430
377
|
:sandbox_only: false
|
431
378
|
- :action: :destroy
|
432
379
|
:method: :delete
|
433
380
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code}
|
434
|
-
:path_regex: v2/accounts/[^/]+?/locations/[^/]
|
381
|
+
:path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?
|
435
382
|
:default_version: 20161012
|
436
383
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteLanguageProfile
|
437
|
-
:comment: Remove a Language Profile from a location.
|
438
384
|
:sandbox_only: false
|
439
385
|
:asset:
|
440
386
|
:actions:
|
@@ -444,7 +390,6 @@
|
|
444
390
|
:path_regex: v2/accounts/[^/]+?/assets
|
445
391
|
:default_version: 20161012
|
446
392
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAssets
|
447
|
-
:comment: List assets in an account.
|
448
393
|
:sandbox_only: false
|
449
394
|
- :action: :create
|
450
395
|
:method: :post
|
@@ -452,33 +397,30 @@
|
|
452
397
|
:path_regex: v2/accounts/[^/]+?/assets
|
453
398
|
:default_version: 20161012
|
454
399
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createAsset
|
455
|
-
:comment: Creates a new Asset in an account.
|
456
400
|
:sandbox_only: false
|
457
401
|
- :action: :show
|
458
402
|
:method: :get
|
459
403
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
460
|
-
:path_regex: v2/accounts/[^/]+?/assets/[^/]
|
404
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+?
|
461
405
|
:default_version: 20161012
|
462
406
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAsset
|
463
|
-
:comment: Get a specific asset.
|
464
407
|
:sandbox_only: false
|
465
408
|
- :action: :update
|
466
409
|
:method: :put
|
467
410
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
468
|
-
:path_regex: v2/accounts/[^/]+?/assets/[^/]
|
411
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+?
|
469
412
|
:default_version: 20161012
|
470
413
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateAsset
|
471
|
-
:comment: Update a specific asset.
|
472
414
|
:sandbox_only: false
|
473
415
|
- :action: :destroy
|
474
416
|
:method: :delete
|
475
417
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId}
|
476
|
-
:path_regex: v2/accounts/[^/]+?/assets/[^/]
|
418
|
+
:path_regex: v2/accounts/[^/]+?/assets/[^/]+?
|
477
419
|
:default_version: 20161012
|
478
420
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset
|
479
|
-
:comment: Delete a specific asset.
|
480
421
|
:sandbox_only: false
|
481
422
|
:power_listings:
|
423
|
+
:module_name: PowerListings
|
482
424
|
:objects:
|
483
425
|
:publishser:
|
484
426
|
:actions:
|
@@ -488,7 +430,6 @@
|
|
488
430
|
:path_regex: v2/accounts/[^/]+?/powerlistings/publishers
|
489
431
|
:default_version: 20161012
|
490
432
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/listPublishers
|
491
|
-
:comment: Retrieve a list of publishers included in an account's subscription.
|
492
433
|
:sandbox_only: false
|
493
434
|
:listing:
|
494
435
|
:actions:
|
@@ -498,7 +439,6 @@
|
|
498
439
|
:path_regex: v2/accounts/[^/]+?/powerlistings/listings
|
499
440
|
:default_version: 20161012
|
500
441
|
: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
442
|
:sandbox_only: false
|
503
443
|
- :action: :opt_in
|
504
444
|
:method: :put
|
@@ -506,7 +446,6 @@
|
|
506
446
|
:path_regex: v2/accounts/[^/]+?/powerlistings/listings/optin
|
507
447
|
:default_version: 20161012
|
508
448
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/optInListings
|
509
|
-
:comment: Opts designated locations into designated publishers.
|
510
449
|
:sandbox_only: false
|
511
450
|
- :action: :opt_out
|
512
451
|
:method: :put
|
@@ -514,7 +453,6 @@
|
|
514
453
|
:path_regex: v2/accounts/[^/]+?/powerlistings/listings/optout
|
515
454
|
:default_version: 20161012
|
516
455
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/optOutListings
|
517
|
-
:comment: Opts designated locations out of designated publishers.
|
518
456
|
:sandbox_only: false
|
519
457
|
:publisher_suggestion:
|
520
458
|
:actions:
|
@@ -524,23 +462,20 @@
|
|
524
462
|
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions
|
525
463
|
:default_version: 20161012
|
526
464
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/listPublisherSuggestions
|
527
|
-
:comment: Retrieve suggestions publishers have submitted for the Locations in an account.
|
528
465
|
:sandbox_only: false
|
529
466
|
- :action: :show
|
530
467
|
:method: :get
|
531
468
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId}
|
532
|
-
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]
|
469
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+?
|
533
470
|
:default_version: 20161012
|
534
471
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getPublisherSuggestion
|
535
|
-
:comment: Fetches details of a specific Publisher Suggestion.
|
536
472
|
:sandbox_only: false
|
537
473
|
- :action: :update
|
538
474
|
:method: :put
|
539
475
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId}
|
540
|
-
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]
|
476
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+?
|
541
477
|
:default_version: 20161012
|
542
478
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updatePublisherSuggestion
|
543
|
-
:comment: Accept or reject a Publisher Suggestion.
|
544
479
|
:sandbox_only: false
|
545
480
|
:duplicate:
|
546
481
|
:actions:
|
@@ -550,7 +485,6 @@
|
|
550
485
|
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates
|
551
486
|
:default_version: 20161012
|
552
487
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/listDuplicates
|
553
|
-
:comment: Retrieve Duplicates for an account.
|
554
488
|
:sandbox_only: false
|
555
489
|
- :action: :create
|
556
490
|
:method: :post
|
@@ -558,25 +492,23 @@
|
|
558
492
|
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates
|
559
493
|
:default_version: 20161012
|
560
494
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createDuplicate
|
561
|
-
:comment: Creates a new Duplicate with status SUPPRESSION_REQUESTED.
|
562
495
|
:sandbox_only: false
|
563
496
|
- :action: :destroy
|
564
497
|
:method: :delete
|
565
498
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId}
|
566
|
-
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]
|
499
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+?
|
567
500
|
:default_version: 20161012
|
568
501
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteDuplicate
|
569
|
-
:comment: Indicates that a Duplicate should be ignored.
|
570
502
|
:sandbox_only: false
|
571
503
|
- :action: :suppress
|
572
504
|
:method: :put
|
573
505
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId}
|
574
|
-
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]
|
506
|
+
:path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+?
|
575
507
|
:default_version: 20161012
|
576
508
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/suppressDuplicate
|
577
|
-
:comment: Request suppression of a Duplicate.
|
578
509
|
:sandbox_only: false
|
579
510
|
:analytics:
|
511
|
+
:module_name: Analytics
|
580
512
|
:objects:
|
581
513
|
:max_date:
|
582
514
|
:actions:
|
@@ -586,7 +518,6 @@
|
|
586
518
|
:path_regex: v2/accounts/[^/]+?/analytics/maxdates
|
587
519
|
:default_version: 20161012
|
588
520
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getMaxDates
|
589
|
-
:comment: The dates through which reporting data is available.
|
590
521
|
:sandbox_only: false
|
591
522
|
:report:
|
592
523
|
:actions:
|
@@ -596,15 +527,13 @@
|
|
596
527
|
:path_regex: v2/accounts/[^/]+?/analytics/reports
|
597
528
|
:default_version: 20161012
|
598
529
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReports
|
599
|
-
:comment: Begins the process of producing a report.
|
600
530
|
:sandbox_only: false
|
601
531
|
- :action: :show
|
602
532
|
:method: :get
|
603
533
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/standardreports/{reportId}
|
604
|
-
:path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]
|
534
|
+
:path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]+?
|
605
535
|
:default_version: 20161012
|
606
536
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/reportStatus
|
607
|
-
:comment: Checks the status of a Report created with async=true.
|
608
537
|
:sandbox_only: false
|
609
538
|
:activity:
|
610
539
|
:actions:
|
@@ -614,9 +543,9 @@
|
|
614
543
|
:path_regex: v2/accounts/[^/]+?/analytics/activity
|
615
544
|
:default_version: 20161012
|
616
545
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/activityLog
|
617
|
-
:comment: Fetches account activity information.
|
618
546
|
:sandbox_only: false
|
619
547
|
:reviews:
|
548
|
+
:module_name: Reviews
|
620
549
|
:objects:
|
621
550
|
:review:
|
622
551
|
:has_many: comments
|
@@ -627,7 +556,6 @@
|
|
627
556
|
:path_regex: v2/accounts/[^/]+?/reviews
|
628
557
|
:default_version: 20161012
|
629
558
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/listReviews
|
630
|
-
:comment: Retrieve all Reviews matching the given criteria.
|
631
559
|
:sandbox_only: false
|
632
560
|
- :action: :create
|
633
561
|
:method: :post
|
@@ -635,23 +563,20 @@
|
|
635
563
|
:path_regex: v2/accounts/[^/]+?/reviews
|
636
564
|
:default_version: 20161012
|
637
565
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReview
|
638
|
-
:comment: Create a new External First Party Review.
|
639
566
|
:sandbox_only: false
|
640
567
|
- :action: :show
|
641
568
|
:method: :get
|
642
569
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}
|
643
|
-
:path_regex: v2/accounts/[^/]+?/reviews/[^/]
|
570
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+?
|
644
571
|
:default_version: 20161012
|
645
572
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReview
|
646
|
-
:comment: Retrieve a specific Review.
|
647
573
|
:sandbox_only: false
|
648
574
|
- :action: :update
|
649
575
|
:method: :put
|
650
576
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}
|
651
|
-
:path_regex: v2/accounts/[^/]+?/reviews/[^/]
|
577
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+?
|
652
578
|
:default_version: 20161012
|
653
579
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateReview
|
654
|
-
:comment: Updates an External First Party Review.
|
655
580
|
:sandbox_only: false
|
656
581
|
:comment:
|
657
582
|
:belongs_to: review
|
@@ -659,10 +584,9 @@
|
|
659
584
|
- :action: :create
|
660
585
|
:method: :post
|
661
586
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}/comments
|
662
|
-
:path_regex: v2/accounts/[^/]+?/reviews/[^/]
|
587
|
+
:path_regex: v2/accounts/[^/]+?/reviews/[^/]+?/comments
|
663
588
|
:default_version: 20161012
|
664
589
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createComment
|
665
|
-
:comment: Creates a new Comment on a Review.
|
666
590
|
:sandbox_only: false
|
667
591
|
:review_invitation:
|
668
592
|
:actions:
|
@@ -672,7 +596,6 @@
|
|
672
596
|
:path_regex: v2/accounts/[^/]+?/reviewinvites
|
673
597
|
:default_version: 20161012
|
674
598
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/listReviewInvitations
|
675
|
-
:comment: Retrieves all review invitations for an account.
|
676
599
|
:sandbox_only: false
|
677
600
|
- :action: :create
|
678
601
|
:method: :post
|
@@ -680,15 +603,13 @@
|
|
680
603
|
:path_regex: v2/accounts/[^/]+?/reviewinvites
|
681
604
|
:default_version: 20161012
|
682
605
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createReviewInvites
|
683
|
-
:comment: Sends review invitations to one or more consumers.
|
684
606
|
:sandbox_only: false
|
685
607
|
- :action: :show
|
686
608
|
:method: :get
|
687
609
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites/{invitationId}
|
688
|
-
:path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]
|
610
|
+
:path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]+?
|
689
611
|
:default_version: 20161012
|
690
612
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewInvitation
|
691
|
-
:comment: Retrieve a specific review invitation.
|
692
613
|
:sandbox_only: false
|
693
614
|
:review_generation_setting:
|
694
615
|
:actions:
|
@@ -698,7 +619,6 @@
|
|
698
619
|
:path_regex: v2/accounts/[^/]+?/reviews/settings/generation
|
699
620
|
:default_version: 20161012
|
700
621
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewGenerationSettings
|
701
|
-
:comment: Returns all current generation settings for a specified account.
|
702
622
|
:sandbox_only: false
|
703
623
|
- :action: :create
|
704
624
|
:alias: :update
|
@@ -708,9 +628,6 @@
|
|
708
628
|
:path_regex: v2/accounts/[^/]+?/reviews/settings/generation
|
709
629
|
:default_version: 20161012
|
710
630
|
: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
631
|
:sandbox_only: false
|
715
632
|
:social:
|
716
633
|
:objects:
|
@@ -723,7 +640,6 @@
|
|
723
640
|
:path_regex: v2/accounts/[^/]+?/posts
|
724
641
|
:default_version: 20161012
|
725
642
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getPosts
|
726
|
-
:comment: Retrieve list of Posts.
|
727
643
|
:sandbox_only: false
|
728
644
|
- :action: :create
|
729
645
|
:method: :post
|
@@ -731,15 +647,13 @@
|
|
731
647
|
:path_regex: v2/accounts/[^/]+?/posts
|
732
648
|
:default_version: 20161012
|
733
649
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createPosts
|
734
|
-
:comment: Create a new Post.
|
735
650
|
:sandbox_only: false
|
736
651
|
- :action: :destroy
|
737
652
|
:method: :delete
|
738
653
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}
|
739
|
-
:path_regex: v2/accounts/[^/]+?/posts/[^/]
|
654
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+?
|
740
655
|
:default_version: 20161012
|
741
656
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deletePost
|
742
|
-
:comment: Deletes an existing Post.
|
743
657
|
:sandbox_only: false
|
744
658
|
:comment:
|
745
659
|
:belongs_to: post
|
@@ -747,34 +661,30 @@
|
|
747
661
|
- :action: :index
|
748
662
|
:method: :get
|
749
663
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments
|
750
|
-
:path_regex: v2/accounts/[^/]+?/posts/[^/]
|
664
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments
|
751
665
|
:default_version: 20161012
|
752
666
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getComments
|
753
|
-
:comment: Retrieve list of Comments for a Post.
|
754
667
|
:sandbox_only: false
|
755
668
|
- :action: :create
|
756
669
|
:method: :post
|
757
670
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments
|
758
|
-
:path_regex: v2/accounts/[^/]+?/posts/[^/]
|
671
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments
|
759
672
|
:default_version: 20161012
|
760
673
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createComment
|
761
|
-
:comment: Create a new Comment in response to another Post / Comment.
|
762
674
|
:sandbox_only: false
|
763
675
|
- :action: :update
|
764
676
|
:method: :put
|
765
677
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId}
|
766
|
-
:path_regex: v2/accounts/[^/]+?/posts/[^/]
|
678
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments/[^/]+?
|
767
679
|
:default_version: 20161012
|
768
680
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateComment
|
769
|
-
:comment: Updates an existing Comment.
|
770
681
|
:sandbox_only: false
|
771
682
|
- :action: :destroy
|
772
683
|
:method: :delete
|
773
684
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId}
|
774
|
-
:path_regex: v2/accounts/[^/]+?/posts/[^/]
|
685
|
+
:path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments/[^/]+?
|
775
686
|
:default_version: 20161012
|
776
687
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteComment
|
777
|
-
:comment: Deletes an existing Comment.
|
778
688
|
:sandbox_only: false
|
779
689
|
:linked_account:
|
780
690
|
:actions:
|
@@ -784,25 +694,23 @@
|
|
784
694
|
:path_regex: v2/accounts/[^/]+?/linkedaccounts
|
785
695
|
:default_version: 20161012
|
786
696
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccounts
|
787
|
-
:comment: Retrieve all Linked Accounts and their last known statuses.
|
788
697
|
:sandbox_only: false
|
789
698
|
- :action: :show
|
790
699
|
:method: :get
|
791
700
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId}
|
792
|
-
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]
|
701
|
+
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+?
|
793
702
|
:default_version: 20161012
|
794
703
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccount
|
795
|
-
:comment: Retrieve a specific Linked Account.
|
796
704
|
:sandbox_only: false
|
797
705
|
- :action: :update
|
798
706
|
:method: :put
|
799
707
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId}
|
800
|
-
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]
|
708
|
+
:path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+?
|
801
709
|
:default_version: 20161012
|
802
710
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateLinkedAccount
|
803
|
-
:comment: Assign or Unassign a Linked Account to one or more Locations.
|
804
711
|
:sandbox_only: false
|
805
712
|
:account_settings:
|
713
|
+
:module_name: AccountSettings
|
806
714
|
:objects:
|
807
715
|
:role:
|
808
716
|
:actions:
|
@@ -812,7 +720,6 @@
|
|
812
720
|
:path_regex: v2/accounts/[^/]+?/roles
|
813
721
|
:default_version: 20161012
|
814
722
|
: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
723
|
:sandbox_only: false
|
817
724
|
:user:
|
818
725
|
:actions:
|
@@ -822,7 +729,6 @@
|
|
822
729
|
:path_regex: v2/accounts/[^/]+?/users
|
823
730
|
:default_version: 20161012
|
824
731
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getUsers
|
825
|
-
:comment: Lists all Users in an account.
|
826
732
|
:sandbox_only: false
|
827
733
|
- :action: :create
|
828
734
|
:method: :post
|
@@ -830,39 +736,34 @@
|
|
830
736
|
:path_regex: v2/accounts/[^/]+?/users
|
831
737
|
:default_version: 20161012
|
832
738
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/createUser
|
833
|
-
:comment: Create a new User.
|
834
739
|
:sandbox_only: false
|
835
740
|
- :action: :show
|
836
741
|
:method: :get
|
837
742
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
838
|
-
:path_regex: v2/accounts/[^/]+?/users/[^/]
|
743
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+?
|
839
744
|
:default_version: 20161012
|
840
745
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getUser
|
841
|
-
:comment: Retrieves details of a specific User.
|
842
746
|
:sandbox_only: false
|
843
747
|
- :action: :update
|
844
748
|
:method: :put
|
845
749
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
846
|
-
:path_regex: v2/accounts/[^/]+?/users/[^/]
|
750
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+?
|
847
751
|
:default_version: 20161012
|
848
752
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser
|
849
|
-
:comment: Updates an existing User.
|
850
753
|
:sandbox_only: false
|
851
754
|
- :action: :destroy
|
852
755
|
:method: :delete
|
853
756
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
|
854
|
-
:path_regex: v2/accounts/[^/]+?/users/[^/]
|
757
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+?
|
855
758
|
:default_version: 20161012
|
856
759
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser
|
857
|
-
:comment: Deletes an existing User.
|
858
760
|
:sandbox_only: false
|
859
761
|
- :action: :change_password
|
860
762
|
:method: :put
|
861
763
|
:endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}/password
|
862
|
-
:path_regex: v2/accounts/[^/]+?/users/[^/]
|
764
|
+
:path_regex: v2/accounts/[^/]+?/users/[^/]+?/password
|
863
765
|
:default_version: 20161012
|
864
766
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword
|
865
|
-
:comment: Updates a User's password.
|
866
767
|
:sandbox_only: false
|
867
768
|
:account:
|
868
769
|
:actions:
|
@@ -872,9 +773,6 @@
|
|
872
773
|
:path_regex: v2/accounts
|
873
774
|
:default_version: 20161012
|
874
775
|
: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
776
|
:sandbox_only: false
|
879
777
|
- :action: :show
|
880
778
|
:method: :get
|
@@ -882,9 +780,9 @@
|
|
882
780
|
:path_regex: v2/accounts/[^/]+?
|
883
781
|
:default_version: 20161012
|
884
782
|
:documentation: http://developer.yext.com/docs/api-reference/#operation/getAccount
|
885
|
-
:comment: Get details for an account.
|
886
783
|
:sandbox_only: false
|
887
784
|
:optimization_tasks:
|
785
|
+
:module_name: OptimizationTasks
|
888
786
|
:objects:
|
889
787
|
:optimization_task:
|
890
788
|
:actions:
|
@@ -894,7 +792,6 @@
|
|
894
792
|
:path_regex: v2/accounts/[^/]+?/optimizationtasks
|
895
793
|
:default_version: 20161012
|
896
794
|
: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
795
|
:sandbox_only: false
|
899
796
|
- :action: :show
|
900
797
|
:method: :get
|
@@ -902,7 +799,6 @@
|
|
902
799
|
:path_regex: v2/accounts/[^/]+?/optimizationlink
|
903
800
|
:default_version: 20161012
|
904
801
|
: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
802
|
:sandbox_only: false
|
907
803
|
:live_api:
|
908
804
|
:documentation: http://developer.yext.com/docs/live-api/
|
@@ -912,40 +808,36 @@
|
|
912
808
|
- :action: :show
|
913
809
|
:method: :get
|
914
810
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/menus/{listId}
|
915
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/menus/[^/]
|
811
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/menus/[^/]+?
|
916
812
|
:default_version: 20161012
|
917
813
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getMenus
|
918
|
-
:comment: Retrieve a specific Menu.
|
919
814
|
:sandbox_only: false
|
920
815
|
:bio:
|
921
816
|
:actions:
|
922
817
|
- :action: :show
|
923
818
|
:method: :get
|
924
819
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/bios/{listId}
|
925
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/bios/[^/]
|
820
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/bios/[^/]+?
|
926
821
|
:default_version: 20161012
|
927
822
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getBios
|
928
|
-
:comment: Retrieve a specific Bios ECL.
|
929
823
|
:sandbox_only: false
|
930
824
|
:product:
|
931
825
|
:actions:
|
932
826
|
- :action: :show
|
933
827
|
:method: :get
|
934
828
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/products/{listId}
|
935
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/products/[^/]
|
829
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/products/[^/]+?
|
936
830
|
:default_version: 20161012
|
937
831
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getProducts
|
938
|
-
:comment: Retrieve a specific Products ECL.
|
939
832
|
:sandbox_only: false
|
940
833
|
:event:
|
941
834
|
:actions:
|
942
835
|
- :action: :show
|
943
836
|
:method: :get
|
944
837
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/events/{listId}
|
945
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/events/[^/]
|
838
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/events/[^/]+?
|
946
839
|
:default_version: 20161012
|
947
840
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getEvents
|
948
|
-
:comment: Retrieve a specific Events ECL.
|
949
841
|
:sandbox_only: false
|
950
842
|
:language_profile:
|
951
843
|
:belongs_to: location
|
@@ -954,18 +846,16 @@
|
|
954
846
|
- :action: :index
|
955
847
|
:method: :get
|
956
848
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/
|
957
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]
|
849
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/
|
958
850
|
:default_version: 20161012
|
959
851
|
:documentation: http://developer.yext.com/docs/live-api/#operation/listLanguageProfiles
|
960
|
-
:comment: Gets all Language Profiles for a Location.
|
961
852
|
:sandbox_only: false
|
962
853
|
- :action: :show
|
963
854
|
:method: :get
|
964
855
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}
|
965
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]
|
856
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?
|
966
857
|
:default_version: 20161012
|
967
858
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfiles
|
968
|
-
:comment: Gets the requested Language Profile for a given Location.
|
969
859
|
:sandbox_only: false
|
970
860
|
:language_profile_schema:
|
971
861
|
:belongs_to: language_profile
|
@@ -973,12 +863,25 @@
|
|
973
863
|
- :action: :show
|
974
864
|
:method: :get
|
975
865
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}/schema
|
976
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]
|
866
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?/schema
|
977
867
|
:default_version: 20161012
|
978
868
|
:documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfilesSchema
|
979
|
-
:
|
980
|
-
|
981
|
-
|
869
|
+
:sandbox_only: false
|
870
|
+
:location_schema:
|
871
|
+
:actions:
|
872
|
+
- :action: :show
|
873
|
+
:method: :get
|
874
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/schema
|
875
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/schema
|
876
|
+
:default_version: 20161012
|
877
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/getLocationSchema
|
878
|
+
:sandbox_only: false
|
879
|
+
- :action: :geo_search
|
880
|
+
:method: :get
|
881
|
+
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/geosearch
|
882
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/geosearch
|
883
|
+
:default_version: 20161012
|
884
|
+
:documentation: http://developer.yext.com/docs/live-api/#operation/geoSearch
|
982
885
|
:sandbox_only: false
|
983
886
|
:location:
|
984
887
|
:has_many: language_profile
|
@@ -990,40 +893,13 @@
|
|
990
893
|
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations
|
991
894
|
:default_version: 20161012
|
992
895
|
: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
896
|
:sandbox_only: false
|
997
897
|
- :action: :show
|
998
898
|
:method: :get
|
999
899
|
:endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}
|
1000
|
-
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]
|
900
|
+
:path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?
|
1001
901
|
:default_version: 20161012
|
1002
902
|
: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
903
|
:sandbox_only: false
|
1028
904
|
:webhooks:
|
1029
905
|
:documentation: http://developer.yext.com/docs/webhooks/
|
@@ -1032,69 +908,58 @@
|
|
1032
908
|
:endpoint: https://[your_hostname]/[your_locations_webhook_path]
|
1033
909
|
:default_version: 20161012
|
1034
910
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/locationsWebhook
|
1035
|
-
:comment: Sends an updated Location to your server.
|
1036
911
|
:sandbox_only: false
|
1037
912
|
:menu:
|
1038
913
|
:endpoint: https://[your_hostname]/[your_menus_webhook_path]
|
1039
914
|
:default_version: 20161012
|
1040
915
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/menusWebhook
|
1041
|
-
:comment: Sends an updated Menu object to your server.
|
1042
916
|
:sandbox_only: false
|
1043
917
|
:bio:
|
1044
918
|
:endpoint: https://[your_hostname]/[your_bios_webhook_path]
|
1045
919
|
:default_version: 20161012
|
1046
920
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/biosWebhook
|
1047
|
-
:comment: Sends an updated Bios object to your server.
|
1048
921
|
:sandbox_only: false
|
1049
922
|
:product:
|
1050
923
|
:endpoint: https://[your_hostname]/[your_products_webhook_path]
|
1051
924
|
:default_version: 20161012
|
1052
925
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/productsWebhook
|
1053
|
-
:comment: Sends an updated Product List object to your server.
|
1054
926
|
:sandbox_only: false
|
1055
927
|
:event:
|
1056
928
|
:endpoint: https://[your_hostname]/[your_events_webhook_path]
|
1057
929
|
:default_version: 20161012
|
1058
930
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/eventsWebhook
|
1059
|
-
:comment: Sends an updated Events List (Calendar) object to your server.
|
1060
931
|
:sandbox_only: false
|
1061
932
|
:power_listings:
|
1062
933
|
:listing:
|
1063
934
|
:endpoint: https://[your_hostname]/[your_listings_webhook_path]
|
1064
935
|
:default_version: 20161012
|
1065
936
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/listingsWebhook
|
1066
|
-
:comment: Sends an updated Listing object to your server.
|
1067
937
|
:sandbox_only: false
|
1068
938
|
:duplicate:
|
1069
939
|
:endpoint: https://[your_hostname]/[your_duplicates_webhook_path]
|
1070
940
|
:default_version: 20161012
|
1071
941
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/duplicatesWebhook
|
1072
|
-
:comment: Sends an updated Duplicate object to your server.
|
1073
942
|
:sandbox_only: false
|
1074
943
|
:publisher_suggestion:
|
1075
944
|
:endpoint: https://[your_hostname]/[your_publisherSuggestions_webhook_path]
|
1076
945
|
:default_version: 20161012
|
1077
946
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/publisherSuggestionsWebhook
|
1078
|
-
:comment: Sends an updated Publisher Suggestion object to your server.
|
1079
947
|
:sandbox_only: false
|
1080
948
|
:reviews:
|
1081
949
|
:review:
|
1082
950
|
:endpoint: https://[your_hostname]/[your_reviews_webhook_path]
|
1083
951
|
:default_version: 20161012
|
1084
952
|
: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
953
|
:sandbox_only: false
|
1087
954
|
:app_directory:
|
1088
955
|
:review:
|
1089
956
|
:endpoint: https://[your_hostname]/[your_unlink_account_webhook_path]
|
1090
957
|
:default_version: 20161012
|
1091
958
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/unlinkWebhook
|
1092
|
-
:comment: Fired when an account uninstalls your App.
|
1093
959
|
:sandbox_only: false
|
1094
960
|
:agreements:
|
1095
961
|
:add_request_update:
|
1096
962
|
:endpoint: https://[your_hostname]/[your_add_request_webhook_path]
|
1097
963
|
:default_version: 20161012
|
1098
964
|
:documentation: http://developer.yext.com/docs/webhooks/#operation/addRequestWebhook
|
1099
|
-
:comment: Fired when an Add Request is updated.
|
1100
965
|
:sandbox_only: false
|