Add get_all_subscribers_list_id() + allow options to be passed to get_objects

Sebastien.Dangelo · Sebastien.Dangelo · commit 416a50c71837 · 2021-03-31T16:15:50.000+02:00
diff --git a/FuelSDKWrapper.py b/FuelSDKWrapper.py
@@ -559,14 +559,16 @@ def extract_data(self, parameters):
         return res
 
     @validate_response()
-    def get_objects(self, object_type, search_filter=None, property_list=None, query_all_accounts=False, is_rest=False):
+    def get_objects(self, object_type, search_filter=None, property_list=None, query_all_accounts=False, is_rest=False, options=None):
         obj = self.get_object_class(object_type, is_rest)
         if search_filter:
             obj.search_filter = search_filter
         if property_list:
             obj.props = property_list
         if query_all_accounts:
             obj.QueryAllAccounts = True
+        if options:
+            obj.options = options
         return obj.get()
 
     @validate_response()
@@ -1136,3 +1138,11 @@ def get_email_preview(self, email_id, list_id=None, data_extension_key=None, con
         token = self.get_client().authToken
         res = requests.post(url, headers={"Authorization": "Bearer {}".format(token)})
         return res.json()
+
+    def get_all_subscribers_list_id(self):
+        res = self.get_objects(ObjectType.LIST_SEND,
+                               search_filter=simple_filter("List.ListName", Operator.EQUALS, "All Subscribers"),
+                               property_list=["List.ID"],
+                               options={"BatchSize": 1})
+        if res.results:
+            return res.results[0].List.ID
diff --git a/README.md b/README.md
@@ -198,6 +198,10 @@ res = api.get_email_preview(
     data_extension_key="My_DE_Key",
     contact_key="My_Contact_Key"
 )
+
+# Retrieve All Subscribers List ID
+# The real ID is not what is sent by the SOAP List object
+all_subscribers_list_id = api.get_all_subscribers_list_id()
 ```
 
 ### Get More Results
diff --git a/__init__.py b/__init__.py
@@ -1,4 +1,4 @@
 __title__ = 'FuelSDKWrapper'
-__version__ = '1.3.3'
+__version__ = '1.3.4'
 __author__ = 'Seb Angel'
 __license__ = 'MIT'
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     readme = f.read()
 
 setup(
-    version='1.3.3',
+    version='1.3.4',
     name='FuelSDKWrapper',
     description='Simplify and enhance the FuelSDK for Salesforce Marketing Cloud (ExactTarget)',
     long_description=readme,
