Merge pull request #155 from amadeus4dev/add-Trip-parser-v3-and-airline-routes

add airline routes + trip parser v3

Author: tsolakoua

.gitignore

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

.npmignore

@@ -6,3 +6,4 @@ spec
 docs
 test.js
 coverage
+.DS_Store

README.md

@@ -177,6 +177,12 @@ amadeus.airport.directDestinations.get({
      departureAirportCode: 'CDG',
 })
 
+//Airline Routes
+//find all destinations served by a given airline
+amadeus.airline.destinations.get({
+     airlineCode: 'BA',
+ })
+
 // Flight Inspiration Search
 amadeus.shopping.flightDestinations.get({
   origin : 'MAD'
@@ -332,18 +338,28 @@ amadeus.travel.analytics.airTraffic.busiestPeriod.get({
   direction: Amadeus.direction.arriving
 })
 
-// Trip Parser API
-// To submit a new job
-amadeus.travel.tripParserJobs().post(
+// Trip Parser API V3
+// parse information from flight, hotel, rail, and rental car confirmation emails
+// Parse directly from your confirmation file by using helper `fromFile`
+amadeus.travel.tripParser.post(
   JSON.stringify({
-    'type': 'trip-parser-job',
-    'content': 'base64String'
-  })
-)
-// To check status of the job with ID 'XXX'
-amadeus.travel.tripParserJobs('XXX').get()
-// To get the results of the job with ID 'XXX'
-amadeus.travel.tripParserJobs('XXX').result.get()
+  'payload': amadeus.travel.tripParser.fromFile(fs.readFileSync('confirmation.eml')),
+  "metadata": {
+    "documentType": "eml",
+    "name": "BOOKING_DOCUMENT",
+    "encoding": "BASE_64"
+  }
+}))
+// Alternatively Parse from a string encoded in BASE_64
+amadeus.travel.tripParser.post(
+  JSON.stringify({
+  'payload': "STRING in BASE_64"
+  "metadata": {
+    "documentType": "html",
+    "name": "BOOKING_DOCUMENT",
+    "encoding": "BASE_64"
+  }
+}))
 
 // City Search API
 // finds cities that match a specific word or string of letters. 

spec/amadeus/namespaces.test.js

