Merge pull request #451 from watson-developer-cloud/readme

feat(readme): Update readme with gdpr support

Author: germanattanasio

README.md

@@ -93,6 +93,50 @@ response = assistant.message(workspace_id=workspace_id, input={
 print(json.dumps(response, indent=2))
 ```
 
+## Sending Request Headers
+Custom headers can be passed in any request in the form of a `dict` as:
+```python
+headers = {
+    'Custom-Header': 'custom_value'
+}
+```
+For example, to send a header called `Custom-Header` to a call in Watson Assistant, pass
+the headers parameter as:
+```python
+from watson_developer_cloud import AssistantV1
+
+assistant = AssistantV1(
+    username='xxx',
+    password='yyy',
+    version='2017-04-21')
+
+response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
+```
+
+## Parsing HTTP Response Info
+If you would like access to some HTTP response information along with the response model, you can set the `set_detailed_response()` to `True`
+```python
+from watson_developer_cloud import AssistantV1
+
+assistant = AssistantV1(
+    username='xxx',
+    password='yyy',
+    version='2017-04-21')
+
+assistant.set_detailed_response(True)
+response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
+print(response)
+```
+
+This would give an output of `DetailedResponse` having the structure:
+```python
+{
+    'result': <response returned by service>,
+    'headers': { <http response headers> }
+}
+```
+You can use the `get_result()` and `get_headers()` to return the result and headers respectively.
+
 ## Dependencies
 
 * [requests]

examples/tone_analyzer_v3.py

@@ -53,3 +53,5 @@
                               headers={'Custom-Header': 'custom_value'})
 
 print(tone)
+print(tone.get_headers())
+print(tone.get_result())

watson_developer_cloud/watson_service.py

@@ -145,15 +145,21 @@ class DetailedResponse(object):
     :param dict headers: A dict of response headers
     """
     def __init__(self, response=None, headers=None):
-        self.response = response
+        self.result = response
         self.headers = headers
 
+    def get_result(self):
+        return self.result
+
+    def get_headers(self):
+        return self.headers
+
     def _to_dict(self):
         _dict = {}
-        if hasattr(self, 'response') and self.response is not None:
-            _dict['response'] = self.response
+        if hasattr(self, 'result') and self.result is not None:
+            _dict['result'] = self.result if isinstance(self.result, dict) else 'HTTP response'
         if hasattr(self, 'headers') and self.headers is not None:
-            _dict['details'] = {'headers': self.headers}
+            _dict['headers'] = self.headers
         return _dict
 
     def __str__(self):