SDK - Trip Purpose Prediction (#43)

Add support for Trip Purpose Prediction API

Author: Anna Tsolakou

README.rst

@@ -256,6 +256,9 @@ List of supported endpoints
     # What are the popular places in Barcelona? (based on a square)
     amadeus.reference_data.locations.points_of_interest.by_square.get(north=41.397158, west=2.160873, south=41.394582, east=2.177181)
 
+    # Trip Purpose Prediction
+    amadeus.travel.predictions.trip_purpose.get(originLocationCode='ATH', destinationLocationCode='MAD', departureDate='2020-08-01', returnDate='2020-08-12', searchDate='2020-06-11')
+
 
 Development & Contributing
 --------------------------

amadeus/namespaces/_travel.py

@@ -1,8 +1,10 @@
 from amadeus.client.decorator import Decorator
 from amadeus.travel._analytics import Analytics
+from amadeus.travel._predictions import Predictions
 
 
 class Travel(Decorator, object):
     def __init__(self, client):
         Decorator.__init__(self, client)
         self.analytics = Analytics(client)
+        self.predictions = Predictions(client)

amadeus/travel/__init__.py

@@ -1,4 +1,4 @@
 from ._analytics import Analytics
+from ._predictions import TripPurpose
 
-
-__all__ = ['Analytics']
+__all__ = ['Analytics', 'TripPurpose']

amadeus/travel/_predictions.py

@@ -0,0 +1,8 @@
+from amadeus.client.decorator import Decorator
+from .predictions import TripPurpose
+
+
+class Predictions(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+        self.trip_purpose = TripPurpose(client)

amadeus/travel/predictions/__init__.py

@@ -0,0 +1,4 @@
+from ._trip_purpose import TripPurpose
+
+
+__all__ = ['TripPurpose']

amadeus/travel/predictions/_trip_purpose.py

@@ -0,0 +1,37 @@
+from amadeus.client.decorator import Decorator
+
+
+class TripPurpose(Decorator, object):
+    def get(self, **params):
+        '''
+        Predicts traveler purpose, Business or Leisure,
+        with the probability in the context of search & shopping
+
+        .. code-block:: python
+
+            amadeus.travel.predictions.trip_purpose.get(
+                            originLocationCode='NYC',
+                            destinationLocationCode='MAD',
+                            departureDate='2020-08-01',
+                            returnDate='2020-08-12',
+                            searchDate='2020-06-11')
+
+        :param originLocationCode: the City/Airport IATA code from which
+            the flight will depart. ``"NYC"``, for example for New York
+
+        :param destinationLocationCode: the City/Airport IATA code to which
+            the flight is going. ``"MAD"``, for example for Madrid
+
+        :param departureDate: the date on which to fly out, in `YYYY-MM-DD` format
+
+        :param returnDate: the date on which the flight returns to the origin,
+            in `YYYY-MM-DD` format
+
+        :param searchDate: the date on which the traveler performs the search,
+            in `YYYY-MM-DD` format.
+            If it is not specified the current date will be used
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get('/v1/travel/predictions/trip-purpose', **params)

docs/index.rst

@@ -68,6 +68,12 @@ Travel/Analytics
 .. autoclass:: amadeus.travel.analytics.FareSearches
   :members: get
 
+Travel/Predictions
+================
+
+.. autoclass:: amadeus.travel.predictions.TripPurpose
+  :members: get
+
 ReferenceData/Locations
 =======================
 

specs/namespaces/namespaces_spec.py

@@ -35,6 +35,9 @@
             be_none)
         expect(client.travel.analytics.air_traffic.busiest_period).not_to(be_none)
 
+        expect(client.travel.predictions).not_to(be_none)
+        expect(client.travel.predictions.trip_purpose).not_to(be_none)
+
         expect(client.shopping).not_to(be_none)
         expect(client.shopping.flight_dates).not_to(be_none)
         expect(client.shopping.flight_destinations).not_to(be_none)
@@ -68,6 +71,8 @@
             client.travel.analytics.air_traffic.busiest_period.get).not_to(
             be_none)
 
+        expect(client.travel.predictions.trip_purpose.get).not_to(be_none)
+
         expect(client.shopping.flight_dates.get).not_to(be_none)
         expect(client.shopping.flight_destinations.get).not_to(be_none)
         expect(client.shopping.flight_offers.get).not_to(be_none)
@@ -156,6 +161,12 @@
                     '/v1/travel/analytics/air-traffic/searched/by-destination',
                     a='b'))
 
+        with it('.travel.predictions.trip_purpose.get'):
+            self.client.travel.predictions.trip_purpose.get(a='b')
+            expect(self.client.get).to(have_been_called_with(
+                '/v1/travel/predictions/trip-purpose', a='b'
+            ))
+
         with it('.shopping.flight_dates.get'):
             self.client.shopping.flight_dates.get(a='b')
             expect(self.client.get).to(have_been_called_with(