RidesService (sdk 0.6.0 API)

```
public interface RidesService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`retrofit2.Call<java.lang.Void>`	`cancelCurrentRide()` Cancels the current ride of a user.
`retrofit2.Call<java.lang.Void>`	`cancelRide(java.lang.String rideId)` Cancels an ongoing Ride for a user.
`retrofit2.Call<RideEstimate>`	`estimateRide(RideRequestParameters rideRequestParameters)` The request estimate endpoint allows a ride to be estimated given the desired product, start, and end locations.
`retrofit2.Call<Ride>`	`getCurrentRide()` Gets the current ride a user is on.
`retrofit2.Call<PaymentMethodsResponse>`	`getPaymentMethods()` Gets the `PaymentMethods` of user and their last used method ID.
`retrofit2.Call<TimeEstimatesResponse>`	`getPickupTimeEstimate(float startLatitude, float startLongitude, java.lang.String productId)` Gets ETAs for all products offered at a given location, with the responses expressed as integers in seconds.
`retrofit2.Call<Place>`	`getPlace(java.lang.String placeId)` Gets information about a user's Place.
`retrofit2.Call<PriceEstimatesResponse>`	`getPriceEstimates(float startLatitude, float startLongitude, float endLatitude, float endLongitude)` Gets an estimated price range for each product offered at a given location.
`retrofit2.Call<Product>`	`getProduct(java.lang.String productId)` Gets information about a specific product.
`retrofit2.Call<ProductsResponse>`	`getProducts(float latitude, float longitude)` Gets information about the products offered at a given location.
`retrofit2.Call<Promotion>`	`getPromotions(float startLatitude, float startLongitude, float endLatitude, float endLongitude)` Gets information about the promotion that will be available to a new user based on their activity's location.
`retrofit2.Call<Ride>`	`getRideDetails(java.lang.String rideId)` Gets details about a specific ride.
`retrofit2.Call<RideMap>`	`getRideMap(java.lang.String rideId)` Get a map with a visual representation of a ride for tracking purposes.
`retrofit2.Call<UserActivityPage>`	`getUserActivity(java.lang.Integer offset, java.lang.Integer limit)` Gets a limited amount of data about a user's lifetime activity.
`retrofit2.Call<UserProfile>`	`getUserProfile()` Gets information about the user that has authorized with the application.
`retrofit2.Call<Ride>`	`requestRide(RideRequestParameters rideRequestParameters)` Requests a ride on behalf of a user given their desired product, start, and end locations.
`retrofit2.Call<Place>`	`setPlace(java.lang.String placeId, PlaceParameters placeParameters)` Sets information about a user's Place.
`retrofit2.Call<java.lang.Void>`	`updateRide(java.lang.String rideId, RideUpdateParameters rideUpdateParameters)` Update an ongoing request's destination.
`retrofit2.Call<java.lang.Void>`	`updateSandboxProduct(java.lang.String productId, SandboxProductRequestParameters sandboxProductRequestParameters)` Updates the product in the `sandbox environement` to simulate the possible responses the Request endpoint will return when requesting a particular product, such as surge pricing and driver availability.
`retrofit2.Call<java.lang.Void>`	`updateSandboxRide(java.lang.String rideId, SandboxRideRequestParameters sandboxRideRequestParameters)` Updates the ride in the `sandbox environement` to simulate the possible states of a the Request.

Method Detail

getPromotions

@GET(value="/v1.2/promotions")
retrofit2.Call<Promotion> getPromotions(@Query(value="start_latitude")
                                                                       float startLatitude,
                                                                       @Query(value="start_longitude")
                                                                       float startLongitude,
                                                                       @Query(value="end_latitude")
                                                                       float endLatitude,
                                                                       @Query(value="end_longitude")
                                                                       float endLongitude)

Gets information about the promotion that will be available to a new user based on their activity's location.

Parameters:: startLatitude - Latitude component of start location.; startLongitude - Longitude component of start location.; endLatitude - Latitude component of end location.; endLongitude - Longitude component of end location.
Returns:: the request Call

getUserActivity

@GET(value="/v1.2/history")
retrofit2.Call<UserActivityPage> getUserActivity(@Nullable @Query(value="offset")
                                                                             java.lang.Integer offset,
                                                                             @Nullable @Query(value="limit")
                                                                             java.lang.Integer limit)

Gets a limited amount of data about a user's lifetime activity.

Parameters:: offset - Offset the list of returned results by this amount. Default is zero.; limit - Number of items to retrieve. Default is 5, maximum is 50.
Returns:: the request Call

getUserProfile
```
@GET(value="/v1.2/me")
retrofit2.Call<UserProfile> getUserProfile()
```
Gets information about the user that has authorized with the application.

Returns:

the request Call

getPriceEstimates

@GET(value="/v1.2/estimates/price")
retrofit2.Call<PriceEstimatesResponse> getPriceEstimates(@Query(value="start_latitude")
                                                                                             float startLatitude,
                                                                                             @Query(value="start_longitude")
                                                                                             float startLongitude,
                                                                                             @Query(value="end_latitude")
                                                                                             float endLatitude,
                                                                                             @Query(value="end_longitude")
                                                                                             float endLongitude)

Gets an estimated price range for each product offered at a given location.

Parameters:: startLatitude - Latitude component of start location.; startLongitude - Longitude component of start location.; endLatitude - Latitude component of end location.; endLongitude - Longitude component of end location.
Returns:: the request Call

getPickupTimeEstimate

@GET(value="/v1.2/estimates/time")
retrofit2.Call<TimeEstimatesResponse> getPickupTimeEstimate(@Query(value="start_latitude")
                                                                                               float startLatitude,
                                                                                               @Query(value="start_longitude")
                                                                                               float startLongitude,
                                                                                               @Nullable @Query(value="product_id")
                                                                                               java.lang.String productId)

Gets ETAs for all products offered at a given location, with the responses expressed as integers in seconds.

Parameters:: startLatitude - Latitude component of start location.; startLongitude - Longitude component of start location.; productId - Unique identifier representing a specific product for a given latitude & longitude.
Returns:: the request Call

getProducts

@GET(value="/v1.2/products")
retrofit2.Call<ProductsResponse> getProducts(@Query(value="latitude")
                                                                          float latitude,
                                                                          @Query(value="longitude")
                                                                          float longitude)

Gets information about the products offered at a given location.

Parameters:: latitude - Latitude component of location.; longitude - Longitude component of location.
Returns:: the request Call

getProduct

@GET(value="/v1.2/products/{product_id}")
retrofit2.Call<Product> getProduct(@Path(value="product_id")
                                                                             java.lang.String productId)

Gets information about a specific product.

Parameters:: productId - The unique product ID to fetch information about.
Returns:: the request Call

cancelRide

@DELETE(value="/v1.2/requests/{request_id}")
retrofit2.Call<java.lang.Void> cancelRide(@Path(value="request_id")
                                                                                       java.lang.String rideId)

Cancels an ongoing Ride for a user.

Parameters:: rideId - Unique identifier representing a Request.
Returns:: the request Call

requestRide

@POST(value="/v1.2/requests")
retrofit2.Call<Ride> requestRide(@Body
                                                               RideRequestParameters rideRequestParameters)

Requests a ride on behalf of a user given their desired product, start, and end locations.

Parameters:: rideRequestParameters - The ride request parameters.
Returns:: the request Call

getCurrentRide

@GET(value="/v1.2/requests/current")
retrofit2.Call<Ride> getCurrentRide()

Gets the current ride a user is on.

Returns:: the request Call

cancelCurrentRide

@DELETE(value="/v1.2/requests/current")
retrofit2.Call<java.lang.Void> cancelCurrentRide()

Cancels the current ride of a user.

Returns:: the request Call

updateRide

@PATCH(value="/v1.2/requests/{request_id}")
retrofit2.Call<java.lang.Void> updateRide(@Nonnull @Path(value="request_id")
                                                                                      java.lang.String rideId,
                                                                                      @Body
                                                                                      RideUpdateParameters rideUpdateParameters)

Update an ongoing request's destination.

Parameters:: rideUpdateParameters - The ride request parameters.
Returns:: the request Call

getPlace

@GET(value="/v1.2/places/{place_id}")
retrofit2.Call<Place> getPlace(@Nonnull @Path(value="place_id")
                                                                     java.lang.String placeId)

Gets information about a user's Place.

Parameters:: placeId - The identifier of a Place.
Returns:: the request Call

setPlace

@PUT(value="/v1.2/places/{place_id}")
retrofit2.Call<Place> setPlace(@Nonnull @Path(value="place_id")
                                                                     java.lang.String placeId,
                                                                     @Nonnull @Body
                                                                     PlaceParameters placeParameters)

Sets information about a user's Place.

Parameters:: placeId - The identifier of a Place.; placeParameters - The place parameters.
Returns:: the request Call

getRideDetails

@GET(value="/v1.2/requests/{request_id}")
retrofit2.Call<Ride> getRideDetails(@Nonnull @Path(value="request_id")
                                                                              java.lang.String rideId)

Gets details about a specific ride.

Parameters:: rideId - The unique identifier for a ride.
Returns:: the request Call

estimateRide
```
@POST(value="/v1.2/requests/estimate")
retrofit2.Call<RideEstimate> estimateRide(@Body
                                                                                 RideRequestParameters rideRequestParameters)
