Added parameters amount,price,profit to AddPurchase and amount,price to AddCartAddition

Author: OndraFiedler

README.rst

@@ -6,7 +6,7 @@ A Python client for easy use of the `Recombee <https://www.recombee.com/>`_  rec
 
 If you don't have an account at Recombee yet, you can create a free account `here <https://www.recombee.com/>`_.
 
-Documentation of the API can be found at `docs.recombee.com <https://docs.recombee.com/)>`_.
+Documentation of the API can be found at `docs.recombee.com <https://docs.recombee.com/>`_.
 
 =============
 Installation

recombee_api_client/api_client.py

@@ -63,7 +63,7 @@ def send(self, request):
 
     @staticmethod
     def __get_http_headers(additional_headers=None):
-        headers = {'User-Agent': 'recombee-python-api-client/1.5.0'}
+        headers = {'User-Agent': 'recombee-python-api-client/1.6.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

recombee_api_client/api_requests/__init__.py

@@ -53,6 +53,10 @@
 from recombee_api_client.api_requests.delete_view_portion import DeleteViewPortion
 from recombee_api_client.api_requests.list_item_view_portions import ListItemViewPortions
 from recombee_api_client.api_requests.list_user_view_portions import ListUserViewPortions
+from recombee_api_client.api_requests.recommend_items_to_user import RecommendItemsToUser
+from recombee_api_client.api_requests.recommend_users_to_user import RecommendUsersToUser
+from recombee_api_client.api_requests.recommend_items_to_item import RecommendItemsToItem
+from recombee_api_client.api_requests.recommend_users_to_item import RecommendUsersToItem
 from recombee_api_client.api_requests.user_based_recommendation import UserBasedRecommendation
 from recombee_api_client.api_requests.item_based_recommendation import ItemBasedRecommendation
 from recombee_api_client.api_requests.reset_database import ResetDatabase

recombee_api_client/api_requests/add_cart_addition.py

@@ -9,7 +9,7 @@ class AddCartAddition(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT):
         """
         Required parameters:
         @param user_id: User who added the item to the cart
@@ -22,11 +22,17 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param amount: Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+        
+        @param price: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp
         self.cascade_create = cascade_create
+        self.amount = amount
+        self.price = price
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -43,6 +49,10 @@ def get_body_parameters(self):
             p['timestamp'] = self.timestamp
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.amount is not DEFAULT:
+            p['amount'] = self.amount
+        if self.price is not DEFAULT:
+            p['price'] = self.price
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_item_property.py

@@ -21,7 +21,7 @@ def __init__(self, property_name, type):
         """
         self.property_name = property_name
         self.type = type
-        self.timeout = 1000
+        self.timeout = 100000
         self.ensure_https = False
         self.method = 'put'
         self.path = "/items/properties/%s" % (self.property_name)

recombee_api_client/api_requests/add_purchase.py

@@ -9,7 +9,7 @@ class AddPurchase(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT, profit=DEFAULT):
         """
         Required parameters:
         @param user_id: User who purchased the item
@@ -22,11 +22,20 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param amount: Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+        
+        @param price: Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+        
+        @param profit: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp
         self.cascade_create = cascade_create
+        self.amount = amount
+        self.price = price
+        self.profit = profit
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -43,6 +52,12 @@ def get_body_parameters(self):
             p['timestamp'] = self.timestamp
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.amount is not DEFAULT:
+            p['amount'] = self.amount
+        if self.price is not DEFAULT:
+            p['price'] = self.price
+        if self.profit is not DEFAULT:
+            p['profit'] = self.profit
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_user_property.py

@@ -21,7 +21,7 @@ def __init__(self, property_name, type):
         """
         self.property_name = property_name
         self.type = type
-        self.timeout = 1000
+        self.timeout = 100000
         self.ensure_https = False
         self.method = 'put'
         self.path = "/users/properties/%s" % (self.property_name)

recombee_api_client/api_requests/delete_item_property.py

@@ -16,7 +16,7 @@ def __init__(self, property_name):
         
         """
         self.property_name = property_name
-        self.timeout = 1000
+        self.timeout = 100000
         self.ensure_https = False
         self.method = 'delete'
         self.path = "/items/properties/%s" % (self.property_name)

recombee_api_client/api_requests/delete_user_property.py

@@ -16,7 +16,7 @@ def __init__(self, property_name):
         
         """
         self.property_name = property_name
-        self.timeout = 1000
+        self.timeout = 100000
         self.ensure_https = False
         self.method = 'delete'
         self.path = "/users/properties/%s" % (self.property_name)

recombee_api_client/api_requests/get_user_property_info.py

@@ -16,7 +16,7 @@ def __init__(self, property_name):
         
         """
         self.property_name = property_name
-        self.timeout = 1000
+        self.timeout = 100000
         self.ensure_https = False
         self.method = 'get'
         self.path = "/users/properties/%s" % (self.property_name)