com.amadeus.travel.analytics.airTraffic.BusiestPeriod Maven / Gradle / Ivy

Go to download
package com.amadeus.travel.analytics.airtraffic;

import com.amadeus.Amadeus;
import com.amadeus.Params;
import com.amadeus.Response;
import com.amadeus.exceptions.ResponseException;
import com.amadeus.resources.Period;
import com.amadeus.resources.Resource;

/**
 * 
 *   A namespaced client for the
 *   /v1/travel/analytics/air-traffic/busiest-period endpoints.
 * 
 *
 * 
 *   Access via the Amadeus client object.
 * 
 *
 *  * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
 * amadeus.travel.analytics.airTraffis.busiestPeriod;
 */
public class BusiestPeriod {
  private Amadeus client;
  public static final String ARRIVING = "ARRIVING";
  public static final String DEPARTING = "DEPARTING";

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

  /**
   * 
   *   Returns a list of busiest periods reports.
   * 
   *
   *    * amadeus.travel.analytics.airTraffic.busiestPeriod.get(Params
   *   .with("cityCode", "PAR")
   *   .and("period", "2017"));
   *
   * @param params the parameters to send to the API
   * @return an API response object
   * @throws ResponseException when an exception occurs
   */
  public Period[] get(Params params) throws ResponseException {
    Response response = client.get("/v1/travel/analytics/air-traffic/busiest-period", params);
    return (Period[]) Resource.fromArray(response, Period[].class);
  }

  /**
   * Convenience method for calling get without any parameters.
   * @see Traveled#get()
   */
  public Period[] get() throws ResponseException {
    return get(null);
  }
}