com.what3words.javawrapper.services.What3WordsV3Service Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of w3w-java-wrapper Show documentation

Java library for what3words REST API.

There is a newer version: 3.1.21

package com.what3words.javawrapper.services;

import com.what3words.javawrapper.response.Autosuggest;
import com.what3words.javawrapper.response.AvailableLanguages;
import com.what3words.javawrapper.response.ConvertTo3WA;
import com.what3words.javawrapper.response.ConvertToCoordinates;
import com.what3words.javawrapper.response.GridSection;

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;

public interface What3WordsV3Service {
    @GET("convert-to-3wa")
    Call convertTo3wa(@Query("coordinates") String coordinates, @Query("language") String language);
    
    @GET("convert-to-coordinates")
    Call convertToCoordinates(@Query("words") String addr);
    
    @GET("autosuggest")
    Call autosuggest(
            @Query("input") String input, 
            @Query("n-results") String nResults, 
            @Query("focus") String focus,
            @Query("n-focus-results") String nFocusResults,
            @Query("clip-to-country") String clipToCountry,
            @Query("clip-to-bounding-box") String clipToBoundingBox,
            @Query("clip-to-circle") String clipToCircle,
            @Query("clip-to-polygon") String clipToPolygon,
            @Query("input-type") String inputType,
            @Query("language") String lang,
            @Query("prefer-land") String preferLand
            );
    
    @GET("grid-section")
    Call gridSection(@Query("bounding-box") String bbox);
    
    @GET("available-languages")
    Call availableLanguages();
}