com.amadeus.analytics.ItineraryPriceMetrics Maven / Gradle / Ivy

Go to download
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;

/**
 * 
 *   A namespaced client for the
 *   /v1/analytics/itinerary-price-metrics endpoints.
 * 
 *
 * 
 *   Access via the Amadeus client object.
 * 
 *
 *  * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
 * amadeus.analytics.itineraryPriceMetrics;
 */
public class ItineraryPriceMetrics {
  private Amadeus client;

  /**
   * Constructor.
   * @hide
   */
  public ItineraryPriceMetrics(Amadeus client) {
    this.client = client;
  }

  /**
   * 
   *   Retrieves itinerary price metrics.
   * 
   *
   *    * amadeus.analytics.itineraryPriceMetrics.get(Params
   *     .with("originIataCode", "MAD")
   *     .and("destinationIataCode", "CDG")
   *     .and("departureDate", "2021-03-21"));
   *
   * @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 get without any parameters.
   * @see ItineraryPriceMetric#get()
   */
  public ItineraryPriceMetric[] get() throws ResponseException {
    return get(null);
  }
}