Add support for Travel Recommendations API (#82)

Author: anthonyroux

.github/CONTRIBUTING.md

@@ -16,7 +16,7 @@ We are trying to keep 100% coverage, so keep an eye on the `coverage` folder for
 
 ### Building the source
 
-To build the source, run `npm run build` or `npm run build watch` to keep watching the source for changes and build accordingly.
+To build the source, run `npm run build` or `npm run build:watch` to keep watching the source for changes and build accordingly.
 
 ### Using a library locally
 

README.md

@@ -109,7 +109,7 @@ amadeus.client.post('/v1/shopping/flight-offers/pricing', JSON.stringify({ data
 
 ## Promises
 
-Every API call returns a `Promise` that either resolves or rejects. 
+Every API call returns a `Promise` that either resolves or rejects.
 
 Every resolved API call returns a `Response` object containing a `body` attribute with the raw response. If the API call contained a JSON response, it will parse the JSON into the `result` attribute. If this data contains a `data` key, that will be made available in `data` attribute.
 
@@ -185,10 +185,10 @@ amadeus.shopping.flightDates.get({
 
 // Flight Offers Search
 amadeus.shopping.flightOffersSearch.get({
-    originLocationCode: 'SYD',
-    destinationLocationCode: 'BKK',
-    departureDate: '2020-08-01',
-    adults: '2'
+  originLocationCode: 'SYD',
+  destinationLocationCode: 'BKK',
+  departureDate: '2020-08-01',
+  adults: '2'
 })
 
 // Flight Choice Prediction
@@ -255,10 +255,10 @@ amadeus.shopping.flightOffersSearch.get({
 // To retrieve the seat map of each flight included
 // in flight offers for MAD-NYC flight on 2020-08-01
 amadeus.shopping.flightOffersSearch.get({
-    originLocationCode: 'SYD',
-    destinationLocationCode: 'BKK',
-    departureDate: '2020-08-01',
-    adults: '1'
+  originLocationCode: 'SYD',
+  destinationLocationCode: 'BKK',
+  departureDate: '2020-08-01',
+  adults: '1'
 }).then(function(response){
     return amadeus.shopping.seatmaps.post(
       JSON.stringify({
@@ -303,21 +303,21 @@ amadeus.referenceData.locations.airports.get({
 
 // Flight Most Booked Destinations
 amadeus.travel.analytics.airTraffic.booked.get({
-    originCityCode : 'MAD',
-    period : '2017-08'
-})
+  originCityCode : 'MAD',
+  period : '2017-08'
+}
 
 // Flight Most Traveled Destinations
 amadeus.travel.analytics.airTraffic.traveled.get({
-    originCityCode : 'MAD',
-    period : '2017-01'
+  originCityCode : 'MAD',
+  period : '2017-01'
 })
 
 // Flight Busiest Traveling Period
 amadeus.travel.analytics.airTraffic.busiestPeriod.get({
-    cityCode: 'MAD',
-    period: '2017',
-    direction: Amadeus.direction.arriving
+  cityCode: 'MAD',
+  period: '2017',
+  direction: Amadeus.direction.arriving
 })
 
 // Trip Parser API
@@ -366,16 +366,16 @@ amadeus.booking.hotelBookings.post(
 // Points of Interest
 // What are the popular places in Barcelona (based a geo location and a radius)
 amadeus.referenceData.locations.pointsOfInterest.get({
-    latitude : 41.397158,
-    longitude : 2.160873
+  latitude : 41.397158,
+  longitude : 2.160873
 })
 
 // What are the popular places in Barcelona? (based on a square)
 amadeus.referenceData.locations.pointsOfInterest.bySquare.get({
-    north: 41.397158,
-    west: 2.160873,
-    south: 41.394582,
-    east: 2.177181
+  north: 41.397158,
+  west: 2.160873,
+  south: 41.394582,
+  east: 2.177181
 })
 
 // Points of Interest
@@ -385,16 +385,16 @@ amadeus.referenceData.locations.pointOfInterest('9CB40CB5D0').get()
 // Hotel Ratings
 // Get Sentiment Analysis of reviews about Holiday Inn Paris Notre Dame.
 amadeus.eReputation.hotelSentiments.get({
-    hotelIds: 'XKPARC12'
+  hotelIds: 'XKPARC12'
 })
 
 // Trip Purpose Prediction
 // Forecast traveler purpose, Business or Leisure, together with the probability in the context of search & shopping.
 amadeus.travel.predictions.tripPurpose.get({
-    originLocationCode: 'NYC',
-    destinationLocationCode: 'MAD',
-    departureDate: '2020-08-01',
-    returnDate: '2020-08-12'
+  originLocationCode: 'NYC',
+  destinationLocationCode: 'MAD',
+  departureDate: '2020-08-01',
+  returnDate: '2020-08-12'
 })
 
 // AI-Generated Photos
@@ -407,25 +407,32 @@ amadeus.media.files.generatedPhotos.get({
 // This machine learning API is based on a prediction model that takes the input of the user - time, carrier, airport and aircraft information;
 // and predict the segment where the flight is likely to lay.
 amadeus.travel.predictions.flightDelay.get({
-    originLocationCode: 'BRU',
-    destinationLocationCode: 'FRA',
-    departureDate: '2020-01-14',
-    departureTime: '11:05:00',
-    arrivalDate: '2020-01-14',
-    arrivalTime: '12:10:00',
-    aircraftCode: '32A',
-    carrierCode: 'LH',
-    flightNumber: '1009',
-    duration: 'PT1H05M'
+  originLocationCode: 'BRU',
+  destinationLocationCode: 'FRA',
+  departureDate: '2020-01-14',
+  departureTime: '11:05:00',
+  arrivalDate: '2020-01-14',
+  arrivalTime: '12:10:00',
+  aircraftCode: '32A',
+  carrierCode: 'LH',
+  flightNumber: '1009',
+  duration: 'PT1H05M'
 })
 
 // Airport On-time Performance
 // Get the percentage of on-time flight departures from JFK
 amadeus.airport.predictions.onTime.get({
-    airportCode: 'JFK',
-    date: '2020-08-01'
+  airportCode: 'JFK',
+  date: '2020-08-01'
+})
+
+// Travel Recommendations
+amadeus.referenceData.recommendedLocations.get({
+  cityCodes: 'PAR',
+  travelerCountryCode: 'FR'
 })
 
+// Safe Place
 // How safe is Barcelona? (based a geo location and a radius)
 amadeus.safety.safetyRatedLocations.get({
   latitude: 41.397158,

spec/amadeus/namespaces.test.js

@@ -26,6 +26,7 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.locations.pointsOfInterest).toBeDefined();
       expect(amadeus.referenceData.locations.pointsOfInterest.bySquare).toBeDefined();
       expect(amadeus.referenceData.airlines).toBeDefined();
+      expect(amadeus.referenceData.recommendedLocations).toBeDefined();
 
       expect(amadeus.travel).toBeDefined();
       expect(amadeus.travel.analytics).toBeDefined();
@@ -84,6 +85,7 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.locations.pointsOfInterest.get).toBeDefined();
       expect(amadeus.referenceData.locations.pointsOfInterest.bySquare.get).toBeDefined();
       expect(amadeus.referenceData.airlines.get).toBeDefined();
+      expect(amadeus.referenceData.recommendedLocations.get).toBeDefined();
 
       expect(amadeus.travel.analytics.airTraffic.traveled.get).toBeDefined();
       expect(amadeus.travel.analytics.airTraffic.booked.get).toBeDefined();
@@ -156,6 +158,13 @@ describe('Namespaces', () => {
         .toHaveBeenCalledWith('/v1/reference-data/locations/airports', {});
     });
 
+    it('.amadeus.referenceData.recommendedLocations.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.referenceData.recommendedLocations.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/reference-data/recommended-locations', {});
+    });
+
     it('.amadeus.referenceData.locations.pointsOfInterest.get', () => {
       amadeus.client.get = jest.fn();
       amadeus.referenceData.locations.pointsOfInterest.get();

src/amadeus/namespaces/reference_data.js

@@ -1,7 +1,8 @@
 import Urls      from './reference_data/urls';
 import Locations from './reference_data/locations';
 import Location  from './reference_data/location';
-import Airlines  from './reference_data/airlines';
+import Airlines from './reference_data/airlines';
+import RecommendedLocations from './reference_data/recommended_locations';
 
 /**
  * A namespaced client for the
@@ -24,6 +25,7 @@ class ReferenceData {
     this.urls      = new Urls(client);
     this.locations = new Locations(client);
     this.airlines  = new Airlines(client);
+    this.recommendedLocations = new RecommendedLocations(client);
   }
 
   /**

src/amadeus/namespaces/reference_data/recommended_locations.js

@@ -0,0 +1,42 @@
+/**
+ * A namespaced client for the
+ * `/v1/reference-data/recommended-locations` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.referenceData.recommendedLocations;
+ * ```
+ *
+ * @param {Client} client
+ */
+class RecommendedLocations {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * Returns the recommended locations (destinations).
+   *
+   * @param {Object} params
+   * @param {string} params.cityCodes Code of the city following IATA standard.
+   * @param {string} params.travelerCountryCode Origin country of the traveler following IATA standard.
+   * @param {string} params.destinationCountryCodes Country codes follow IATA standard.
+   * @return {Promise.<Response,ResponseError>} a Promise
+   *
+   * Get recommended destinations from a given origin
+   *
+   * ```js
+   * amadeus.referenceData.recommendedDestinations.get({
+   *   cityCodes: 'PAR',
+   *   travelerCountryCode: 'FR'
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/reference-data/recommended-locations', params);
+  }
+}
+
+export default RecommendedLocations;