Merge pull request #151 from amadeus4dev/add_city_seacrch_api

add_city_search_api

Author: tsolakoua

.DS_Store

@@ -4,3 +4,4 @@ coverage
 test.js
 docs
 .vscode/
+.DS_Store

.gitignore

@@ -345,6 +345,13 @@ amadeus.travel.tripParserJobs('XXX').get()
 // To get the results of the job with ID 'XXX'
 amadeus.travel.tripParserJobs('XXX').result.get()
 
+// City Search API
+// finds cities that match a specific word or string of letters. 
+// Return a list of cities matching a keyword 'Paris'
+amadeus.referenceData.locations.cities.get({
+  keyword: 'Paris'
+})
+
 //Hotel List API 
 //Get list of hotels by city code
 amadeus.referenceData.locations.hotels.byCity.get({

README.md

@@ -22,6 +22,7 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.location).toBeDefined();
       expect(amadeus.referenceData.locations).toBeDefined();
       expect(amadeus.referenceData.locations.airports).toBeDefined();
+      expect(amadeus.referenceData.locations.cities).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byCity).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byGeocode).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byHotels).toBeDefined();
@@ -108,6 +109,7 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.location('ALHR').get).toBeDefined();
       expect(amadeus.referenceData.locations.get).toBeDefined();
       expect(amadeus.referenceData.locations.airports.get).toBeDefined();
+      expect(amadeus.referenceData.locations.cities.get).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byCity.get).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byGeocode.get).toBeDefined();
       expect(amadeus.referenceData.locations.hotels.byHotels.get).toBeDefined();
@@ -202,6 +204,13 @@ describe('Namespaces', () => {
         .toHaveBeenCalledWith('/v1/reference-data/locations/airports', {});
     });
 
+    it('.amadeus.referenceData.locations.cities.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.referenceData.locations.cities.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/reference-data/locations/cities', {});
+    });
+
     it('.amadeus.referenceData.locations.hotels.byCity.get', () => {
       amadeus.client.get = jest.fn();
       amadeus.referenceData.locations.hotels.byCity.get();

package-lock.json

@@ -1,4 +1,5 @@
 import Airports from './locations/airports';
+import Cities from './locations/cities';
 import Hotels from './locations/hotels';
 import PointOfInterest from './locations/poi';
 import PointsOfInterest from './locations/pois';
@@ -21,6 +22,7 @@ class Locations {
   constructor(client) {
     this.client = client;
     this.airports = new Airports(client);
+    this.cities = new Cities(client);
     this.hotels = new Hotels(client);
     this.pointsOfInterest = new PointsOfInterest(client);
   }

spec/amadeus/namespaces.test.js

@@ -0,0 +1,40 @@
+/**
+ * A namespaced client for the
+ * `/v2/reference-data/locations/cities` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.referenceData.locations.cities;
+ * ```
+ *
+ * @param {Client} client
+ */
+class Cities {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * Return a list of cities matching a given keyword..
+   *
+   * @param {Object} params
+   * @param {string} params.keyword keyword that should represent
+   * the start of a word in a city name
+   * @return {Promise.<Response,ResponseError>} a Promise
+   *
+   * Return a list of cities matching a keyword 'France'
+   *
+   * ```js
+   * amadeus.referenceData.locations.cities.get({
+   *   keyword: 'FRANCE'
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/reference-data/locations/cities', params);
+  }
+}
+
+export default Cities;