Add getting started sample

Author: DanyilNefodov

mailjet_rest/client.py

@@ -12,7 +12,7 @@
 requests.packages.urllib3.disable_warnings()
 
 
-def prepare_url(key: str):
+def prepare_url(key):
     """Replaces capital letters to lower one with dash prefix."""
     char_elem = key.group(0)
     if char_elem.isupper():

samples/contacts_sample.py

@@ -0,0 +1,55 @@
+import json
+import os
+
+from mailjet_rest import Client
+
+
+mailjet30 = Client(auth=(os.environ["MJ_APIKEY_PUBLIC"],
+                         os.environ["MJ_APIKEY_PRIVATE"]))
+
+mailjet31 = Client(auth=(os.environ["MJ_APIKEY_PUBLIC"],
+                         os.environ["MJ_APIKEY_PRIVATE"]),
+                   version="v3.1")
+
+
+def create_contact():
+    """POST https://api.mailjet.com/v3/REST/contact"""
+    data = {
+        "IsExcludedFromCampaigns": "true",
+        "Name": "New Contact",
+        "Email": "[email protected]",
+    }
+    return mailjet30.contact.create(data=data)
+
+
+def create_contact_metadata():
+    """POST https://api.mailjet.com/v3/REST/contactmetadata"""
+    data = {
+        "Datatype": "str",
+        "Name": "first_name",
+        "NameSpace": "static"
+    }
+    return mailjet30.contactmetadata.create(data=data)
+
+
+def edit_contact_data():
+    """PUT https://api.mailjet.com/v3/REST/contactdata/$contact_ID"""
+    id = "*********"  # Put real ID to make it work.
+    data = {
+        "Data": [
+            {
+                "Name": "first_name",
+                "Value": "John"
+            }
+        ]
+    }
+    return mailjet30.contactdata.update(id=id, data=data)
+
+
+if __name__ == "__main__":
+    result = edit_contact_data()
+    print(result.status_code)
+    try:
+        print(json.dumps(result.json(), indent=4))
+    except json.decoder.JSONDecodeError:
+        print(result.text)

samples/getting_started_sample.py

@@ -0,0 +1,81 @@
+import json
+import os
+
+from mailjet_rest import Client
+
+
+mailjet30 = Client(auth=(os.environ["MJ_APIKEY_PUBLIC"],
+                         os.environ["MJ_APIKEY_PRIVATE"]))
+
+mailjet31 = Client(auth=(os.environ["MJ_APIKEY_PUBLIC"],
+                         os.environ["MJ_APIKEY_PRIVATE"]),
+                   version="v3.1")
+
+
+def send_messages():
+    """POST https://api.mailjet.com/v3.1/send"""
+    data = {
+        "Messages": [
+            {
+                "From": {
+                    "Email": "[email protected]",
+                    "Name": "Mailjet Pilot"
+                },
+                "To": [
+                    {
+                        "Email": "[email protected]",
+                        "Name": "passenger 1"
+                    }
+                ],
+                "Subject": "Your email flight plan!",
+                "TextPart": "Dear passenger 1, welcome to Mailjet! May the "
+                            "delivery force be with you!",
+                "HTMLPart": "<h3>Dear passenger 1, welcome to <a href=\"https"
+                            "://www.mailjet.com/\">Mailjet</a>!<br />May the "
+                            "delivery force be with you!"
+            }
+        ],
+        "SandboxMode": True,  # Remove to send real message.
+    }
+    return mailjet31.send.create(data=data)
+
+
+def retrieve_messages_from_campaign():
+    """GET https://api.mailjet.com/v3/REST/message?CampaignID=$CAMPAIGNID"""
+    filters = {
+        "CampaignID": "*****",  # Put real ID to make it work.
+    }
+    return mailjet30.message.get(filters=filters)
+
+
+def retrieve_message():
+    """GET https://api.mailjet.com/v3/REST/message/$MESSAGE_ID"""
+    _id = "*****************"  # Put real ID to make it work.
+    return mailjet30.message.get(_id)
+
+
+def view_message_history():
+    """GET https://api.mailjet.com/v3/REST/messagehistory/$MESSAGE_ID"""
+    _id = "*****************"  # Put real ID to make it work.
+    return mailjet30.messagehistory.get(_id)
+
+
+def retrieve_statistic():
+    """GET https://api.mailjet.com/v3/REST/statcounters?CounterSource=APIKey
+                \\&CounterTiming=Message\\&CounterResolution=Lifetime
+    """
+    filters = {
+        "CounterSource": "APIKey",
+        "CounterTiming": "Message",
+        "CounterResolution": "Lifetime",
+    }
+    return mailjet30.statcounters.get(filters=filters)
+
+
+if __name__ == "__main__":
+    result = retrieve_statistic()
+    print(result.status_code)
+    try:
+        print(json.dumps(result.json(), indent=4))
+    except json.decoder.JSONDecodeError:
+        print(result.text)