DRAFT: Adding support for Trip Purpose Prediction API (#36)

* Adding support for Trip Purpose Prediction API

* Fix comments on PR + solve merge conflicts

* Fix comments on PR + solve merge conflicts

* Refactor Flight Delay Prediction and Airport-On Time performance

Author: anthonyroux

.gitignore

@@ -8,4 +8,5 @@ build
 out
 .DS_Store
 amadeus-java.iml
-Bin/
+Bin/
+.vscode/

README.md

@@ -315,14 +315,14 @@ PointOfInterest[] pointsOfInterest = amadeus.referenceData.locations.pointsOfInt
     .and("west", "2.160873")
     .and("south", "41.394582")
     .and("east", "2.177181"));
- 
+
 // What's the likelihood flights from this airport will leave on time?
-OnTime AirportOnTime = amadeus.airport.predictions.onTime.get(Params
+Prediction AirportOnTime = amadeus.airport.predictions.onTime.get(Params
     .with("airportCode", "NCE")
-    .and("date", "2020-09-01"));  
+    .and("date", "2020-09-01"));
 
 // What's the likelihood of a given flight to be delayed?
-Delay[] flightDelay = amadeus.travel.predictions.flightDelay.get(Params
+Prediction[] flightDelay = amadeus.travel.predictions.flightDelay.get(Params
     .with("originLocationCode", "NCE")
     .and("destinationLocationCode", "IST")
     .and("departureDate", "2020-08-01")
@@ -353,6 +353,13 @@ SeatMap[] seatmap = amadeus.shopping.seatMaps.post(body);
 // AI-Generated Photos
 GeneratedPhoto photo = amadeus.media.files.generatedPhotos.get(Params
     .with("category", "BEACH"));
+
+// Trip Purpose Prediction
+Prediction tripPurpose = amadeus.travel.predictions.tripPurpose.get(Params
+    .with("originLocationCode", "NYC")
+    .and("destinationLocationCode", "MAD")
+    .and("departureDate", "2020-08-01")
+    .and("returnDate", "2020-08-12"));
 ```
 
 ## Development & Contributing

src/main/java/com/amadeus/Travel.java

@@ -1,7 +1,7 @@
 package com.amadeus;
 
+import com.amadeus.travel.Predictions;
 import com.amadeus.travel.analytics.Analytics;
-import com.amadeus.travel.predictions.Predictions;
 
 /**
  * <p>

src/main/java/com/amadeus/airport/predictions/AirportOnTime.java

@@ -4,7 +4,7 @@
 import com.amadeus.Params;
 import com.amadeus.Response;
 import com.amadeus.exceptions.ResponseException;
-import com.amadeus.resources.OnTime;
+import com.amadeus.resources.Prediction;
 import com.amadeus.resources.Resource;
 
 /**
@@ -46,16 +46,16 @@ public AirportOnTime(Amadeus client) {
    * @return an API response object
    * @throws ResponseException when an exception occurs
    */
-  public OnTime get(Params params) throws ResponseException {
+  public Prediction get(Params params) throws ResponseException {
     Response response = client.get("/v1/airport/predictions/on-time", params);
-    return (OnTime) Resource.fromObject(response, OnTime.class);
+    return (Prediction) Resource.fromObject(response, Prediction.class);
   }
 
   /**
    * Convenience method for calling <code>get</code> without any parameters.
    * @see AirportOnTime#get()
    */
-  public OnTime get() throws ResponseException {
+  public Prediction get() throws ResponseException {
     return get(null);
   }
 }

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

@@ -4,16 +4,18 @@
 import lombok.ToString;
 
 /**
- * A Delay object as returned by the FlightDelay API.
- * @see com.amadeus.travel.predictions.FlightDelay#get()
+ * An Period object as returned by the Prediction APIs.
+ *
+ * @see com.amadeus.travel.predictions.TripPurpose#get()
  */
 @ToString
-public class Delay extends Resource {
-  protected Delay() {}
+public class Prediction extends Resource {
+  protected Prediction() {
+  }
 
+  private @Getter String type;
+  private @Getter String subType;
   private @Getter String id;
-  private @Getter String probability;
   private @Getter String result;
-  private @Getter String subType;
-  private @Getter String type;
+  private @Getter String probability;
 }

…in/java/com/amadeus/resources/Delay.java …va/com/amadeus/resources/Prediction.javasrc/main/java/com/amadeus/resources/Delay.java renamed to src/main/java/com/amadeus/resources/Prediction.java src/main/java/com/amadeus/resources/Delay.java renamed to src/main/java/com/amadeus/resources/Prediction.java

@@ -1,6 +1,8 @@
-package com.amadeus.travel.predictions;
+package com.amadeus.travel;
 
 import com.amadeus.Amadeus;
+import com.amadeus.travel.predictions.FlightDelay;
+import com.amadeus.travel.predictions.TripPurpose;
 
 /**
  * <p>
@@ -21,18 +23,25 @@
 public class Predictions {
   /**
    * <p>
-   *   A namespaced client for the
+   * A namespaced client for the
+   * <code>/v1/travel/predictions/trip-purpose</code> endpoints.
+   * </p>
+   */
+  public TripPurpose tripPurpose;
+
+  /**   A namespaced client for the
    *   <code>/v1/travel/predictions/flight-delay</code> endpoints.
    * </p>
    */
   public FlightDelay flightDelay;
 
-
   /**
    * Constructor.
+   *
    * @hide
    */
   public Predictions(Amadeus client) {
+    this.tripPurpose = new TripPurpose(client);
     this.flightDelay = new FlightDelay(client);
   }
 }

src/main/java/com/amadeus/travel/Predictions.java

@@ -4,7 +4,7 @@
 import com.amadeus.Params;
 import com.amadeus.Response;
 import com.amadeus.exceptions.ResponseException;
-import com.amadeus.resources.Delay;
+import com.amadeus.resources.Prediction;
 import com.amadeus.resources.Resource;
 
 /**
@@ -54,16 +54,16 @@ public FlightDelay(Amadeus client) {
    * @return an API response object
    * @throws ResponseException when an exception occurs
    */
-  public Delay[] get(Params params) throws ResponseException {
+  public Prediction[] get(Params params) throws ResponseException {
     Response response = client.get("/v1/travel/predictions/flight-delay", params);
-    return (Delay[]) Resource.fromArray(response, Delay[].class);
+    return (Prediction[]) Resource.fromArray(response, Prediction[].class);
   }
 
   /**
    * Convenience method for calling <code>get</code> without any parameters.
    * @see FlightDelay#get()
    */
-  public Delay[] get() throws ResponseException {
+  public Prediction[] get() throws ResponseException {
     return get(null);
   }
 }

src/main/java/com/amadeus/travel/predictions/FlightDelay.java

@@ -0,0 +1,67 @@
+package com.amadeus.travel.predictions;
+
+import com.amadeus.Amadeus;
+import com.amadeus.Params;
+import com.amadeus.Response;
+import com.amadeus.exceptions.ResponseException;
+import com.amadeus.resources.Prediction;
+import com.amadeus.resources.Resource;
+
+
+/**
+ * <p>
+ * A namespaced client for the
+ * <code>/v1/travel/predictions/trip-purpose</code> endpoints.
+ * </p>
+ *
+ * <p>
+ * Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.travel.predictions.tripPurpose;</pre>
+ */
+public class TripPurpose {
+  private Amadeus client;
+
+  /**
+   * Constructor.
+   *
+   * @hide
+   */
+  public TripPurpose(Amadeus client) {
+    this.client = client;
+  }
+
+  /**
+   * <p>
+   * Returns a trip purpose prediction.
+   * </p>
+   *
+   * <pre>
+   * amadeus.travel.predictions.tripPurpose.get(Params
+   *   .with("originLocationCode", "NYC")
+   *   .and("destinationLocationCode", "MAD")
+   *   .and("departureDate", "2020-08-01")
+   *   .and("returnDate", "2020-08-12"));
+   *   </pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+  public Prediction get(Params params) throws ResponseException {
+    Response response = client.get("/v1/travel/predictions/trip-purpose", params);
+    return (Prediction) Resource.fromObject(response, Prediction.class);
+  }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   *
+   * @see TripPurpose#get()
+   */
+  public Prediction get() throws ResponseException {
+    return get(null);
+  }
+}

src/main/java/com/amadeus/travel/predictions/TripPurpose.java

@@ -25,6 +25,7 @@
 import com.amadeus.travel.analytics.airTraffic.BusiestPeriod;
 import com.amadeus.travel.analytics.airTraffic.Traveled;
 import com.amadeus.travel.predictions.FlightDelay;
+import com.amadeus.travel.predictions.TripPurpose;
 import com.google.gson.JsonArray;
 import com.google.gson.JsonObject;
 import junit.framework.TestCase;
@@ -52,6 +53,7 @@ public void testAllNamespacesExist() {
     TestCase.assertNotNull(client.referenceData.airlines);
     TestCase.assertNotNull(client.travel.analytics.airTraffic.traveled);
     TestCase.assertNotNull(client.travel.analytics.airTraffic.booked);
+    TestCase.assertNotNull(client.travel.predictions.tripPurpose);
     TestCase.assertNotNull(client.travel.predictions.flightDelay);
     TestCase.assertNotNull(client.shopping.flightDates);
     TestCase.assertNotNull(client.shopping.flightDestinations);
@@ -266,15 +268,22 @@ public void testGetMethods() throws ResponseException {
     HotelSentiments hotelSentiments = new HotelSentiments(client);
     TestCase.assertNotNull(hotelSentiments.get(params));
 
-    // Test airport-on-time 
+    // Test trip purpose prediction
+    Mockito.when(client.get("/v1/travel/predictions/trip-purpose", null))
+            .thenReturn(singleResponse);
+    Mockito.when(client.get("/v1/travel/predictions/trip-purpose", params))
+            .thenReturn(singleResponse);
+    TripPurpose tripPurpose = new TripPurpose(client);
+    TestCase.assertNotNull(tripPurpose.get(params));
+    // Test airport-on-time
     Mockito.when(client.get("/v1/airport/predictions/on-time", null))
             .thenReturn(singleResponse);
     Mockito.when(client.get("/v1/airport/predictions/on-time", params))
             .thenReturn(singleResponse);
     AirportOnTime airportOnTime = new AirportOnTime(client);
     TestCase.assertNotNull(airportOnTime.get());
     TestCase.assertNotNull(airportOnTime.get(params));
-    
+
     // Test flight delay predictions
     Mockito.when(client.get("/v1/travel/predictions/flight-delay", null))
         .thenReturn(multiResponse);
@@ -290,8 +299,8 @@ public void testGetMethods() throws ResponseException {
     Mockito.when(client.get("/v1/shopping/seatmaps", params))
         .thenReturn(multiResponse);
     SeatMaps seatmap = new SeatMaps(client);
-    TestCase.assertNotNull(seatmap.get(params));    
-    
+    TestCase.assertNotNull(seatmap.get(params));
+
     // Test fetching a specific offer
     Mockito.when(client.get("/v1/booking/flight-orders/XXX", null))
         .thenReturn(singleResponse);
@@ -339,11 +348,11 @@ public void testPostMethods() throws ResponseException {
     Mockito.when(client.post("/v1/booking/flight-orders", (String) null))
             .thenReturn(singleResponse);
     Mockito.when(client.post("/v1/booking/flight-orders", body))
-            .thenReturn(singleResponse);   
+            .thenReturn(singleResponse);
     FlightOrders order = new FlightOrders(client);
     TestCase.assertNotNull(order.post());
     TestCase.assertNotNull(order.post(body));
-    
+
     // Test SeatMaps post
     Mockito.when(client.post("/v1/shopping/seatmaps", (String) null))
             .thenReturn(multiResponse);