Merge pull request #92 from amadeus4dev/flight-price-analysis

Add support for Flight Price Analysis

Author: tsolakoua

README.md

@@ -378,6 +378,12 @@ DatedFlight[] flightStatus = amadeus.schedule.flights.get(Params
     .with("carrierCode", "AZ")
     .and("flightNumber", "319")
     .and("scheduledDepartureDate", "2021-03-13"));
+
+// Flight Price Analysis
+ItineraryPriceMetric[] metrics = amadeus.analytics.itineraryPriceMetrics.get(Params
+    .with("originIataCode", "MAD")
+    .and("destinationIataCode", "CDG")
+    .and("departureDate", "2021-03-21"));
 ```
 
 ## Development & Contributing

src/main/java/com/amadeus/Amadeus.java

@@ -90,6 +90,13 @@ public class Amadeus extends HTTPClient {
    */
   public Schedule schedule;
 
+  /**
+   * <p>
+   * A namespaced client for the <code>/v1/analytics</code> endpoints.
+   * </p>
+   */
+  public Analytics analytics;
+
   protected Amadeus(Configuration configuration) {
     super(configuration);
     this.referenceData = new ReferenceData(this);
@@ -101,6 +108,7 @@ protected Amadeus(Configuration configuration) {
     this.media = new Media(this);
     this.safety = new Safety(this);
     this.schedule = new Schedule(this);
+    this.analytics = new Analytics(this);
 
   }
 

src/main/java/com/amadeus/Analytics.java

@@ -0,0 +1,37 @@
+package com.amadeus;
+
+import com.amadeus.analytics.ItineraryPriceMetrics;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v1/analytics</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.analytics;</pre>
+ *
+ * @hide
+ */
+public class Analytics {
+  /**
+   * <p>
+   *   A namespaced client for the
+   *   <code>/v1/analytics/itineraryPriceMetrics</code> endpoints.
+   * </p>
+   */
+  public ItineraryPriceMetrics itineraryPriceMetrics;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public Analytics(Amadeus client) {
+    this.itineraryPriceMetrics = new ItineraryPriceMetrics(client);
+  }
+}

src/main/java/com/amadeus/analytics/ItineraryPriceMetrics.java

@@ -0,0 +1,62 @@
+package com.amadeus.analytics;
+
+import com.amadeus.Amadeus;
+import com.amadeus.Params;
+import com.amadeus.Response;
+import com.amadeus.exceptions.ResponseException;
+import com.amadeus.resources.ItineraryPriceMetric;
+import com.amadeus.resources.Resource;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v1/analytics/itinerary-price-metrics</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.analytics.itineraryPriceMetrics;</pre>
+ */
+public class ItineraryPriceMetrics {
+  private Amadeus client;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public ItineraryPriceMetrics(Amadeus client) {
+    this.client = client;
+  }
+
+  /**
+   * <p>
+   *   Retrieves itinerary price metrics.
+   * </p>
+   *
+   * <pre>
+   * amadeus.analytics.itineraryPriceMetrics.get(Params
+   *     .with("originIataCode", "MAD")
+   *     .and("destinationIataCode", "CDG")
+   *     .and("departureDate", "2021-03-21"));</pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+  public ItineraryPriceMetric[] get(Params params) throws ResponseException {
+    Response response = client.get("/v1/analytics/itinerary-price-metrics", params);
+    return (ItineraryPriceMetric[]) Resource.fromArray(response, ItineraryPriceMetric[].class);
+  }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   * @see ItineraryPriceMetric#get()
+   */
+  public ItineraryPriceMetric[] get() throws ResponseException {
+    return get(null);
+  }
+}

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

@@ -0,0 +1,38 @@
+package com.amadeus.resources;
+
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * A ItineraryPriceMetric object as returned by the Flight Price Analysis API.
+ * @see com.amadeus.analytics.ItineraryPriceMetrics#get()
+ */
+@ToString
+public class ItineraryPriceMetric extends Resource {
+  protected ItineraryPriceMetric() {}
+
+  private @Getter String type;
+  private @Getter Location origin;
+  private @Getter Location destination;
+  private @Getter String departureDate;
+  private @Getter String transportType;
+  private @Getter String currencyCode;
+  private @Getter Boolean oneWay;
+  private @Getter PriceMetrics[] priceMetrics;
+
+  @ToString
+  public class Location {
+    protected Location() {}
+
+    private @Getter String iataCode;
+  }
+
+  @ToString
+  public class PriceMetrics {
+    protected PriceMetrics() {}
+
+    private @Getter String amount;
+    private @Getter String quartileRanking;
+  }
+
+}

src/test/java/com/amadeus/NamespaceTest.java

@@ -1,6 +1,7 @@
 package com.amadeus;
 
 import com.amadeus.airport.predictions.AirportOnTime;
+import com.amadeus.analytics.ItineraryPriceMetrics;
 import com.amadeus.booking.FlightOrder;
 import com.amadeus.booking.FlightOrders;
 import com.amadeus.booking.HotelBookings;
@@ -415,6 +416,16 @@ public void testGetMethods() throws ResponseException {
     TestCase.assertNotNull(flightStatus.get());
     TestCase.assertNotNull(flightStatus.get(params));
     TestCase.assertEquals(flightStatus.get().length, 2);
+
+    // Testing flight price analysis
+    Mockito.when(client.get("/v1/analytics/itinerary-price-metrics", null))
+        .thenReturn(multiResponse);
+    Mockito.when(client.get("/v1/analytics/itinerary-price-metrics", params))
+        .thenReturn(multiResponse);
+    ItineraryPriceMetrics metrics = new ItineraryPriceMetrics(client);
+    TestCase.assertNotNull(metrics.get());
+    TestCase.assertNotNull(metrics.get(params));
+    TestCase.assertEquals(metrics.get().length, 2);
   }
 
   @Test