@@ -48,8 +48,7 @@ describe('Namespaces', () => {
       expect(amadeus.travel.predictions).toBeDefined();
       expect(amadeus.travel.predictions.tripPurpose).toBeDefined();
       expect(amadeus.travel.predictions.flightDelay).toBeDefined();
-      expect(amadeus.travel.tripParserJobs).toBeDefined();
-      expect(amadeus.travel.tripParserJobs('XXX').result).toBeDefined();
+      expect(amadeus.travel.tripParser).toBeDefined();
 
       expect(amadeus.shopping).toBeDefined();
       expect(amadeus.shopping.flightDates).toBeDefined();
@@ -103,6 +102,8 @@ describe('Namespaces', () => {
       expect(amadeus.dutyOfCare).toBeDefined();
       expect(amadeus.dutyOfCare.diseases).toBeDefined();
       expect(amadeus.dutyOfCare.diseases.covid19AreaReport).toBeDefined();
+
+      expect(amadeus.airline.destinations).toBeDefined();
     });
 
     it('should define all expected .get methods', () => {
@@ -126,8 +127,6 @@ describe('Namespaces', () => {
       expect(amadeus.travel.analytics.airTraffic.busiestPeriod.get).toBeDefined();
       expect(amadeus.travel.predictions.tripPurpose.get).toBeDefined();
       expect(amadeus.travel.predictions.flightDelay.get).toBeDefined();
-      expect(amadeus.travel.tripParserJobs('XXX').get).toBeDefined();
-      expect(amadeus.travel.tripParserJobs('XXX').result.get).toBeDefined();
 
       expect(amadeus.shopping.flightDates.get).toBeDefined();
       expect(amadeus.shopping.flightDestinations.get).toBeDefined();
@@ -162,13 +161,15 @@ describe('Namespaces', () => {
       expect(amadeus.location.analytics.categoryRatedAreas.get).toBeDefined();
 
       expect(amadeus.dutyOfCare.diseases.covid19AreaReport.get).toBeDefined();
+
+      expect(amadeus.airline.destinations.get).toBeDefined();
     });
 
     it('should define all expected .post methods', () => {
       expect(amadeus.shopping.flightOffers.prediction.post).toBeDefined();
       expect(amadeus.booking.flightOrders.post).toBeDefined();
       expect(amadeus.shopping.flightOffersSearch.post).toBeDefined();
-      expect(amadeus.travel.tripParserJobs('XXX').post).toBeDefined();
+      expect(amadeus.travel.tripParser.post).toBeDefined();
       expect(amadeus.shopping.flightOffers.pricing.post).toBeDefined();
       expect(amadeus.shopping.seatmaps.post).toBeDefined();
       expect(amadeus.booking.hotelBookings.post).toBeDefined();
@@ -318,25 +319,11 @@ describe('Namespaces', () => {
         .toHaveBeenCalledWith('/v1/travel/analytics/air-traffic/busiest-period', {});
     });
 
-    it('.amadeus.travel.tripParserJobs().get', () => {
-      amadeus.client.get = jest.fn();
-      amadeus.travel.tripParserJobs('XXX').get();
-      expect(amadeus.client.get)
-        .toHaveBeenCalledWith('/v2/travel/trip-parser-jobs/XXX');
-    });
-
-    it('.amadeus.travel.tripParserJobs().result.get', () => {
-      amadeus.client.get = jest.fn();
-      amadeus.travel.tripParserJobs('XXX').result.get();
-      expect(amadeus.client.get)
-        .toHaveBeenCalledWith('/v2/travel/trip-parser-jobs/XXX/result');
-    });
-
-    it('.amadeus.travel.tripParserJobs().post', () => {
+    it('.amadeus.travel.tripParser.post', () => {
       amadeus.client.post = jest.fn();
-      amadeus.travel.tripParserJobs().post();
+      amadeus.travel.tripParser.post();
       expect(amadeus.client.post)
-        .toHaveBeenCalledWith('/v2/travel/trip-parser-jobs', {});
+        .toHaveBeenCalledWith('/v3/travel/trip-parser', {});
     });
 
     it('.amadeus.shopping.flightDates.get', () => {
@@ -556,5 +543,12 @@ describe('Namespaces', () => {
         .toHaveBeenCalledWith('/v1/duty-of-care/diseases/covid19-area-report', {});
     });
 
+    it('.amadeus.airline.destinations.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.airline.destinations.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/airline/destinations', {});
+    });
+
   });
 });

src/amadeus.js

@@ -13,6 +13,7 @@ import Schedule      from './amadeus/namespaces/schedule';
 import Analytics     from './amadeus/namespaces/analytics';
 import Location      from './amadeus/namespaces/location';
 import DutyOfCare    from './amadeus/namespaces/duty_of_care';
+import Airline       from './amadeus/namespaces/airline';
 
 
 /**
@@ -78,6 +79,7 @@ class Amadeus {
     this.analytics      = new Analytics(this.client);
     this.location       = new Location(this.client);
     this.dutyOfCare     = new DutyOfCare(this.client);
+    this.airline        = new Airline(this.client);
   }
 
   /**

src/amadeus/namespaces/airline.js

@@ -0,0 +1,24 @@
+import Destinations from './airline/destinations';
+
+/**
+ * A namespaced client for the
+ * `/v1/airline` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.airline;
+ * ```
+ *
+ * @param {Client} client
+ * @property {predictions} predictions
+ */
+class Airline {
+  constructor(client) {
+    this.client = client;
+    this.destinations = new Destinations(client);
+  }
+}
+
+export default Airline;

src/amadeus/namespaces/airline/destinations.js

@@ -0,0 +1,38 @@
+/**
+ * A namespaced client for the
+ * `/v1/airline/destinations` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.airline.destinations;
+ * ```
+ *
+ * @param {Client} client
+ */
+class Destinations {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+     * find all destinations served by a given airline
+     *
+     * @param {Object} params
+     * @param {string} params.airlineCode airline IATA code, e.g. BA for British airways
+     * @return {Promise.<Response,ResponseError>} a Promise
+     *
+     *  What destinations are served by this airline?
+     *  ```js
+     * amadeus.airline.destinations.get({
+     *   airlineCode: 'BA',
+     * })
+     * ```
+     */
+  get(params = {}) {
+    return this.client.get('/v1/airline/destinations', params);
+  }
+}
+
+export default Destinations;

src/amadeus/namespaces/travel.js

@@ -1,10 +1,10 @@
 import Analytics from './travel/analytics';
 import Predictions from './travel/predictions';
-import TripParserJobs from './travel/trip_parser_jobs';
+import TripParser from './travel/trip_parser';
 
 /**
  * A namespaced client for the
- * `/v1/travel` & `/v2/travel` endpoints
+ * `/v1/travel` & `/v2/travel` & `/v3/travel` endpoints
  *
  * Access via the {@link Amadeus} object
  *
@@ -16,18 +16,15 @@ import TripParserJobs from './travel/trip_parser_jobs';
  * @param {Client} client
  * @property {Analytics} analytics
  * @property {Predictions} predictions
- * @property {TripParserJobs} tripParserJobs
+ * @property {TripParser} tripParser
  * @protected
  */
 class Travel {
   constructor(client) {
     this.client    = client;
     this.analytics = new Analytics(client);
     this.predictions = new Predictions(client);
-  }
-
-  tripParserJobs (jobId) {
-    return new TripParserJobs(this.client, jobId);
+    this.tripParser = new TripParser(client);
   }
 }
 

src/amadeus/namespaces/travel/trip_parser.js

@@ -0,0 +1,43 @@
+/**
+ * A namespaced client for the
+ * `/v3/travel/trip-parser` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.tripParser;
+ * ```
+ *
+ * @param {Client} client
+ */
+class TripParser {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+     * parse information from flight, hotel, rail, and rental car confirmation emails
+     *
+     * @param {Object} params
+     * @return {Promise.<Response,ResponseError>} a Promise
+     *
+     * "How can I show travelers their full itinerary in one place?"
+     *
+     * ```js
+     * amadeus.tripParser.post(body);
+     * ```
+     */
+  post(params = {}) {
+    return this.client.post('/v3/travel/trip-parser', params);
+  }
+  /**
+  * Helper method to convert file contents in UTF-8 encoded string
+  * into Base64 encoded string
+  */
+  fromFile(fileContentsInUTF8Format) {
+    return (new Buffer.from(fileContentsInUTF8Format)).toString('base64');
+  }
+}
+
+export default TripParser;