```
The request estimate endpoint allows a ride to be estimated given the desired product, start, and end locations. If the end location is not provided, only the pickup ETA and details of surge pricing information are provided. If the pickup ETA is null, there are no cars available, but an estimate may still be given to the user.

You can use this endpoint to determine if surge pricing is in effect. Do this before attempting to make a request so that you can preemptively have a user confirm surge by sending them to the surge_confirmation_href provided in the response.

Parameters:

rideRequestParameters - The ride request parameters.

Returns:

the request Call

getRideMap
```
@GET(value="/v1.2/requests/{request_id}/map")
retrofit2.Call<RideMap> getRideMap(@Nonnull @Path(value="request_id")
                                                                                 java.lang.String rideId)
```
Get a map with a visual representation of a ride for tracking purposes. Maps are only available after a ride has been accepted by a driver and is in the 'accepted' state. Attempting to get a map before that will result in a 404 error.

Parameters:

rideId - Unique identifier representing a ride.

Returns:

the request Call

getPaymentMethods
```
@GET(value="/v1.2/payment-methods")
retrofit2.Call<PaymentMethodsResponse> getPaymentMethods()
```
Gets the PaymentMethods of user and their last used method ID.

Returns:

the request Call

updateSandboxProduct

@PUT(value="/v1.2/sandbox/products/{product_id}")
retrofit2.Call<java.lang.Void> updateSandboxProduct(@Path(value="product_id")
                                                                                                      java.lang.String productId,
                                                                                                      @Body
                                                                                                      SandboxProductRequestParameters sandboxProductRequestParameters)

Updates the product in the sandbox environement to simulate the possible responses the Request endpoint will return when requesting a particular product, such as surge pricing and driver availability. Will fail when called in SessionConfiguration.Environment#PRODUCTION.

Parameters:: productId - The unique product ID to update.; sandboxProductRequestParameters - The sandbox product request parameters.
Returns:: the request Call

updateSandboxRide

@PUT(value="/v1.2/sandbox/requests/{request_id}")
retrofit2.Call<java.lang.Void> updateSandboxRide(@Path(value="request_id")
                                                                                                   java.lang.String rideId,
                                                                                                   @Body
                                                                                                   SandboxRideRequestParameters sandboxRideRequestParameters)

Updates the ride in the sandbox environement to simulate the possible states of a the Request. Will fail when called in SessionConfiguration.Environment#PRODUCTION.

Parameters:: rideId - Unique identifier representing a Request.; sandboxRideRequestParameters - The sandbox ride request parameters.
Returns:: the request Call

Interface RidesService