Low-fare Search deco and update Flight Choice Prediction v2 (#73)

* update choice prediction version & deco LFS & update docs

* add choiceProbability to FlightOffersSearch model

* update date on readme

* delete run file

Author: tsolakoua

README.md

@@ -220,12 +220,6 @@ FlightDate[] flightDates = amadeus.shopping.flightDates.get(Params
   .with("origin", "MAD")
   .and("destination", "MUC"));
 
-// Flight Low-fare Search
-FlightOffer[] flightOffers = amadeus.shopping.flightOffers.get(Params
-  .with("origin", "NYC")
-  .and("destination", "MAD")
-  .and("departureDate", "2020-04-01"));
-
 // Flight Offers Search v2 GET
 FlightOfferSearch[] flightOffersSearches = amadeus.shopping.flightOffersSearch.get(
               Params.with("originLocationCode", "SYD")
@@ -253,17 +247,21 @@ FlightPrice[] flightPricing = amadeus.shopping.flightOffersSearch.pricing.post(
                           .and("forceClass", "false"));
 
 // Flight Choice Prediction
-// Note that the example calls 2 APIs: Flight Low-fare Search & Flight Choice Prediction
-FlightOffer[] flightOffers = amadeus.shopping.flightOffers
-        .get(Params.with("origin", "MAD").and("destination", "NYC").and("departureDate", "2020-08-01").and("max", "2"));
+// Note that the example calls 2 APIs: Flight Offers Search & Flight Choice Prediction
+FlightOfferSearch[] flightOffers = amadeus.shopping.flightOffersSearch.get(
+              Params.with("originLocationCode", "NYC")
+                      .and("destinationLocationCode", "MAD")
+                      .and("departureDate", "2020-11-01")
+                      .and("returnDate", "2020-11-09")
+                      .and("adults", 1));
 
 // Using a JSonObject
 JsonObject result = flightOffers[0].getResponse().getResult();
-FlightOffer[] flightOffersPrediction = amadeus.shopping.flightOffers.prediction.post(result);
+FlightOfferSearch[] flightOffersPrediction = amadeus.shopping.flightOffers.prediction.post(result);
 
 // Using a String
 String body = flightOffers[0].getResponse().getBody();
-FlightOffer[] flightOffersPrediction = amadeus.shopping.flightOffers.prediction.post(body);
+FlightOfferSearch[] flightOffersPrediction = amadeus.shopping.flightOffers.prediction.post(body);
 
 // Flight Check-in Links
 CheckinLink[] checkinLinks = amadeus.referenceData.urls.checkinLinks.get(Params

src/main/java/com/amadeus/resources/FlightOffer.java

@@ -25,8 +25,7 @@ protected FlightOfferSearch() {}
   private @Getter PricingOptions pricingOptions;
   private @Getter String[] validatingAirlineCodes;
   private @Getter TravelerPricing[] travelerPricings;
-
-
+  private @Getter String choiceProbability;
 
   @ToString
   public class Itinerary {

src/main/java/com/amadeus/resources/FlightOfferSearch.java

@@ -1,13 +1,7 @@
 package com.amadeus.shopping;
 
 import com.amadeus.Amadeus;
-import com.amadeus.Params;
-import com.amadeus.Response;
-import com.amadeus.exceptions.ResponseException;
-import com.amadeus.resources.FlightOffer;
-import com.amadeus.resources.Resource;
 import com.amadeus.shopping.flightOffers.Prediction;
-import com.google.gson.Gson;
 
 /**
  * <p>
@@ -36,31 +30,4 @@ public FlightOffers(Amadeus client) {
     this.prediction = new Prediction(client);
   }
 
-  /**
-   * <p>
-   *   Find the cheapest bookable flights.
-   * </p>
-   *
-   * <pre>
-   * amadeus.shopping.flightOffers.get(Params
-   *   .with("origin", "LHR")
-   *   .and("destination", "LAX")
-   *   .and("departureDate", "2020-08-01"));</pre>
-   *
-   * @param params the parameters to send to the API
-   * @return an API response object
-   * @throws ResponseException when an exception occurs
-   */
-  public FlightOffer[] get(Params params) throws ResponseException {
-    Response response = client.get("/v1/shopping/flight-offers", params);
-    return (FlightOffer[]) Resource.fromArray(response, FlightOffer[].class);
-  }
-
-  /**
-   * Convenience method for calling <code>get</code> without any parameters.
-   * @see FlightOffers#get()
-   */
-  public FlightOffer[] get() throws ResponseException {
-    return get(null);
-  }
 }

src/main/java/com/amadeus/shopping/FlightOffers.java

@@ -3,7 +3,7 @@
 import com.amadeus.Amadeus;
 import com.amadeus.Response;
 import com.amadeus.exceptions.ResponseException;
-import com.amadeus.resources.FlightOffer;
+import com.amadeus.resources.FlightOfferSearch;
 import com.amadeus.resources.Resource;
 
 import com.google.gson.JsonObject;
@@ -15,7 +15,7 @@
 /**
  * <p>
  * A namespaced client for the
- * <code>/v1/shopping/flight-offers/prediction</code> endpoints.
+ * <code>/v2/shopping/flight-offers/prediction</code> endpoints.
  * </p>
  *
  * <p>
@@ -41,9 +41,9 @@ public Prediction(Amadeus client) {
 
   /**
    * <p>
-   * This machine learning API is based on a prediction model that takes the response of a flight
-   * search as input (Flight Low-fare Search) and predict, for each itinerary, the probably for a
-   * travel to select it.
+   * This Machine Learning API is based on a prediction model that takes the response of a flight
+   * search as input (Flight Offers Search) and predicts, for each itinerary, the probability to
+   * be selected.
    * </p>
    *
    * <pre>
@@ -53,16 +53,16 @@ public Prediction(Amadeus client) {
    * @return an API resource
    * @throws ResponseException when an exception occurs
    */
-  public FlightOffer[] post(JsonObject body) throws ResponseException {
-    Response response = client.post("/v1/shopping/flight-offers/prediction", body);
-    return (FlightOffer[]) Resource.fromArray(response, FlightOffer[].class);
+  public FlightOfferSearch[] post(JsonObject body) throws ResponseException {
+    Response response = client.post("/v2/shopping/flight-offers/prediction", body);
+    return (FlightOfferSearch[]) Resource.fromArray(response, FlightOfferSearch[].class);
   }
 
   /**
    * <p>
    * This machine learning API is based on a prediction model that takes the response of a flight
-   * search as input (Flight Low-fare Search) and predict, for each itinerary, the probably for a
-   * travel to select it.
+   * search as input (Flight Offers Search) and predicts, for each itinerary, the probability to
+   * be selected.
    * </p>
    *
    * <pre>
@@ -72,17 +72,17 @@ public FlightOffer[] post(JsonObject body) throws ResponseException {
    * @return an API resource
    * @throws ResponseException when an exception occurs
    */
-  public FlightOffer[] post(String body) throws ResponseException {
-    Response response = client.post("/v1/shopping/flight-offers/prediction", body);
-    return (FlightOffer[]) Resource.fromArray(response, FlightOffer[].class);
+  public FlightOfferSearch[] post(String body) throws ResponseException {
+    Response response = client.post("/v2/shopping/flight-offers/prediction", body);
+    return (FlightOfferSearch[]) Resource.fromArray(response, FlightOfferSearch[].class);
   }
 
   /**
    * Convenience method for calling <code>post</code> without any parameters.
    *
    * @see Prediction#post()
    */
-  public FlightOffer[] post() throws ResponseException {
+  public FlightOfferSearch[] post() throws ResponseException {
     return post((String) null);
   }
 }

src/main/java/com/amadeus/shopping/flightOffers/Prediction.java

@@ -229,16 +229,6 @@ public void testGetMethods() throws ResponseException {
     TestCase.assertNotNull(flightDestinations.get(params));
     TestCase.assertEquals(flightDestinations.get().length, 2);
 
-    // Testing flight offer search
-    Mockito.when(client.get("/v1/shopping/flight-offers", null))
-        .thenReturn(multiResponse);
-    Mockito.when(client.get("/v1/shopping/flight-offers", params))
-        .thenReturn(multiResponse);
-    FlightOffers flightOffers = new FlightOffers(client);
-    TestCase.assertNotNull(flightOffers.get());
-    TestCase.assertNotNull(flightOffers.get(params));
-    TestCase.assertEquals(flightOffers.get().length, 2);
-
     // Testing hotel offer search
     Mockito.when(client.get("/v2/shopping/hotel-offers", null))
         .thenReturn(multiResponse);
@@ -338,9 +328,9 @@ public void testGetMethods() throws ResponseException {
   @Test
   public void testPostMethods() throws ResponseException {
     // Testing flight choice prediction
-    Mockito.when(client.post("/v1/shopping/flight-offers/prediction", (String) null))
+    Mockito.when(client.post("/v2/shopping/flight-offers/prediction", (String) null))
         .thenReturn(multiResponse);
-    Mockito.when(client.post("/v1/shopping/flight-offers/prediction", body))
+    Mockito.when(client.post("/v2/shopping/flight-offers/prediction", body))
         .thenReturn(multiResponse);
     Prediction flightOffersPrediction = new Prediction(client);
     TestCase.assertNotNull(flightOffersPrediction.post());