Add method for getting campaigns statistic based on list of emails

Author: Alexey Moroz

pysendpulse/examples/sendpulse-rest-api-example.py

@@ -73,6 +73,10 @@
     emails_for_delete = ['[email protected]']
     SPApiProxy.delete_emails_from_addressbook(ADDRESSBOOK_ID, emails_for_delete)
 
+    #Get campaigns statistic for list of emails
+    emails_list = ['[email protected]']
+    SPApiProxy.get_emails_stat_by_campaigns(emails_list)
+
     # Add sender "FROM" email
     SPApiProxy.add_sender('[email protected]', 'Jane Roe')
 
@@ -117,7 +121,7 @@
         '11111111111',
         '22222222222'
     ]
-    SPApiProxy.sms_add_phones(ADDRESSBOOK_ID, phones_for_add);
+    SPApiProxy.sms_add_phones(ADDRESSBOOK_ID, phones_for_add)
 
     # Add phones to address book
     phones_for_add = {
@@ -139,7 +143,7 @@
                  ]
         }
 
-    SPApiProxy.sms_add_phones_with_variables(ADDRESSBOOK_ID, phones_for_add);
+    SPApiProxy.sms_add_phones_with_variables(ADDRESSBOOK_ID, phones_for_add)
 
     # Update phones variables from the address book
     phones_for_update = [
@@ -150,7 +154,7 @@
             "name":"name","type":"string", "value":"Michael"
         }
     ]
-    SPApiProxy.sms_update_phones_variables(ADDRESSBOOK_ID, phones_for_update, variables);
+    SPApiProxy.sms_update_phones_variables(ADDRESSBOOK_ID, phones_for_update, variables)
 
     # Get information about phone from the address book
     SPApiProxy.sms_get_phone_info(ADDRESSBOOK_ID, '1111111111')
@@ -160,7 +164,7 @@
         '11111111111',
         '22222222222'
     ]
-    SPApiProxy.sms_delete_phones(ADDRESSBOOK_ID, phones_for_remove);
+    SPApiProxy.sms_delete_phones(ADDRESSBOOK_ID, phones_for_remove)
 
     # Get phones from the blacklist
     SPApiProxy.sms_get_blacklist()
@@ -170,24 +174,24 @@
         '111222227',
         '222333337'
     ]
-    SPApiProxy.sms_add_phones_to_blacklist(phones_for_add_to_blacklist, 'test');
+    SPApiProxy.sms_add_phones_to_blacklist(phones_for_add_to_blacklist, 'test')
 
     # Remove phones from blacklist
     phones_for_remove = [
         '11111111111',
         '22222222222'
     ]
-    SPApiProxy.sms_delete_phones_from_blacklist(phones_for_remove);
+    SPApiProxy.sms_delete_phones_from_blacklist(phones_for_remove)
 
     # Get info by phones from the blacklist
     phones = [
         '11111111111',
         '22222222222'
     ]
-    SPApiProxy.sms_get_phones_info_from_blacklist(phones);
+    SPApiProxy.sms_get_phones_info_from_blacklist(phones)
 
     # Create new sms campaign
-    SPApiProxy.sms_add_campaign(SENDER_NAME, ADDRESSBOOK_ID, 'test');
+    SPApiProxy.sms_add_campaign(SENDER_NAME, ADDRESSBOOK_ID, 'test')
 
     # Send sms by some phones
     phones_for_send = [
@@ -196,19 +200,19 @@
     SPApiProxy.sms_send(SENDER_NAME, phones_for_send, 'test')
 
     # Get list of sms campaigns
-    date_from = '2018-04-10 23:00:00';
-    date_to = '2018-05-10 23:00:00';
-    SPApiProxy.sms_get_list_campaigns(date_from, date_to);
+    date_from = '2018-04-10 23:00:00'
+    date_to = '2018-05-10 23:00:00'
+    SPApiProxy.sms_get_list_campaigns(date_from, date_to)
 
     # Get information about sms campaign
-    SPApiProxy.sms_get_campaign_info(CAMPAIGN_ID);
+    SPApiProxy.sms_get_campaign_info(CAMPAIGN_ID)
 
     # Cancel sms campaign
-    SPApiProxy.sms_cancel_campaign(CAMPAIGN_ID);
+    SPApiProxy.sms_cancel_campaign(CAMPAIGN_ID)
 
     # Get cost sms campaign
-    SPApiProxy.sms_get_campaign_cost('sender', 'test', ADDRESSBOOK_ID);
+    SPApiProxy.sms_get_campaign_cost('sender', 'test', ADDRESSBOOK_ID)
     #SPApiProxy.sms_get_campaign_cost('sender', 'test', None, ['111111111'])
 
     # Remove sms campaign
-    SPApiProxy.sms_delete_campaign(CAMPAIGN_ID);
+    SPApiProxy.sms_delete_campaign(CAMPAIGN_ID)

pysendpulse/pysendpulse.py

@@ -322,6 +322,22 @@ def delete_emails_from_addressbook(self, id, emails):
             return self.__handle_error("Emails list can't be converted by JSON library")
         return self.__handle_result(self.__send_request('addressbooks/{}/emails'.format(id), 'DELETE', {'emails': emails}))
 
+    def get_emails_stat_by_campaigns(self, emails):
+        """ Get campaigns statistic for list of emails
+
+        @param emails: list of emails ['test_1@test_1.com', ..., 'test_n@test_n.com']
+        @return: dictionary with response message
+        """
+        logging.info("Function call: get_emails_stat_by_campaigns")
+        if not emails:
+            self.__handle_error("Empty emails")
+        try:
+            emails = json.dumps(emails)
+        except:
+            logging.debug("Emails: {}".format(emails))
+            return self.__handle_error("Emails list can't be converted by JSON library")
+        return self.__handle_result(self.__send_request('emails/campaigns', 'POST', {'emails': emails}))
+
     # ------------------------------------------------------------------ #
     #                        EMAIL  CAMPAIGNS                            #
     # ------------------------------------------------------------------ #