Support ListScenarios endpoint

Author: OndraFiedler

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Recombee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

recombee_api_client/api_client.py

@@ -94,7 +94,7 @@ def __get_base_uri(options: dict, region: str) -> str:
 
     @staticmethod
     def __get_http_headers(additional_headers: dict = None) -> dict:
-        headers = {'User-Agent': 'recombee-python-api-client/5.0.2'}
+        headers = {'User-Agent': 'recombee-python-api-client/5.1.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

recombee_api_client/api_requests/__init__.py

@@ -76,6 +76,7 @@
 from recombee_api_client.api_requests.list_segmentations import ListSegmentations
 from recombee_api_client.api_requests.get_segmentation import GetSegmentation
 from recombee_api_client.api_requests.delete_segmentation import DeleteSegmentation
-from recombee_api_client.api_requests.reset_database import ResetDatabase
 from recombee_api_client.api_requests.batch import Batch
+from recombee_api_client.api_requests.list_scenarios import ListScenarios
+from recombee_api_client.api_requests.reset_database import ResetDatabase
 from recombee_api_client.api_requests.request import Request

recombee_api_client/api_requests/add_manual_reql_segment.py

@@ -8,7 +8,7 @@ class AddManualReqlSegment(Request):
     """
     Adds a new Segment into a Manual ReQL Segmentation.
     
-    The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
+    The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
     
     Required parameters:
     

recombee_api_client/api_requests/add_search_synonym.py

@@ -6,7 +6,7 @@
 
 class AddSearchSynonym(Request):
     """
-    Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+    Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
     
     When the `term` is used in the search query, the `synonym` is also used for the full-text search.
     Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).

recombee_api_client/api_requests/create_auto_reql_segmentation.py

@@ -6,7 +6,7 @@
 
 class CreateAutoReqlSegmentation(Request):
     """
-    Segment the items using a [ReQL](https://docs.recombee.com/reql.html) expression.
+    Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
     
     For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
     

recombee_api_client/api_requests/create_manual_reql_segmentation.py

@@ -6,7 +6,7 @@
 
 class CreateManualReqlSegmentation(Request):
     """
-    Segment the items using multiple [ReQL](https://docs.recombee.com/reql.html) filters.
+    Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
     
     Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
     

recombee_api_client/api_requests/delete_item.py

@@ -10,7 +10,7 @@ class DeleteItem(Request):
     
     If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
     
-    If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+    If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
     
     Required parameters:
     

recombee_api_client/api_requests/delete_more_items.py

@@ -8,10 +8,10 @@ class DeleteMoreItems(Request):
     """
     Deletes all the items that pass the filter.
     
-    If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+    If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
     Required parameters:
     
-    :param filter: A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+    :param filter: A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
     
 
     """

recombee_api_client/api_requests/delete_search_synonym.py

@@ -6,7 +6,7 @@
 
 class DeleteSearchSynonym(Request):
     """
-    Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+    Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#search-items).
     
     Required parameters: