diff --git a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingCriteria.java b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingCriteria.java index 69c2f71c3..94b3edaef 100644 --- a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingCriteria.java +++ b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingCriteria.java @@ -20,7 +20,7 @@ public final class GeocodingCriteria { public static final String MODE_PLACES = "mapbox.places"; /** - * Geocoding mode for enterprise/batch geocoding. + * Geocoding mode for batch and permanent geocoding. For more information about this mode, contact Mapbox sales. * * @since 1.0.0 */ diff --git a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingService.java b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingService.java index 79817e503..c6723fa46 100644 --- a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingService.java +++ b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/GeocodingService.java @@ -22,7 +22,7 @@ public interface GeocodingService { * {@link MapboxGeocoding.Builder}. * * @param userAgent The user - * @param mode mapbox.places or mapbox.places-permanent for enterprise geocoding. + * @param mode mapbox.places or mapbox.places-permanent for batch and permanent geocoding. * @param query a location; a place name for forward geocoding or a coordinate pair * (longitude, latitude location) for reverse geocoding * @param accessToken Mapbox access token. diff --git a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/MapboxGeocoding.java b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/MapboxGeocoding.java index 13eaf4486..70ae644fc 100644 --- a/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/MapboxGeocoding.java +++ b/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/MapboxGeocoding.java @@ -43,8 +43,9 @@ * states and countries that contain the given coordinates. *

* Batch Geocoding - * This feature is limited to enterprise customers only and the {@link #mode()} must be set to + * The {@link #mode()} must be set to * {@link GeocodingCriteria#MODE_PLACES_PERMANENT}. + * For more information about batch geocoding, contact Mapbox sales. *

* Batch requests have the same parameters as normal requests, but can include more than one query * by using {@link MapboxGeocoding.Builder#query(String)} and separating queries with the {@code ;} @@ -231,10 +232,12 @@ public static Builder builder() { /** * This builder is used to create a new request to the Mapbox Geocoding API. At a bare minimum, * your request must include an access token and a query of some kind. All other fields can - * be left alone inorder to use the default behaviour of the API. + * be left alone in order to use the default behaviour of the API. *

- * By default, the geocoding mode is set to places but can be changed to batch if you have an - * enterprise Mapbox plan. + * By default, the geocoding mode is set to mapbox.places. + * The mode can be changed to mapbox.places-permanent + * to enable batch and permanent geocoding. For more information about + * mapbox.places-permanent, contact Mapbox sales. *

* Note to contributors: All optional booleans in this builder use the object {@code Boolean} * rather than the primitive to allow for unset (null) values. @@ -251,9 +254,9 @@ public abstract static class Builder { /** * Perform a reverse geocode on the provided {@link Point}. Only one point can be passed in as - * the query and isn't guaranteed to return a result. If you are an enterprise customer and - * wanting to do a batch reverse Geocode, you can use the {@link #query(String)} method - * separating them with a semicolon. + * the query and isn't guaranteed to return a result. If you + * want to do a batch reverse Geocode, you can use the {@link #query(String)} method + * separating them with a semicolon. For more information about batch geocoding, contact Mapbox sales. * * @param point a GeoJSON point which matches to coordinate you'd like to reverse geocode * @return this builder for chaining options together @@ -268,8 +271,9 @@ public Builder query(@NonNull Point point) { /** * This method can be used for performing a forward geocode on a string representing a address - * or POI. If you are an enterprise customer and wish to perform a batch geocode, separate your - * queries with a semicolon. + * or POI. If you want to perform a batch geocode, separate your + * queries with a semicolon. For more information about batch geocoding, + * contact Mapbox sales. * * @param query a String containing the text you'd like to forward geocode * @return this builder for chaining options together @@ -281,15 +285,16 @@ public Builder query(@NonNull Point point) { * This sets the kind of geocoding result you desire, either ephemeral geocoding or batch * geocoding. *

- * Note tht batch geocoding's only available to users under a enterprise plan and will return an - * error code rather than a successful result. + * To access batch geocoding, contact Mapbox sales. + * If you do not have access to batch geocoding, it will return + * an error code rather than a successful result. *

* Options avaliable to pass in include, {@link GeocodingCriteria#MODE_PLACES} for a ephemeral - * geocoding result (default) or {@link GeocodingCriteria#MODE_PLACES_PERMANENT} for enterprise - * batch geocoding. + * geocoding result (default) or {@link GeocodingCriteria#MODE_PLACES_PERMANENT} for + * batch and permanent geocoding. *

* - * @param mode mapbox.places or mapbox.places-permanent for enterprise/batch geocoding + * @param mode mapbox.places or mapbox.places-permanent for batch and permanent geocoding * @return this builder for chaining options together * @since 1.0.0 */