Pull request #9: feature/EOA-2074-update-functionality

Merge in SDK/python_telesign from feature/EOA-2074-update-functionality to developer

* commit 'e7a16da2cb1aa5d737de4b0f1ae0c3b0b5a72d12':
  update comment
  revert back the name TeleSignSDK
  updated comments
  Added patch method to rest.py for update functionality

Author: mmohanty-telesign

RELEASE

@@ -1,3 +1,6 @@
+2.3.0
+- Added PATCH method to the RestClient class to facilitate Update Verification Process action
+
 2.2.7
 - Added tracking to requests
 

setup.py

@@ -11,7 +11,7 @@
 
 here = path.abspath(path.dirname(__file__))
 
-version = "2.2.7"
+version = "2.3.0"
 
 with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()

telesign/rest.py

@@ -16,8 +16,8 @@
 
 class RestClient(requests.models.RequestEncodingMixin):
     """
-    The TeleSign RestClient is a generic HTTP REST client that can be extended to make requests against any of
-    TeleSign's REST API endpoints.
+    The Telesign RestClient is a generic HTTP REST client that can be extended to make requests against any of
+    Telesign's REST API endpoints.
 
     RequestEncodingMixin offers the function _encode_params for url encoding the body for use in string_to_sign outside
     of a regular HTTP request.
@@ -54,7 +54,7 @@ def __init__(self,
                  timeout=10,
                  auth_method=None):
         """
-        TeleSign RestClient useful for making generic RESTful requests against our API.
+        Telesign RestClient useful for making generic RESTful requests against our API.
 
         :param customer_id: Your customer_id string associated with your account.
         :param api_key: Your api_key string associated with your account.
@@ -99,25 +99,25 @@ def generate_telesign_headers(customer_id,
                                   content_type=None,
                                   auth_method=None):
         """
-        Generates the TeleSign REST API headers used to authenticate requests.
+        Generates the Telesign REST API headers used to authenticate requests.
 
         Creates the canonicalized string_to_sign and generates the HMAC signature. This is used to authenticate requests
-        against the TeleSign REST API.
+        against the Telesign REST API.
 
         See https://developer.telesign.com/docs/authentication for detailed API documentation.
 
         :param customer_id: Your account customer_id.
         :param api_key: Your account api_key.
         :param method_name: The HTTP method name of the request as a upper case string, should be one of 'POST', 'GET',
-            'PUT' or 'DELETE'.
+            'PUT', 'PATCH' or 'DELETE'.
         :param resource: The partial resource URI to perform the request against, as a string.
         :param url_encoded_fields: HTTP body parameters to perform the HTTP request with, must be a urlencoded string.
         :param date_rfc2616: The date and time of the request formatted in rfc 2616, as a string.
         :param nonce: A unique cryptographic nonce for the request, as a string.
         :param user_agent: (optional) User Agent associated with the request, as a string.
         :param content_type: (optional) ContentType of the request, as a string.
         :param auth_method: (optional) Authentication type ex: Basic, HMAC etc
-        :return: The TeleSign authentication headers.
+        :return: The Telesign authentication headers.
         """
         if date_rfc2616 is None:
             date_rfc2616 = formatdate(usegmt=True)
@@ -177,7 +177,7 @@ def generate_telesign_headers(customer_id,
 
     def post(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API POST handler.
+        Generic Telesign REST API POST handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -188,7 +188,7 @@ def post(self, resource, body=None, json_fields=None, **query_params):
 
     def get(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API GET handler.
+        Generic Telesign REST API GET handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -199,7 +199,7 @@ def get(self, resource, body=None, json_fields=None, **query_params):
 
     def put(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API PUT handler.
+        Generic Telesign REST API PUT handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -213,18 +213,30 @@ def set_endpoint(self, rest_endpoint):
 
     def delete(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API DELETE handler.
+        Generic Telesign REST API DELETE handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
         :param query_params: query_params to perform the DELETE request with, as a dictionary.
         :return: The RestClient Response object.
         """
         return self._execute(self.session.delete, 'DELETE', resource, body, json_fields, **query_params)
+    
+    def patch(self, resource, body=None, json_fields=None, **query_params):
+        """
+        Generic Telesign REST API PATCH handler.
+
+        :param resource: The partial resource URI to perform the request against, as a string.
+        :param body: (optional) A dictionary sent as a part of request body.
+        :param json_fields: (optional) A dictionary sent as a JSON body.
+        :param query_params: query_params to perform the PATCH request with, as a dictionary.
+        :return: The RestClient Response object.
+        """
+        return self._execute(self.session.patch, 'PATCH', resource, body, json_fields, **query_params)
 
     def _execute(self, method_function, method_name, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API request handler.
+        Generic Telesign REST API request handler.
 
         :param method_function: The Requests HTTP request function to perform the request.
         :param method_name: The HTTP method name, as an upper case string.