Top 4.7% forks on proxy.golang.org
proxy.golang.org : github.com/yext/yext-go
Package yext provides bindings for Yext Location Cloud APIs. For full documentation visit http://developer.yext.com/docs/api-reference/ Create an authenticated client (requires an API key) List all locations Fetch a single location Create a new location (see full documentation for required fields) Edit an existing location The behavior of the API client can be controlled with a Config instance. The Config type exposes chainable utility methods to make construction simpler. By default, clients will retry API requests up to 3 times in the case of non-4xx errors including HTTP transport, 5xx responses, etc. This can be modified via Config: In order to support partial object updates, many of the struct attributes are represented as pointers in order to differentiate between "not-present" and "zero-valued". Helpers are provided to make it easier to work with the pointers: In addition, accessors are provided to make extracting data from the model objects simpler: Errors returned from the API are surfaced as Errors objects. The Errors object is comprised of a list of errors, each with a Message, Code, and Type. A full list of expected errors can be found here: http://developer.yext.com/support/error-messages/ Most functions that interact with the API will return at least two parameters - a yext.Response object and an error. Response contains a Meta substructure that in turn has a UUID and Errors attribute. The UUID can be used to look up individual requests in the developer.yext.com portal, useful for debugging requests. Most of the functionality within the API is exposed via domain-specific services available under the `Client` object. For example, if you are interacting with Locations, use the Client instance's LocationService. If you need to interact with Users, you'd use the UserService. Each service provides a set of common data-access functions that you can use to interact with objects under the service's domain. Where appropriate, services will expose additional, domain-specific functionality.
Registry
-
Source
- Documentation
- JSON
purl: pkg:golang/github.com/yext/yext-go
License: MIT
Latest release: over 1 year ago
First release: over 6 years ago
Namespace: github.com/yext
Stars: 7 on GitHub
Forks: 5 on GitHub
See more repository details: repos.ecosyste.ms
Last synced: 11 days ago