Merge pull request #75 from campaignmonitor/EL-281

EL-281 -- Update the phyton wrapper

Author: YahyaZ

.travis.yml

@@ -6,6 +6,8 @@ python:
   - 3.6
   - 3.7
   - 3.8
+  - 3.9
+  - 3.10
 install:
   - pip install coverage coveralls
 script:

HISTORY.md

@@ -1,5 +1,14 @@
 # createsend-python history
 
+## v7.0.0 - 19 Nov, 2021
+* Upgrades to Createsend API v3.3 which includes new breaking changes
+* Breaking: 'client.campaigns' now returned an object to support pagination (use .Results to get the array of campaigns)
+* Added 'Tags' as another field that is returned in 'client.scheduled', 'client.drafts' and client.campaigns'
+* Added 'Name' as another field that is returned in 'campaign.summary'
+* Add new support for 'client.tags' endpoint (ie: getting list of tags for the client)
+* Add support for pagination, filtering and sorting to 'client.campaigns' endpoint
+* Add Python 3.10 to `tox.ini`
+
 ## v6.1.2 - 10 Feb, 2021
 * Add `excludemessagebody` parameter for Transactional message details endpoint
   and update tests.

README.md

@@ -1,6 +1,6 @@
 # createsend
 
-A Python library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/). Requires Python 2.7, 3.4, 3.5, 3.6 or 3.7.
+A Python library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/). Requires Python 2.7, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9 or 3.10.
 
 ## Installation
 
@@ -89,7 +89,7 @@ clients = cs.clients()
 ```
 
 ## Basic usage
-This example of listing all your clients and their campaigns demonstrates basic usage of the library and the data returned from the API:
+This example of listing all your clients and their draft campaigns demonstrates basic usage of the library and the data returned from the API:
 
 ```python
 from createsend import *
@@ -104,7 +104,7 @@ for cl in clients:
   print("Client: %s" % cl.Name)
   client = Client(auth, cl.ClientID)
   print("- Campaigns:")
-  for cm in client.campaigns():
+  for cm in client.drafts():
     print("  - %s" % cm.Subject)
 ```
 

lib/createsend/client.py

@@ -29,9 +29,17 @@ def details(self):
         response = self._get("/clients/%s.json" % self.client_id)
         return json_to_py(response)
 
-    def campaigns(self):
+    def campaigns(self, sent_from_date="", sent_to_date="", tags="", page=1, page_size=1000, order_direction="desc"):
         """Gets the sent campaigns belonging to this client."""
-        response = self._get(self.uri_for("campaigns"))
+        params = {
+            "sentfromdate": sent_from_date,
+            "senttodate": sent_to_date,
+            "page": page,
+            "tags": tags,
+            "pagesize": page_size,
+            "orderdirection": order_direction,
+        }
+        response = self._get(self.uri_for("campaigns"), params=params)
         return json_to_py(response)
 
     def scheduled(self):
@@ -44,6 +52,11 @@ def drafts(self):
         response = self._get(self.uri_for("drafts"))
         return json_to_py(response)
 
+    def tags(self):
+        """Gets the list of tags belonging to this client."""
+        response = self._get(self.uri_for("tags"))
+        return json_to_py(response)
+
     def lists(self):
         """Gets the subscriber lists belonging to this client."""
         response = self._get(self.uri_for("lists"))

lib/createsend/createsend.py

@@ -252,7 +252,7 @@ def _delete(self, path, params={}):
 
 class CreateSend(CreateSendBase):
     """Provides high level CreateSend functionality/data you'll probably need."""
-    base_uri = "https://api.createsend.com/api/v3.2"
+    base_uri = "https://api.createsend.com/api/v3.3"
     oauth_uri = "https://api.createsend.com/oauth"
     oauth_token_uri = "%s/token" % oauth_uri
     platform = os.getenv('SERVER_SOFTWARE') or platform.platform()

lib/createsend/utils.py

@@ -171,6 +171,6 @@ def createsend_url(self, url):
             if url.startswith("http"):
                 return url
             else:
-                return "https://api.createsend.com/api/v3.2/%s" % url
+                return "https://api.createsend.com/api/v3.3/%s" % url
 
     return Faker(expected_url, filename, status, body)

samples/campaigns.py

@@ -0,0 +1,13 @@
+from createsend import *
+
+auth = {
+  'access_token': 'YOUR_ACCESS_TOKEN',
+  'refresh_token': 'YOUR_REFRESH_TOKEN' }
+campaignId = 'YOUR_CAMPAIGN_ID'
+
+campaign = Campaign(auth, campaignId)
+
+# Get the summary info for a campaign
+summary = campaign.summary()
+for property, value in vars(summary).items():
+  print(property, ":", value)

samples/clients.py

@@ -0,0 +1,56 @@
+from createsend import *
+
+auth = {
+  'access_token': 'YOUR_ACCESS_TOKEN',
+  'refresh_token': 'YOUR_REFRESH_TOKEN' }
+clientId = 'YOUR_CLIENT_ID'
+
+
+cs = CreateSend(auth)
+client = Client(auth, clientId)
+
+# Get list of sent campaigns
+print("List of sent campaigns:")
+pageNumber = 1
+pagedCampaigns = client.campaigns(page = 1)
+numberOfPages = pagedCampaigns.NumberOfPages
+while pageNumber <= numberOfPages:
+  if (pageNumber > 1):
+    pagedCampaigns = client.campaigns(page = pageNumber)
+  
+  print("  Page: %d" % pageNumber)
+  for cm in pagedCampaigns.Results:
+    print("    - %s" % cm.Subject)
+  
+  pageNumber = pageNumber + 1
+
+  
+# Get list of sent campaigns filtered by tags and date
+print("List of sent campaigns at 2021 with ABTest tag:")
+pageNumber = 1
+pagedCampaigns = client.campaigns(page = 1, sent_from_date="2021-01-01", sent_to_date="2022-01-01", tags="ABTest")
+numberOfPages = pagedCampaigns.NumberOfPages
+while pageNumber <= numberOfPages:
+  if (pageNumber > 1):
+    pagedCampaigns = client.campaigns(page = pageNumber, sent_from_date="2021-01-01", sent_to_date="2022-01-01", tags="ABTest")
+  
+  print("  Page: %d" % pageNumber)
+  for cm in pagedCampaigns.Results:
+    print("    - %s" % cm.Subject)
+  
+  pageNumber = pageNumber + 1
+
+# Get list of drafts campaigns
+print("List of drafts campaigns:")
+for cm in client.drafts():
+  print("  - %s" % cm.Subject)
+
+# Get list of scheduled campaigns
+print("List of scheduled campaigns:")
+for cm in client.scheduled():
+  print("  - %s" % cm.Subject)
+
+# Get list of tags
+print("List of tags:")
+for tag in client.tags():
+  print("  Tag: %s - NumberOfCampaigns: %d" % (tag.Name, tag.NumberOfCampaigns))

samples/general.py

@@ -0,0 +1,12 @@
+from createsend import *
+
+auth = {
+  'access_token': 'YOUR_ACCESS_TOKEN',
+  'refresh_token': 'YOUR_REFRESH_TOKEN' }
+
+cs = CreateSend(auth)
+clients = cs.clients()
+
+# Get list of clients 
+for cl in clients:
+  print("Client: %s - Id: %s" % (cl.Name, cl.ClientID))

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="createsend",
-    version='6.1.2',
+    version='7.0.0',
     description="A library which implements the complete functionality of the Campaign Monitor API.",
     author='Campaign Monitor',
     author_email='[email protected]',
@@ -48,5 +48,7 @@
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
     ]
 )