Merge pull request #146 from sendgrid/api_keys_v3

Added api_keys POST, PATCH, DELETE

Author: thinkingserious

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.15] - 2015-11-17 ##
+
+### Added ###
+
+- API Keys documentation for [POST, PATCH, DELETE]
+
 ## [1.5.14] - 2015-11-09 ##
 
 ### Fixed ###

README.rst

@@ -248,6 +248,29 @@ List all API Keys belonging to the authenticated user.
     client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
     status, msg = client.apikeys.get()
     
+Generate a new API Key for the authenticated user
+
+.. code:: python
+
+    client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    name = "My Amazing API Key"
+    status, msg = client.apikeys.post(name)
+    
+Revoke an existing API Key
+
+.. code:: python
+
+    client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    status, msg = client.apikeys.delete(api_key_id)
+    
+Update the name of an existing API Key
+
+.. code:: python
+
+    client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    name = "My NEW API Key 3000"
+    status, msg = client.apikeys.patch(api_key_id, name)
+    
 `Suppression Management`_
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

example_v2_test.py

@@ -9,12 +9,14 @@
 sg = sendgrid.SendGridClient(os.environ.get('SENDGRID_USERNAME'), os.environ.get('SENDGRID_PASSWORD'))
 
 """
+to = 'Jane Doe <example@example.com>'
+from = 'John Doe <example@example.com>'
 message = sendgrid.Mail()
-message.add_to('Elmer Thomas <elmer@thinkingserious.com>')
+message.add_to(to)
 message.set_subject('Testing from the Python library')
 message.set_html('<b>This was a successful test!</b>')
 message.set_text('This was a successful test!')
-message.set_from('Elmer Thomas <dx@sendgrid.com>')
+message.set_from(from)
 status, msg = sg.send(message)
 print status
 print msg

example_v3_test.py

@@ -11,8 +11,7 @@
 client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
 
 """
-
-email = 'elmer.thomas+test_global0@gmail.com'
+email = 'example@example.com'
 status, msg = client.asm_global_suppressions.delete(email)
 print status
 print msg
@@ -21,7 +20,7 @@
 print status
 print msg
 
-status, msg = client.asm_global_suppressions.post(['elmer.thomas+test_global0@gmail.com'])
+status, msg = client.asm_global_suppressions.post(['example@example.com'])
 print status
 print msg
 
@@ -47,24 +46,24 @@
 print msg
 
 # In the global suppression list
-status, msg = client.asm_global_suppressions.get('elmer.thomas+test_global@gmail.com')
+status, msg = client.asm_global_suppressions.get('example@example.com')
 print status
 print msg
 
 # Not in the global suppression list
-status, msg = client.asm_global_suppressions.get('elmer.thomas@gmail.com')
+status, msg = client.asm_global_suppressions.get('example@example.com')
 print status
 print msg
 
 status, msg = client.apikeys.get()
 print status
 print msg
 
-status, msg = client.asm_suppressions.delete(67,'elmer+test@thinkingserious.com')
+status, msg = client.asm_suppressions.delete(67,'example@example.com')
 print status
 print msg
 
-status, msg = client.asm_suppressions.post(60, ['elmer+test@thinkingserious.com', 'elmer.thomas@yahoo.com'])
+status, msg = client.asm_suppressions.post(60, ['example@example.com', 'example@example.com])
 print status
 print msg
 

sendgrid/version.py

@@ -1,2 +1,2 @@
-version_info = (1, 5, 14)
+version_info = (1, 5, 15)
 __version__ = '.'.join(str(v) for v in version_info)